public class MedicationOrder extends BaseResource implements IResource
Definition: 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.
Requirements:
Profile Definition: http://hl7.org/fhir/profiles/MedicationOrder
| Modifier and Type | Class and Description |
|---|---|
static class |
MedicationOrder.DispenseRequest
Block class for child element: MedicationOrder.dispenseRequest ()
|
static class |
MedicationOrder.DosageInstruction
Block class for child element: MedicationOrder.dosageInstruction ()
|
static class |
MedicationOrder.Substitution
Block class for child element: MedicationOrder.substitution ()
|
| Modifier and Type | Field and Description |
|---|---|
static TokenClientParam |
CODE
Fluent Client search parameter constant for code
|
static DateClientParam |
DATEWRITTEN
Fluent Client search parameter constant for datewritten
|
static ReferenceClientParam |
ENCOUNTER
Fluent Client search parameter constant for encounter
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_MEDICATION
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PRESCRIBER
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
MEDICATION
Fluent Client search parameter constant for medication
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static ReferenceClientParam |
PRESCRIBER
Fluent Client search parameter constant for prescriber
|
static String |
SP_CODE
Search parameter constant for code
|
static String |
SP_DATEWRITTEN
Search parameter constant for datewritten
|
static String |
SP_ENCOUNTER
Search parameter constant for encounter
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_MEDICATION
Search parameter constant for medication
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_PRESCRIBER
Search parameter constant for prescriber
|
static String |
SP_STATUS
Search parameter constant for status
|
static TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
MedicationOrder() |
| Modifier and Type | Method and Description |
|---|---|
MedicationOrder.DosageInstruction |
addDosageInstruction()
Adds and returns a new value for dosageInstruction ()
|
MedicationOrder |
addDosageInstruction(MedicationOrder.DosageInstruction theValue)
Adds a given new value for dosageInstruction ()
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (id)
|
MedicationOrder |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
Date |
getDateEnded()
Gets the value(s) for dateEnded ().
|
DateTimeDt |
getDateEndedElement()
Gets the value(s) for dateEnded ().
|
Date |
getDateWritten()
Gets the value(s) for dateWritten (when.recorded).
|
DateTimeDt |
getDateWrittenElement()
Gets the value(s) for dateWritten (when.recorded).
|
MedicationOrder.DispenseRequest |
getDispenseRequest()
Gets the value(s) for dispenseRequest ().
|
List<MedicationOrder.DosageInstruction> |
getDosageInstruction()
Gets the value(s) for dosageInstruction ().
|
MedicationOrder.DosageInstruction |
getDosageInstructionFirstRep()
Gets the first repetition for dosageInstruction (),
creating it if it does not already exist.
|
ResourceReferenceDt |
getEncounter()
Gets the value(s) for encounter (context).
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (id).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (id),
creating it if it does not already exist.
|
IDatatype |
getMedication()
Gets the value(s) for medication[x] (what).
|
String |
getNote()
Gets the value(s) for note ().
|
StringDt |
getNoteElement()
Gets the value(s) for note ().
|
ResourceReferenceDt |
getPatient()
Gets the value(s) for patient (who.focus).
|
ResourceReferenceDt |
getPrescriber()
Gets the value(s) for prescriber (who.actor).
|
ResourceReferenceDt |
getPriorPrescription()
Gets the value(s) for priorPrescription ().
|
IDatatype |
getReason()
Gets the value(s) for reason[x] (why).
|
CodeableConceptDt |
getReasonEnded()
Gets the value(s) for reasonEnded ().
|
String |
getResourceName() |
String |
getStatus()
Gets the value(s) for status (status).
|
BoundCodeDt<MedicationOrderStatusEnum> |
getStatusElement()
Gets the value(s) for status (status).
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
MedicationOrder.Substitution |
getSubstitution()
Gets the value(s) for substitution ().
|
boolean |
isEmpty() |
MedicationOrder |
setDateEnded(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for dateEnded ()
|
MedicationOrder |
setDateEnded(DateTimeDt theValue)
Sets the value(s) for dateEnded ()
|
MedicationOrder |
setDateEndedWithSecondsPrecision(Date theDate)
Sets the value for dateEnded ()
|
MedicationOrder |
setDateWritten(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for dateWritten (when.recorded)
|
MedicationOrder |
setDateWritten(DateTimeDt theValue)
Sets the value(s) for dateWritten (when.recorded)
|
MedicationOrder |
setDateWrittenWithSecondsPrecision(Date theDate)
Sets the value for dateWritten (when.recorded)
|
MedicationOrder |
setDispenseRequest(MedicationOrder.DispenseRequest theValue)
Sets the value(s) for dispenseRequest ()
|
MedicationOrder |
setDosageInstruction(List<MedicationOrder.DosageInstruction> theValue)
Sets the value(s) for dosageInstruction ()
|
MedicationOrder |
setEncounter(ResourceReferenceDt theValue)
Sets the value(s) for encounter (context)
|
MedicationOrder |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)
|
MedicationOrder |
setMedication(IDatatype theValue)
Sets the value(s) for medication[x] (what)
|
MedicationOrder |
setNote(String theString)
Sets the value for note ()
|
MedicationOrder |
setNote(StringDt theValue)
Sets the value(s) for note ()
|
MedicationOrder |
setPatient(ResourceReferenceDt theValue)
Sets the value(s) for patient (who.focus)
|
MedicationOrder |
setPrescriber(ResourceReferenceDt theValue)
Sets the value(s) for prescriber (who.actor)
|
MedicationOrder |
setPriorPrescription(ResourceReferenceDt theValue)
Sets the value(s) for priorPrescription ()
|
MedicationOrder |
setReason(IDatatype theValue)
Sets the value(s) for reason[x] (why)
|
MedicationOrder |
setReasonEnded(CodeableConceptDt theValue)
Sets the value(s) for reasonEnded ()
|
MedicationOrder |
setStatus(BoundCodeDt<MedicationOrderStatusEnum> theValue)
Sets the value(s) for status (status)
|
MedicationOrder |
setStatus(MedicationOrderStatusEnum theValue)
Sets the value(s) for status (status)
|
MedicationOrder |
setSubstitution(MedicationOrder.Substitution theValue)
Sets the value(s) for substitution ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_DATEWRITTEN
Description: Return prescriptions written on this date
Type: date
Path: MedicationOrder.dateWritten
public static final DateClientParam DATEWRITTEN
Description: Return prescriptions written on this date
Type: date
Path: MedicationOrder.dateWritten
public static final String SP_ENCOUNTER
Description: Return prescriptions with this encounter identifier
Type: reference
Path: MedicationOrder.encounter
public static final ReferenceClientParam ENCOUNTER
Description: Return prescriptions with this encounter identifier
Type: reference
Path: MedicationOrder.encounter
public static final String SP_IDENTIFIER
Description: Return prescriptions with this external identifier
Type: token
Path: MedicationOrder.identifier
public static final TokenClientParam IDENTIFIER
Description: Return prescriptions with this external identifier
Type: token
Path: MedicationOrder.identifier
public static final String SP_MEDICATION
Description: Return administrations of this medication reference
Type: reference
Path: MedicationOrder.medicationReference
public static final ReferenceClientParam MEDICATION
Description: Return administrations of this medication reference
Type: reference
Path: MedicationOrder.medicationReference
public static final String SP_CODE
Description: Return administrations of this medication code
Type: token
Path: MedicationOrder.medicationCodeableConcept
public static final TokenClientParam CODE
Description: Return administrations of this medication code
Type: token
Path: MedicationOrder.medicationCodeableConcept
public static final String SP_PATIENT
Description: The identity of a patient to list orders for
Type: reference
Path: MedicationOrder.patient
public static final ReferenceClientParam PATIENT
Description: The identity of a patient to list orders for
Type: reference
Path: MedicationOrder.patient
public static final String SP_STATUS
Description: Status of the prescription
Type: token
Path: MedicationOrder.status
public static final TokenClientParam STATUS
Description: Status of the prescription
Type: token
Path: MedicationOrder.status
public static final String SP_PRESCRIBER
Description:
Type: reference
Path: MedicationOrder.prescriber
public static final ReferenceClientParam PRESCRIBER
Description:
Type: reference
Path: MedicationOrder.prescriber
public static final Include INCLUDE_ENCOUNTER
public static final Include INCLUDE_MEDICATION
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_PRESCRIBER
public MedicationOrder()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<IdentifierDt> getIdentifier()
null.
Definition: 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.
public MedicationOrder setIdentifier(List<IdentifierDt> theValue)
Definition: 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.
public IdentifierDt addIdentifier()
Definition: 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.
public MedicationOrder addIdentifier(IdentifierDt theValue)
Definition: 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.
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
Definition: 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.
public DateTimeDt getDateWrittenElement()
null.
Definition: The date (and perhaps time) when the prescription was written
public Date getDateWritten()
null.
Definition: The date (and perhaps time) when the prescription was written
public MedicationOrder setDateWritten(DateTimeDt theValue)
Definition: The date (and perhaps time) when the prescription was written
public MedicationOrder setDateWritten(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The date (and perhaps time) when the prescription was written
public MedicationOrder setDateWrittenWithSecondsPrecision(Date theDate)
Definition: The date (and perhaps time) when the prescription was written
public BoundCodeDt<MedicationOrderStatusEnum> getStatusElement()
null.
Definition: A code specifying the state of the order. Generally this will be active or completed state
public String getStatus()
null.
Definition: A code specifying the state of the order. Generally this will be active or completed state
public MedicationOrder setStatus(BoundCodeDt<MedicationOrderStatusEnum> theValue)
Definition: A code specifying the state of the order. Generally this will be active or completed state
public MedicationOrder setStatus(MedicationOrderStatusEnum theValue)
Definition: A code specifying the state of the order. Generally this will be active or completed state
public DateTimeDt getDateEndedElement()
null.
Definition: The date (and perhaps time) when the prescription was stopped
public Date getDateEnded()
null.
Definition: The date (and perhaps time) when the prescription was stopped
public MedicationOrder setDateEnded(DateTimeDt theValue)
Definition: The date (and perhaps time) when the prescription was stopped
public MedicationOrder setDateEnded(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The date (and perhaps time) when the prescription was stopped
public MedicationOrder setDateEndedWithSecondsPrecision(Date theDate)
Definition: The date (and perhaps time) when the prescription was stopped
public CodeableConceptDt getReasonEnded()
null.
Definition: The reason why the prescription was stopped, if it was
public MedicationOrder setReasonEnded(CodeableConceptDt theValue)
Definition: The reason why the prescription was stopped, if it was
public ResourceReferenceDt getPatient()
null.
Definition: A link to a resource representing the person to whom the medication will be given.
public MedicationOrder setPatient(ResourceReferenceDt theValue)
Definition: A link to a resource representing the person to whom the medication will be given.
public ResourceReferenceDt getPrescriber()
null.
Definition: The healthcare professional responsible for authorizing the prescription
public MedicationOrder setPrescriber(ResourceReferenceDt theValue)
Definition: The healthcare professional responsible for authorizing the prescription
public ResourceReferenceDt getEncounter()
null.
Definition: A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
public MedicationOrder setEncounter(ResourceReferenceDt theValue)
Definition: A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
public IDatatype getReason()
null.
Definition: Can be the reason or the indication for writing the prescription.
public MedicationOrder setReason(IDatatype theValue)
Definition: Can be the reason or the indication for writing the prescription.
public StringDt getNoteElement()
null.
Definition: Extra information about the prescription that could not be conveyed by the other attributes.
public String getNote()
null.
Definition: Extra information about the prescription that could not be conveyed by the other attributes.
public MedicationOrder setNote(StringDt theValue)
Definition: Extra information about the prescription that could not be conveyed by the other attributes.
public MedicationOrder setNote(String theString)
Definition: Extra information about the prescription that could not be conveyed by the other attributes.
public IDatatype getMedication()
null.
Definition: 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.
public MedicationOrder setMedication(IDatatype theValue)
Definition: 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.
public List<MedicationOrder.DosageInstruction> getDosageInstruction()
null.
Definition: Indicates how the medication is to be used by the patient
public MedicationOrder setDosageInstruction(List<MedicationOrder.DosageInstruction> theValue)
Definition: Indicates how the medication is to be used by the patient
public MedicationOrder.DosageInstruction addDosageInstruction()
Definition: Indicates how the medication is to be used by the patient
public MedicationOrder addDosageInstruction(MedicationOrder.DosageInstruction theValue)
Definition: Indicates how the medication is to be used by the patient
theValue - The dosageInstruction to add (must not be null)public MedicationOrder.DosageInstruction getDosageInstructionFirstRep()
Definition: Indicates how the medication is to be used by the patient
public MedicationOrder.DispenseRequest getDispenseRequest()
null.
Definition: 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.
public MedicationOrder setDispenseRequest(MedicationOrder.DispenseRequest theValue)
Definition: 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.
public MedicationOrder.Substitution getSubstitution()
null.
Definition: 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.
public MedicationOrder setSubstitution(MedicationOrder.Substitution theValue)
Definition: 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.
public ResourceReferenceDt getPriorPrescription()
null.
Definition: A link to a resource representing an earlier order or prescription that this order supersedes
public MedicationOrder setPriorPrescription(ResourceReferenceDt theValue)
Definition: A link to a resource representing an earlier order or prescription that this order supersedes
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.