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 Summary
Modifier and TypeClassDescriptionstatic class
static class
static enum
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected DateTimeType
The date (and perhaps time) when the prescription was stopped.protected DateTimeType
The 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 Reference
A link to a resource that identifies the particular occurrence of contact between patient and health care provider.protected Encounter
The 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 Type
Identifies the medication being administered.protected StringType
Extra information about the prescription that could not be conveyed by the other attributes.protected Reference
A link to a resource representing the person to whom the medication will be given.protected Patient
The actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.)protected Reference
The healthcare professional responsible for authorizing the prescription.protected Practitioner
The actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.)protected Reference
A link to a resource representing an earlier order or prescription that this order supersedes.protected MedicationOrder
The 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 Type
Can be the reason or the indication for writing the prescription.protected CodeableConcept
The reason why the prescription was stopped, if it was.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
protected 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.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
boolean
equalsDeep
(Base other) boolean
equalsShallow
(Base other) fhirType()
getNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(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) void
setProperty
(String name, Base value) setReasonEnded
(CodeableConcept value) protected MedicationOrder
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
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. -
dateWritten
The date (and perhaps time) when the prescription was written. -
status
A code specifying the state of the order. Generally this will be active or completed state. -
dateEnded
The date (and perhaps time) when the prescription was stopped. -
reasonEnded
The reason why the prescription was stopped, if it was. -
patient
A link to a resource representing the person to whom the medication will be given. -
patientTarget
The actual object that is the target of the reference (A link to a resource representing the person to whom the medication will be given.) -
prescriber
The healthcare professional responsible for authorizing the prescription. -
prescriberTarget
The actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.) -
encounter
A link to a resource that identifies the particular occurrence of contact between patient and health care provider. -
encounterTarget
The 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.) -
reason
Can be the reason or the indication for writing the prescription. -
note
Extra information about the prescription that could not be conveyed by the other attributes. -
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. -
dosageInstruction
Indicates how the medication is to be used by the patient. -
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. -
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. -
priorPrescription
A link to a resource representing an earlier order or prescription that this order supersedes. -
priorPrescriptionTarget
The 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
-
MedicationOrder
public 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:
patient
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)
-
setPatientTarget
- Parameters:
value
-patient
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person to whom the medication will be given.)
-
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:
prescriber
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 healthcare professional responsible for authorizing the prescription.)
-
setPrescriberTarget
- Parameters:
value
-prescriber
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 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:
encounter
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 that identifies the particular occurrence of contact between patient and health care provider.)
-
setEncounterTarget
- Parameters:
value
-encounter
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 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
-
setDispenseRequest
public 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:
priorPrescription
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 an earlier order or prescription that this order supersedes.)
-
setPriorPrescriptionTarget
- Parameters:
value
-priorPrescription
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 an earlier order or prescription that this order supersedes.)
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-