public class MedicationDispense extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
MedicationDispense.MedicationDispenseDosageInstructionComponent |
static class |
MedicationDispense.MedicationDispenseStatus |
static class |
MedicationDispense.MedicationDispenseStatusEnumFactory |
static class |
MedicationDispense.MedicationDispenseSubstitutionComponent |
| Modifier and Type | Field and Description |
|---|---|
protected List<Reference> |
authorizingPrescription
Indicates the medication order that is being dispensed against.
|
protected List<MedicationOrder> |
authorizingPrescriptionTarget
The actual objects that are the target of the reference (Indicates the medication order that is being dispensed against.)
|
protected SimpleQuantity |
daysSupply
The amount of medication expressed as a timing amount.
|
protected Reference |
destination
Identification of the facility/location where the medication was shipped to, as part of the dispense event.
|
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.)
|
protected Reference |
dispenser
The individual responsible for dispensing the medication.
|
protected Practitioner |
dispenserTarget
The actual object that is the target of the reference (The individual responsible for dispensing the medication.)
|
protected List<MedicationDispense.MedicationDispenseDosageInstructionComponent> |
dosageInstruction
Indicates how the medication is to be used by the patient.
|
protected Identifier |
identifier
Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
|
protected Type |
medication
Identifies the medication being administered.
|
protected StringType |
note
Extra information about the dispense that could not be conveyed in the other attributes.
|
protected Reference |
patient
A link to a resource representing the person to whom the medication will be given.
|
protected Patient |
patientTarget
The actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.)
|
protected SimpleQuantity |
quantity
The amount of medication that has been dispensed.
|
protected List<Reference> |
receiver
Identifies the person who picked up the medication.
|
protected List<Resource> |
receiverTarget
The actual objects that are the target of the reference (Identifies the person who picked up the medication.
|
static String |
SP_CODE |
static String |
SP_DESTINATION |
static String |
SP_DISPENSER |
static String |
SP_IDENTIFIER |
static String |
SP_MEDICATION |
static String |
SP_PATIENT |
static String |
SP_PRESCRIPTION |
static String |
SP_RECEIVER |
static String |
SP_RESPONSIBLEPARTY |
static String |
SP_STATUS |
static String |
SP_TYPE |
static String |
SP_WHENHANDEDOVER |
static String |
SP_WHENPREPARED |
protected Enumeration<MedicationDispense.MedicationDispenseStatus> |
status
A code specifying the state of the set of dispense events.
|
protected MedicationDispense.MedicationDispenseSubstitutionComponent |
substitution
Indicates whether or not substitution was made as part of the dispense.
|
protected CodeableConcept |
type
Indicates the type of dispensing event that is performed.
|
protected DateTimeType |
whenHandedOver
The time the dispensed product was provided to the patient or their representative.
|
protected DateTimeType |
whenPrepared
The time when the dispensed product was packaged and reviewed.
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
MedicationDispense() |
MedicationDispense(Type medication) |
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setTextcopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, getStructureFhirVersionEnum, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetasetIdcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected Identifier identifier
protected Enumeration<MedicationDispense.MedicationDispenseStatus> status
protected Reference patient
protected Patient patientTarget
protected Practitioner dispenserTarget
protected List<Reference> authorizingPrescription
protected List<MedicationOrder> authorizingPrescriptionTarget
protected CodeableConcept type
protected SimpleQuantity quantity
protected SimpleQuantity daysSupply
protected Type medication
protected DateTimeType whenPrepared
protected DateTimeType whenHandedOver
protected Reference destination
protected Location destinationTarget
protected List<Reference> receiver
protected List<Resource> receiverTarget
protected StringType note
protected List<MedicationDispense.MedicationDispenseDosageInstructionComponent> dosageInstruction
protected MedicationDispense.MedicationDispenseSubstitutionComponent substitution
public static final String SP_IDENTIFIER
public static final String SP_CODE
public static final String SP_RECEIVER
public static final String SP_DESTINATION
public static final String SP_MEDICATION
public static final String SP_RESPONSIBLEPARTY
public static final String SP_TYPE
public static final String SP_WHENHANDEDOVER
public static final String SP_WHENPREPARED
public static final String SP_DISPENSER
public static final String SP_PRESCRIPTION
public static final String SP_PATIENT
public static final String SP_STATUS
public MedicationDispense()
public MedicationDispense(Type medication)
public Identifier getIdentifier()
identifier (Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.)public boolean hasIdentifier()
public MedicationDispense setIdentifier(Identifier value)
value - identifier (Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.)public Enumeration<MedicationDispense.MedicationDispenseStatus> getStatusElement()
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 valuepublic boolean hasStatusElement()
public boolean hasStatus()
public MedicationDispense setStatusElement(Enumeration<MedicationDispense.MedicationDispenseStatus> value)
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 valuepublic MedicationDispense.MedicationDispenseStatus getStatus()
public MedicationDispense setStatus(MedicationDispense.MedicationDispenseStatus value)
value - A code specifying the state of the set of dispense events.public Reference getPatient()
patient (A link to a resource representing the person to whom the medication will be given.)public boolean hasPatient()
public MedicationDispense setPatient(Reference value)
value - patient (A link to a resource representing the person to whom the medication will be given.)public Patient getPatientTarget()
patient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)public MedicationDispense setPatientTarget(Patient value)
value - patient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)public Reference getDispenser()
dispenser (The individual responsible for dispensing the medication.)public boolean hasDispenser()
public MedicationDispense setDispenser(Reference value)
value - dispenser (The individual responsible for dispensing the medication.)public Practitioner getDispenserTarget()
dispenser The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The individual responsible for dispensing the medication.)public MedicationDispense setDispenserTarget(Practitioner value)
value - dispenser The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The individual responsible for dispensing the medication.)public List<Reference> getAuthorizingPrescription()
authorizingPrescription (Indicates the medication order that is being dispensed against.)public boolean hasAuthorizingPrescription()
public Reference addAuthorizingPrescription()
authorizingPrescription (Indicates the medication order that is being dispensed against.)public MedicationDispense addAuthorizingPrescription(Reference t)
public List<MedicationOrder> getAuthorizingPrescriptionTarget()
authorizingPrescription (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Indicates the medication order that is being dispensed against.)public MedicationOrder addAuthorizingPrescriptionTarget()
authorizingPrescription (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Indicates the medication order that is being dispensed against.)public CodeableConcept getType()
type (Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.)public boolean hasType()
public MedicationDispense setType(CodeableConcept value)
value - type (Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.)public SimpleQuantity getQuantity()
quantity (The amount of medication that has been dispensed. Includes unit of measure.)public boolean hasQuantity()
public MedicationDispense setQuantity(SimpleQuantity value)
value - quantity (The amount of medication that has been dispensed. Includes unit of measure.)public SimpleQuantity getDaysSupply()
daysSupply (The amount of medication expressed as a timing amount.)public boolean hasDaysSupply()
public MedicationDispense setDaysSupply(SimpleQuantity value)
value - daysSupply (The amount of medication expressed as a timing amount.)public Type getMedication()
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.)public CodeableConcept getMedicationCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMedicationCodeableConcept()
public Reference getMedicationReference() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMedicationReference()
public boolean hasMedication()
public MedicationDispense setMedication(Type value)
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.)public DateTimeType getWhenPreparedElement()
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 valuepublic boolean hasWhenPreparedElement()
public boolean hasWhenPrepared()
public MedicationDispense setWhenPreparedElement(DateTimeType value)
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 valuepublic Date getWhenPrepared()
public MedicationDispense setWhenPrepared(Date value)
value - The time when the dispensed product was packaged and reviewed.public DateTimeType getWhenHandedOverElement()
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 valuepublic boolean hasWhenHandedOverElement()
public boolean hasWhenHandedOver()
public MedicationDispense setWhenHandedOverElement(DateTimeType value)
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 valuepublic Date getWhenHandedOver()
public MedicationDispense setWhenHandedOver(Date value)
value - The time the dispensed product was provided to the patient or their representative.public Reference getDestination()
destination (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)public boolean hasDestination()
public MedicationDispense setDestination(Reference value)
value - destination (Identification of the facility/location where the medication was shipped to, as part of the dispense event.)public Location getDestinationTarget()
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.)public MedicationDispense setDestinationTarget(Location value)
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.)public List<Reference> getReceiver()
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.)public boolean hasReceiver()
public Reference addReceiver()
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.)public MedicationDispense addReceiver(Reference t)
public List<Resource> getReceiverTarget()
receiver (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.)public StringType getNoteElement()
note (Extra information about the dispense that could not be conveyed in the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the valuepublic boolean hasNoteElement()
public boolean hasNote()
public MedicationDispense setNoteElement(StringType value)
value - note (Extra information about the dispense that could not be conveyed in the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the valuepublic String getNote()
public MedicationDispense setNote(String value)
value - Extra information about the dispense that could not be conveyed in the other attributes.public List<MedicationDispense.MedicationDispenseDosageInstructionComponent> getDosageInstruction()
dosageInstruction (Indicates how the medication is to be used by the patient.)public boolean hasDosageInstruction()
public MedicationDispense.MedicationDispenseDosageInstructionComponent addDosageInstruction()
dosageInstruction (Indicates how the medication is to be used by the patient.)public MedicationDispense addDosageInstruction(MedicationDispense.MedicationDispenseDosageInstructionComponent t)
public MedicationDispense.MedicationDispenseSubstitutionComponent getSubstitution()
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.)public boolean hasSubstitution()
public MedicationDispense setSubstitution(MedicationDispense.MedicationDispenseSubstitutionComponent value)
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.)protected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic MedicationDispense copy()
copy in class DomainResourceprotected MedicationDispense typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2018 University Health Network. All rights reserved.