![](/hapi-fhir/images/logos/raccoon-forwards.png)
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static enum
static class
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionIndicates the medication order that is being dispensed against.protected List
<MedicationRequest> The actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.)protected CodeableConcept
Indicates type of medication dispense and where the medication is expected to be consumed or administered.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected Reference
The encounter or episode of care that establishes the context for this event.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for contextprotected Resource
The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this event.)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.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for destinationprotected 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.)Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g.protected List
<DetectedIssue> The actual objects that are the target of the reference (Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g.Indicates how the medication is to be used by the patient.A summary of the events of interest that have occurred, such as when the dispense was verified.protected List
<Provenance> The actual objects that are the target of the reference (A summary of the events of interest that have occurred, such as when the dispense was verified.)protected List
<Identifier> Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Type
Identifies the medication being administered.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for medicationprotected BooleanType
True if the dispense was not performed for some reason.protected Type
Indicates the reason why a dispense was not performed.protected List
<Annotation> Extra information about the dispense that could not be conveyed in the other attributes.The procedure that the dispense is done because of.The actual objects that are the target of the reference (The procedure that the dispense is done because of.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientIndicates who or what performed the event.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for performerstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for prescriptionprotected SimpleQuantity
The amount of medication that has been dispensed.Identifies the person who picked up the medication.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for receiverThe actual objects that are the target of the reference (Identifies the person who picked up the medication.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for responsiblepartystatic final String
Search parameter: codestatic final String
Search parameter: contextstatic final String
Search parameter: destinationstatic final String
Search parameter: identifierstatic final String
Search parameter: medicationstatic final String
Search parameter: patientstatic final String
Search parameter: performerstatic final String
Search parameter: prescriptionstatic final String
Search parameter: receiverstatic final String
Search parameter: responsiblepartystatic final String
Search parameter: statusstatic final String
Search parameter: subjectstatic final String
Search parameter: typestatic final String
Search parameter: whenhandedoverstatic final String
Search parameter: whenpreparedA code specifying the state of the set of dispense events.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
A link to a resource representing the person or the group to whom the medication will be given.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (A link to a resource representing the person or the group to whom the medication will be given.)Indicates whether or not substitution was made as part of the dispense.Additional information that supports the medication being dispensed.The actual objects that are the target of the reference (Additional information that supports the medication being dispensed.)protected CodeableConcept
Indicates the type of dispensing event that is performed.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typeprotected DateTimeType
The time the dispensed product was provided to the patient or their representative.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for whenhandedoverprotected DateTimeType
The time when the dispensed product was packaged and reviewed.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for whenpreparedFields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu3.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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadaddNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadcopy()
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) boolean
getNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setAuthorizingPrescription
(List<Reference> theAuthorizingPrescription) setCategory
(CodeableConcept value) setContext
(Reference value) setContextTarget
(Resource value) setDaysSupply
(SimpleQuantity value) setDestination
(Reference value) setDestinationTarget
(Location value) setDetectedIssue
(List<Reference> theDetectedIssue) setDosageInstruction
(List<Dosage> theDosageInstruction) setEventHistory
(List<Reference> theEventHistory) setIdentifier
(List<Identifier> theIdentifier) setMedication
(Type value) setNotDone
(boolean value) setNotDoneElement
(BooleanType value) setNotDoneReason
(Type value) setNote
(List<Annotation> theNote) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setQuantity
(SimpleQuantity value) setReceiver
(List<Reference> theReceiver) setSubject
(Reference value) setSubjectTarget
(Resource value) setSupportingInformation
(List<Reference> theSupportingInformation) setType
(CodeableConcept value) setWhenHandedOver
(Date value) setWhenPrepared
(Date value) protected MedicationDispense
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, 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. -
partOf
The procedure that the dispense is done because of. -
partOfTarget
The actual objects that are the target of the reference (The procedure that the dispense is done because of.) -
status
A code specifying the state of the set of dispense events. -
category
Indicates type of medication dispense and where the medication is expected to be consumed or administered. -
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. -
subject
A link to a resource representing the person or the group to whom the medication will be given. -
subjectTarget
The actual object that is the target of the reference (A link to a resource representing the person or the group to whom the medication will be given.) -
context
The encounter or episode of care that establishes the context for this event. -
contextTarget
The actual object that is the target of the reference (The encounter or episode of care that establishes the context for this event.) -
supportingInformation
Additional information that supports the medication being dispensed. -
supportingInformationTarget
The actual objects that are the target of the reference (Additional information that supports the medication being dispensed.) -
performer
Indicates who or what performed the event. It should be assumed that the performer is the dispenser of 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. -
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. If nothing is specified, substitution was not done. -
detectedIssue
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc. -
detectedIssueTarget
The actual objects that are the target of the reference (Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.) -
notDone
True if the dispense was not performed for some reason. -
notDoneReason
Indicates the reason why a dispense was not performed. -
eventHistory
A summary of the events of interest that have occurred, such as when the dispense was verified. -
eventHistoryTarget
The actual objects that are the target of the reference (A summary of the events of interest that have occurred, such as when the dispense was verified.) -
SP_IDENTIFIER
Search parameter: identifierDescription: Return dispenses with this external identifier
Type: token
Path: MedicationDispense.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Return dispenses with this external identifier
Type: token
Path: MedicationDispense.identifier
-
SP_PERFORMER
Search parameter: performerDescription: Return dispenses performed by a specific individual
Type: reference
Path: MedicationDispense.performer.actor
- See Also:
-
PERFORMER
Fluent Client search parameter constant for performerDescription: Return dispenses performed by a specific individual
Type: reference
Path: MedicationDispense.performer.actor
-
INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:performer". -
SP_CODE
Search parameter: codeDescription: Return dispenses of this medicine code
Type: token
Path: MedicationDispense.medicationCodeableConcept
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Return dispenses of this medicine code
Type: token
Path: MedicationDispense.medicationCodeableConcept
-
SP_RECEIVER
Search parameter: receiverDescription: The identity of a receiver to list dispenses for
Type: reference
Path: MedicationDispense.receiver
- See Also:
-
RECEIVER
Fluent Client search parameter constant for receiverDescription: The identity of a receiver to list dispenses for
Type: reference
Path: MedicationDispense.receiver
-
INCLUDE_RECEIVER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:receiver". -
SP_SUBJECT
Search parameter: subjectDescription: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:subject". -
SP_DESTINATION
Search parameter: destinationDescription: Return dispenses that should be sent to a specific destination
Type: reference
Path: MedicationDispense.destination
- See Also:
-
DESTINATION
Fluent Client search parameter constant for destinationDescription: Return dispenses that should be sent to a specific destination
Type: reference
Path: MedicationDispense.destination
-
INCLUDE_DESTINATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:destination". -
SP_MEDICATION
Search parameter: medicationDescription: Return dispenses of this medicine resource
Type: reference
Path: MedicationDispense.medicationReference
- See Also:
-
MEDICATION
Fluent Client search parameter constant for medicationDescription: Return dispenses of this medicine resource
Type: reference
Path: MedicationDispense.medicationReference
-
INCLUDE_MEDICATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:medication". -
SP_RESPONSIBLEPARTY
Search parameter: responsiblepartyDescription: Return dispenses with the specified responsible party
Type: reference
Path: MedicationDispense.substitution.responsibleParty
- See Also:
-
RESPONSIBLEPARTY
Fluent Client search parameter constant for responsiblepartyDescription: Return dispenses with the specified responsible party
Type: reference
Path: MedicationDispense.substitution.responsibleParty
-
INCLUDE_RESPONSIBLEPARTY
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:responsibleparty". -
SP_TYPE
Search parameter: typeDescription: Return dispenses of a specific type
Type: token
Path: MedicationDispense.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: Return dispenses of a specific type
Type: token
Path: MedicationDispense.type
-
SP_WHENHANDEDOVER
Search parameter: whenhandedoverDescription: Returns dispenses handed over on this date
Type: date
Path: MedicationDispense.whenHandedOver
- See Also:
-
WHENHANDEDOVER
Fluent Client search parameter constant for whenhandedoverDescription: Returns dispenses handed over on this date
Type: date
Path: MedicationDispense.whenHandedOver
-
SP_WHENPREPARED
Search parameter: whenpreparedDescription: Returns dispenses prepared on this date
Type: date
Path: MedicationDispense.whenPrepared
- See Also:
-
WHENPREPARED
Fluent Client search parameter constant for whenpreparedDescription: Returns dispenses prepared on this date
Type: date
Path: MedicationDispense.whenPrepared
-
SP_PRESCRIPTION
Search parameter: prescriptionDescription: The identity of a prescription to list dispenses from
Type: reference
Path: MedicationDispense.authorizingPrescription
- See Also:
-
PRESCRIPTION
Fluent Client search parameter constant for prescriptionDescription: The identity of a prescription to list dispenses from
Type: reference
Path: MedicationDispense.authorizingPrescription
-
INCLUDE_PRESCRIPTION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:prescription". -
SP_PATIENT
Search parameter: patientDescription: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:patient". -
SP_CONTEXT
Search parameter: contextDescription: Returns dispenses with a specific context (episode or episode of care)
Type: reference
Path: MedicationDispense.context
- See Also:
-
CONTEXT
Fluent Client search parameter constant for contextDescription: Returns dispenses with a specific context (episode or episode of care)
Type: reference
Path: MedicationDispense.context
-
INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:context". -
SP_STATUS
Search parameter: statusDescription: Return dispenses with a specified dispense status
Type: token
Path: MedicationDispense.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: Return dispenses with a specified dispense status
Type: token
Path: MedicationDispense.status
-
-
Constructor Details
-
MedicationDispense
public MedicationDispense()Constructor -
MedicationDispense
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getPartOf
- Returns:
partOf
(The procedure that the dispense is done because of.)
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist
-
getPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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.
-
getCategory
- Returns:
category
(Indicates type of medication dispense and where the medication is expected to be consumed or administered.)
-
hasCategory
-
setCategory
- Parameters:
value
-category
(Indicates type of medication dispense and where the medication is expected to be consumed or administered.)
-
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.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getSubject
- Returns:
subject
(A link to a resource representing the person or the group to whom the medication will be given.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(A link to a resource representing the person or the group to whom the medication will be given.)
-
getSubjectTarget
- Returns:
subject
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 or the group to whom the medication will be given.)
-
setSubjectTarget
- Parameters:
value
-subject
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 or the group to whom the medication will be given.)
-
getContext
- Returns:
context
(The encounter or episode of care that establishes the context for this event.)
-
hasContext
-
setContext
- Parameters:
value
-context
(The encounter or episode of care that establishes the context for this event.)
-
getContextTarget
- Returns:
context
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 encounter or episode of care that establishes the context for this event.)
-
setContextTarget
- Parameters:
value
-context
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 encounter or episode of care that establishes the context for this event.)
-
getSupportingInformation
- Returns:
supportingInformation
(Additional information that supports the medication being dispensed.)
-
setSupportingInformation
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupportingInformation
-
addSupportingInformation
-
addSupportingInformation
-
getSupportingInformationFirstRep
- Returns:
- The first repetition of repeating field
supportingInformation
, creating it if it does not already exist
-
getSupportingInformationTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getPerformer
- Returns:
performer
(Indicates who or what performed the event. It should be assumed that the performer is the dispenser of the medication.)
-
setPerformer
public MedicationDispense setPerformer(List<MedicationDispense.MedicationDispensePerformerComponent> thePerformer) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformer
-
addPerformer
-
addPerformer
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist
-
getAuthorizingPrescription
- Returns:
authorizingPrescription
(Indicates the medication order that is being dispensed against.)
-
setAuthorizingPrescription
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAuthorizingPrescription
-
addAuthorizingPrescription
-
addAuthorizingPrescription
-
getAuthorizingPrescriptionFirstRep
- Returns:
- The first repetition of repeating field
authorizingPrescription
, creating it if it does not already exist
-
getAuthorizingPrescriptionTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addAuthorizingPrescriptionTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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.)
-
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.)
-
setReceiver
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReceiver
-
addReceiver
-
addReceiver
-
getReceiverFirstRep
- Returns:
- The first repetition of repeating field
receiver
, creating it if it does not already exist
-
getReceiverTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getNote
- Returns:
note
(Extra information about the dispense that could not be conveyed in the other attributes.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
getDosageInstruction
- Returns:
dosageInstruction
(Indicates how the medication is to be used by the patient.)
-
setDosageInstruction
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDosageInstruction
-
addDosageInstruction
-
addDosageInstruction
-
getDosageInstructionFirstRep
- Returns:
- The first repetition of repeating field
dosageInstruction
, creating it if it does not already exist
-
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. If nothing is specified, substitution was not done.)
-
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. If nothing is specified, substitution was not done.)
-
getDetectedIssue
- Returns:
detectedIssue
(Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.)
-
setDetectedIssue
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDetectedIssue
-
addDetectedIssue
-
addDetectedIssue
-
getDetectedIssueFirstRep
- Returns:
- The first repetition of repeating field
detectedIssue
, creating it if it does not already exist
-
getDetectedIssueTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addDetectedIssueTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getNotDoneElement
- Returns:
notDone
(True if the dispense was not performed for some reason.). This is the underlying object with id, value and extensions. The accessor "getNotDone" gives direct access to the value
-
hasNotDoneElement
-
hasNotDone
-
setNotDoneElement
- Parameters:
value
-notDone
(True if the dispense was not performed for some reason.). This is the underlying object with id, value and extensions. The accessor "getNotDone" gives direct access to the value
-
getNotDone
- Returns:
- True if the dispense was not performed for some reason.
-
setNotDone
- Parameters:
value
- True if the dispense was not performed for some reason.
-
getNotDoneReason
- Returns:
notDoneReason
(Indicates the reason why a dispense was not performed.)
-
getNotDoneReasonCodeableConcept
public CodeableConcept getNotDoneReasonCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException- Returns:
notDoneReason
(Indicates the reason why a dispense was not performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasNotDoneReasonCodeableConcept
-
getNotDoneReasonReference
- Returns:
notDoneReason
(Indicates the reason why a dispense was not performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasNotDoneReasonReference
-
hasNotDoneReason
-
setNotDoneReason
public MedicationDispense setNotDoneReason(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError - Parameters:
value
-notDoneReason
(Indicates the reason why a dispense was not performed.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getEventHistory
- Returns:
eventHistory
(A summary of the events of interest that have occurred, such as when the dispense was verified.)
-
setEventHistory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEventHistory
-
addEventHistory
-
addEventHistory
-
getEventHistoryFirstRep
- Returns:
- The first repetition of repeating field
eventHistory
, creating it if it does not already exist
-
getEventHistoryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addEventHistoryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
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
-