public class MedicationOrder extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
MedicationOrder.MedicationOrderDispenseRequestComponent |
static class |
MedicationOrder.MedicationOrderDosageInstructionComponent |
static class |
MedicationOrder.MedicationOrderStatus |
static class |
MedicationOrder.MedicationOrderStatusEnumFactory |
static class |
MedicationOrder.MedicationOrderSubstitutionComponent |
| Modifier and Type | Field and Description |
|---|---|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CODE
Fluent Client search parameter constant for code
|
protected DateTimeType |
dateEnded
The date (and perhaps time) when the prescription was stopped.
|
protected DateTimeType |
dateWritten
The date (and perhaps time) when the prescription was written.
|
static ca.uhn.fhir.rest.gclient.DateClientParam |
DATEWRITTEN
Fluent Client search parameter constant for datewritten
|
protected MedicationOrder.MedicationOrderDispenseRequestComponent |
dispenseRequest
Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription).
|
protected List<MedicationOrder.MedicationOrderDosageInstructionComponent> |
dosageInstruction
Indicates how the medication is to be used by the patient.
|
protected Reference |
encounter
A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
ENCOUNTER
Fluent Client search parameter constant for encounter
|
protected Encounter |
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.)
|
protected List<Identifier> |
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.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_MEDICATION
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_PRESCRIBER
Constant for fluent queries to be used to add include statements.
|
protected Type |
medication
Identifies the medication being administered.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
MEDICATION
Fluent Client search parameter constant for medication
|
protected List<Annotation> |
note
Extra information about the prescription that could not be conveyed by the other attributes.
|
protected Reference |
patient
A link to a resource representing the person to whom the medication will be given.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
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 Reference |
prescriber
The healthcare professional responsible for authorizing the prescription.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
PRESCRIBER
Fluent Client search parameter constant for prescriber
|
protected Practitioner |
prescriberTarget
The actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.)
|
protected Reference |
priorPrescription
A link to a resource representing an earlier order or prescription that this order supersedes.
|
protected MedicationOrder |
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.)
|
protected List<CodeableConcept> |
reasonCode
Can be the reason or the indication for writing the prescription.
|
protected CodeableConcept |
reasonEnded
The reason why the prescription was stopped, if it was.
|
protected List<Reference> |
reasonReference
Condition that supports why the prescription is being written.
|
protected List<Condition> |
reasonReferenceTarget
The actual objects that are the target of the reference (Condition that supports why the prescription is being written.)
|
static String |
SP_CODE
Search parameter: code
|
static String |
SP_DATEWRITTEN
Search parameter: datewritten
|
static String |
SP_ENCOUNTER
Search parameter: encounter
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
static String |
SP_MEDICATION
Search parameter: medication
|
static String |
SP_PATIENT
Search parameter: patient
|
static String |
SP_PRESCRIBER
Search parameter: prescriber
|
static String |
SP_STATUS
Search parameter: status
|
protected Enumeration<MedicationOrder.MedicationOrderStatus> |
status
A code specifying the state of the order.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
protected MedicationOrder.MedicationOrderSubstitutionComponent |
substitution
Indicates whether or not substitution can or should be part of the dispense.
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
MedicationOrder()
Constructor
|
MedicationOrder(Type medication)
Constructor
|
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setTextcopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, setIdcastToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected List<Identifier> identifier
protected Enumeration<MedicationOrder.MedicationOrderStatus> status
protected Type medication
protected Reference patient
protected Patient patientTarget
protected Reference encounter
protected Encounter encounterTarget
protected DateTimeType dateWritten
protected Reference prescriber
protected Practitioner prescriberTarget
protected List<CodeableConcept> reasonCode
protected List<Reference> reasonReference
protected List<Condition> reasonReferenceTarget
protected DateTimeType dateEnded
protected CodeableConcept reasonEnded
protected List<Annotation> note
protected List<MedicationOrder.MedicationOrderDosageInstructionComponent> dosageInstruction
protected MedicationOrder.MedicationOrderDispenseRequestComponent dispenseRequest
protected MedicationOrder.MedicationOrderSubstitutionComponent substitution
protected Reference priorPrescription
protected MedicationOrder priorPrescriptionTarget
public static final String SP_MEDICATION
Description: Return administrations of this medication reference
Type: reference
Path: MedicationOrder.medicationReference
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MEDICATION
Description: Return administrations of this medication reference
Type: reference
Path: MedicationOrder.medicationReference
public static final ca.uhn.fhir.model.api.Include INCLUDE_MEDICATION
public static final String SP_DATEWRITTEN
Description: Return prescriptions written on this date
Type: date
Path: MedicationOrder.dateWritten
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATEWRITTEN
Description: Return prescriptions written on this date
Type: date
Path: MedicationOrder.dateWritten
public static final String SP_PATIENT
Description: The identity of a patient to list orders for
Type: reference
Path: MedicationOrder.patient
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Description: The identity of a patient to list orders for
Type: reference
Path: MedicationOrder.patient
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
public static final String SP_STATUS
Description: Status of the prescription
Type: token
Path: MedicationOrder.status
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Description: Status of the prescription
Type: token
Path: MedicationOrder.status
public static final String SP_PRESCRIBER
Description: Who ordered the medication(s)
Type: reference
Path: MedicationOrder.prescriber
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRESCRIBER
Description: Who ordered the medication(s)
Type: reference
Path: MedicationOrder.prescriber
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRESCRIBER
public static final String SP_CODE
Description: Return administrations of this medication code
Type: token
Path: MedicationOrder.medicationCodeableConcept
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Description: Return administrations of this medication code
Type: token
Path: MedicationOrder.medicationCodeableConcept
public static final String SP_ENCOUNTER
Description: Return prescriptions with this encounter identifier
Type: reference
Path: MedicationOrder.encounter
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
Description: Return prescriptions with this encounter identifier
Type: reference
Path: MedicationOrder.encounter
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
public static final String SP_IDENTIFIER
Description: Return prescriptions with this external identifier
Type: token
Path: MedicationOrder.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: Return prescriptions with this external identifier
Type: token
Path: MedicationOrder.identifier
public MedicationOrder()
public MedicationOrder(Type medication)
public List<Identifier> getIdentifier()
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.)public boolean hasIdentifier()
public Identifier addIdentifier()
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.)public MedicationOrder addIdentifier(Identifier t)
public Enumeration<MedicationOrder.MedicationOrderStatus> getStatusElement()
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 valuepublic boolean hasStatusElement()
public boolean hasStatus()
public MedicationOrder setStatusElement(Enumeration<MedicationOrder.MedicationOrderStatus> value)
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 valuepublic MedicationOrder.MedicationOrderStatus getStatus()
public MedicationOrder setStatus(MedicationOrder.MedicationOrderStatus value)
value - A code specifying the state of the order. Generally this will be active or completed state.public Type getMedication()
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.)public CodeableConcept getMedicationCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMedicationCodeableConcept()
public Reference getMedicationReference() throws org.hl7.fhir.exceptions.FHIRException
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.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasMedicationReference()
public boolean hasMedication()
public MedicationOrder setMedication(Type value)
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.)public Reference getPatient()
patient (A link to a resource representing the person to whom the medication will be given.)public boolean hasPatient()
public MedicationOrder 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 MedicationOrder 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 getEncounter()
encounter (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)public boolean hasEncounter()
public MedicationOrder setEncounter(Reference value)
value - encounter (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)public Encounter getEncounterTarget()
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.)public MedicationOrder setEncounterTarget(Encounter value)
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.)public DateTimeType getDateWrittenElement()
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 valuepublic boolean hasDateWrittenElement()
public boolean hasDateWritten()
public MedicationOrder setDateWrittenElement(DateTimeType value)
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 valuepublic Date getDateWritten()
public MedicationOrder setDateWritten(Date value)
value - The date (and perhaps time) when the prescription was written.public Reference getPrescriber()
prescriber (The healthcare professional responsible for authorizing the prescription.)public boolean hasPrescriber()
public MedicationOrder setPrescriber(Reference value)
value - prescriber (The healthcare professional responsible for authorizing the prescription.)public Practitioner getPrescriberTarget()
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.)public MedicationOrder setPrescriberTarget(Practitioner value)
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.)public List<CodeableConcept> getReasonCode()
reasonCode (Can be the reason or the indication for writing the prescription.)public boolean hasReasonCode()
public CodeableConcept addReasonCode()
reasonCode (Can be the reason or the indication for writing the prescription.)public MedicationOrder addReasonCode(CodeableConcept t)
public List<Reference> getReasonReference()
reasonReference (Condition that supports why the prescription is being written.)public boolean hasReasonReference()
public Reference addReasonReference()
reasonReference (Condition that supports why the prescription is being written.)public MedicationOrder addReasonReference(Reference t)
public List<Condition> getReasonReferenceTarget()
reasonReference (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. Condition that supports why the prescription is being written.)public Condition addReasonReferenceTarget()
reasonReference (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. Condition that supports why the prescription is being written.)public DateTimeType getDateEndedElement()
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 valuepublic boolean hasDateEndedElement()
public boolean hasDateEnded()
public MedicationOrder setDateEndedElement(DateTimeType value)
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 valuepublic Date getDateEnded()
public MedicationOrder setDateEnded(Date value)
value - The date (and perhaps time) when the prescription was stopped.public CodeableConcept getReasonEnded()
reasonEnded (The reason why the prescription was stopped, if it was.)public boolean hasReasonEnded()
public MedicationOrder setReasonEnded(CodeableConcept value)
value - reasonEnded (The reason why the prescription was stopped, if it was.)public List<Annotation> getNote()
note (Extra information about the prescription that could not be conveyed by the other attributes.)public boolean hasNote()
public Annotation addNote()
note (Extra information about the prescription that could not be conveyed by the other attributes.)public MedicationOrder addNote(Annotation t)
public List<MedicationOrder.MedicationOrderDosageInstructionComponent> getDosageInstruction()
dosageInstruction (Indicates how the medication is to be used by the patient.)public boolean hasDosageInstruction()
public MedicationOrder.MedicationOrderDosageInstructionComponent addDosageInstruction()
dosageInstruction (Indicates how the medication is to be used by the patient.)public MedicationOrder addDosageInstruction(MedicationOrder.MedicationOrderDosageInstructionComponent t)
public MedicationOrder.MedicationOrderDispenseRequestComponent getDispenseRequest()
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.)public boolean hasDispenseRequest()
public MedicationOrder setDispenseRequest(MedicationOrder.MedicationOrderDispenseRequestComponent value)
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.)public MedicationOrder.MedicationOrderSubstitutionComponent getSubstitution()
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.)public boolean hasSubstitution()
public MedicationOrder setSubstitution(MedicationOrder.MedicationOrderSubstitutionComponent value)
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.)public Reference getPriorPrescription()
priorPrescription (A link to a resource representing an earlier order or prescription that this order supersedes.)public boolean hasPriorPrescription()
public MedicationOrder setPriorPrescription(Reference value)
value - priorPrescription (A link to a resource representing an earlier order or prescription that this order supersedes.)public MedicationOrder getPriorPrescriptionTarget()
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.)public MedicationOrder setPriorPrescriptionTarget(MedicationOrder value)
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.)protected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty 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 MedicationOrder copy()
copy in class DomainResourceprotected MedicationOrder 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.