STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

F.24.1.4 StructureDefinition: QICore-MedicationOrder - Detailed Descriptions

Definitions for the qicore-medicationorder Profile.

MedicationOrder(QICore-MedicationOrder)
Definition

Profile of medication prescription, indicating which elements must be supported in rule and measure interpreters.

Control0..*
TypeMedicationOrder
Alternate NamesPrescription
MedicationOrder.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

MedicationOrder.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
MedicationOrder.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

MedicationOrder.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

MedicationOrder.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

MedicationOrder.contained
Definition

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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

MedicationOrder.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationOrder.modifierExtension
Definition

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. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationOrder.identifier
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.

Control0..*
TypeIdentifier
MedicationOrder.status
Definition

A code specifying the state of the order. Generally this will be active or completed state.

Control0..1
BindingA code specifying the state of the prescribing event. Describes the lifecycle of the prescription.
The codes SHALL be taken from MedicationOrderStatus
Typecode
Is Modifiertrue
Must Supporttrue
MedicationOrder.medication[x]
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.

Control1..1
BindingThe set of RxNorm codes to represent medications
The codes SHOULD be taken from Medication Clinical Drug (RxNorm)
TypeChoice of: CodeableConcept, Reference(QICore-Medication)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. Note: do not use Medication.name to describe the prescribed medication. When the only available information is a text description of the medication, Medication.code.text should be used.

MedicationOrder.patient
Definition

A link to a resource representing the person to whom the medication will be given.

Control0..1
TypeReference(QICore-Patient)
Must Supporttrue
Comments

SubstanceAdministration->subject->Patient.

MedicationOrder.encounter
Definition

A link to a resource that identifies the particular occurrence of contact between patient and health care provider.

Control0..1
TypeReference(QICore-Encounter)
Must Supporttrue
Comments

SubstanceAdministration->component->EncounterEvent.

MedicationOrder.dateWritten
Definition

The date (and perhaps time) when the prescription was written.

Control0..1
TypedateTime
Must Supporttrue
MedicationOrder.prescriber
Definition

The healthcare professional responsible for authorizing the prescription.

Control0..1
TypeReference(QICore-Practitioner)
MedicationOrder.reasonCode
Definition

Can be the reason or the indication for writing the prescription.

Control0..*
BindingThe reason code for the presecription
The codes SHOULD be taken from Problem Value Set
TypeCodeableConcept
Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference instead.

MedicationOrder.reasonReference
Definition

Condition that supports why the prescription is being written.

Control0..*
TypeReference(Condition)
MedicationOrder.dateEnded
Definition

The date (and perhaps time) when the prescription was stopped.

Control0..1
TypedateTime
MedicationOrder.reasonEnded
Definition

The reason why the prescription was stopped, if it was.

Control0..1
BindingCodes indicating why the medication was terminated; e.g. Adverse reaction, medication change, issue resolved, etc.
TypeCodeableConcept
MedicationOrder.note
Definition

Extra information about the prescription that could not be conveyed by the other attributes.

Control0..*
TypeAnnotation
MedicationOrder.dosageInstruction
Definition

Indicates how the medication is to be used by the patient.

Control0..*
TypeBackboneElement
Must Supporttrue
Comments

When the dose or rate is intended to change over the entire administration period, e.g. Tapering dose prescriptions, multiple instances of dosage instructions will need to be supplied to convey the different doses/rates. Another common example in institutional settings is 'titration' of an IV medication dose to maintain a specific stated hemodynamic value or range e.g. drug x to be administered to maintain AM (arterial mean) greater than 65.

MedicationOrder.dosageInstruction.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
MedicationOrder.dosageInstruction.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
MedicationOrder.dosageInstruction.extension (http://hl7.org/fhir/StructureDefinition/pharmacy-core-doseType)
Definition

The type of dose, e.g., initial, maintenance, loading.

Control0..1
TypeExtension (Extension Type: CodeableConcept)
MedicationOrder.dosageInstruction.extension (http://hl7.org/fhir/StructureDefinition/pharmacy-core-infuseOver)
Definition

For infused medications, the length of time the infusion process, as a duration. Note the difference between infuseOver and duration of treatment (specified in administrationFrequency). An order may call for infusing a patient TID for an hour each time over a duration of 5 days.

Control0..1
TypeExtension (Extension Type: Quantity(Duration))
MedicationOrder.dosageInstruction.extension (http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrement)
Definition

Change in the dosing rate applied each rateIncrementInterval, e.g., 20 mL/hour. The rate increment is usually an increase for a patient who is initiating tube feeding. The increase is continued until the maxDeliveryRate or rateGoal is reached.

Control0..1
TypeExtension (Extension Type: Ratio)
MedicationOrder.dosageInstruction.extension (http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateIncrementInterval)
Definition

Period of time after which the rate increment should be attempted, e.g., 4 hours.

Control0..1
TypeExtension (Extension Type: Quantity(Duration))
MedicationOrder.dosageInstruction.extension (http://hl7.org/fhir/StructureDefinition/pharmacy-core-rateGoal)
Definition

The target rate to reach for this infusion. Note that deliveryRateGoal is typically less than the maximum delivery rate which is the rate not to exceed. For enteral feeding orders, a target tube feeding rate of 75ml/hour may be specified.

Control0..1
TypeExtension (Extension Type: Ratio)
MedicationOrder.dosageInstruction.extension (http://hl7.org/fhir/StructureDefinition/pharmacy-core-minDosePerPeriod)
Definition

The minimum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g., 10 mg in 24 hours.

Control0..1
TypeExtension (Extension Type: Ratio)
MedicationOrder.dosageInstruction.extension (http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryRate)
Definition

The maximum rate of substance administration. For volume medications, the maximum rate is to be expressed as a volume per time period. This value may be used as a stopping condition when a deliveryRateIncrement is specified without a count.

Control0..1
TypeExtension (Extension Type: Ratio)
MedicationOrder.dosageInstruction.extension (http://hl7.org/fhir/StructureDefinition/pharmacy-core-maxDeliveryVolume)
Definition

The maximum volume of fluid to administer to a patient.

Control0..1
TypeExtension (Extension Type: Quantity)
MedicationOrder.dosageInstruction.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationOrder.dosageInstruction.text
Definition

Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing.

Control0..1
Typestring
MedicationOrder.dosageInstruction.additionalInstructions
Definition

Additional instructions such as "Swallow with plenty of water" which may or may not be coded.

Control0..1
BindingCodes identifying additional instructions such as "take with water" or "avoid operating heavy machinery".
TypeCodeableConcept
MedicationOrder.dosageInstruction.timing
Definition

The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".

Control0..1
TypeTiming
Comments

This attribute may not always be populated while the DosageInstruction.text is expected to be populated. If both are populated, then the DosageInstruction.text should reflect the content of the Dosage.timing.

MedicationOrder.dosageInstruction.asNeeded[x]
Definition

Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).

Control0..1
BindingA coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc.
TypeChoice of: boolean, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Specifically if 'boolean' datatype is selected, then the following logic applies: If set to True, this indicates that the medication is only taken when needed, within the specified schedule.

MedicationOrder.dosageInstruction.site[x]
Definition

A coded specification of the anatomic site where the medication first enters the body.

Control0..1
Bindingnull
The codes SHOULD be taken from Vaccine Administered Body Site
TypeChoice of: CodeableConcept, Reference(BodySite)
[x] NoteSee Choice of Data Types for further information about how to use [x]
MedicationOrder.dosageInstruction.route
Definition

A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.

Control0..1
BindingA coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
For example codes, see SNOMED CT Route Codes
TypeCodeableConcept
MedicationOrder.dosageInstruction.method
Definition

A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.

Control0..1
BindingA coded concept describing the technique by which the medicine is administered.
TypeCodeableConcept
Comments

Terminologies used often pre-coordinate this term with the route and or form of administration.

MedicationOrder.dosageInstruction.dose[x]
Definition

The amount of therapeutic or other substance given at one administration event.

Control0..1
TypeChoice of: Range, Quantity(SimpleQuantity)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours.

MedicationOrder.dosageInstruction.rate[x]
Definition

Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.

Control0..1
TypeChoice of: Ratio, Range, Quantity(SimpleQuantity)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationOrder with an updated rate, or captured with a new MedicationOrder with the new rate.

MedicationOrder.dosageInstruction.maxDosePerPeriod
Definition

The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.

Control0..1
TypeRatio
Comments

This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day".

MedicationOrder.dispenseRequest
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.

Control0..1
TypeBackboneElement
Must Supporttrue
MedicationOrder.dispenseRequest.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
MedicationOrder.dispenseRequest.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationOrder.dispenseRequest.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationOrder.dispenseRequest.medication[x]
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.

Control0..1
TypeChoice of: CodeableConcept, Reference(QICore-Medication)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended.

MedicationOrder.dispenseRequest.validityPeriod
Definition

This indicates the validity period of a prescription (stale dating the Prescription).

Control0..1
TypePeriod
Requirements

Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.

Comments

It reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations.

MedicationOrder.dispenseRequest.numberOfRepeatsAllowed
Definition

An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.

Control0..1
TypepositiveInt
Comments

If displaying "number of authorized refills", subtract 1 from this number.

MedicationOrder.dispenseRequest.quantity
Definition

The amount that is to be dispensed for one fill.

Control0..1
TypeQuantity(SimpleQuantity)
MedicationOrder.dispenseRequest.expectedSupplyDuration
Definition

Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.

Control0..1
TypeQuantity(Duration)
Comments

In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.

MedicationOrder.substitution
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.

Control0..1
TypeBackboneElement
MedicationOrder.substitution.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
MedicationOrder.substitution.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationOrder.substitution.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

MedicationOrder.substitution.type
Definition

A code signifying whether a different drug should be dispensed from what was prescribed.

Control1..1
BindingA coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.
For example codes, see ActSubstanceAdminSubstitutionCode
TypeCodeableConcept
MedicationOrder.substitution.reason
Definition

Indicates the reason for the substitution, or why substitution must or must not be performed.

Control0..1
BindingA coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.
For example codes, see SubstanceAdminSubstitutionReason
TypeCodeableConcept
MedicationOrder.priorPrescription
Definition

A link to a resource representing an earlier order or prescription that this order supersedes.

Control0..1
TypeReference(MedicationOrder)