DispenseItemBuilder (Clinical Document Library 2.0.0 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 this method may be called repeatedly without overwriting the previous value may be chained with other calls
`DispenseItemBuilder`	`additionalComments(String comments)` Add additionalComments may be chained with other calls
`DispenseItem`	`build()` Builds a completed prescription item.
`DispenseItemBuilder`	`claimTypeCategory(Coded catagory)` Add a claim type category Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`closeTheGapId(UniqueIdentifier closeTheGapId)` Add a close the gap ID may be chained with other calls
`DispenseItemBuilder`	`dispenseItem(UniqueIdentifier id)` Add a dispense item identifier Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`dispensingStatusType(DispensingStatusType type)` Add a dispensing status Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`earlySupplyWithBenifit(boolean earlySupplyWithBenifit)` Add a code identifying the supply as early with pbs benefits may be chained with other calls
`DispenseItemBuilder`	`eventDate(org.joda.time.DateTime date)` Add a dispense event date Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`formula(String formula)` Add a formula may be chained with other calls
`DispenseItemBuilder`	`isbrandSubstitutionOccured(boolean isSubstituted)` Add an indicator to signal weather brand substitution occurred or not Mandatory Field may be chained with other calls
`void`	`isValid()`
`DispenseItemBuilder`	`labelInstruction(String instruction)` Add a label instruction may be chained with other calls
`DispenseItemBuilder`	`maximumNumberOfRepeats(int maxRepeats)` Add a maximum number of repeats Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`numberOfThisDispense(int numberOfThisDispense)` Add a maximum number of repeats Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`patientCategory(PatientCategory catagory)` Add a patient category Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`pbsItemCode(Coded code)` Add a PBS/RPBS item code may be chained with other calls
`DispenseItemBuilder`	`pbsManufacturerCode(UniqueIdentifier pbsManufacturerCode)` Add a PBS/RPBS manufacturer code may be chained with other calls
`DispenseItemBuilder`	`prescriptionItem(UniqueIdentifier id)` Add a prescription item identifier Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`quantityDispensed(QuantityUnitDescription quantityDispensed)` Add quantity dispensed Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`racfId(String racfId)` Add an racf Id may be chained with other calls
`DispenseItemBuilder`	`therapeuticGood(Code code)` Add a Therapeutic Good identifier Mandatory Field may be chained with other calls
`DispenseItemBuilder`	`underCoPayment(ClaimTypeCategory underCoPayment)` Add a code signaling this item was under co-payment may be chained with other calls

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(org.joda.time.DateTime 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 weather 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 catagory)
```
    Add a claim type category
    Mandatory Field
    may be chained with other calls
  - patientCategory
```
public DispenseItemBuilder patientCategory(PatientCategory catagory)
```
    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 signaling this item was under co-payment
    may be chained with other calls
  - earlySupplyWithBenifit
```
public DispenseItemBuilder earlySupplyWithBenifit(boolean earlySupplyWithBenifit)
```
    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
  - 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