DispenseItemBuilder (Clinical Document Library 2.0.2 API)

java.lang.Object
- au.gov.nehta.model.clinical.etp.dispenserecord.DispenseItemBuilder

public class DispenseItemBuilder
extends Object

Constructor Summary

Constructors
Constructor and Description

DispenseItemBuilder()

Constructors
Constructor and Description
`DispenseItemBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DispenseItemBuilder`	`addExtemporaneousIngredients(Ingredient i)` Add a patient category.
`DispenseItemBuilder`	`additionalComments(String comments)` Add additionalComments.
`DispenseItem`	`build()` Builds a completed prescription item.
`DispenseItemBuilder`	`claimTypeCategory(Coded category)` Add a claim type category. Mandatory Field
`DispenseItemBuilder`	`closeTheGapId(UniqueIdentifier closeTheGapId)` Add a close the gap ID.
`DispenseItemBuilder`	`dispenseItem(UniqueIdentifier id)` Add a dispense item identifier. Mandatory Field
`DispenseItemBuilder`	`dispensingStatusType(DispensingStatusType type)` Add a dispensing status. Mandatory Field
`DispenseItemBuilder`	`earlySupplyWithBenifit(boolean earlySupplyWithBenefit)` Add a code identifying the supply as early with pbs benefits.
`DispenseItemBuilder`	`eventDate(ZonedDateTime date)` Add a dispense event date. Mandatory Field
`DispenseItemBuilder`	`formula(String formula)` Add a formula.
`DispenseItemBuilder`	`isbrandSubstitutionOccured(boolean isSubstituted)` Add an indicator to signal whether brand substitution occurred or not. Mandatory Field
`void`	`isValid()`
`DispenseItemBuilder`	`labelInstruction(String instruction)` Add a label instruction
`DispenseItemBuilder`	`maximumNumberOfRepeats(int maxRepeats)` Add a maximum number of repeats. Mandatory Field
`DispenseItemBuilder`	`numberOfThisDispense(int numberOfThisDispense)` Add a maximum number of repeats. Mandatory Field
`DispenseItemBuilder`	`patientCategory(PatientCategory category)` Add a patient category. Mandatory Field
`DispenseItemBuilder`	`pbsItemCode(Coded code)` Add a PBS/RPBS item code.
`DispenseItemBuilder`	`pbsManufacturerCode(UniqueIdentifier pbsManufacturerCode)` Add a PBS/RPBS manufacturer code.
`DispenseItemBuilder`	`prescriptionItem(UniqueIdentifier id)` Add a prescription item identifier. Mandatory Field
`DispenseItemBuilder`	`quantityDispensed(QuantityUnitDescription quantityDispensed)` Add quantity dispensed. Mandatory Field
`DispenseItemBuilder`	`racfId(String racfId)` Add an racf Id.
`DispenseItemBuilder`	`therapeuticGood(Code code)` Add a Therapeutic Good identifier. Mandatory Field
`DispenseItemBuilder`	`underCoPayment(ClaimTypeCategory underCoPayment)` Add a code signalling 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
  - DispenseItemBuilder
```
public DispenseItemBuilder()
```
- Method Detail
  - therapeuticGood
```
public DispenseItemBuilder therapeuticGood(Code code)
```
    Add a Therapeutic Good identifier.
    Mandatory Field
    
    May be chained with other calls.
  - eventDate
```
public DispenseItemBuilder eventDate(ZonedDateTime date)
```
    Add a dispense event date.
    Mandatory Field
    
    May be chained with other calls.
  - prescriptionItem
```
public DispenseItemBuilder prescriptionItem(UniqueIdentifier id)
```
    Add a prescription item identifier.
    Mandatory Field
    
    May be chained with other calls.
  - dispenseItem
```
public DispenseItemBuilder dispenseItem(UniqueIdentifier id)
```
    Add a dispense item identifier.
    Mandatory Field
    
    May be chained with other calls.
  - isbrandSubstitutionOccured
```
public DispenseItemBuilder isbrandSubstitutionOccured(boolean isSubstituted)
```
    Add an indicator to signal whether brand substitution occurred or not.
    Mandatory Field
    
    May be chained with other calls.
  - maximumNumberOfRepeats
```
public DispenseItemBuilder maximumNumberOfRepeats(int maxRepeats)
```
    Add a maximum number of repeats.
    Mandatory Field
    
    May be chained with other calls.
  - numberOfThisDispense
```
public DispenseItemBuilder numberOfThisDispense(int numberOfThisDispense)
```
    Add a maximum number of repeats.
    Mandatory Field
    
    May be chained with other calls.
  - quantityDispensed
```
public DispenseItemBuilder quantityDispensed(QuantityUnitDescription quantityDispensed)
```
    Add quantity dispensed.
    Mandatory Field
    
    May be chained with other calls.
  - claimTypeCategory
```
public DispenseItemBuilder claimTypeCategory(Coded category)
```
    Add a claim type category.
    Mandatory Field
    
    May be chained with other calls.
  - patientCategory
```
public DispenseItemBuilder patientCategory(PatientCategory category)
```
    Add a patient category.
    Mandatory Field
    
    May be chained with other calls.
  - dispensingStatusType
```
public DispenseItemBuilder dispensingStatusType(DispensingStatusType type)
```
    Add a dispensing status.
    Mandatory Field
    
    May be chained with other calls.
  - addExtemporaneousIngredients
```
public DispenseItemBuilder 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 DispenseItemBuilder formula(String formula)
```
    Add a formula.
    
    May be chained with other calls.
  - labelInstruction
```
public DispenseItemBuilder labelInstruction(String instruction)
```
    Add a label instruction
    
    may be chained with other calls
  - closeTheGapId
```
public DispenseItemBuilder closeTheGapId(UniqueIdentifier closeTheGapId)
```
    Add a close the gap ID.
    
    May be chained with other calls.
  - pbsItemCode
```
public DispenseItemBuilder pbsItemCode(Coded code)
```
    Add a PBS/RPBS item code.
    
    May be chained with other calls.
  - pbsManufacturerCode
```
public DispenseItemBuilder pbsManufacturerCode(UniqueIdentifier pbsManufacturerCode)
```
    Add a PBS/RPBS manufacturer code.
    
    May be chained with other calls.
  - underCoPayment
```
public DispenseItemBuilder underCoPayment(ClaimTypeCategory underCoPayment)
```
    Add a code signalling this item was under co-payment.
    
    May be chained with other calls.
  - earlySupplyWithBenifit
```
public DispenseItemBuilder earlySupplyWithBenifit(boolean earlySupplyWithBenefit)
```
    Add a code identifying the supply as early with pbs benefits.
    
    May be chained with other calls.
  - additionalComments
```
public DispenseItemBuilder additionalComments(String comments)
```
    Add additionalComments.
    
    May be chained with other calls.
  - racfId
```
public DispenseItemBuilder racfId(String racfId)
```
    Add an racf Id.
    
    May be chained with other calls.
  - build
```
public DispenseItem build()
                   throws IllegalArgumentException
```
    Builds a completed prescription item.
    
    Returns:
    
    a valid DispenseItem
    
    Throws:
    
    IllegalArgumentException - if illegal argument provided
  - isValid
```
public void isValid()
             throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException

Class DispenseItemBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DispenseItemBuilder

Method Detail

therapeuticGood

eventDate

prescriptionItem

dispenseItem

isbrandSubstitutionOccured

maximumNumberOfRepeats

numberOfThisDispense

quantityDispensed

claimTypeCategory

patientCategory

dispensingStatusType

addExtemporaneousIngredients

formula

labelInstruction

closeTheGapId

pbsItemCode

pbsManufacturerCode

underCoPayment

earlySupplyWithBenifit

additionalComments

racfId

build

isValid