PCEHRDispenseItemBuilder (Clinical Document Library 2.0.2 API)

java.lang.Object
- au.gov.nehta.model.cda.npdr.PCEHRDispenseItemBuilder

public class PCEHRDispenseItemBuilder
extends Object

Constructor Summary

Constructors
Constructor and Description

PCEHRDispenseItemBuilder()

Constructors
Constructor and Description
`PCEHRDispenseItemBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PCEHRDispenseItemBuilder`	`addExtemporaneousIngredients(Ingredient i)` Add a patient category
`PCEHRDispenseItemBuilder`	`additionalComments(String comments)` Add additionalComments
`PCEHRDispenseItem`	`build()` Builds a completed prescription item.
`PCEHRDispenseItemBuilder`	`claimTypeCategory(Coded category)` Add a claim type category Mandatory Field
`PCEHRDispenseItemBuilder`	`closeTheGapId(UniqueIdentifier closeTheGapId)` Add a close the gap ID
`PCEHRDispenseItemBuilder`	`dispenseItem(UniqueIdentifier id)` Add a dispense item identifier Mandatory Field
`PCEHRDispenseItemBuilder`	`dispensingStatusType(DispensingStatusType type)` Add a dispensing status Mandatory Field
`PCEHRDispenseItemBuilder`	`earlySupplyWithBenifit(boolean earlySupplyWithBenefit)` Add a code identifying the supply as early with pbs benefits
`PCEHRDispenseItemBuilder`	`eventDate(ZonedDateTime date)` Add a dispense event date Mandatory Field
`PCEHRDispenseItemBuilder`	`formula(String formula)` Add a formula
`PCEHRDispenseItemBuilder`	`isbrandSubstitutionOccured(boolean isSubstituted)` Add an indicator to signal whether brand substitution occurred or not Mandatory Field
`void`	`isValid()`
`PCEHRDispenseItemBuilder`	`labelInstruction(String instruction)` Add a label instruction
`PCEHRDispenseItemBuilder`	`maximumNumberOfRepeats(int maxRepeats)` Add a maximum number of repeats Mandatory Field
`PCEHRDispenseItemBuilder`	`numberOfThisDispense(int numberOfThisDispense)` Add a maximum number of repeats Mandatory Field
`PCEHRDispenseItemBuilder`	`patientCategory(PatientCategory category)` Add a patient category Mandatory Field
`PCEHRDispenseItemBuilder`	`pbsItemCode(Coded pbsItemCode)` Add a PBS/RPBS item code
`PCEHRDispenseItemBuilder`	`pbsManufacturerCode(UniqueIdentifier pbsManufacturerCode)` Add a PBS/RPBS manufacturer code
`PCEHRDispenseItemBuilder`	`prescriptionItem(UniqueIdentifier id)` Add a prescription item identifier Mandatory Field
`PCEHRDispenseItemBuilder`	`quantityDispensed(QuantityUnitDescription quantityDispensed)` Add quantity dispensed Mandatory Field
`PCEHRDispenseItemBuilder`	`racfId(String racfId)` Add an racf Id
`PCEHRDispenseItemBuilder`	`therapeuticGood(Code code)` Add a Therapeutic Good identifier Mandatory Field
`PCEHRDispenseItemBuilder`	`underCoPayment(ClaimTypeCategory underCoPayment)` Add a code signaling this item was under co-payment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PCEHRDispenseItemBuilder
```
public PCEHRDispenseItemBuilder()
```
- Method Detail
  - therapeuticGood
```
public PCEHRDispenseItemBuilder therapeuticGood(Code code)
```
    Add a Therapeutic Good identifier
    Mandatory Field
    
    May be chained with other calls
  - eventDate
```
public PCEHRDispenseItemBuilder eventDate(ZonedDateTime date)
```
    Add a dispense event date
    Mandatory Field
    
    May be chained with other calls
  - prescriptionItem
```
public PCEHRDispenseItemBuilder prescriptionItem(UniqueIdentifier id)
```
    Add a prescription item identifier
    Mandatory Field
    
    May be chained with other calls
  - dispenseItem
```
public PCEHRDispenseItemBuilder dispenseItem(UniqueIdentifier id)
```
    Add a dispense item identifier
    Mandatory Field
    
    May be chained with other calls
  - isbrandSubstitutionOccured
```
public PCEHRDispenseItemBuilder isbrandSubstitutionOccured(boolean isSubstituted)
```
    Add an indicator to signal whether brand substitution occurred or not
    Mandatory Field
    
    May be chained with other calls
  - maximumNumberOfRepeats
```
public PCEHRDispenseItemBuilder maximumNumberOfRepeats(int maxRepeats)
```
    Add a maximum number of repeats
    Mandatory Field
    
    May be chained with other calls
  - numberOfThisDispense
```
public PCEHRDispenseItemBuilder numberOfThisDispense(int numberOfThisDispense)
```
    Add a maximum number of repeats
    Mandatory Field
    
    May be chained with other calls
  - claimTypeCategory
```
public PCEHRDispenseItemBuilder claimTypeCategory(Coded category)
```
    Add a claim type category
    Mandatory Field
    
    May be chained with other calls
  - patientCategory
```
public PCEHRDispenseItemBuilder patientCategory(PatientCategory category)
```
    Add a patient category
    Mandatory Field
    
    May be chained with other calls
  - dispensingStatusType
```
public PCEHRDispenseItemBuilder dispensingStatusType(DispensingStatusType type)
```
    Add a dispensing status
    Mandatory Field
    
    May be chained with other calls
  - quantityDispensed
```
public PCEHRDispenseItemBuilder quantityDispensed(QuantityUnitDescription quantityDispensed)
```
    Add quantity dispensed
    Mandatory Field
    
    may be chained with other calls
  - addExtemporaneousIngredients
```
public PCEHRDispenseItemBuilder addExtemporaneousIngredients(Ingredient i)
```
    Add a patient category
    
    This method may be called repeatedly without overwriting the previous value
    
    May be chained with other calls
  - formula
```
public PCEHRDispenseItemBuilder formula(String formula)
```
    Add a formula
    
    May be chained with other calls
  - labelInstruction
```
public PCEHRDispenseItemBuilder labelInstruction(String instruction)
```
    Add a label instruction
    
    May be chained with other calls
  - closeTheGapId
```
public PCEHRDispenseItemBuilder closeTheGapId(UniqueIdentifier closeTheGapId)
```
    Add a close the gap ID
    
    May be chained with other calls
  - pbsItemCode
```
public PCEHRDispenseItemBuilder pbsItemCode(Coded pbsItemCode)
```
    Add a PBS/RPBS item code
    
    May be chained with other calls
  - pbsManufacturerCode
```
public PCEHRDispenseItemBuilder pbsManufacturerCode(UniqueIdentifier pbsManufacturerCode)
```
    Add a PBS/RPBS manufacturer code
    
    May be chained with other calls
  - underCoPayment
```
public PCEHRDispenseItemBuilder underCoPayment(ClaimTypeCategory underCoPayment)
```
    Add a code signaling this item was under co-payment
    
    May be chained with other calls
  - earlySupplyWithBenifit
```
public PCEHRDispenseItemBuilder earlySupplyWithBenifit(boolean earlySupplyWithBenefit)
```
    Add a code identifying the supply as early with pbs benefits
    
    May be chained with other calls
  - additionalComments
```
public PCEHRDispenseItemBuilder additionalComments(String comments)
```
    Add additionalComments
    
    May be chained with other calls
  - racfId
```
public PCEHRDispenseItemBuilder racfId(String racfId)
```
    Add an racf Id
    
    May be chained with other calls
  - build
```
public PCEHRDispenseItem build()
                        throws IllegalArgumentException
```
    Builds a completed prescription item.
    
    Returns:
    
    a valid DispenseItem
    
    Throws:
    
    IllegalArgumentException - Exception when illegal argument provided.
  - isValid
```
public void isValid()
             throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException

Class PCEHRDispenseItemBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PCEHRDispenseItemBuilder

Method Detail

therapeuticGood

eventDate

prescriptionItem

dispenseItem

isbrandSubstitutionOccured

maximumNumberOfRepeats

numberOfThisDispense

claimTypeCategory

patientCategory

dispensingStatusType

quantityDispensed

addExtemporaneousIngredients

formula

labelInstruction

closeTheGapId

pbsItemCode

pbsManufacturerCode

underCoPayment

earlySupplyWithBenifit

additionalComments

racfId

build

isValid