PCEHRPrescriptionItemBuilder (Clinical Document Library 2.0.2 API)

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

```
public class PCEHRPrescriptionItemBuilder
extends Object
```
Build a Prescription Item ensuring all mandatory fields are present.
Use the various methods to add data to the prescription item then call build() to get your NPDRPrescriptionItemImpl.
build() will throw illegalArgumentException if any mandatory data is missing.

Constructor Summary

Constructors
Constructor and Description

PCEHRPrescriptionItemBuilder()
Builds valid Prescription Items.

Constructors
Constructor and Description
`PCEHRPrescriptionItemBuilder()` Builds valid Prescription Items.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PCEHRPrescriptionItemBuilder`	`additionalComments(String additionalComments)` Add Additional Comments May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`addStructuredTime(SetComponentTime time)` Add a Structured Time May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`brandSubstituteAllowed(Boolean isSubstitute)` Add an indicator for if the script allows brand Substitution May be chained with other calls
`PCEHRPrescriptionItem`	`build()` Build a Prescription Item
`PCEHRPrescriptionItemBuilder`	`dateTimeExpires(ZonedDateTime expires)` Add a prescription expiry timestamp May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`dateTimeWritten(ZonedDateTime written)` Add a creation timestamp May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`directions(String directionsForUse)` Add a Directions May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`dispenseQuantity(QuantityUnitDescription dispenseQuantity)` Add a DispenseQuantity.
`PCEHRPrescriptionItemBuilder`	`dispensItemIdentifier(UniqueIdentifier id)` Add a Dispense item identifier May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`form(SNOMED_AU_Code form)` Add a form (The formulation or presentation of the overall substance.) May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`formula(String formula)` Add a formula May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`maximumNumberOfRepeats(Integer repeats)` Add maximum Number Of Repeats May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`medicalBenefitCategoryType(MedicalBenefitCategoryType type)` Add a Medical Benefit Category Type May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`minimumIntervalBetweenRepeats(SimplifiedPeriodicIntervalTime period)` Add a Minimum Interval Between Repeats May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`minimumIntervalBetweenRepeats(TimeQuantity timeInterval)` Add a Minimum Interval Between Repeats May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`pbsRPBSItemCode(Coded itemAsATranslatedCode)` Add PBSRPBSItemCode May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`pbsRpbsManufacturerCode(UniqueIdentifier id)` Add a PBS/RPBS Manufacturer Code May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`pbsType(PBSPrescriptionTypeCode type)` Add a PBS Type May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`prescriptionItemIdentifier(PrescriptionItemIdentifier id)` Add Prescription Item Identifier May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`quantityDescription(String qtyDesc)`
`PCEHRPrescriptionItemBuilder`	`reasonForTherapeuticGood(String reasonForTherapeuticGood)` Add a Reason For Therapeutic Good May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`routeCode(SNOMED_AU_Code snomed)` Add a Route Code May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`setTimingDescription(String string)` Add a timing description May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`therapeuticGoodGenericName(String genericName)` Add a Therapeutic Good Generic Name May be chained with other calls
`PCEHRPrescriptionItemBuilder`	`therapeuticGoodGenericStrength(String strength)` Add a Therapeutic Good Generic strength This will be represented as an NCTIS data element 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
  - PCEHRPrescriptionItemBuilder
```
public PCEHRPrescriptionItemBuilder()
```
    Builds valid Prescription Items.
    Use the various methods to add data to the prescription item then call build() to get your PrescriptionItemImpl.
    build() will throw illegalArgumentException if any mandatory data is missing.
- Method Detail
  - form
```
public PCEHRPrescriptionItemBuilder form(SNOMED_AU_Code form)
```
    Add a form (The formulation or presentation of the overall substance.)
    May be chained with other calls
  - therapeuticGoodGenericName
```
public PCEHRPrescriptionItemBuilder therapeuticGoodGenericName(String genericName)
```
    Add a Therapeutic Good Generic Name
    May be chained with other calls
  - therapeuticGoodGenericStrength
```
public PCEHRPrescriptionItemBuilder therapeuticGoodGenericStrength(String strength)
```
    Add a Therapeutic Good Generic strength
    This will be represented as an NCTIS data element May be chained with other calls
  - dateTimeWritten
```
public PCEHRPrescriptionItemBuilder dateTimeWritten(ZonedDateTime written)
```
    Add a creation timestamp
    May be chained with other calls
  - dateTimeExpires
```
public PCEHRPrescriptionItemBuilder dateTimeExpires(ZonedDateTime expires)
```
    Add a prescription expiry timestamp
    May be chained with other calls
  - formula
```
public PCEHRPrescriptionItemBuilder formula(String formula)
```
    Add a formula
    May be chained with other calls
  - quantityDescription
```
public PCEHRPrescriptionItemBuilder quantityDescription(String qtyDesc)
```
  - dispenseQuantity
```
public PCEHRPrescriptionItemBuilder dispenseQuantity(QuantityUnitDescription dispenseQuantity)
```
    Add a DispenseQuantity.
    May be chained with other calls
  - dispensItemIdentifier
```
public PCEHRPrescriptionItemBuilder dispensItemIdentifier(UniqueIdentifier id)
```
    Add a Dispense item identifier
    May be chained with other calls
  - minimumIntervalBetweenRepeats
```
public PCEHRPrescriptionItemBuilder minimumIntervalBetweenRepeats(TimeQuantity timeInterval)
```
    Add a Minimum Interval Between Repeats
    May be chained with other calls
  - minimumIntervalBetweenRepeats
```
public PCEHRPrescriptionItemBuilder minimumIntervalBetweenRepeats(SimplifiedPeriodicIntervalTime period)
```
    Add a Minimum Interval Between Repeats
    May be chained with other calls
  - reasonForTherapeuticGood
```
public PCEHRPrescriptionItemBuilder reasonForTherapeuticGood(String reasonForTherapeuticGood)
```
    Add a Reason For Therapeutic Good
    May be chained with other calls
  - additionalComments
```
public PCEHRPrescriptionItemBuilder additionalComments(String additionalComments)
```
    Add Additional Comments
    May be chained with other calls
    
    Returns:
    
    The builder with additional comments added.
  - pbsRPBSItemCode
```
public PCEHRPrescriptionItemBuilder pbsRPBSItemCode(Coded itemAsATranslatedCode)
```
    Add PBSRPBSItemCode
    May be chained with other calls
  - prescriptionItemIdentifier
```
public PCEHRPrescriptionItemBuilder prescriptionItemIdentifier(PrescriptionItemIdentifier id)
```
    Add Prescription Item Identifier
    May be chained with other calls
  - brandSubstituteAllowed
```
public PCEHRPrescriptionItemBuilder brandSubstituteAllowed(Boolean isSubstitute)
```
    Add an indicator for if the script allows brand Substitution
    May be chained with other calls
  - maximumNumberOfRepeats
```
public PCEHRPrescriptionItemBuilder maximumNumberOfRepeats(Integer repeats)
```
    Add maximum Number Of Repeats
    May be chained with other calls
  - medicalBenefitCategoryType
```
public PCEHRPrescriptionItemBuilder medicalBenefitCategoryType(MedicalBenefitCategoryType type)
```
    Add a Medical Benefit Category Type
    May be chained with other calls
  - directions
```
public PCEHRPrescriptionItemBuilder directions(String directionsForUse)
```
    Add a Directions
    May be chained with other calls
  - pbsType
```
public PCEHRPrescriptionItemBuilder pbsType(PBSPrescriptionTypeCode type)
```
    Add a PBS Type
    May be chained with other calls
  - addStructuredTime
```
public PCEHRPrescriptionItemBuilder addStructuredTime(SetComponentTime time)
```
    Add a Structured Time
    May be chained with other calls
  - pbsRpbsManufacturerCode
```
public PCEHRPrescriptionItemBuilder pbsRpbsManufacturerCode(UniqueIdentifier id)
```
    Add a PBS/RPBS Manufacturer Code
    May be chained with other calls
  - setTimingDescription
```
public PCEHRPrescriptionItemBuilder setTimingDescription(String string)
```
    Add a timing description
    May be chained with other calls
  - routeCode
```
public PCEHRPrescriptionItemBuilder routeCode(SNOMED_AU_Code snomed)
```
    Add a Route Code
    May be chained with other calls
  - build
```
public PCEHRPrescriptionItem build()
                            throws IllegalArgumentException
```
    Build a Prescription Item
    Mandatory items are:
    Prescription expiry time
    Prescription written time
    therapeuticGoodIdentification pbs/rpbs item code
    prescriptionItemIdentifier
    brandSubstituteAllowed
    maximumNumberOfRepeats
    medicalBenefitCategoryType
    instructions for use (directions)
    Pbs type
    close the gap id
    groundsForConcurrentSupply
    
    Items not allowed for a prescription request:
    
    GroundsForConcurrentSupply
    ReasonForTherapeuticGood
    MinimumIntervalBetweenRepeats
    
    Returns:
    
    the built prescriptionItem object
    
    Throws:
    
    IllegalArgumentException - if a mandatory data item has not been set.

Class PCEHRPrescriptionItemBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PCEHRPrescriptionItemBuilder

Method Detail

form

therapeuticGoodGenericName

therapeuticGoodGenericStrength

dateTimeWritten

dateTimeExpires

formula

quantityDescription

dispenseQuantity

dispensItemIdentifier

minimumIntervalBetweenRepeats

minimumIntervalBetweenRepeats

reasonForTherapeuticGood

additionalComments

pbsRPBSItemCode

prescriptionItemIdentifier

brandSubstituteAllowed

maximumNumberOfRepeats

medicalBenefitCategoryType

directions

pbsType

addStructuredTime

pbsRpbsManufacturerCode

setTimingDescription

routeCode

build