PrescriptionItemBuilder (Clinical Document Library 2.0.2 API)

java.lang.Object
- au.gov.nehta.model.clinical.etp.eprescription.PrescriptionItemBuilder

```
public class PrescriptionItemBuilder
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 PrescriptionItemImpl.
build() will throw illegalArgumentException if any mandatory data is missing.

Constructor Summary

Constructors
Constructor and Description

PrescriptionItemBuilder()
Builds valid Prescription Items.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PrescriptionItemBuilder`	`additionalComments(String additionalComments)` Add Additional Comments. May be chained with other calls.
`PrescriptionItemBuilder`	`addStructuredTime(SetComponentTime time)` Add a Structured Time. May be chained with other calls.
`PrescriptionItemBuilder`	`approachSiteCode(SNOMED_AU_Code snomed)` Add an approach site. May be chained with other calls.
`PrescriptionItemBuilder`	`brandSubstituteAllowed(Boolean isSubstitute)` Add an indicator for if the script allows brand Substitution. May be chained with other calls.
`PrescriptionItem`	`build()` Build a Prescription Item
`PrescriptionItem`	`buildPCEHRPrescriptionItem()` Build a Prescription Item suitable for a prescription request
`PrescriptionItem`	`buildPrescriptionRequestItem()` Build a Prescription Item suitable for a prescription request
`PrescriptionItemBuilder`	`closeTheGap(UniqueIdentifier id)` Add a close the gap benefit id. May be chained with other calls.
`PrescriptionItemBuilder`	`dateTimeExpires(ZonedDateTime expires)` Add a prescription expiry timestamp. May be chained with other calls.
`PrescriptionItemBuilder`	`dateTimeWritten(ZonedDateTime written)` Add a creation timestamp. May be chained with other calls.
`PrescriptionItemBuilder`	`directions(String directionsForUse)` Add a Directions. May be chained with other calls.
`PrescriptionItemBuilder`	`dispenseQuantity(QuantityUnitDescription dispenseQuantity)` Add a DispenseQuantity.
`PrescriptionItemBuilder`	`dispensItemIdentifier(UniqueIdentifier id)` Add a Dispense item identifier. May be chained with other calls.
`PrescriptionItemBuilder`	`dosage(Dosage dosage)` Add a Dosage. May be chained with other calls.
`PrescriptionItemBuilder`	`extemporaneousIngredient(Ingredient ingr)` Add an Ingredient. May be called multiple times.
`PrescriptionItemBuilder`	`formula(String formula)` Add a formula. May be chained with other calls.
`PrescriptionItemBuilder`	`groundsForConcurrentSupply(GroundsForConcurrentSupply grounds)` Add grounds for concurrent supply. May be chained with other calls.
`PrescriptionItemBuilder`	`longTerm(Boolean isLongTerm)` Add an indicator describing if this item is for long term usage. May be chained with other calls.
`PrescriptionItemBuilder`	`maximumNumberOfRepeats(Integer repeats)` Add maximum Number Of Repeats may be chained with other calls
`PrescriptionItemBuilder`	`medicalBenefitCategoryType(MedicalBenefitCategoryType type)` Add a Medical Benefit Category Type. May be chained with other calls.
`PrescriptionItemBuilder`	`medicationInstruction(UniqueIdentifier id)` Add a medication instruction identifier. May be chained with other calls.
`PrescriptionItemBuilder`	`methodCode(SNOMED_AU_Code snomed)` Add a Method Code. May be chained with other calls.
`PrescriptionItemBuilder`	`minimumIntervalBetweenRepeats(SimplifiedPeriodicIntervalTime period)` Add a Minimum Interval Between Repeats. May be chained with other calls.
`PrescriptionItemBuilder`	`minimumIntervalBetweenRepeats(TimeQuantity timeInterval)` Add a Minimum Interval Between Repeats may be chained with other calls
`PrescriptionItemBuilder`	`pbsAuthorityApprovalNumber(UniqueIdentifier id)` This Element Should NOT be populated if: (i) 1 the Medical Benefit Category type is PBS; and 2 the item is not listed as Authority Required, 'Authority Required (Streamlined)', or an application to increase the maximum quantity and/or repeats has not been approved; or (ii) the Medical Benefit Category type is neither PBS nor RPBS.
`PrescriptionItemBuilder`	`pbsAuthorityPrescriptionNumber(UniqueIdentifier id)` Add a PBS Authority Prescription Number. May be chained with other calls.
`PrescriptionItemBuilder`	`pbsRPBSItemCode(Coded code)` Add PBSRPBSItemCode. May be chained with other calls.
`PrescriptionItemBuilder`	`pbsRpbsManufacturerCode(UniqueIdentifier id)` Add a PBS/RPBS Manufacturer Code. May be chained with other calls.
`PrescriptionItemBuilder`	`pbsType(PBSPrescriptionTypeCode type)` Add a PBS Type. May be chained with other calls.
`PrescriptionItemBuilder`	`prescriptionItemIdentifier(PrescriptionItemIdentifier id)` Add Prescription Item Identifier. May be chained with other calls.
`PrescriptionItemBuilder`	`prn(Boolean prn)` Add a prn. May be chained with other calls.
`PrescriptionItemBuilder`	`reasonForTherapeuticGood(String reasonForTherapeuticGood)` Add a Reason For Therapeutic Good. May be chained with other calls.
`PrescriptionItemBuilder`	`routeCode(SNOMED_AU_Code snomed)` Add a Route Code. May be chained with other calls.
`PrescriptionItemBuilder`	`setTimingDescription(String string)` Add a timming description. May be chained with other calls.
`PrescriptionItemBuilder`	`startCriterion(PreciseDate date)` Add a Start criterion date. May be chained with other calls.
`PrescriptionItemBuilder`	`stateAuthorityNumber(UniqueIdentifier stateAuthorityNumber)` Add a State Authority Number. May be chained with other calls.
`PrescriptionItemBuilder`	`stopCriterion(PreciseDate date)` Add a Stop criterion date. May be chained with other calls.
`PrescriptionItemBuilder`	`streamlinedAuthorityApprovalNumber(UniqueIdentifier id)` Add a Streamlined Authority Approval Number. 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
  - PrescriptionItemBuilder
```
public PrescriptionItemBuilder()
```
    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
  - dateTimeWritten
```
public PrescriptionItemBuilder dateTimeWritten(ZonedDateTime written)
```
    Add a creation timestamp.
    May be chained with other calls.
  - dateTimeExpires
```
public PrescriptionItemBuilder dateTimeExpires(ZonedDateTime expires)
```
    Add a prescription expiry timestamp.
    May be chained with other calls.
  - formula
```
public PrescriptionItemBuilder formula(String formula)
```
    Add a formula.
    May be chained with other calls.
  - dosage
```
public PrescriptionItemBuilder dosage(Dosage dosage)
```
    Add a Dosage.
    May be chained with other calls.
  - dispenseQuantity
```
public PrescriptionItemBuilder dispenseQuantity(QuantityUnitDescription dispenseQuantity)
```
    Add a DispenseQuantity.
    May be chained with other calls.
  - dispensItemIdentifier
```
public PrescriptionItemBuilder dispensItemIdentifier(UniqueIdentifier id)
```
    Add a Dispense item identifier.
    May be chained with other calls.
  - minimumIntervalBetweenRepeats
```
public PrescriptionItemBuilder minimumIntervalBetweenRepeats(TimeQuantity timeInterval)
```
    Add a Minimum Interval Between Repeats
    may be chained with other calls
  - minimumIntervalBetweenRepeats
```
public PrescriptionItemBuilder minimumIntervalBetweenRepeats(SimplifiedPeriodicIntervalTime period)
```
    Add a Minimum Interval Between Repeats.
    May be chained with other calls.
  - stateAuthorityNumber
```
public PrescriptionItemBuilder stateAuthorityNumber(UniqueIdentifier stateAuthorityNumber)
```
    Add a State Authority Number.
    May be chained with other calls.
  - reasonForTherapeuticGood
```
public PrescriptionItemBuilder reasonForTherapeuticGood(String reasonForTherapeuticGood)
```
    Add a Reason For Therapeutic Good.
    May be chained with other calls.
  - additionalComments
```
public PrescriptionItemBuilder additionalComments(String additionalComments)
```
    Add Additional Comments.
    May be chained with other calls.
  - pbsRPBSItemCode
```
public PrescriptionItemBuilder pbsRPBSItemCode(Coded code)
```
    Add PBSRPBSItemCode.
    May be chained with other calls.
  - prescriptionItemIdentifier
```
public PrescriptionItemBuilder prescriptionItemIdentifier(PrescriptionItemIdentifier id)
```
    Add Prescription Item Identifier.
    May be chained with other calls.
  - brandSubstituteAllowed
```
public PrescriptionItemBuilder brandSubstituteAllowed(Boolean isSubstitute)
```
    Add an indicator for if the script allows brand Substitution.
    May be chained with other calls.
  - maximumNumberOfRepeats
```
public PrescriptionItemBuilder maximumNumberOfRepeats(Integer repeats)
```
    Add maximum Number Of Repeats
    may be chained with other calls
  - medicalBenefitCategoryType
```
public PrescriptionItemBuilder medicalBenefitCategoryType(MedicalBenefitCategoryType type)
```
    Add a Medical Benefit Category Type.
    May be chained with other calls.
  - groundsForConcurrentSupply
```
public PrescriptionItemBuilder groundsForConcurrentSupply(GroundsForConcurrentSupply grounds)
```
    Add grounds for concurrent supply.
    May be chained with other calls.
  - directions
```
public PrescriptionItemBuilder directions(String directionsForUse)
```
    Add a Directions.
    May be chained with other calls.
  - pbsType
```
public PrescriptionItemBuilder pbsType(PBSPrescriptionTypeCode type)
```
    Add a PBS Type.
    May be chained with other calls.
  - closeTheGap
```
public PrescriptionItemBuilder closeTheGap(UniqueIdentifier id)
```
    Add a close the gap benefit id.
    May be chained with other calls.
    
    Indicates that a subsidy under the PBS Closing the Gap Co-payment measure applies to this item.
    
    Parameters:
    
    id - An extension and root detailing the CTG benefit identifiers
  - pbsAuthorityPrescriptionNumber
```
public PrescriptionItemBuilder pbsAuthorityPrescriptionNumber(UniqueIdentifier id)
```
    Add a PBS Authority Prescription Number.
    May be chained with other calls.
    
    Parameters:
    
    id - A unique identifier for the PBS Authority Prescription Number.
  - pbsAuthorityApprovalNumber
```
public PrescriptionItemBuilder pbsAuthorityApprovalNumber(UniqueIdentifier id)
```
    This Element Should NOT be populated if: (i) 1 the Medical Benefit Category type is PBS; and 2 the item is not listed as Authority Required, 'Authority Required (Streamlined)', or an application to increase the maximum quantity and/or repeats has not been approved; or (ii) the Medical Benefit Category type is neither PBS nor RPBS.
    
    Parameters:
    
    id - thePbs Authority Approval Number as a root+extension
  - prn
```
public PrescriptionItemBuilder prn(Boolean prn)
```
    Add a prn.
    May be chained with other calls.
    
    Parameters:
    
    prn - - An indicator that states the timing of the use or administration of the medicine, vaccine or other therapeutic good is dependent, within limits, on the conditions or symptoms of the subject of care.
  - longTerm
```
public PrescriptionItemBuilder longTerm(Boolean isLongTerm)
```
    Add an indicator describing if this item is for long term usage.
    May be chained with other calls.
  - medicationInstruction
```
public PrescriptionItemBuilder medicationInstruction(UniqueIdentifier id)
```
    Add a medication instruction identifier.
    May be chained with other calls.
  - streamlinedAuthorityApprovalNumber
```
public PrescriptionItemBuilder streamlinedAuthorityApprovalNumber(UniqueIdentifier id)
```
    Add a Streamlined Authority Approval Number.
    May be chained with other calls.
  - addStructuredTime
```
public PrescriptionItemBuilder addStructuredTime(SetComponentTime time)
```
    Add a Structured Time.
    May be chained with other calls.
  - pbsRpbsManufacturerCode
```
public PrescriptionItemBuilder pbsRpbsManufacturerCode(UniqueIdentifier id)
```
    Add a PBS/RPBS Manufacturer Code.
    May be chained with other calls.
  - startCriterion
```
public PrescriptionItemBuilder startCriterion(PreciseDate date)
```
    Add a Start criterion date.
    May be chained with other calls.
  - stopCriterion
```
public PrescriptionItemBuilder stopCriterion(PreciseDate date)
```
    Add a Stop criterion date.
    May be chained with other calls.
  - setTimingDescription
```
public PrescriptionItemBuilder setTimingDescription(String string)
```
    Add a timming description.
    May be chained with other calls.
  - approachSiteCode
```
public PrescriptionItemBuilder approachSiteCode(SNOMED_AU_Code snomed)
```
    Add an approach site.
    May be chained with other calls.
  - routeCode
```
public PrescriptionItemBuilder routeCode(SNOMED_AU_Code snomed)
```
    Add a Route Code.
    May be chained with other calls.
  - methodCode
```
public PrescriptionItemBuilder methodCode(SNOMED_AU_Code snomed)
```
    Add a Method Code.
    May be chained with other calls.
  - extemporaneousIngredient
```
public PrescriptionItemBuilder extemporaneousIngredient(Ingredient ingr)
```
    Add an Ingredient.
    May be called multiple times.
    May be chained with other calls.
  - build
```
public PrescriptionItem 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.
  - buildPrescriptionRequestItem
```
public PrescriptionItem buildPrescriptionRequestItem()
                                              throws IllegalArgumentException
```
    Build a Prescription Item suitable for a prescription request
    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
    
    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. - if a supplied field is not allowed, eg: ReasonForTheraputicGood
  - buildPCEHRPrescriptionItem
```
public PrescriptionItem buildPCEHRPrescriptionItem()
                                            throws IllegalArgumentException
```
    Build a Prescription Item suitable for a prescription request
    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
    
    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. - if a supplied field is not allowed, eg: ReasonForTheraputicGood

Class PrescriptionItemBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PrescriptionItemBuilder

Method Detail

dateTimeWritten

dateTimeExpires

formula

dosage

dispenseQuantity

dispensItemIdentifier

minimumIntervalBetweenRepeats

minimumIntervalBetweenRepeats

stateAuthorityNumber

reasonForTherapeuticGood

additionalComments

pbsRPBSItemCode

prescriptionItemIdentifier

brandSubstituteAllowed

maximumNumberOfRepeats

medicalBenefitCategoryType

groundsForConcurrentSupply

directions

pbsType

closeTheGap

pbsAuthorityPrescriptionNumber

pbsAuthorityApprovalNumber

prn

longTerm

medicationInstruction

streamlinedAuthorityApprovalNumber

addStructuredTime

pbsRpbsManufacturerCode

startCriterion

stopCriterion

setTimingDescription

approachSiteCode

routeCode

methodCode

extemporaneousIngredient

build

buildPrescriptionRequestItem

buildPCEHRPrescriptionItem