Class MedicationDispense
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.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.MedicationDispensePerformerComponentstatic 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<MedicationRequest>authorizingPrescriptionTargetThe actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.)protected CodeableConceptcategoryIndicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected ReferencecontextThe encounter or episode of care that establishes the context for this event.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCONTEXTFluent Client search parameter constant for contextprotected ResourcecontextTargetThe actual object that is the target of the reference (The encounter or episode of care that establishes the context for this event.)protected QuantitydaysSupplyThe 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.static ca.uhn.fhir.rest.gclient.ReferenceClientParamDESTINATIONFluent Client search parameter constant for destinationprotected 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 List<Reference>detectedIssueIndicates 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>detectedIssueTargetThe 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.protected List<Dosage>dosageInstructionIndicates how the medication is to be used by the patient.protected List<Reference>eventHistoryA summary of the events of interest that have occurred, such as when the dispense was verified.protected List<Provenance>eventHistoryTargetThe 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>identifierIdentifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_CONTEXTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DESTINATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MEDICATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PERFORMERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PRESCRIPTIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_RECEIVERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_RESPONSIBLEPARTYConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected ReferencelocationThe principal physical location where the dispense was performed.protected LocationlocationTargetThe actual object that is the target of the reference (The principal physical location where the dispense was performed.)protected TypemedicationIdentifies the medication being administered.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMEDICATIONFluent Client search parameter constant for medicationprotected List<Annotation>noteExtra information about the dispense that could not be conveyed in the other attributes.protected List<Reference>partOfThe procedure that trigger the dispense.protected List<Procedure>partOfTargetThe actual objects that are the target of the reference (The procedure that trigger the dispense.)static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected List<MedicationDispense.MedicationDispensePerformerComponent>performerIndicates who or what performed the event.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPERFORMERFluent Client search parameter constant for performerstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamPRESCRIPTIONFluent Client search parameter constant for prescriptionprotected QuantityquantityThe amount of medication that has been dispensed.protected List<Reference>receiverIdentifies the person who picked up the medication.static ca.uhn.fhir.rest.gclient.ReferenceClientParamRECEIVERFluent Client search parameter constant for receiverprotected List<Resource>receiverTargetThe actual objects that are the target of the reference (Identifies the person who picked up the medication.static ca.uhn.fhir.rest.gclient.ReferenceClientParamRESPONSIBLEPARTYFluent Client search parameter constant for responsiblepartystatic StringSP_CODESearch parameter: codestatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_DESTINATIONSearch parameter: destinationstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_MEDICATIONSearch parameter: medicationstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERFORMERSearch parameter: performerstatic StringSP_PRESCRIPTIONSearch parameter: prescriptionstatic StringSP_RECEIVERSearch parameter: receiverstatic StringSP_RESPONSIBLEPARTYSearch parameter: responsiblepartystatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_TYPESearch parameter: typestatic StringSP_WHENHANDEDOVERSearch parameter: whenhandedoverstatic StringSP_WHENPREPAREDSearch parameter: whenpreparedprotected Enumeration<MedicationDispense.MedicationDispenseStatus>statusA code specifying the state of the set of dispense events.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected TypestatusReasonIndicates the reason why a dispense was not performed.protected ReferencesubjectA link to a resource representing the person or the group to whom the medication will be given.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected ResourcesubjectTargetThe 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.)protected MedicationDispense.MedicationDispenseSubstitutionComponentsubstitutionIndicates whether or not substitution was made as part of the dispense.protected List<Reference>supportingInformationAdditional information that supports the medication being dispensed.protected List<Resource>supportingInformationTargetThe actual objects that are the target of the reference (Additional information that supports the medication being dispensed.)protected CodeableConcepttypeIndicates the type of dispensing event that is performed.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typeprotected DateTimeTypewhenHandedOverThe time the dispensed product was provided to the patient or their representative.static ca.uhn.fhir.rest.gclient.DateClientParamWHENHANDEDOVERFluent Client search parameter constant for whenhandedoverprotected DateTimeTypewhenPreparedThe time when the dispensed product was packaged and reviewed.static ca.uhn.fhir.rest.gclient.DateClientParamWHENPREPAREDFluent Client search parameter constant for whenprepared-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MedicationDispense()ConstructorMedicationDispense(Enumeration<MedicationDispense.MedicationDispenseStatus> status, Type medication)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
-
partOfTarget
protected List<Procedure> partOfTarget
The actual objects that are the target of the reference (The procedure that trigger the dispense.)
-
status
protected Enumeration<MedicationDispense.MedicationDispenseStatus> status
A code specifying the state of the set of dispense events.
-
statusReason
protected Type statusReason
Indicates the reason why a dispense was not performed.
-
category
protected CodeableConcept category
Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
-
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.
-
subject
protected Reference subject
A link to a resource representing the person or the group to whom the medication will be given.
-
subjectTarget
protected Resource 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
protected Reference context
The encounter or episode of care that establishes the context for this event.
-
contextTarget
protected Resource 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
protected List<Reference> supportingInformation
Additional information that supports the medication being dispensed.
-
supportingInformationTarget
protected List<Resource> supportingInformationTarget
The actual objects that are the target of the reference (Additional information that supports the medication being dispensed.)
-
performer
protected List<MedicationDispense.MedicationDispensePerformerComponent> performer
Indicates who or what performed the event.
-
location
protected Reference location
The principal physical location where the dispense was performed.
-
locationTarget
protected Location locationTarget
The actual object that is the target of the reference (The principal physical location where the dispense was performed.)
-
authorizingPrescription
protected List<Reference> authorizingPrescription
Indicates the medication order that is being dispensed against.
-
authorizingPrescriptionTarget
protected List<MedicationRequest> 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 Quantity quantity
The amount of medication that has been dispensed. Includes unit of measure.
-
daysSupply
protected Quantity daysSupply
The amount of medication expressed as a timing amount.
-
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 List<Annotation> note
Extra information about the dispense that could not be conveyed in the other attributes.
-
dosageInstruction
protected List<Dosage> 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. If nothing is specified, substitution was not done.
-
detectedIssue
protected List<Reference> 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
protected List<DetectedIssue> 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.)
-
eventHistory
protected List<Reference> eventHistory
A summary of the events of interest that have occurred, such as when the dispense was verified.
-
eventHistoryTarget
protected List<Provenance> 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
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Returns dispenses with this external identifier
Type: token
Path: MedicationDispense.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Returns dispenses with this external identifier
Type: token
Path: MedicationDispense.identifier
-
SP_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: Returns dispenses performed by a specific individual
Type: reference
Path: MedicationDispense.performer.actor
- See Also:
- Constant Field Values
-
PERFORMER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
Fluent Client search parameter constant for performerDescription: Returns dispenses performed by a specific individual
Type: reference
Path: MedicationDispense.performer.actor
-
INCLUDE_PERFORMER
public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:performer".
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: Returns dispenses of this medicine code
Type: token
Path: MedicationDispense.medicationCodeableConcept
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: Returns dispenses of this medicine code
Type: token
Path: MedicationDispense.medicationCodeableConcept
-
SP_RECEIVER
public static final String SP_RECEIVER
Search parameter: receiverDescription: The identity of a receiver to list dispenses for
Type: reference
Path: MedicationDispense.receiver
- See Also:
- Constant Field Values
-
RECEIVER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECEIVER
Fluent Client search parameter constant for receiverDescription: The identity of a receiver to list dispenses for
Type: reference
Path: MedicationDispense.receiver
-
INCLUDE_RECEIVER
public static final ca.uhn.fhir.model.api.Include INCLUDE_RECEIVER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:receiver".
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The identity of a patient for whom to list dispenses
Type: reference
Path: MedicationDispense.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: The identity of a patient for whom to list dispenses
Type: reference
Path: MedicationDispense.subject
-
INCLUDE_SUBJECT
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:subject".
-
SP_DESTINATION
public static final String SP_DESTINATION
Search parameter: destinationDescription: Returns dispenses that should be sent to a specific destination
Type: reference
Path: MedicationDispense.destination
- See Also:
- Constant Field Values
-
DESTINATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DESTINATION
Fluent Client search parameter constant for destinationDescription: Returns dispenses that should be sent to a specific destination
Type: reference
Path: MedicationDispense.destination
-
INCLUDE_DESTINATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_DESTINATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:destination".
-
SP_MEDICATION
public static final String SP_MEDICATION
Search parameter: medicationDescription: Returns dispenses of this medicine resource
Type: reference
Path: MedicationDispense.medicationReference
- See Also:
- Constant Field Values
-
MEDICATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MEDICATION
Fluent Client search parameter constant for medicationDescription: Returns dispenses of this medicine resource
Type: reference
Path: MedicationDispense.medicationReference
-
INCLUDE_MEDICATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_MEDICATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:medication".
-
SP_RESPONSIBLEPARTY
public static final String SP_RESPONSIBLEPARTY
Search parameter: responsiblepartyDescription: Returns dispenses with the specified responsible party
Type: reference
Path: MedicationDispense.substitution.responsibleParty
- See Also:
- Constant Field Values
-
RESPONSIBLEPARTY
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RESPONSIBLEPARTY
Fluent Client search parameter constant for responsiblepartyDescription: Returns dispenses with the specified responsible party
Type: reference
Path: MedicationDispense.substitution.responsibleParty
-
INCLUDE_RESPONSIBLEPARTY
public static final ca.uhn.fhir.model.api.Include INCLUDE_RESPONSIBLEPARTY
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:responsibleparty".
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: Returns dispenses of a specific type
Type: token
Path: MedicationDispense.type
- See Also:
- Constant Field Values
-
TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Fluent Client search parameter constant for typeDescription: Returns dispenses of a specific type
Type: token
Path: MedicationDispense.type
-
SP_WHENHANDEDOVER
public static final String SP_WHENHANDEDOVER
Search parameter: whenhandedoverDescription: Returns dispenses handed over on this date
Type: date
Path: MedicationDispense.whenHandedOver
- See Also:
- Constant Field Values
-
WHENHANDEDOVER
public static final ca.uhn.fhir.rest.gclient.DateClientParam WHENHANDEDOVER
Fluent Client search parameter constant for whenhandedoverDescription: Returns dispenses handed over on this date
Type: date
Path: MedicationDispense.whenHandedOver
-
SP_WHENPREPARED
public static final String SP_WHENPREPARED
Search parameter: whenpreparedDescription: Returns dispenses prepared on this date
Type: date
Path: MedicationDispense.whenPrepared
- See Also:
- Constant Field Values
-
WHENPREPARED
public static final ca.uhn.fhir.rest.gclient.DateClientParam WHENPREPARED
Fluent Client search parameter constant for whenpreparedDescription: Returns dispenses prepared on this date
Type: date
Path: MedicationDispense.whenPrepared
-
SP_PRESCRIPTION
public static final String SP_PRESCRIPTION
Search parameter: prescriptionDescription: The identity of a prescription to list dispenses from
Type: reference
Path: MedicationDispense.authorizingPrescription
- See Also:
- Constant Field Values
-
PRESCRIPTION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRESCRIPTION
Fluent Client search parameter constant for prescriptionDescription: The identity of a prescription to list dispenses from
Type: reference
Path: MedicationDispense.authorizingPrescription
-
INCLUDE_PRESCRIPTION
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRESCRIPTION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:prescription".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: The identity of a patient to list dispenses for
Type: reference
Path: MedicationDispense.subject
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:patient".
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: Returns dispenses with a specific context (episode or episode of care)
Type: reference
Path: MedicationDispense.context
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationDispense:context".
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Returns dispenses with a specified dispense status
Type: token
Path: MedicationDispense.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Returns dispenses with a specified dispense status
Type: token
Path: MedicationDispense.status
-
-
Constructor Detail
-
MedicationDispense
public MedicationDispense()
Constructor
-
MedicationDispense
public MedicationDispense(Enumeration<MedicationDispense.MedicationDispenseStatus> status, Type medication)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.)
-
setIdentifier
public MedicationDispense setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public MedicationDispense addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getPartOf
public List<Reference> getPartOf()
- Returns:
partOf(The procedure that trigger the dispense.)
-
setPartOf
public MedicationDispense setPartOf(List<Reference> thePartOf)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
addPartOf
public MedicationDispense addPartOf(Reference t)
-
getPartOfFirstRep
public Reference getPartOfFirstRep()
- Returns:
- The first repetition of repeating field
partOf, creating it if it does not already exist
-
getPartOfTarget
@Deprecated public List<Procedure> getPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addPartOfTarget
@Deprecated public Procedure addPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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.
-
getStatusReason
public Type getStatusReason()
- Returns:
statusReason(Indicates the reason why a dispense was not performed.)
-
getStatusReasonCodeableConcept
public CodeableConcept getStatusReasonCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
statusReason(Indicates the reason why a dispense was not performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStatusReasonCodeableConcept
public boolean hasStatusReasonCodeableConcept()
-
getStatusReasonReference
public Reference getStatusReasonReference() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
statusReason(Indicates the reason why a dispense was not performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStatusReasonReference
public boolean hasStatusReasonReference()
-
hasStatusReason
public boolean hasStatusReason()
-
setStatusReason
public MedicationDispense setStatusReason(Type value)
- Parameters:
value-statusReason(Indicates the reason why a dispense was not performed.)
-
getCategory
public CodeableConcept getCategory()
- Returns:
category(Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).)
-
hasCategory
public boolean hasCategory()
-
setCategory
public MedicationDispense setCategory(CodeableConcept value)
- Parameters:
value-category(Indicates the type of medication dispense (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).)
-
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.)
-
getSubject
public Reference getSubject()
- Returns:
subject(A link to a resource representing the person or the group to whom the medication will be given.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public MedicationDispense setSubject(Reference value)
- Parameters:
value-subject(A link to a resource representing the person or the group to whom the medication will be given.)
-
getSubjectTarget
public Resource getSubjectTarget()
- Returns:
subjectThe 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
public MedicationDispense setSubjectTarget(Resource value)
- Parameters:
value-subjectThe 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
public Reference getContext()
- Returns:
context(The encounter or episode of care that establishes the context for this event.)
-
hasContext
public boolean hasContext()
-
setContext
public MedicationDispense setContext(Reference value)
- Parameters:
value-context(The encounter or episode of care that establishes the context for this event.)
-
getContextTarget
public Resource getContextTarget()
- Returns:
contextThe 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
public MedicationDispense setContextTarget(Resource value)
- Parameters:
value-contextThe 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
public List<Reference> getSupportingInformation()
- Returns:
supportingInformation(Additional information that supports the medication being dispensed.)
-
setSupportingInformation
public MedicationDispense setSupportingInformation(List<Reference> theSupportingInformation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupportingInformation
public boolean hasSupportingInformation()
-
addSupportingInformation
public Reference addSupportingInformation()
-
addSupportingInformation
public MedicationDispense addSupportingInformation(Reference t)
-
getSupportingInformationFirstRep
public Reference getSupportingInformationFirstRep()
- Returns:
- The first repetition of repeating field
supportingInformation, creating it if it does not already exist
-
getSupportingInformationTarget
@Deprecated public List<Resource> getSupportingInformationTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getPerformer
public List<MedicationDispense.MedicationDispensePerformerComponent> getPerformer()
- Returns:
performer(Indicates who or what performed the event.)
-
setPerformer
public MedicationDispense setPerformer(List<MedicationDispense.MedicationDispensePerformerComponent> thePerformer)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPerformer
public boolean hasPerformer()
-
addPerformer
public MedicationDispense.MedicationDispensePerformerComponent addPerformer()
-
addPerformer
public MedicationDispense addPerformer(MedicationDispense.MedicationDispensePerformerComponent t)
-
getPerformerFirstRep
public MedicationDispense.MedicationDispensePerformerComponent getPerformerFirstRep()
- Returns:
- The first repetition of repeating field
performer, creating it if it does not already exist
-
getLocation
public Reference getLocation()
- Returns:
location(The principal physical location where the dispense was performed.)
-
hasLocation
public boolean hasLocation()
-
setLocation
public MedicationDispense setLocation(Reference value)
- Parameters:
value-location(The principal physical location where the dispense was performed.)
-
getLocationTarget
public Location getLocationTarget()
- Returns:
locationThe 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 principal physical location where the dispense was performed.)
-
setLocationTarget
public MedicationDispense setLocationTarget(Location value)
- Parameters:
value-locationThe 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 principal physical location where the dispense was performed.)
-
getAuthorizingPrescription
public List<Reference> getAuthorizingPrescription()
- Returns:
authorizingPrescription(Indicates the medication order that is being dispensed against.)
-
setAuthorizingPrescription
public MedicationDispense setAuthorizingPrescription(List<Reference> theAuthorizingPrescription)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthorizingPrescription
public boolean hasAuthorizingPrescription()
-
addAuthorizingPrescription
public Reference addAuthorizingPrescription()
-
addAuthorizingPrescription
public MedicationDispense addAuthorizingPrescription(Reference t)
-
getAuthorizingPrescriptionFirstRep
public Reference getAuthorizingPrescriptionFirstRep()
- Returns:
- The first repetition of repeating field
authorizingPrescription, creating it if it does not already exist
-
getAuthorizingPrescriptionTarget
@Deprecated public List<MedicationRequest> getAuthorizingPrescriptionTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addAuthorizingPrescriptionTarget
@Deprecated public MedicationRequest addAuthorizingPrescriptionTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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 Quantity getQuantity()
- Returns:
quantity(The amount of medication that has been dispensed. Includes unit of measure.)
-
hasQuantity
public boolean hasQuantity()
-
setQuantity
public MedicationDispense setQuantity(Quantity value)
- Parameters:
value-quantity(The amount of medication that has been dispensed. Includes unit of measure.)
-
getDaysSupply
public Quantity getDaysSupply()
- Returns:
daysSupply(The amount of medication expressed as a timing amount.)
-
hasDaysSupply
public boolean hasDaysSupply()
-
setDaysSupply
public MedicationDispense setDaysSupply(Quantity value)
- Parameters:
value-daysSupply(The amount of medication expressed as a timing amount.)
-
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.)
-
setReceiver
public MedicationDispense setReceiver(List<Reference> theReceiver)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReceiver
public boolean hasReceiver()
-
addReceiver
public Reference addReceiver()
-
addReceiver
public MedicationDispense addReceiver(Reference t)
-
getReceiverFirstRep
public Reference getReceiverFirstRep()
- Returns:
- The first repetition of repeating field
receiver, creating it if it does not already exist
-
getReceiverTarget
@Deprecated public List<Resource> getReceiverTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getNote
public List<Annotation> getNote()
- Returns:
note(Extra information about the dispense that could not be conveyed in the other attributes.)
-
setNote
public MedicationDispense setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public MedicationDispense addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist
-
getDosageInstruction
public List<Dosage> getDosageInstruction()
- Returns:
dosageInstruction(Indicates how the medication is to be used by the patient.)
-
setDosageInstruction
public MedicationDispense setDosageInstruction(List<Dosage> theDosageInstruction)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDosageInstruction
public boolean hasDosageInstruction()
-
addDosageInstruction
public Dosage addDosageInstruction()
-
addDosageInstruction
public MedicationDispense addDosageInstruction(Dosage t)
-
getDosageInstructionFirstRep
public Dosage getDosageInstructionFirstRep()
- Returns:
- The first repetition of repeating field
dosageInstruction, creating it if it does not already exist
-
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. If nothing is specified, substitution was not done.)
-
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. If nothing is specified, substitution was not done.)
-
getDetectedIssue
public List<Reference> 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
public MedicationDispense setDetectedIssue(List<Reference> theDetectedIssue)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDetectedIssue
public boolean hasDetectedIssue()
-
addDetectedIssue
public Reference addDetectedIssue()
-
addDetectedIssue
public MedicationDispense addDetectedIssue(Reference t)
-
getDetectedIssueFirstRep
public Reference getDetectedIssueFirstRep()
- Returns:
- The first repetition of repeating field
detectedIssue, creating it if it does not already exist
-
getDetectedIssueTarget
@Deprecated public List<DetectedIssue> getDetectedIssueTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addDetectedIssueTarget
@Deprecated public DetectedIssue addDetectedIssueTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getEventHistory
public List<Reference> getEventHistory()
- Returns:
eventHistory(A summary of the events of interest that have occurred, such as when the dispense was verified.)
-
setEventHistory
public MedicationDispense setEventHistory(List<Reference> theEventHistory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEventHistory
public boolean hasEventHistory()
-
addEventHistory
public Reference addEventHistory()
-
addEventHistory
public MedicationDispense addEventHistory(Reference t)
-
getEventHistoryFirstRep
public Reference getEventHistoryFirstRep()
- Returns:
- The first repetition of repeating field
eventHistory, creating it if it does not already exist
-
getEventHistoryTarget
@Deprecated public List<Provenance> getEventHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addEventHistoryTarget
@Deprecated public Provenance addEventHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin 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
-
copyValues
public void copyValues(MedicationDispense dst)
-
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
-
-