HS.FHIRModel.R4.MedicationRequest
class HS.FHIRModel.R4.MedicationRequest extends HS.FHIRModel.FHIRClassSuper
******************************************* MedicationRequest generated class schema
*****************************************
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
Property Inventory
- _authoredOn
- _doNotPerform
- _implicitRules
- _instantiatesCanonical
- _instantiatesUri
- _intent
- _language
- _priority
- _reportedBoolean
- _status
- authoredOn
- basedOn
- category
- contained
- courseOfTherapyType
- detectedIssue
- dispenseRequest
- doNotPerform
- dosageInstruction
- encounter
- eventHistory
- extension
- fhirID
- groupIdentifier
- identifier
- implicitRules
- instantiatesCanonical
- instantiatesUri
- insurance
- intent
- language
- medicationCodeableConcept
- medicationReference
- meta
- modifierExtension
- note
- performer
- performerType
- priorPrescription
- priority
- reasonCode
- reasonReference
- recorder
- reportedBoolean
- reportedReference
- requester
- resourceType
- status
- statusReason
- subject
- substitution
- supportingInformation
- text
Method Inventory
- IncludeBasedOn()
- IncludeCategory()
- IncludeContained()
- IncludeCourseOfTherapyType()
- IncludeDetectedIssue()
- IncludeDispenseRequest()
- IncludeDosageInstruction()
- IncludeEncounter()
- IncludeEventHistory()
- IncludeExtension()
- IncludeGroupIdentifier()
- IncludeIdentifier()
- IncludeInstantiatesCanonical()
- IncludeInstantiatesUri()
- IncludeInsurance()
- IncludeMedicationCodeableConcept()
- IncludeMedicationReference()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeNote()
- IncludePerformer()
- IncludePerformerType()
- IncludePriorPrescription()
- IncludeReasonCode()
- IncludeReasonReference()
- IncludeRecorder()
- IncludeReportedReference()
- IncludeRequester()
- IncludeStatusReason()
- IncludeSubject()
- IncludeSubstitution()
- IncludeSupportingInformation()
- IncludeText()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_MEDICATIONREQUEST;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is
empty then the class name will be used to construct a default XML type.
The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.
Properties
property _authoredOn as HS.FHIRModel.R4.Element;
Extensions for authoredOn
Property methods: _authoredOnGet(), _authoredOnGetSwizzled(), _authoredOnIsValid(), _authoredOnNewObject(), _authoredOnSet()
property _doNotPerform as HS.FHIRModel.R4.Element;
Extensions for doNotPerform
Property methods: _doNotPerformGet(), _doNotPerformGetSwizzled(), _doNotPerformIsValid(), _doNotPerformNewObject(), _doNotPerformSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiatesCanonical as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiatesCanonical
Property methods: _instantiatesCanonicalGet(), _instantiatesCanonicalGetSwizzled(), _instantiatesCanonicalIsValid(), _instantiatesCanonicalNewObject(), _instantiatesCanonicalSet()
property _instantiatesUri as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _intent as HS.FHIRModel.R4.Element;
Extensions for intent
Property methods: _intentGet(), _intentGetSwizzled(), _intentIsValid(), _intentNewObject(), _intentSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _priority as HS.FHIRModel.R4.Element;
Extensions for priority
Property methods: _priorityGet(), _priorityGetSwizzled(), _priorityIsValid(), _priorityNewObject(), _prioritySet()
property _reportedBoolean as HS.FHIRModel.R4.Element;
Extensions for reportedBoolean
Property methods: _reportedBooleanGet(), _reportedBooleanGetSwizzled(), _reportedBooleanIsValid(), _reportedBooleanNewObject(), _reportedBooleanSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property authoredOn as %String;
The date (and perhaps time) when the prescription was initially written
or authored on.
Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
A plan or request that is fulfilled in whole or in part by this medication
request.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
Indicates the type of medication request (for example, where the
medication is expected to be consumed or administered (i.e. inpatient
or outpatient)).
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property courseOfTherapyType as HS.FHIRModel.R4.CodeableConcept;
The description of the overall patte3rn of the administration of
the medication to the patient.
Property methods: courseOfTherapyTypeGet(), courseOfTherapyTypeGetSwizzled(), courseOfTherapyTypeIsValid(), courseOfTherapyTypeNewObject(), courseOfTherapyTypeSet()
property detectedIssue as HS.FHIRModel.R4.SeqOfReference;
Indicates an actual or potential clinical issue with or between one
or more active or proposed clinical actions for a patient; e.g.
Drug-drug interaction, duplicate therapy, dosage alert etc.
Property methods: detectedIssueGet(), detectedIssueGetSwizzled(), detectedIssueIsValid(), detectedIssueNewObject(), detectedIssueSet()
property dispenseRequest as HS.FHIRModel.R4.MedicationRequestX.DispenseRequest;
Indicates the specific details for the dispense or medication supply
part of a medication request (also known as a Medication Prescription
or Medication Order). 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.
Property methods: dispenseRequestGet(), dispenseRequestGetSwizzled(), dispenseRequestIsValid(), dispenseRequestNewObject(), dispenseRequestSet()
property doNotPerform as %Boolean;
If true indicates that the provider is asking for the medication
request not to occur.
Property methods: doNotPerformDisplayToLogical(), doNotPerformGet(), doNotPerformIsValid(), doNotPerformLogicalToDisplay(), doNotPerformLogicalToXSD(), doNotPerformNormalize(), doNotPerformSet(), doNotPerformXSDToLogical()
property dosageInstruction as HS.FHIRModel.R4.SeqOfDosage;
Indicates how the medication is to be used by the patient.
Property methods: dosageInstructionGet(), dosageInstructionGetSwizzled(), dosageInstructionIsValid(), dosageInstructionNewObject(), dosageInstructionSet()
property encounter as HS.FHIRModel.R4.Reference;
The Encounter during which this [x] was created or to which the creation
of this record is tightly associated.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property eventHistory as HS.FHIRModel.R4.SeqOfReference;
Links to Provenance records for past versions of this resource or
fulfilling request or event resources that identify key state transitions
or updates that are likely to be relevant to a user looking at the
current version of the resource.
Property methods: eventHistoryGet(), eventHistoryGetSwizzled(), eventHistoryIsValid(), eventHistoryNewObject(), eventHistorySet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property groupIdentifier as HS.FHIRModel.R4.Identifier;
A shared identifier common to all requests that were authorized more
or less simultaneously by a single author, representing the identifier
of the requisition or prescription.
Property methods: groupIdentifierGet(), groupIdentifierGetSwizzled(), groupIdentifierIsValid(), groupIdentifierNewObject(), groupIdentifierSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifiers associated with this medication request that are defined
by business processes and/or used to refer to it when a direct URL
reference to the resource itself is not appropriate. They are business
identifiers assigned to this resource by the performer or other
systems and remain constant as the resource is updated and propagates
from server to server.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property instantiatesCanonical as HS.FHIRModel.R4.SeqOfString;
The URL pointing to a protocol, guideline, orderset, or other definition
that is adhered to in whole or in part by this MedicationRequest.
Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as HS.FHIRModel.R4.SeqOfString;
The URL pointing to an externally maintained protocol, guideline,
orderset or other definition that is adhered to in whole or in part
by this MedicationRequest.
Property methods: instantiatesUriGet(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriNewObject(), instantiatesUriSet()
property insurance as HS.FHIRModel.R4.SeqOfReference;
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations
that may be required for delivering the requested service.
Property methods: insuranceGet(), insuranceGetSwizzled(), insuranceIsValid(), insuranceNewObject(), insuranceSet()
property intent as %String;
Whether the request is a proposal, plan, or an original order.
Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property medicationCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
Identifies the medication being requested. 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.
Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()
property medicationReference as HS.FHIRModel.R4.Reference;
Identifies the medication being requested. 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.
Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it and/or the understanding of the
containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define
an extension, there is a set of requirements that SHALL be met as
part of the definition of the extension. Applications processing
a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property note as HS.FHIRModel.R4.SeqOfAnnotation;
Extra information about the prescription that could not be conveyed
by the other attributes.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property performer as HS.FHIRModel.R4.Reference;
The specified desired performer of the medication treatment (e.g.
the performer of the medication administration).
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property performerType as HS.FHIRModel.R4.CodeableConcept;
Indicates the type of performer of the administration of the medication.
Property methods: performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property priorPrescription as HS.FHIRModel.R4.Reference;
A link to a resource representing an earlier order related order
or prescription.
Property methods: priorPrescriptionGet(), priorPrescriptionGetSwizzled(), priorPrescriptionIsValid(), priorPrescriptionNewObject(), priorPrescriptionSet()
property priority as %String;
Indicates how quickly the Medication Request should be addressed
with respect to other requests.
Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
The reason or the indication for ordering or not ordering the medication.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Condition or observation that supports why the medication was ordered.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property recorder as HS.FHIRModel.R4.Reference;
The person who entered the order on behalf of another individual
for example in the case of a verbal or a telephone order.
Property methods: recorderGet(), recorderGetSwizzled(), recorderIsValid(), recorderNewObject(), recorderSet()
property reportedBoolean as %Boolean;
Indicates if this record was captured as a secondary 'reported' record
rather than as an original primary source-of-truth record. It may
also indicate the source of the report.
Property methods: reportedBooleanDisplayToLogical(), reportedBooleanGet(), reportedBooleanIsValid(), reportedBooleanLogicalToDisplay(), reportedBooleanLogicalToXSD(), reportedBooleanNormalize(), reportedBooleanSet(), reportedBooleanXSDToLogical()
property reportedReference as HS.FHIRModel.R4.Reference;
Indicates if this record was captured as a secondary 'reported' record
rather than as an original primary source-of-truth record. It may
also indicate the source of the report.
Property methods: reportedReferenceGet(), reportedReferenceGetSwizzled(), reportedReferenceIsValid(), reportedReferenceNewObject(), reportedReferenceSet()
property requester as HS.FHIRModel.R4.Reference;
The individual, organization, or device that initiated the request
and has responsibility for its activation.
Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property resourceType as %String [ InitialExpression = "MedicationRequest" , Required ];
This is a MedicationRequest resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String;
A code specifying the current state of the order. Generally, this
will be active or completed state.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReason as HS.FHIRModel.R4.CodeableConcept;
Captures the reason for the current state of the MedicationRequest.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIRModel.R4.Reference [ Required ];
A link to a resource representing the person or set of individuals
to whom the medication will be given.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property substitution as HS.FHIRModel.R4.MedicationRequestX.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. This block explains the prescriber's
intent. If nothing is specified substitution may be done.
Property methods: substitutionGet(), substitutionGetSwizzled(), substitutionIsValid(), substitutionNewObject(), substitutionSet()
property supportingInformation as HS.FHIRModel.R4.SeqOfReference;
Include additional information (for example, patient height and weight)
that supports the ordering of the medication.
Property methods: supportingInformationGet(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationNewObject(), supportingInformationSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
Methods
method IncludeBasedOn()
method IncludeCategory()
method IncludeContained()
method IncludeCourseOfTherapyType()
method IncludeDetectedIssue()
method IncludeDispenseRequest()
method IncludeDosageInstruction()
method IncludeEncounter()
method IncludeEventHistory()
method IncludeExtension()
method IncludeGroupIdentifier()
method IncludeIdentifier()
method IncludeInstantiatesCanonical()
method IncludeInstantiatesUri()
method IncludeInsurance()
method IncludeMedicationCodeableConcept()
method IncludeMedicationReference()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludePerformer()
method IncludePerformerType()
method IncludePriorPrescription()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRecorder()
method IncludeReportedReference()
method IncludeRequester()
method IncludeStatusReason()
method IncludeSubject()
method IncludeSubstitution()
method IncludeSupportingInformation()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.MedicationRequest
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()