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
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionIndicates the medication order that is being dispensed against.protected List
<MedicationOrder> The actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.)protected SimpleQuantity
The amount of medication expressed as a timing amount.protected Reference
Identification of the facility/location where the medication was shipped to, as part of the dispense event.protected Location
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.)protected Reference
The individual responsible for dispensing the medication.protected Practitioner
The actual object that is the target of the reference (The individual responsible for dispensing the medication.)Indicates how the medication is to be used by the patient.protected Identifier
Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.protected Type
Identifies the medication being administered.protected StringType
Extra information about the dispense that could not be conveyed in the other attributes.protected Reference
A link to a resource representing the person to whom the medication will be given.protected Patient
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.)protected SimpleQuantity
The amount of medication that has been dispensed.Identifies the person who picked up the medication.The actual objects that are the target of the reference (Identifies the person who picked up the medication.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
A code specifying the state of the set of dispense events.Indicates whether or not substitution was made as part of the dispense.protected CodeableConcept
Indicates the type of dispensing event that is performed.protected DateTimeType
The time the dispensed product was provided to the patient or their representative.protected DateTimeType
The 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
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
boolean
equalsDeep
(Base other) boolean
equalsShallow
(Base other) fhirType()
getNote()
getType()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> childrenList) setDaysSupply
(SimpleQuantity value) setDestination
(Reference value) setDestinationTarget
(Location value) setDispenser
(Reference value) setDispenserTarget
(Practitioner value) setIdentifier
(Identifier value) setMedication
(Type value) setNoteElement
(StringType value) setPatient
(Reference value) setPatientTarget
(Patient value) void
setProperty
(String name, Base value) setQuantity
(SimpleQuantity value) setType
(CodeableConcept value) setWhenHandedOver
(Date value) setWhenPrepared
(Date value) protected MedicationDispense
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR. -
status
A code specifying the state of the set of dispense events. -
patient
A link to a resource representing the person to whom the medication will be given. -
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.) -
dispenser
The individual responsible for dispensing the medication. -
dispenserTarget
The actual object that is the target of the reference (The individual responsible for dispensing the medication.) -
authorizingPrescription
Indicates the medication order that is being dispensed against. -
authorizingPrescriptionTarget
The actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.) -
type
Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. -
quantity
The amount of medication that has been dispensed. Includes unit of measure. -
daysSupply
The amount of medication expressed as a timing amount. -
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
The time when the dispensed product was packaged and reviewed. -
whenHandedOver
The time the dispensed product was provided to the patient or their representative. -
destination
Identification of the facility/location where the medication was shipped to, as part of the dispense event. -
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
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
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
Extra information about the dispense that could not be conveyed in the other attributes. -
dosageInstruction
Indicates how the medication is to be used by the patient. -
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
- See Also:
-
SP_CODE
- See Also:
-
SP_RECEIVER
- See Also:
-
SP_DESTINATION
- See Also:
-
SP_MEDICATION
- See Also:
-
SP_RESPONSIBLEPARTY
- See Also:
-
SP_TYPE
- See Also:
-
SP_WHENHANDEDOVER
- See Also:
-
SP_WHENPREPARED
- See Also:
-
SP_DISPENSER
- See Also:
-
SP_PRESCRIPTION
- See Also:
-
SP_PATIENT
- See Also:
-
SP_STATUS
- See Also:
-
-
Constructor Details
-
MedicationDispense
public MedicationDispense() -
MedicationDispense
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.)
-
hasIdentifier
-
setIdentifier
- Parameters:
value
-identifier
(Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.)
-
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
-
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
- Returns:
- A code specifying the state of the set of dispense events.
-
setStatus
- Parameters:
value
- A code specifying the state of the set of dispense events.
-
getPatient
- Returns:
patient
(A link to a resource representing the person to whom the medication will be given.)
-
hasPatient
-
setPatient
- Parameters:
value
-patient
(A link to a resource representing the person to whom the medication will be given.)
-
getPatientTarget
- Returns:
patient
The 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
- Parameters:
value
-patient
The 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
- Returns:
dispenser
(The individual responsible for dispensing the medication.)
-
hasDispenser
-
setDispenser
- Parameters:
value
-dispenser
(The individual responsible for dispensing the medication.)
-
getDispenserTarget
- Returns:
dispenser
The 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
- Parameters:
value
-dispenser
The 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
- Returns:
authorizingPrescription
(Indicates the medication order that is being dispensed against.)
-
hasAuthorizingPrescription
-
addAuthorizingPrescription
- Returns:
authorizingPrescription
(Indicates the medication order that is being dispensed against.)
-
addAuthorizingPrescription
-
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
- 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
- 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
-
setType
- 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
- Returns:
quantity
(The amount of medication that has been dispensed. Includes unit of measure.)
-
hasQuantity
-
setQuantity
- Parameters:
value
-quantity
(The amount of medication that has been dispensed. Includes unit of measure.)
-
getDaysSupply
- Returns:
daysSupply
(The amount of medication expressed as a timing amount.)
-
hasDaysSupply
-
setDaysSupply
- Parameters:
value
-daysSupply
(The amount of medication expressed as a timing amount.)
-
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
- 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
-
getMedicationReference
- 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
-
hasMedication
-
setMedication
- 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
- 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
-
hasWhenPrepared
-
setWhenPreparedElement
- 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
- Returns:
- The time when the dispensed product was packaged and reviewed.
-
setWhenPrepared
- Parameters:
value
- The time when the dispensed product was packaged and reviewed.
-
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
-
hasWhenHandedOver
-
setWhenHandedOverElement
- 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
- Returns:
- The time the dispensed product was provided to the patient or their representative.
-
setWhenHandedOver
- Parameters:
value
- The time the dispensed product was provided to the patient or their representative.
-
getDestination
- Returns:
destination
(Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
-
hasDestination
-
setDestination
- Parameters:
value
-destination
(Identification of the facility/location where the medication was shipped to, as part of the dispense event.)
-
getDestinationTarget
- Returns:
destination
The 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
- Parameters:
value
-destination
The 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
- 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
-
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
-
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
- 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
-
hasNote
-
setNoteElement
- 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
- Returns:
- Extra information about the dispense that could not be conveyed in the other attributes.
-
setNote
- Parameters:
value
- Extra information about the dispense that could not be conveyed in the other attributes.
-
getDosageInstruction
- Returns:
dosageInstruction
(Indicates how the medication is to be used by the patient.)
-
hasDosageInstruction
-
addDosageInstruction
- Returns:
dosageInstruction
(Indicates how the medication is to be used by the patient.)
-
addDosageInstruction
-
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
-
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
- Overrides:
listChildren
in classDomainResource
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-