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