Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (5)
Properties (25)
Inherited Members

Show private members

HS.FHIR.DTL.vSTU3.Model.Resource.MedicationRequest

class HS.FHIR.DTL.vSTU3.Model.Resource.MedicationRequest extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

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

Parameters

parameter ELEMENTQUALIFIED = 1;

Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = MedicationRequest;

Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

parameter XMLPROJECTION = ELEMENT;

parameter XMLSEQUENCE = 1;

Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

parameter XMLTYPE = 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 %String (MAXLEN = 1000000, XMLNAME = "authoredOn", XMLPROJECTION = "ATTRIBUTE");

dateTime

When request was initially authored.

Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()

property basedOn as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");

Reference

What request fulfills.

CarePlan | MedicationRequest | ProcedureRequest | ReferralRequest

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()

property category as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");

CodeableConcept

Type of medication usage.

medication-request-category is the PREFERRED FHIR3 ValueSet for codes, but if you need to express meanings not found in medication-request-category, you may use codes from any ValueSet.

Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()

property context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");

Reference

Created during encounter/admission/stay.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()

property definition as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");

Reference

Protocol or definition.

ActivityDefinition | PlanDefinition

Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()

property detectedIssue as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "detectedIssue", XMLPROJECTION = "ELEMENT");

Reference

Clinical Issue with action.

DetectedIssue

Property methods: detectedIssueBuildValueArray(), detectedIssueCollectionToDisplay(), detectedIssueCollectionToOdbc(), detectedIssueDisplayToCollection(), detectedIssueGet(), detectedIssueGetObject(), detectedIssueGetObjectId(), detectedIssueGetSwizzled(), detectedIssueIsValid(), detectedIssueOdbcToCollection(), detectedIssueSet(), detectedIssueSetObject(), detectedIssueSetObjectId()

property dispenseRequest as HS.FHIR.DTL.vSTU3.Model.Element.MedicationRequest.dispenseRequest (XMLNAME = "dispenseRequest", XMLPROJECTION = "ELEMENT");

BackboneElement

Medication supply authorization.

Property methods: dispenseRequestGet(), dispenseRequestGetSwizzled(), dispenseRequestIsValid(), dispenseRequestNewObject(), dispenseRequestSet()

property dosageInstruction as list of HS.FHIR.DTL.vSTU3.Model.Element.Dosage (XMLNAME = "dosageInstruction", XMLPROJECTION = "ELEMENT");

Dosage

How the medication should be taken.

Property methods: dosageInstructionBuildValueArray(), dosageInstructionCollectionToDisplay(), dosageInstructionCollectionToOdbc(), dosageInstructionDisplayToCollection(), dosageInstructionGet(), dosageInstructionGetObject(), dosageInstructionGetObjectId(), dosageInstructionGetSwizzled(), dosageInstructionIsValid(), dosageInstructionOdbcToCollection(), dosageInstructionSet(), dosageInstructionSetObject(), dosageInstructionSetObjectId()

property eventHistory as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "eventHistory", XMLPROJECTION = "ELEMENT");

Reference

A list of events of interest in the lifecycle.

Provenance

Property methods: eventHistoryBuildValueArray(), eventHistoryCollectionToDisplay(), eventHistoryCollectionToOdbc(), eventHistoryDisplayToCollection(), eventHistoryGet(), eventHistoryGetObject(), eventHistoryGetObjectId(), eventHistoryGetSwizzled(), eventHistoryIsValid(), eventHistoryOdbcToCollection(), eventHistorySet(), eventHistorySetObject(), eventHistorySetObjectId()

property groupIdentifier as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "groupIdentifier", XMLPROJECTION = "ELEMENT");

Identifier

Composite request this is part of.

Property methods: groupIdentifierGet(), groupIdentifierGetSwizzled(), groupIdentifierIsValid(), groupIdentifierNewObject(), groupIdentifierSet()

property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifier

External ids for this request.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()

property intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE") [ Required ];

code

Whether the request is a proposal, plan, or an original order.

medication-request-intent is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend medication-request-intent and you may NOT use codes from other ValueSets.

Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()

property medicationCodeableConcept as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "medicationCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];

CodeableConcept

Medication to be taken.

any FHIR3 code may be used; medication-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()

property medicationReference as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "medicationReference", XMLPROJECTION = "ELEMENT") [ Required ];

Reference

Medication to be taken.

Medication.

Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()

property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Annotation

Information about the prescription.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()

property priorPrescription as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "priorPrescription", XMLPROJECTION = "ELEMENT");

Reference

An order/prescription that is being replaced.

MedicationRequest

Property methods: priorPrescriptionGet(), priorPrescriptionGetSwizzled(), priorPrescriptionIsValid(), priorPrescriptionNewObject(), priorPrescriptionSet()

property priority as %String (MAXLEN = 1000000, XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");

code

routine | urgent | stat | asap

medication-request-priority is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend medication-request-priority and you may NOT use codes from other ValueSets.

Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()

property reasonCode as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");

CodeableConcept

Reason or indication for writing the prescription.

any FHIR3 code may be used; condition-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()

property reasonReference as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");

Reference

Condition or Observation that supports why the prescription is being written.

Condition | Observation

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()

property recorder as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "recorder", XMLPROJECTION = "ELEMENT");

Reference

Person who entered the request.

Practitioner

Property methods: recorderGet(), recorderGetSwizzled(), recorderIsValid(), recorderNewObject(), recorderSet()

property requester as HS.FHIR.DTL.vSTU3.Model.Element.MedicationRequest.requester (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");

BackboneElement

Who/What requested the Request.

Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()

property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE");

code

medication-request-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend medication-request-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()

property subject as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];

Reference

Who or group medication request is for.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

property substitution as HS.FHIR.DTL.vSTU3.Model.Element.MedicationRequest.substitution (XMLNAME = "substitution", XMLPROJECTION = "ELEMENT");

BackboneElement

Any restrictions on medication substitution.

Property methods: substitutionGet(), substitutionGetSwizzled(), substitutionIsValid(), substitutionNewObject(), substitutionSet()

property supportingInformation as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");

Reference

Information to support ordering of the medication.

Any FHIR3 Resource may be indicated by this Reference

Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

Feedback