Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.MedicationRequest

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

Ordering of medication for patient or group.

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.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

What request fulfills.

CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property category as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of medication usage.

any FHIR4 code may be used; medicationrequest-category shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property courseOfTherapyType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "courseOfTherapyType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Overall pattern of medication administration.

any FHIR4 code may be used; medicationrequest-course-of-therapy shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: courseOfTherapyTypeGet(), courseOfTherapyTypeGetSwizzled(), courseOfTherapyTypeIsValid(), courseOfTherapyTypeNewObject(), courseOfTherapyTypeSet()
property detectedIssue as list of HS.FHIR.DTL.vR4.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.vR4.Model.Element.MedicationRequest.dispenseRequest (XMLNAME = "dispenseRequest", XMLPROJECTION = "ELEMENT");
BackboneElement

Medication supply authorization.

Property methods: dispenseRequestGet(), dispenseRequestGetSwizzled(), dispenseRequestIsValid(), dispenseRequestNewObject(), dispenseRequestSet()
property doNotPerform as %Boolean (XMLNAME = "doNotPerform", XMLPROJECTION = "ATTRIBUTE");
boolean

True if request is prohibiting action.

Property methods: doNotPerformDisplayToLogical(), doNotPerformGet(), doNotPerformIsValid(), doNotPerformLogicalToDisplay(), doNotPerformLogicalToXSD(), doNotPerformNormalize(), doNotPerformSet(), doNotPerformXSDToLogical()
property dosageInstruction as list of HS.FHIR.DTL.vR4.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 encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Encounter created as part of encounter/admission/stay.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property eventHistory as list of HS.FHIR.DTL.vR4.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.vR4.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.vR4.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 instantiatesCanonical as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesCanonical", XMLPROJECTION = "ELEMENT");
canonical

Instantiates FHIR protocol or definition.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: instantiatesCanonicalBuildValueArray(), instantiatesCanonicalCollectionToDisplay(), instantiatesCanonicalCollectionToOdbc(), instantiatesCanonicalDisplayToCollection(), instantiatesCanonicalDisplayToLogical(), instantiatesCanonicalGet(), instantiatesCanonicalGetObject(), instantiatesCanonicalGetObjectId(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalLogicalToDisplay(), instantiatesCanonicalLogicalToOdbc(), instantiatesCanonicalNormalize(), instantiatesCanonicalOdbcToCollection(), instantiatesCanonicalSet(), instantiatesCanonicalSetObject(), instantiatesCanonicalSetObjectId()
property instantiatesUri as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesUri", XMLPROJECTION = "ELEMENT");
uri

Instantiates external protocol or definition.

Property methods: instantiatesUriBuildValueArray(), instantiatesUriCollectionToDisplay(), instantiatesUriCollectionToOdbc(), instantiatesUriDisplayToCollection(), instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriGetObject(), instantiatesUriGetObjectId(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriOdbcToCollection(), instantiatesUriSet(), instantiatesUriSetObject(), instantiatesUriSetObjectId()
property insurance as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT");
Reference

Associated insurance coverage.

Coverage | ClaimResponse

Property methods: insuranceBuildValueArray(), insuranceCollectionToDisplay(), insuranceCollectionToOdbc(), insuranceDisplayToCollection(), insuranceGet(), insuranceGetObject(), insuranceGetObjectId(), insuranceGetSwizzled(), insuranceIsValid(), insuranceOdbcToCollection(), insuranceSet(), insuranceSetObject(), insuranceSetObjectId()
property intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option

medicationrequest-intent|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend medicationrequest-intent|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property medicationCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "medicationCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Medication to be taken.

any FHIR4 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.vR4.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.vR4.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 performer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Reference

Intended performer of administration.

Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam

Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet(), performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property performerType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "performerType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Desired kind of performer of the medication administration.

any FHIR4 code may be used; performer-role shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property priorPrescription as HS.FHIR.DTL.vR4.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 | asap | stat

request-priority|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend request-priority|4.0.1 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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason or indication for ordering or not ordering the medication.

any FHIR4 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.vR4.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.vR4.Model.Base.Reference (XMLNAME = "recorder", XMLPROJECTION = "ELEMENT");
Reference

Person who entered the request.

Practitioner | PractitionerRole

Property methods: recorderGet(), recorderGetSwizzled(), recorderIsValid(), recorderNewObject(), recorderSet()
property reportedBoolean as %Boolean (XMLNAME = "reportedBoolean", XMLPROJECTION = "ATTRIBUTE");
boolean

Reported rather than primary record.

Property methods: reportedBooleanDisplayToLogical(), reportedBooleanGet(), reportedBooleanIsValid(), reportedBooleanLogicalToDisplay(), reportedBooleanLogicalToXSD(), reportedBooleanNormalize(), reportedBooleanSet(), reportedBooleanXSDToLogical()
property reportedReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reportedReference", XMLPROJECTION = "ELEMENT");
Reference

Reported rather than primary record.

Patient | Practitioner | PractitionerRole | RelatedPerson | Organization

Property methods: reportedReferenceGet(), reportedReferenceGetSwizzled(), reportedReferenceIsValid(), reportedReferenceNewObject(), reportedReferenceSet()
property requester as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
Reference

Who/What requested the Request.

Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device

Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown

medicationrequest-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend medicationrequest-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet(), statusSet()
property statusReason as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for current status.

any FHIR4 code may be used; medicationrequest-status-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIR.DTL.vR4.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.vR4.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.vR4.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Reference

Information to support ordering of the medication.

Any FHIR4 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

FeedbackOpens in a new tab