Package org.hl7.fhir.dstu2.model
Class MedicationDispense
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.BaseResource
-
- org.hl7.fhir.dstu2.model.Resource
-
- org.hl7.fhir.dstu2.model.DomainResource
-
- org.hl7.fhir.dstu2.model.MedicationDispense
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class MedicationDispense extends DomainResource
Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMedicationDispense.MedicationDispenseDosageInstructionComponentstatic classMedicationDispense.MedicationDispenseStatusstatic classMedicationDispense.MedicationDispenseStatusEnumFactorystatic classMedicationDispense.MedicationDispenseSubstitutionComponent
-
Field Summary
Fields Modifier and Type Field Description protected List<Reference>authorizingPrescriptionIndicates the medication order that is being dispensed against.protected List<MedicationOrder>authorizingPrescriptionTargetThe actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.)protected SimpleQuantitydaysSupplyThe amount of medication expressed as a timing amount.protected ReferencedestinationIdentification of the facility/location where the medication was shipped to, as part of the dispense event.protected LocationdestinationTargetThe actual object that is the target of the reference (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)protected ReferencedispenserThe individual responsible for dispensing the medication.protected PractitionerdispenserTargetThe actual object that is the target of the reference (The individual responsible for dispensing the medication.)protected List<MedicationDispense.MedicationDispenseDosageInstructionComponent>dosageInstructionIndicates how the medication is to be used by the patient.protected IdentifieridentifierIdentifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.protected TypemedicationIdentifies the medication being administered.protected StringTypenoteExtra information about the dispense that could not be conveyed in the other attributes.protected ReferencepatientA link to a resource representing the person to whom the medication will be given.protected PatientpatientTargetThe actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.)protected SimpleQuantityquantityThe amount of medication that has been dispensed.protected List<Reference>receiverIdentifies the person who picked up the medication.protected List<Resource>receiverTargetThe actual objects that are the target of the reference (Identifies the person who picked up the medication.static StringSP_CODEstatic StringSP_DESTINATIONstatic StringSP_DISPENSERstatic StringSP_IDENTIFIERstatic StringSP_MEDICATIONstatic StringSP_PATIENTstatic StringSP_PRESCRIPTIONstatic StringSP_RECEIVERstatic StringSP_RESPONSIBLEPARTYstatic StringSP_STATUSstatic StringSP_TYPEstatic StringSP_WHENHANDEDOVERstatic StringSP_WHENPREPAREDprotected Enumeration<MedicationDispense.MedicationDispenseStatus>statusA code specifying the state of the set of dispense events.protected MedicationDispense.MedicationDispenseSubstitutionComponentsubstitutionIndicates whether or not substitution was made as part of the dispense.protected CodeableConcepttypeIndicates the type of dispensing event that is performed.protected DateTimeTypewhenHandedOverThe time the dispensed product was provided to the patient or their representative.protected DateTimeTypewhenPreparedThe time when the dispensed product was packaged and reviewed.-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MedicationDispense()MedicationDispense(Type medication)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected Identifier identifier
Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
-
status
protected Enumeration<MedicationDispense.MedicationDispenseStatus> status
A code specifying the state of the set of dispense events.
-
patient
protected Reference patient
A link to a resource representing the person to whom the medication will be given.
-
patientTarget
protected Patient patientTarget
The actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.)
-
dispenserTarget
protected Practitioner dispenserTarget
The actual object that is the target of the reference (The individual responsible for dispensing the medication.)
-
authorizingPrescription
protected List<Reference> authorizingPrescription
Indicates the medication order that is being dispensed against.
-
authorizingPrescriptionTarget
protected List<MedicationOrder> authorizingPrescriptionTarget
The actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.)
-
type
protected CodeableConcept type
Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
-
quantity
protected SimpleQuantity quantity
The amount of medication that has been dispensed. Includes unit of measure.
-
daysSupply
protected SimpleQuantity daysSupply
The amount of medication expressed as a timing amount.
-
medication
protected Type medication
Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
whenPrepared
protected DateTimeType whenPrepared
The time when the dispensed product was packaged and reviewed.
-
whenHandedOver
protected DateTimeType whenHandedOver
The time the dispensed product was provided to the patient or their representative.
-
destination
protected Reference destination
Identification of the facility/location where the medication was shipped to, as part of the dispense event.
-
destinationTarget
protected Location destinationTarget
The actual object that is the target of the reference (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
-
receiver
protected List<Reference> receiver
Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
-
receiverTarget
protected List<Resource> receiverTarget
The actual objects that are the target of the reference (Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.)
-
note
protected StringType note
Extra information about the dispense that could not be conveyed in the other attributes.
-
dosageInstruction
protected List<MedicationDispense.MedicationDispenseDosageInstructionComponent> dosageInstruction
Indicates how the medication is to be used by the patient.
-
substitution
protected MedicationDispense.MedicationDispenseSubstitutionComponent substitution
Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why.
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
- See Also:
- Constant Field Values
-
SP_CODE
public static final String SP_CODE
- See Also:
- Constant Field Values
-
SP_RECEIVER
public static final String SP_RECEIVER
- See Also:
- Constant Field Values
-
SP_DESTINATION
public static final String SP_DESTINATION
- See Also:
- Constant Field Values
-
SP_MEDICATION
public static final String SP_MEDICATION
- See Also:
- Constant Field Values
-
SP_RESPONSIBLEPARTY
public static final String SP_RESPONSIBLEPARTY
- See Also:
- Constant Field Values
-
SP_TYPE
public static final String SP_TYPE
- See Also:
- Constant Field Values
-
SP_WHENHANDEDOVER
public static final String SP_WHENHANDEDOVER
- See Also:
- Constant Field Values
-
SP_WHENPREPARED
public static final String SP_WHENPREPARED
- See Also:
- Constant Field Values
-
SP_DISPENSER
public static final String SP_DISPENSER
- See Also:
- Constant Field Values
-
SP_PRESCRIPTION
public static final String SP_PRESCRIPTION
- See Also:
- Constant Field Values
-
SP_PATIENT
public static final String SP_PATIENT
- See Also:
- Constant Field Values
-
SP_STATUS
public static final String SP_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MedicationDispense
public MedicationDispense()
-
MedicationDispense
public MedicationDispense(Type medication)
-
-
Method Detail
-
getIdentifier
public Identifier getIdentifier()
- Returns:
identifier(Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.)
-
hasIdentifier
public boolean hasIdentifier()
-
setIdentifier
public MedicationDispense setIdentifier(Identifier value)
- Parameters:
value-identifier(Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.)
-
getStatusElement
public Enumeration<MedicationDispense.MedicationDispenseStatus> getStatusElement()
- Returns:
status(A code specifying the state of the set of dispense events.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public MedicationDispense setStatusElement(Enumeration<MedicationDispense.MedicationDispenseStatus> value)
- Parameters:
value-status(A code specifying the state of the set of dispense events.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public MedicationDispense.MedicationDispenseStatus getStatus()
- Returns:
- A code specifying the state of the set of dispense events.
-
setStatus
public MedicationDispense setStatus(MedicationDispense.MedicationDispenseStatus value)
- Parameters:
value- A code specifying the state of the set of dispense events.
-
getPatient
public Reference getPatient()
- Returns:
patient(A link to a resource representing the person to whom the medication will be given.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public MedicationDispense setPatient(Reference value)
- Parameters:
value-patient(A link to a resource representing the person to whom the medication will be given.)
-
getPatientTarget
public Patient getPatientTarget()
- Returns:
patientThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)
-
setPatientTarget
public MedicationDispense setPatientTarget(Patient value)
- Parameters:
value-patientThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)
-
getDispenser
public Reference getDispenser()
- Returns:
dispenser(The individual responsible for dispensing the medication.)
-
hasDispenser
public boolean hasDispenser()
-
setDispenser
public MedicationDispense setDispenser(Reference value)
- Parameters:
value-dispenser(The individual responsible for dispensing the medication.)
-
getDispenserTarget
public Practitioner getDispenserTarget()
- Returns:
dispenserThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The individual responsible for dispensing the medication.)
-
setDispenserTarget
public MedicationDispense setDispenserTarget(Practitioner value)
- Parameters:
value-dispenserThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The individual responsible for dispensing the medication.)
-
getAuthorizingPrescription
public List<Reference> getAuthorizingPrescription()
- Returns:
authorizingPrescription(Indicates the medication order that is being dispensed against.)
-
hasAuthorizingPrescription
public boolean hasAuthorizingPrescription()
-
addAuthorizingPrescription
public Reference addAuthorizingPrescription()
- Returns:
authorizingPrescription(Indicates the medication order that is being dispensed against.)
-
addAuthorizingPrescription
public MedicationDispense addAuthorizingPrescription(Reference t)
-
getAuthorizingPrescriptionTarget
public List<MedicationOrder> getAuthorizingPrescriptionTarget()
- Returns:
authorizingPrescription(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Indicates the medication order that is being dispensed against.)
-
addAuthorizingPrescriptionTarget
public MedicationOrder addAuthorizingPrescriptionTarget()
- Returns:
authorizingPrescription(Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Indicates the medication order that is being dispensed against.)
-
getType
public CodeableConcept getType()
- Returns:
type(Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.)
-
hasType
public boolean hasType()
-
setType
public MedicationDispense setType(CodeableConcept value)
- Parameters:
value-type(Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.)
-
getQuantity
public SimpleQuantity getQuantity()
- Returns:
quantity(The amount of medication that has been dispensed. Includes unit of measure.)
-
hasQuantity
public boolean hasQuantity()
-
setQuantity
public MedicationDispense setQuantity(SimpleQuantity value)
- Parameters:
value-quantity(The amount of medication that has been dispensed. Includes unit of measure.)
-
getDaysSupply
public SimpleQuantity getDaysSupply()
- Returns:
daysSupply(The amount of medication expressed as a timing amount.)
-
hasDaysSupply
public boolean hasDaysSupply()
-
setDaysSupply
public MedicationDispense setDaysSupply(SimpleQuantity value)
- Parameters:
value-daysSupply(The amount of medication expressed as a timing amount.)
-
getMedication
public Type getMedication()
- Returns:
medication(Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.)
-
getMedicationCodeableConcept
public CodeableConcept getMedicationCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
medication(Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMedicationCodeableConcept
public boolean hasMedicationCodeableConcept()
-
getMedicationReference
public Reference getMedicationReference() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
medication(Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMedicationReference
public boolean hasMedicationReference()
-
hasMedication
public boolean hasMedication()
-
setMedication
public MedicationDispense setMedication(Type value)
- Parameters:
value-medication(Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.)
-
getWhenPreparedElement
public DateTimeType getWhenPreparedElement()
- Returns:
whenPrepared(The time when the dispensed product was packaged and reviewed.). This is the underlying object with id, value and extensions. The accessor "getWhenPrepared" gives direct access to the value
-
hasWhenPreparedElement
public boolean hasWhenPreparedElement()
-
hasWhenPrepared
public boolean hasWhenPrepared()
-
setWhenPreparedElement
public MedicationDispense setWhenPreparedElement(DateTimeType value)
- Parameters:
value-whenPrepared(The time when the dispensed product was packaged and reviewed.). This is the underlying object with id, value and extensions. The accessor "getWhenPrepared" gives direct access to the value
-
getWhenPrepared
public Date getWhenPrepared()
- Returns:
- The time when the dispensed product was packaged and reviewed.
-
setWhenPrepared
public MedicationDispense setWhenPrepared(Date value)
- Parameters:
value- The time when the dispensed product was packaged and reviewed.
-
getWhenHandedOverElement
public DateTimeType getWhenHandedOverElement()
- Returns:
whenHandedOver(The time the dispensed product was provided to the patient or their representative.). This is the underlying object with id, value and extensions. The accessor "getWhenHandedOver" gives direct access to the value
-
hasWhenHandedOverElement
public boolean hasWhenHandedOverElement()
-
hasWhenHandedOver
public boolean hasWhenHandedOver()
-
setWhenHandedOverElement
public MedicationDispense setWhenHandedOverElement(DateTimeType value)
- Parameters:
value-whenHandedOver(The time the dispensed product was provided to the patient or their representative.). This is the underlying object with id, value and extensions. The accessor "getWhenHandedOver" gives direct access to the value
-
getWhenHandedOver
public Date getWhenHandedOver()
- Returns:
- The time the dispensed product was provided to the patient or their representative.
-
setWhenHandedOver
public MedicationDispense setWhenHandedOver(Date value)
- Parameters:
value- The time the dispensed product was provided to the patient or their representative.
-
getDestination
public Reference getDestination()
- Returns:
destination(Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
-
hasDestination
public boolean hasDestination()
-
setDestination
public MedicationDispense setDestination(Reference value)
- Parameters:
value-destination(Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
-
getDestinationTarget
public Location getDestinationTarget()
- Returns:
destinationThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
-
setDestinationTarget
public MedicationDispense setDestinationTarget(Location value)
- Parameters:
value-destinationThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
-
getReceiver
public List<Reference> getReceiver()
- Returns:
receiver(Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.)
-
hasReceiver
public boolean hasReceiver()
-
addReceiver
public Reference addReceiver()
- Returns:
receiver(Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.)
-
addReceiver
public MedicationDispense addReceiver(Reference t)
-
getReceiverTarget
public List<Resource> getReceiverTarget()
- Returns:
receiver(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.)
-
getNoteElement
public StringType getNoteElement()
- Returns:
note(Extra information about the dispense that could not be conveyed in the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
-
hasNoteElement
public boolean hasNoteElement()
-
hasNote
public boolean hasNote()
-
setNoteElement
public MedicationDispense setNoteElement(StringType value)
- Parameters:
value-note(Extra information about the dispense that could not be conveyed in the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
-
getNote
public String getNote()
- Returns:
- Extra information about the dispense that could not be conveyed in the other attributes.
-
setNote
public MedicationDispense setNote(String value)
- Parameters:
value- Extra information about the dispense that could not be conveyed in the other attributes.
-
getDosageInstruction
public List<MedicationDispense.MedicationDispenseDosageInstructionComponent> getDosageInstruction()
- Returns:
dosageInstruction(Indicates how the medication is to be used by the patient.)
-
hasDosageInstruction
public boolean hasDosageInstruction()
-
addDosageInstruction
public MedicationDispense.MedicationDispenseDosageInstructionComponent addDosageInstruction()
- Returns:
dosageInstruction(Indicates how the medication is to be used by the patient.)
-
addDosageInstruction
public MedicationDispense addDosageInstruction(MedicationDispense.MedicationDispenseDosageInstructionComponent t)
-
getSubstitution
public MedicationDispense.MedicationDispenseSubstitutionComponent getSubstitution()
- Returns:
substitution(Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why.)
-
hasSubstitution
public boolean hasSubstitution()
-
setSubstitution
public MedicationDispense setSubstitution(MedicationDispense.MedicationDispenseSubstitutionComponent value)
- Parameters:
value-substitution(Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why.)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public MedicationDispense copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected MedicationDispense typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-