
Package org.hl7.fhir.dstu2.model
Class MedicationOrder
java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.MedicationOrder
- 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
An order for both supply of the medication and the instructions for
 administration of the medication to a patient. The resource is called
 "MedicationOrder" rather than "MedicationPrescription" to generalize the use
 across inpatient and outpatient settings as well as for care plans, etc.
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic enumstatic classstatic class
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected DateTimeTypeThe date (and perhaps time) when the prescription was stopped.protected DateTimeTypeThe date (and perhaps time) when the prescription was written.Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription).Indicates how the medication is to be used by the patient.protected ReferenceA link to a resource that identifies the particular occurrence of contact between patient and health care provider.protected EncounterThe actual object that is the target of the reference (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)protected List<Identifier> External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created.protected TypeIdentifies the medication being administered.protected StringTypeExtra information about the prescription that could not be conveyed by the other attributes.protected ReferenceA link to a resource representing the person to whom the medication will be given.protected PatientThe 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 ReferenceThe healthcare professional responsible for authorizing the prescription.protected PractitionerThe actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.)protected ReferenceA link to a resource representing an earlier order or prescription that this order supersedes.protected MedicationOrderThe actual object that is the target of the reference (A link to a resource representing an earlier order or prescription that this order supersedes.)protected TypeCan be the reason or the indication for writing the prescription.protected CodeableConceptThe reason why the prescription was stopped, if it was.static final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected Enumeration<MedicationOrder.MedicationOrderStatus> A code specifying the state of the order.Indicates whether or not substitution can or should be part of the dispense.Fields inherited from class org.hl7.fhir.dstu2.model.DomainResourcecontained, extension, modifierExtension, textFields inherited from class org.hl7.fhir.dstu2.model.Resourceid, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResourceRES_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_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResourceINCLUDE_ALL, WILDCARD_ALL_SET
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptioncopy()booleanequalsDeep(Base other) booleanequalsShallow(Base other) fhirType()getNote()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasNote()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> childrenList) setDateEnded(Date value) setDateEndedElement(DateTimeType value) setDateWritten(Date value) setEncounter(Reference value) setEncounterTarget(Encounter value) setMedication(Type value) setNoteElement(StringType value) setPatient(Reference value) setPatientTarget(Patient value) setPrescriber(Reference value) setPrescriberTarget(Practitioner value) setPriorPrescription(Reference value) voidsetProperty(String name, Base value) setReasonEnded(CodeableConcept value) protected MedicationOrderMethods inherited from class org.hl7.fhir.dstu2.model.DomainResourceaddContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setTextMethods inherited from class org.hl7.fhir.dstu2.model.ResourcecopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.dstu2.model.BaseResourcegetStructureFhirVersionEnum, setIdMethods inherited from class org.hl7.fhir.dstu2.model.BasecastToAddress, 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, setUserDataINNMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResourcegetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBasegetFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResourcegetMeta, getStructureFhirVersionEnum, isDeleted, setId
- 
Field Details- 
identifierExternal identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system.
- 
dateWrittenThe date (and perhaps time) when the prescription was written.
- 
statusA code specifying the state of the order. Generally this will be active or completed state.
- 
dateEndedThe date (and perhaps time) when the prescription was stopped.
- 
reasonEndedThe reason why the prescription was stopped, if it was.
- 
patientA link to a resource representing the person to whom the medication will be given.
- 
patientTargetThe actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.)
- 
prescriberThe healthcare professional responsible for authorizing the prescription.
- 
prescriberTargetThe actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.)
- 
encounterA link to a resource that identifies the particular occurrence of contact between patient and health care provider.
- 
encounterTargetThe actual object that is the target of the reference (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)
- 
reasonCan be the reason or the indication for writing the prescription.
- 
noteExtra information about the prescription that could not be conveyed by the other attributes.
- 
medicationIdentifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
- 
dosageInstructionIndicates how the medication is to be used by the patient.
- 
dispenseRequestIndicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
- 
substitutionIndicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.
- 
priorPrescriptionA link to a resource representing an earlier order or prescription that this order supersedes.
- 
priorPrescriptionTargetThe actual object that is the target of the reference (A link to a resource representing an earlier order or prescription that this order supersedes.)
- 
SP_PRESCRIBER- See Also:
 
- 
SP_IDENTIFIER- See Also:
 
- 
SP_CODE- See Also:
 
- 
SP_PATIENT- See Also:
 
- 
SP_DATEWRITTEN- See Also:
 
- 
SP_MEDICATION- See Also:
 
- 
SP_ENCOUNTER- See Also:
 
- 
SP_STATUS- See Also:
 
 
- 
- 
Constructor Details- 
MedicationOrderpublic MedicationOrder()
- 
MedicationOrder
 
- 
- 
Method Details- 
getIdentifier- Returns:
- identifier(External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system.)
 
- 
hasIdentifier
- 
addIdentifier- Returns:
- identifier(External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system.)
 
- 
addIdentifier
- 
getDateWrittenElement- Returns:
- dateWritten(The date (and perhaps time) when the prescription was written.). This is the underlying object with id, value and extensions. The accessor "getDateWritten" gives direct access to the value
 
- 
hasDateWrittenElement
- 
hasDateWritten
- 
setDateWrittenElement- Parameters:
- value-- dateWritten(The date (and perhaps time) when the prescription was written.). This is the underlying object with id, value and extensions. The accessor "getDateWritten" gives direct access to the value
 
- 
getDateWritten- Returns:
- The date (and perhaps time) when the prescription was written.
 
- 
setDateWritten- Parameters:
- value- The date (and perhaps time) when the prescription was written.
 
- 
getStatusElement- Returns:
- status(A code specifying the state of the order. Generally this will be active or completed state.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
 
- 
hasStatusElement
- 
hasStatus
- 
setStatusElement- Parameters:
- value-- status(A code specifying the state of the order. Generally this will be active or completed state.). 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 order. Generally this will be active or completed state.
 
- 
setStatus- Parameters:
- value- A code specifying the state of the order. Generally this will be active or completed state.
 
- 
getDateEndedElement- Returns:
- dateEnded(The date (and perhaps time) when the prescription was stopped.). This is the underlying object with id, value and extensions. The accessor "getDateEnded" gives direct access to the value
 
- 
hasDateEndedElement
- 
hasDateEnded
- 
setDateEndedElement- Parameters:
- value-- dateEnded(The date (and perhaps time) when the prescription was stopped.). This is the underlying object with id, value and extensions. The accessor "getDateEnded" gives direct access to the value
 
- 
getDateEnded- Returns:
- The date (and perhaps time) when the prescription was stopped.
 
- 
setDateEnded- Parameters:
- value- The date (and perhaps time) when the prescription was stopped.
 
- 
getReasonEnded- Returns:
- reasonEnded(The reason why the prescription was stopped, if it was.)
 
- 
hasReasonEnded
- 
setReasonEnded- Parameters:
- value-- reasonEnded(The reason why the prescription was stopped, if it was.)
 
- 
getPatient- Returns:
- patient(A link to a resource representing the person to whom the medication will be given.)
 
- 
hasPatient
- 
setPatient- Parameters:
- value-- patient(A link to a resource representing the person to whom the medication will be given.)
 
- 
getPatientTarget- Returns:
- patientThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)
 
- 
setPatientTarget- Parameters:
- value-- patientThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)
 
- 
getPrescriber- Returns:
- prescriber(The healthcare professional responsible for authorizing the prescription.)
 
- 
hasPrescriber
- 
setPrescriber- Parameters:
- value-- prescriber(The healthcare professional responsible for authorizing the prescription.)
 
- 
getPrescriberTarget- Returns:
- prescriberThe 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 healthcare professional responsible for authorizing the prescription.)
 
- 
setPrescriberTarget- Parameters:
- value-- prescriberThe 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 healthcare professional responsible for authorizing the prescription.)
 
- 
getEncounter- Returns:
- encounter(A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)
 
- 
hasEncounter
- 
setEncounter- Parameters:
- value-- encounter(A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)
 
- 
getEncounterTarget- Returns:
- encounterThe 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 that identifies the particular occurrence of contact between patient and health care provider.)
 
- 
setEncounterTarget- Parameters:
- value-- encounterThe 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 that identifies the particular occurrence of contact between patient and health care provider.)
 
- 
getReason- Returns:
- reason(Can be the reason or the indication for writing the prescription.)
 
- 
getReasonCodeableConcept- Returns:
- reason(Can be the reason or the indication for writing the prescription.)
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
hasReasonCodeableConcept
- 
getReasonReference- Returns:
- reason(Can be the reason or the indication for writing the prescription.)
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
hasReasonReference
- 
hasReason
- 
setReason- Parameters:
- value-- reason(Can be the reason or the indication for writing the prescription.)
 
- 
getNoteElement- Returns:
- note(Extra information about the prescription that could not be conveyed by the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
 
- 
hasNoteElement
- 
hasNote
- 
setNoteElement- Parameters:
- value-- note(Extra information about the prescription that could not be conveyed by the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
 
- 
getNote- Returns:
- Extra information about the prescription that could not be conveyed by the other attributes.
 
- 
setNote- Parameters:
- value- Extra information about the prescription that could not be conveyed by the other attributes.
 
- 
getMedication- Returns:
- medication(Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.)
 
- 
getMedicationCodeableConcept- Returns:
- medication(Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an 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 a link to a resource that represents the medication which may be the details of the medication or simply an 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 a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.)
 
- 
getDosageInstruction- Returns:
- dosageInstruction(Indicates how the medication is to be used by the patient.)
 
- 
hasDosageInstruction
- 
addDosageInstruction- Returns:
- dosageInstruction(Indicates how the medication is to be used by the patient.)
 
- 
addDosageInstruction
- 
getDispenseRequest- Returns:
- dispenseRequest(Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.)
 
- 
hasDispenseRequest
- 
setDispenseRequestpublic MedicationOrder setDispenseRequest(MedicationOrder.MedicationOrderDispenseRequestComponent value) - Parameters:
- value-- dispenseRequest(Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.)
 
- 
getSubstitution- Returns:
- substitution(Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.)
 
- 
hasSubstitution
- 
setSubstitution- Parameters:
- value-- substitution(Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.)
 
- 
getPriorPrescription- Returns:
- priorPrescription(A link to a resource representing an earlier order or prescription that this order supersedes.)
 
- 
hasPriorPrescription
- 
setPriorPrescription- Parameters:
- value-- priorPrescription(A link to a resource representing an earlier order or prescription that this order supersedes.)
 
- 
getPriorPrescriptionTarget- Returns:
- priorPrescriptionThe 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 an earlier order or prescription that this order supersedes.)
 
- 
setPriorPrescriptionTarget- Parameters:
- value-- priorPrescriptionThe 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 an earlier order or prescription that this order supersedes.)
 
- 
listChildren- Overrides:
- listChildrenin class- DomainResource
 
- 
setProperty- Overrides:
- setPropertyin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
addChild- Overrides:
- addChildin class- DomainResource
- Throws:
- org.hl7.fhir.exceptions.FHIRException
 
- 
fhirType- Specified by:
- fhirTypein interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- fhirTypein class- DomainResource
 
- 
copy- Specified by:
- copyin class- DomainResource
 
- 
typedCopy
- 
equalsDeep- Overrides:
- equalsDeepin class- DomainResource
 
- 
equalsShallow- Overrides:
- equalsShallowin class- DomainResource
 
- 
isEmpty- Specified by:
- isEmptyin interface- org.hl7.fhir.instance.model.api.IBase
- Overrides:
- isEmptyin class- DomainResource
 
- 
getResourceType- Specified by:
- getResourceTypein class- Resource
 
 
-