PrescribeIT® Specification and Guide Version 5.0

 

The official URL for this profile is:

http://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder-discontinue

Download Excel representation

Description of Profiles, Differentials, Snapshots and how the different presentations work.

>

This structure is derived from MedicationOrder

NameCard.TypeConstraints and Usage
.  MedicationOrder 0..*MedicationOrderDefinition:
An order for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationOrder" rather than "MedicationPrescription" to generalize the use across inpatient and outpatient settings as well as for care plans, etc.


Comments:
For Task e110-m - New RX Fill Request, this conveys the details of a single medication order.



For Task e120-m - Renewal RX Fill Request, this conveys the medication order for which a fill is being requested.



For Task p160-m - RX Renewal Create Request, this conveys the details of a single medication order for which the renewal is being requested.

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


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

..  contained 1..1ResourceDefinition:
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.


Comments:
Conformance Rule: This will be used to contain the Medication resource. No other resources should be 'contained'.

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (renderedDosageInstruction)
1..1Medication Rendered Dosage InstructionDefinition:
This represents the complete instruction on how the discontinued medication was to be taken by the patient. This is made up of 'Ad-hoc instructions' and/or the 'textual rendition of the elements within the structured dosage lines'


Comments:
Usage Note: This will be populated by the EMR and will reflect the instructions of the discontinued medication as it was provided on the original prescription or or as entered by the prescriber on a standalone discontinue order.



Conformance Rule: The rendered dosage instruction element in the message must contain ALL dosage instructions that are supported. This field must include ALL the information contained in the structured dosage instructions fields that are supported and populated, (such as dosage quantity, dosage unit, frequency, frequency period administration start/end date, route, site of admin etc.) as well as any additional patient instructions fields that may be supported and populated (e.g. take with food, starting one day before dental appointment).



Conformance Rule: If an EMR has discrete field for Pharmacy Notes (Dispenser Instructions), they should not be included here. If EMR's have both concepts combined into one instruction field, then those instructions must be included as part of the rendered dosage instructions.

..  extension
     (protocol)
0..10Medication Order ProtocolDefinition:
Identifies the Protocol, Order set, Guideline or other definition that guided the creation of this prescription


Comments:
Conformance Rule: This element is not supported and must not be populated or included when the sender is sending the discontinue, therefore the receiver will never need to display this value.

..  extension
     (treatmentType)
0..1Medication Order Treatment TypeDefinition:
Identifies whether this drug is for acute or chronic use


Comments:
Conformance Rule: This element is not supported and must not be populated or included when the sender is sending the discontinue, therefore the receiver will never need to display this value.

..  extension
     (supportingInformation)
0..3Medication Order Supporting InformationDefinition:
Additional information that relevant (e.g. observations, allergies, etc.)


Comments:
Conformance Rule: Cardinality must be 0..1 for Shared Health List-Allergies and 0..2 for Shared Health Pharmacy-related Observation (i.e. 1 for height and 1 for weight) as per bundle



Conformance Rule: When sending this is the current list of allergies and observation for the patient from the sending system and should not include or replay back any information that is received in an incoming message.



Conformance Rule: Only 1 allergy list, 1 weight and 1 height observation can be sent per bundle. If different values need to be sent that are specific to one medication order that must be sent as part of the pharmacist instructions or note data elements instead.



Usage Note: See the functional specifications document for further requirements related to sending the allergy and observations information.



Usage Note: The URL for this extension does not refer to an existing web-page as is a pre-adoption extension. Refer to the Shared Health implementation Guide for more information.

..  identifier 1..3Shared Health IdentifierSlice: Unordered, Open by pattern:type
Definition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
These are the identifiers assigned by the EMR and, in some cases, by the DIS.

..  identifier
     (EMR-id)
1..1PrescribeIT® Prescriber Prescription IdentifierDefinition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
In the context of a new prescription (e110, e120, e162, or e163), this Prescription business identifier is generated by the EMR.



In the context of a Cancel Rx Fill Request (e140), this Prescription Identifier should be populated with the same Rx that was included in the original new prescription message (e110, e120, e162, or e163).



In the context of a Discontinue Rx Fill Request (e150), this Prescription Identifier should be populated with the same Rx that was included in the original new prescription message (e110, e120, e162, e163, or e180).



In the context of a Renewal Request (p160), this Prescription business Identifier is for the prescription that is being requested to be renewed. In most cases, this will be a value that was originally generated by the EMR. However, in some cases (e.g. the renewal of a paper/fax prescription), there will be no EMR generated prescription identifier, and in this case, the PMS should generate its own Prescription business identifier.



In the context of an Rx Response - Denied (e161), or an Rx Response - Under Review (e164), this Prescription Identifier should be populated with the MedicationOrder.identifier(EMR-id) provided in the Renewal Request (p160).

...  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/identifier-type","code":"PLAC"}]}
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


....  coding 1..*CodingSlice: Unordered, Open by value:system, value:code
Definition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

.....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

.....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

.....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

....  coding
         (placer)
0..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

.....  system 1..1uriFixed Value: http://hl7.org/fhir/identifier-type
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: http://hl7.org/fhir/identifier-type

.....  code 1..1codeFixed Value: PLAC
Definition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
Fixed value: PLAC

.....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

...  system 1..1uriEMR-id-branch-2: This must be an OID ending in .2
Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.


Comments:
Conformance Rule: This must be an OID of the URI form [Vendor root].[Application instance node].2 (e.g. urn:oid:1.2.3.4). The branch, “.2” is appended to create a unique namespace for the Prescription Identifer

...  value 1..1stringExample' General': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
Usage Rule: The business identifier that uniquely identifies a prescription.

..  identifier
     (DIS-id)
0..2IdentifierDefinition:
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.


Comments:
In the context of Tasks e110, e120, e162, e163, and e180, this identifier will not be present in the message transmitted from the EMR to the PrescribeIT® Switch. As the message passes through the PrescribeIT® Switch in a jurisdiction which has a Drug Information System (DIS), the PrescribeIT® Switch will add the DIS's identifier to the MedicationOrder. PMS is to use this identifier to record the dispense event against the correct DIS Prescription identifier, if possible.



In the context of Tasks e140 and p160, this is not applicable.

...  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"RRI"}]}
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


...  system 0..1uriExample' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.

...  value 1..1stringExample' General': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

..  status 1..1codeBinding: MedicationOrderStatus (required): A code specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Fixed Value: active
Definition:
A code specifying the state of the order. Generally this will be active or completed state.


Comments:
Fixed value: active

..  medication[x]
     (medicationReference)
1..1Reference(PrescribeIT® Medication) {c}Definition:
A reference from one resource to another.


Comments:
Usage Note: this is populated with the reference to the Medication resource pertaining to this Medication Order. It will point to the 'contained' Medication resource. This will reference the medication id value without the '#'

..  patient 1..1Reference(Shared Health Patient) {b}Definition:
A reference from one resource to another.


Comments:
Usage Note: This must point to the patient associated with the message.

..  reasonCode 0..5Shared Health CodeableConcept Required Text with optional codeBinding: PrescriptionIndicationForUse (20220331) (extensible)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: This element is not supported and must not be populated or included when the sender is sending the discontinue, therefore the receiver will never need to display this value.

...  coding 0..1CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

...  text 1..1stringMax Length: 2500
Definition:
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.


Comments:
Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner

..  note 0..1AnnotationDefinition:
Extra information about the prescription that could not be conveyed by the other attributes.


Comments:
Conformance Rule: This element is not supported and must not be populated or included when the sender is sending the discontinue, therefore the receiver will never need to display this value.

...  text 1..1stringMax Length: 2500
Definition:
The text of the annotation.

..  dosageInstruction 0..*BackboneElementDefinition:
Indicates how the medication is to be used by the patient.


Comments:
Conformance Rule: For EMRs that can support structured dosage instruction, this element must be populated when the prescriber specifies any of structured dosage information. Anything that is populated as part of the structured dosage information must also be part of the RENDERED_DOSAGE_INSTRUCTION element.



Usage Note: An Excel spreadsheet providing guidance on how to populate dosage instructions can be found under 'Scope and Usage'.



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.

...  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

...  extension
       (sequence)
1..1Medication Dosage Line SequenceDefinition:
Optional Extensions Element - found in all resources.


Comments:
Conformance Rule: This must match the positional sequence of the dosageInstruction repetition. I.e. The first dosageInstruction repetition must have a 'sequence' value of 1, the second a 'sequence' value of 2, etc.

...  extension
       (instructionRelationship)
0..1Medication Order Dosage Instruction RelationshipDefinition:
Optional Extensions Element - found in all resources.


Comments:
Conformance Rule: As this will establish the relationship to the previous dosage lines (example: first and second dosage line, the second and thrid dosage line, etc.) this must be present for all dosage lines except for the FIRST dosage line.



Usage Note: ANDs are instructions lines that are done together and THENs are instructions that are sequential and are done following the previous line. ANDs and THENs can be used individually or mixed together depending on the specific instructions.



Example using just AND: Take 1 tablet every morning and 2 tablets every evening.



Example using just THEN: Take 1 tablet every morning for 1 week THEN take 2 tablets every morning for 1 week.



Example using both: Take 1 tablet every morning AND 2 tablets every evening for 1 week THEN take 2 tablets every morning AND 3 tablets every evening for 1 week.

...  text 0..1stringDefinition:
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.


Comments:
Conformance Rule: When providing multiple dosage lines can be expressed individually. All dosage lines (full text content) must be concatenated into MedicationOrder.extension(renderedDosageInstruction) as PMS will not be forced to support the receipt of individual lines.



Usage Note: This is a string composed of any available discrete MedicationOrder.dosageInstruction child elements such as timing, asNeeded[x], siteCodeableConcept, route, dose[x], rate[x], and maxDosePerPeriod for each repetition sequence line.



Example: Prednisone; variable dosage instruction, or concurrent instructions (1 pill morning and 1 pill before bed) or sequential dosages (1 pill for 2 days, then 2 pills).

...  additionalInstructions 0..1Shared Health CodeableConcept Text RequiredBinding: (unbound) (example): Codes identifying additional instructions such as "take with water" or "avoid operating heavy machinery".


Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: When providing an additional instruction at the dosage line level (complex), this should be populated when appropriate.



Usage Note: It may be necessary for the EMR to parse instructions such as QHS (take at bedtime), into two data elements DOSAGE_TIMING_FREQUENCY = once a day and 'at bedtime' would be placed into this field.

....  text 1..1stringMax Length: 2500
Definition:
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.


Comments:
Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner

...  timing 0..1TimingDefinition:
The timing schedule on how the patient is to take the medication. The timing schedules allows many different expressions to be expressed. For example: Every 8 hours, Three times a day, 1/2 an hour before breakfast for 10 days from 17 Oct 2017 to 27 Oct 2017


Comments:
Conformance Rule: For EMRs that can support structured dosage instruction, this must be populated if prescriber specifies any of structured timing information. Anything that is populated as part of the structured timing information must also be part of the RENDERED_DOSAGE_INSTRUCTION.



Usage Note: An Excel spreadsheet providing guidance on how to populate dosage instructions can be found under 'Scope and Usage'.

....  event 0..1dateTimeDefinition:
Identifies specific times when the event occurs.

....  repeat 0..1Elementtim-3: Either frequency or when can exist, not both
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-9: If there's an offset, there must be a when
tim-6: If there's a periodMax, there must be a period
tim-8: If there's a countMax, there must be a count
tim-7: If there's a durationMax, there must be a duration
tim-4: duration SHALL be a non-negative value
Definition:
A set of rules that describe when the event should occur.


Comments:
Conformance Rule: If an EMR cannot send discrete elements in all cases for timing.repeat element, this is acceptable as long as RENDERED_DOSAGE_INSTRUCTION captures the timing.

.....  bounds[x] 0..1Period, Shared Health Duration, RangeDefinition:
boundsPeriod defines the start and/or end date of the period over which the specified instruction should take place for a given dosage line. For example, if the prescriber wants a patient to start taking the medication starting the day before surgery, and the surgery is scheduled for Feb 16th 2019, the start date within bounds period would be Feb 15 2019. The end date can be included if the prescriber wants the patient to stop medication after a certain number of days. In the example above lets say the prescriber wants to the patient to stop the medication after 10 days the end date would Feb 26 2019.



boundsDuration defines the amount of time that the patient should be taking the specified instruction for a given dosage line. As an example, a prescription may call for taking 1-2 pills per day for 10 days. The boundsDuration would be 10 days.



boundsRange defines a minimum and maximum amount of time that the patient should be taking the specified instruction for a given dosage line. As an example, a prescriber may indicate that a patient should apply a cream 2 times per day for a minimum of 10 days but if the rash persists, continue applying for up to 14 days. In this case the minimum for boundsRange would be 10 days and the maximum for boundsRange would be 14 days.

.....  count 0..1integerDefinition:
count defines how many time the dosing activities should be repeated across all periods. For example, if a prescriber wants a patient to take 1 pill morning and night every day for 10 days, the dose is 1 pill, the frequency is 2 per day, the period is one day, and the count is 20 doses (corresponding to 10 days times 2 doses per day).


Comments:
If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.

.....  countMax 0..1integerDefinition:
countMax defines the max number of doses that should be taken across all periods within a dosage line. countMax is only used when the count is expressed as a range of values. For example, if a prescriber wants a patient to take a dose of 2 pills per day for 7-10 days, the dose is 2 pills, the frequency is 1 dose per day, the period is 1 days, the count is 7 doses, and the countMax is 10 doses.

.....  duration 0..1decimalDefinition:
duration defines the amount of time it takes to provide a SINGLE dose of a medication to a patient. For most medications, duration is not relevant. However, one example that uses duration would be the application of a patch. The prescriber may instruct the patient to apply a patch for 10 hours each day for 10 days. In this case, the dose would be 1 patch, the duration would be 10 hours, the period would be 1 day, and the count would be 10 doses.


Comments:
For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

.....  durationMax 0..1decimalDefinition:
durationMax defines the maximum amount of time CAN/SHOULD take to provide a SINGLE dose of a medication to a patient. durationMax implies the usage of a range of values for the duration. For most medications, duration and durationMax is not relevant. However, one example that uses duration and durationMax would be the application of a patch for a range of time each day. The prescriber may instruct the patient to apply a patch for 10-12 hours each day for 10 days. In this case, the dose would be 1 patch, the duration would be 10 hours, the durationMax would be 12 hours, the period would be 1 day, and the count would be 10 doses.


Comments:
For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

.....  durationUnit 0..1codeBinding: x_TimeUnitsOfMeasure (20230710) (required)
Definition:
The units of time for the duration, in UCUM units.

.....  frequency 0..1integerDefinition:
frequency defines the number of times to apply a single dose of a medication within a particular period. For example, the prescriber may instruct the patient to take 1 tablet 3 times per day for 10 days. In this cases, the dose would be 1 tablet, the frequency would be 3 times, the period would be 1 day, and the count would be 30 doses.

.....  frequencyMax 0..1integerDefinition:
frequencyMax defines the maximum number of times to apply a single dose of a medication within a particular period. Using frequencyMax implies that the frequency is a range of values. For example, the prescriber may instruct the patient to take 1 tablet 3-4 times per day for 10 days. In this cases, the dose would be 1 tablet, the frequency would be 3 times, the frequencyMax would be 4 times, the period would be 1 day, and the count would be 30 doses.

.....  period 0..1decimalDefinition:
The period defines the amount of time over which the frequency of doses should occur. For example, the prescriber may instruct the patient to take 1 tablet every day for 10 days. In this case, the period is 1 day.

.....  periodMax 0..1decimalDefinition:
The periodMax defines the maximum amount of time over which the frequency of doses should occur. For example, the prescriber may instruct the patient to apply one patch every 48 to 72 hours and leave the patch on for 12 hour and do this for 1 month. In this case, the dose would be one patch, the frequency would be 1, the duration would be 12 hours, the period would be 48 hours, the periodMax would be 72 hours, and the boundPeriod would be a start day of today and an end date of 2 months from now.

.....  periodUnit 0..1codeBinding: x_TimeUnitsOfMeasure (20230710) (required)
Definition:
The units of time for the period in UCUM units.

...  asNeeded[x] 0..1boolean, CodeableConceptBinding: (unbound) (example): A 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.


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).


Comments:
Conformance Rule: This is ONLY populated when the medication is prescribed on an as needed (i.e. PRN) basis.



Conformance Rule: Set value = true



Conformance Rule: When this is specified, it is not acceptable to express the quantity exclusively as a duration/DAYS_SUPPLY. The DOSAGE_QUANTITY must be provided.



The CodeableConcept should not be used at this time. If it is present, treat it as though the boolean value is set to true.

...  site[x]
       (siteCodeableConcept)
0..1Shared Health CodeableConcept Required Text with optional codeBinding: PrescriptionAdministrationSite (20220331) (extensible)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: When providing a structured SIG, this should be populated when appropriate. If not structured, this should be part of the SIG (RENDERED_DOSAGE_INSTRUCTION)

...  route 0..1Shared Health CodeableConcept Required Text with optional codeBinding: PrescriptionRouteOfAdministration (20190415) (extensible)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: Coding should be populated if a code is available. However, text is always required.

...  dose[x] 0..1PrescribeIT® Drug Quantity for Administration, PrescribeIT® Drug RangeBinding: PrescriptionDoseQuantityUnit (20220331) (extensible)
Definition:
The amount of therapeutic or other substance given at one administration event.


Comments:
Conformance Rule: Could be sent as part of the dosage instruction. OR for those EMRs that can support it, this should be specified.

...  rate[x]
       (rateRatio)
0..1RatioDefinition:
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.


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.

....  numerator 1..1PrescribeIT® Drug Quantity for AdministrationBinding: PrescribedQuantityUnit (20220331) (extensible)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
Definition:
A measured or counted amount of a medication expressed as a value and human-readable string with optional coded units expressed in a local coding system


Comments:
Usage Note: Quantity is used throughout the messages. It may be a drug form (e.g. TAB) an administrable drug (e.g. PUFF) form or a unit of measure (e.g. mg).

....  denominator 1..1Shared Health Quantityqty-3: If a code for the unit is present, the system SHALL also be present
Definition:
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.


Comments:
This indicates the unit of time (e.g. per day, every 4 weeks, etc.)

...  maxDosePerPeriod 0..1RatioDefinition:
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.


Comments:
Conformance Rule: When providing a structured SIG, this should be populated when appropriate.

....  numerator 1..1PrescribeIT® Drug Quantity for AdministrationBinding: PrescribedQuantityUnit (20220331) (extensible)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
Definition:
A measured or counted amount of a medication expressed as a value and human-readable string with optional coded units expressed in a local coding system


Comments:
Conformance Rule: Quantity is used throughout the messages. It may be a drug form (e.g. TAB) an adminstratable drug (e.g. PUFF) for or a unit of measure (e.g. mg). If this is provided it is mandatory to send a value from the PrescribeIT® Drug Quantity.

....  denominator 1..1Shared Health Quantityqty-3: If a code for the unit is present, the system SHALL also be present
Definition:
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.


Comments:
This indicates the unit of time (e.g. per day, every 4 weeks, etc.)

This structure is derived from MedicationOrder

Summary

Mandatory: 8 elements (9 nested mandatory elements)
Must-Support: 52 elements
Fixed Value: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationOrder.identifier is sliced based on the value of pattern:type

This structure is derived from MedicationOrder

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder S0..*MedicationOrderPrescription of medication to for patient
... id S1..1idLogical id of this artifact
... contained S1..1ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-medication-rendered-dosage S1..1stringRendered Dosage Instruction
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-rendered-dosage
... ext-medicationorder-protocol S0..10string, uri, Shared Health IdentifierProtocol, order set, guideline, etc.
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-protocol
... ext-medicationorder-treatment-type S0..1codeACU | CHRON
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-treatment-type
Binding: PrescriptionTreatmentCategory (20190415) (required)
... ext-medicationorder-supportinginfo S0..3Reference()Allergies, height, weight, etc.
URL: http://hl7.org/fhir/StructureDefinition/extension-MedicationRequest.supportingInfo profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-supportinginfo
... identifier S1..3(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:EMR-id S1..1PrescribeIT® Prescriber Prescription IdentifierEMR Prescription Identifier
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
.... identifier:DIS-id S0..2IdentifierDIS Order identifier
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: RRI
..... system S0..1uriThe namespace for the identifier
..... value S1..1stringThe value that is unique
... status S1..1codeactive | on-hold | completed | entered-in-error | stopped | draft
Fixed Value: active
... medicationReference S1..1Reference(PrescribeIT® Medication) {c}A reference from one resource to another
... patient S1..1Reference(Shared Health Patient) {b}A reference from one resource to another
... reasonCode S0..5Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionIndicationForUse (20220331) (extensible)
.... text S1..1stringPlain text representation of the concept
... note S0..1AnnotationInformation about the prescription
.... text S1..1stringThe annotation - text content
Max Length: 2500
... dosageInstruction S0..*BackboneElementHow medication should be taken
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-medication-dosageinstruction-sequence S1..1integerSequence of dosage instruction
URL: http://hl7.org/fhir/StructureDefinition/extension-Dosage.sequence profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medication-dosageinstruction-sequence
.... ext-medicationorder-dosageinstruction-relationship S0..1codeAND | THEN
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dosageinstruction-relationship
Binding: PrescriptionDosageInstructionLineRelationship (20170626) (required)
.... text S0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions S0..1Shared Health CodeableConcept Text RequiredConcept - reference to a terminology or just text
..... text S1..1stringPlain text representation of the concept
.... timing S0..1TimingWhen medication should be administered
..... event S0..1dateTimeWhen the event occurs
..... repeat S0..1ElementWhen the event is to occur
...... bounds[x] S0..1Length/Range of lengths, or (Start and/or end) limits
....... boundsPeriodPeriod
....... boundsQuantityQuantity(Shared Health Duration)
....... boundsRangeRange
...... count S0..1integerNumber of times to repeat
...... countMax S0..1integerMaximum number of times to repeat
...... duration S0..1decimalHow long when it happens
...... durationMax S0..1decimalHow long when it happens (Max)
...... durationUnit S0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: x_TimeUnitsOfMeasure (20230710) (required)
...... frequency S0..1integerEvent occurs frequency times per period
...... frequencyMax S0..1integerEvent occurs up to frequencyMax times per period
...... period S0..1decimalEvent occurs frequency times per period
...... periodMax S0..1decimalUpper limit of period (3-4 hours)
...... periodUnit S0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: x_TimeUnitsOfMeasure (20230710) (required)
...... when 0..0
...... offset 0..0
.... asNeeded[x] S0..1boolean, CodeableConceptTake "as needed" (for x)
.... siteCodeableConcept S0..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionAdministrationSite (20220331) (extensible)
.... route S0..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionRouteOfAdministration (20190415) (extensible)
.... dose[x] S0..1Amount of medication per dose
Binding: PrescriptionDoseQuantityUnit (20220331) (extensible)
..... doseQuantityQuantity(PrescribeIT® Drug Quantity for Administration)
..... doseRangeRange(PrescribeIT® Drug Range)
.... rateRatio S0..1RatioAmount of medication per unit of time
..... numerator S1..1PrescribeIT® Drug Quantity for AdministrationQuantity of a medication
Binding: PrescribedQuantityUnit (20220331) (extensible)
..... denominator S1..1Shared Health QuantityA measured or measurable amount
.... maxDosePerPeriod S0..1RatioUpper limit on medication per unit of time
..... numerator S1..1PrescribeIT® Drug Quantity for AdministrationQuantity of a medication
Binding: PrescribedQuantityUnit (20220331) (extensible)
..... denominator S1..1Shared Health QuantityA measured or measurable amount
... dispenseRequest 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder SΣ0..*MedicationOrderPrescription of medication to for patient
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained S1..1ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-medication-rendered-dosage S1..1stringRendered Dosage Instruction
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-rendered-dosage
... ext-medicationorder-protocol S0..10string, uri, Shared Health IdentifierProtocol, order set, guideline, etc.
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-protocol
... ext-medicationorder-treatment-type S0..1codeACU | CHRON
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-treatment-type
Binding: PrescriptionTreatmentCategory (20190415) (required)
... ext-medicationorder-supportinginfo S0..3Reference()Allergies, height, weight, etc.
URL: http://hl7.org/fhir/StructureDefinition/extension-MedicationRequest.supportingInfo profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-supportinginfo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..3(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:EMR-id S1..1PrescribeIT® Prescriber Prescription IdentifierEMR Prescription Identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... coding SΣ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
....... coding:All Slices Content/Rules for all slices
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system SΣ1..1uriIdentity of the terminology system
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeSymbol in syntax defined by the system
........ display SΣ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:placer SΣ0..*CodingCode defined by a terminology system
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
........ display SΣ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣI1..1uriThe namespace for the identifier
EMR-id-branch-2: This must be an OID ending in .2
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:DIS-id SΣ0..2IdentifierDIS Order identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: RRI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ0..1uriThe namespace for the identifier
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | on-hold | completed | entered-in-error | stopped | draft
Binding: MedicationOrderStatus (required): A code specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Fixed Value: active
... medication[x] Σ1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference SΣ1..1Reference(PrescribeIT® Medication) {c}A reference from one resource to another
... patient SΣ1..1Reference(Shared Health Patient) {b}A reference from one resource to another
... encounter Σ0..1Reference(Encounter)Created during encounter/admission/stay
... dateWritten Σ0..1dateTimeWhen prescription was authorized
... prescriber Σ0..1Reference(Practitioner)Who ordered the medication(s)
... reasonCode S0..5Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionIndicationForUse (20220331) (extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ0..1CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display SΣ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ1..1stringPlain text representation of the concept
Max Length: 2500
... reasonReference Σ0..*Reference(Condition)Condition that supports why the prescription is being written
... dateEnded Σ0..1dateTimeWhen prescription was stopped
... reasonEnded Σ0..1CodeableConceptWhy prescription was stopped
Binding: (unbound) (example): Codes indicating why the medication was terminated; e.g. Adverse reaction, medication change, issue resolved, etc.

... note SΣ0..1AnnotationInformation about the prescription
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text S1..1stringThe annotation - text content
Max Length: 2500
... dosageInstruction SΣ0..*BackboneElementHow medication should be taken
.... id 0..1idxml:id (or equivalent in JSON)
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-medication-dosageinstruction-sequence S1..1integerSequence of dosage instruction
URL: http://hl7.org/fhir/StructureDefinition/extension-Dosage.sequence profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medication-dosageinstruction-sequence
.... ext-medicationorder-dosageinstruction-relationship S0..1codeAND | THEN
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dosageinstruction-relationship
Binding: PrescriptionDosageInstructionLineRelationship (20170626) (required)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... text SΣ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions S0..1Shared Health CodeableConcept Text RequiredConcept - reference to a terminology or just text
Binding: (unbound) (example): Codes identifying additional instructions such as "take with water" or "avoid operating heavy machinery".

..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding Σ0..*CodingCode defined by a terminology system
..... text SΣ1..1stringPlain text representation of the concept
Max Length: 2500
.... timing SΣ0..1TimingWhen medication should be administered
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... event SΣ0..1dateTimeWhen the event occurs
..... repeat SΣI0..1ElementWhen the event is to occur
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... bounds[x] SΣ0..1Length/Range of lengths, or (Start and/or end) limits
....... boundsPeriodPeriod
....... boundsQuantityQuantity(Shared Health Duration)
....... boundsRangeRange
...... count SΣ0..1integerNumber of times to repeat
...... countMax SΣ0..1integerMaximum number of times to repeat
...... duration SΣ0..1decimalHow long when it happens
...... durationMax SΣ0..1decimalHow long when it happens (Max)
...... durationUnit SΣ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: x_TimeUnitsOfMeasure (20230710) (required)
...... frequency SΣ0..1integerEvent occurs frequency times per period
...... frequencyMax SΣ0..1integerEvent occurs up to frequencyMax times per period
...... period SΣ0..1decimalEvent occurs frequency times per period
...... periodMax SΣ0..1decimalUpper limit of period (3-4 hours)
...... periodUnit SΣ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: x_TimeUnitsOfMeasure (20230710) (required)
..... code Σ0..1CodeableConceptQD | QOD | Q4H | Q6H | BID | TID | QID | AM | PM +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

.... asNeeded[x] SΣ0..1Take "as needed" (for x)
Binding: (unbound) (example): A 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.

..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site[x] Σ0..1(Slice Definition)Body site to administer to
Slice: Unordered, Closed by type:$this
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body.

..... site[x]:siteCodeableConcept S0..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionAdministrationSite (20220331) (extensible)
.... route S0..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionRouteOfAdministration (20190415) (extensible)
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: (unbound) (example): A coded concept describing the technique by which the medicine is administered.

.... dose[x] SΣ0..1Amount of medication per dose
Binding: PrescriptionDoseQuantityUnit (20220331) (extensible)
..... doseQuantityQuantity(PrescribeIT® Drug Quantity for Administration)
..... doseRangeRange(PrescribeIT® Drug Range)
.... rate[x] Σ0..1(Slice Definition)Amount of medication per unit of time
Slice: Unordered, Closed by type:$this
..... rate[x]:rateRatio SΣ0..1RatioAmount of medication per unit of time
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... numerator SI1..1PrescribeIT® Drug Quantity for AdministrationQuantity of a medication
Binding: PrescribedQuantityUnit (20220331) (extensible)
...... denominator SI1..1Shared Health QuantityA measured or measurable amount
.... maxDosePerPeriod SΣ0..1RatioUpper limit on medication per unit of time
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... numerator SI1..1PrescribeIT® Drug Quantity for AdministrationQuantity of a medication
Binding: PrescribedQuantityUnit (20220331) (extensible)
..... denominator SI1..1Shared Health QuantityA measured or measurable amount
... substitution Σ0..1BackboneElementAny restrictions on medication substitution
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ1..1CodeableConceptgeneric | formulary +
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason Σ0..1CodeableConceptWhy should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.

... priorPrescription Σ0..1Reference(MedicationOrder)An order/prescription that this supersedes

doco Documentation for this format

Grid View

This structure is derived from MedicationOrder

NameCard.TypeConstraints and Usage
.  MedicationOrder 0..*MedicationOrderDefinition:
An order for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationOrder" rather than "MedicationPrescription" to generalize the use across inpatient and outpatient settings as well as for care plans, etc.


Comments:
For Task e110-m - New RX Fill Request, this conveys the details of a single medication order.



For Task e120-m - Renewal RX Fill Request, this conveys the medication order for which a fill is being requested.



For Task p160-m - RX Renewal Create Request, this conveys the details of a single medication order for which the renewal is being requested.

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


Comments:
Usage Note: This will usually be a GUID and is assigned by the sending application.

..  contained 1..1ResourceDefinition:
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.


Comments:
Conformance Rule: This will be used to contain the Medication resource. No other resources should be 'contained'.

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

..  extension
     (renderedDosageInstruction)
1..1Medication Rendered Dosage InstructionDefinition:
This represents the complete instruction on how the discontinued medication was to be taken by the patient. This is made up of 'Ad-hoc instructions' and/or the 'textual rendition of the elements within the structured dosage lines'


Comments:
Usage Note: This will be populated by the EMR and will reflect the instructions of the discontinued medication as it was provided on the original prescription or or as entered by the prescriber on a standalone discontinue order.



Conformance Rule: The rendered dosage instruction element in the message must contain ALL dosage instructions that are supported. This field must include ALL the information contained in the structured dosage instructions fields that are supported and populated, (such as dosage quantity, dosage unit, frequency, frequency period administration start/end date, route, site of admin etc.) as well as any additional patient instructions fields that may be supported and populated (e.g. take with food, starting one day before dental appointment).



Conformance Rule: If an EMR has discrete field for Pharmacy Notes (Dispenser Instructions), they should not be included here. If EMR's have both concepts combined into one instruction field, then those instructions must be included as part of the rendered dosage instructions.

..  extension
     (protocol)
0..10Medication Order ProtocolDefinition:
Identifies the Protocol, Order set, Guideline or other definition that guided the creation of this prescription


Comments:
Conformance Rule: This element is not supported and must not be populated or included when the sender is sending the discontinue, therefore the receiver will never need to display this value.

..  extension
     (treatmentType)
0..1Medication Order Treatment TypeDefinition:
Identifies whether this drug is for acute or chronic use


Comments:
Conformance Rule: This element is not supported and must not be populated or included when the sender is sending the discontinue, therefore the receiver will never need to display this value.

..  extension
     (supportingInformation)
0..3Medication Order Supporting InformationDefinition:
Additional information that relevant (e.g. observations, allergies, etc.)


Comments:
Conformance Rule: Cardinality must be 0..1 for Shared Health List-Allergies and 0..2 for Shared Health Pharmacy-related Observation (i.e. 1 for height and 1 for weight) as per bundle



Conformance Rule: When sending this is the current list of allergies and observation for the patient from the sending system and should not include or replay back any information that is received in an incoming message.



Conformance Rule: Only 1 allergy list, 1 weight and 1 height observation can be sent per bundle. If different values need to be sent that are specific to one medication order that must be sent as part of the pharmacist instructions or note data elements instead.



Usage Note: See the functional specifications document for further requirements related to sending the allergy and observations information.



Usage Note: The URL for this extension does not refer to an existing web-page as is a pre-adoption extension. Refer to the Shared Health implementation Guide for more information.

..  identifier 1..3Shared Health IdentifierSlice: Unordered, Open by pattern:type
Definition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
These are the identifiers assigned by the EMR and, in some cases, by the DIS.

..  identifier
     (EMR-id)
1..1PrescribeIT® Prescriber Prescription IdentifierDefinition:
A technical identifier - identifies some entity uniquely and unambiguously.


Comments:
In the context of a new prescription (e110, e120, e162, or e163), this Prescription business identifier is generated by the EMR.



In the context of a Cancel Rx Fill Request (e140), this Prescription Identifier should be populated with the same Rx that was included in the original new prescription message (e110, e120, e162, or e163).



In the context of a Discontinue Rx Fill Request (e150), this Prescription Identifier should be populated with the same Rx that was included in the original new prescription message (e110, e120, e162, e163, or e180).



In the context of a Renewal Request (p160), this Prescription business Identifier is for the prescription that is being requested to be renewed. In most cases, this will be a value that was originally generated by the EMR. However, in some cases (e.g. the renewal of a paper/fax prescription), there will be no EMR generated prescription identifier, and in this case, the PMS should generate its own Prescription business identifier.



In the context of an Rx Response - Denied (e161), or an Rx Response - Under Review (e164), this Prescription Identifier should be populated with the MedicationOrder.identifier(EMR-id) provided in the Renewal Request (p160).

...  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/identifier-type","code":"PLAC"}]}
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


....  coding 1..*CodingSlice: Unordered, Open by value:system, value:code
Definition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

.....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

.....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

.....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

....  coding
         (placer)
0..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

.....  system 1..1uriFixed Value: http://hl7.org/fhir/identifier-type
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: http://hl7.org/fhir/identifier-type

.....  code 1..1codeFixed Value: PLAC
Definition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
Fixed value: PLAC

.....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

...  system 1..1uriEMR-id-branch-2: This must be an OID ending in .2
Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.


Comments:
Conformance Rule: This must be an OID of the URI form [Vendor root].[Application instance node].2 (e.g. urn:oid:1.2.3.4). The branch, “.2” is appended to create a unique namespace for the Prescription Identifer

...  value 1..1stringExample' General': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
Usage Rule: The business identifier that uniquely identifies a prescription.

..  identifier
     (DIS-id)
0..2IdentifierDefinition:
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.


Comments:
In the context of Tasks e110, e120, e162, e163, and e180, this identifier will not be present in the message transmitted from the EMR to the PrescribeIT® Switch. As the message passes through the PrescribeIT® Switch in a jurisdiction which has a Drug Information System (DIS), the PrescribeIT® Switch will add the DIS's identifier to the MedicationOrder. PMS is to use this identifier to record the dispense event against the correct DIS Prescription identifier, if possible.



In the context of Tasks e140 and p160, this is not applicable.

...  type 1..1Shared Health CodeableConcept CodeBinding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"RRI"}]}
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


...  system 0..1uriExample' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.

...  value 1..1stringExample' General': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

..  status 1..1codeBinding: MedicationOrderStatus (required): A code specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Fixed Value: active
Definition:
A code specifying the state of the order. Generally this will be active or completed state.


Comments:
Fixed value: active

..  medication[x]
     (medicationReference)
1..1Reference(PrescribeIT® Medication) {c}Definition:
A reference from one resource to another.


Comments:
Usage Note: this is populated with the reference to the Medication resource pertaining to this Medication Order. It will point to the 'contained' Medication resource. This will reference the medication id value without the '#'

..  patient 1..1Reference(Shared Health Patient) {b}Definition:
A reference from one resource to another.


Comments:
Usage Note: This must point to the patient associated with the message.

..  reasonCode 0..5Shared Health CodeableConcept Required Text with optional codeBinding: PrescriptionIndicationForUse (20220331) (extensible)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: This element is not supported and must not be populated or included when the sender is sending the discontinue, therefore the receiver will never need to display this value.

...  coding 0..1CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

...  text 1..1stringMax Length: 2500
Definition:
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.


Comments:
Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner

..  note 0..1AnnotationDefinition:
Extra information about the prescription that could not be conveyed by the other attributes.


Comments:
Conformance Rule: This element is not supported and must not be populated or included when the sender is sending the discontinue, therefore the receiver will never need to display this value.

...  text 1..1stringMax Length: 2500
Definition:
The text of the annotation.

..  dosageInstruction 0..*BackboneElementDefinition:
Indicates how the medication is to be used by the patient.


Comments:
Conformance Rule: For EMRs that can support structured dosage instruction, this element must be populated when the prescriber specifies any of structured dosage information. Anything that is populated as part of the structured dosage information must also be part of the RENDERED_DOSAGE_INSTRUCTION element.



Usage Note: An Excel spreadsheet providing guidance on how to populate dosage instructions can be found under 'Scope and Usage'.



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.

...  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

...  extension
       (sequence)
1..1Medication Dosage Line SequenceDefinition:
Optional Extensions Element - found in all resources.


Comments:
Conformance Rule: This must match the positional sequence of the dosageInstruction repetition. I.e. The first dosageInstruction repetition must have a 'sequence' value of 1, the second a 'sequence' value of 2, etc.

...  extension
       (instructionRelationship)
0..1Medication Order Dosage Instruction RelationshipDefinition:
Optional Extensions Element - found in all resources.


Comments:
Conformance Rule: As this will establish the relationship to the previous dosage lines (example: first and second dosage line, the second and thrid dosage line, etc.) this must be present for all dosage lines except for the FIRST dosage line.



Usage Note: ANDs are instructions lines that are done together and THENs are instructions that are sequential and are done following the previous line. ANDs and THENs can be used individually or mixed together depending on the specific instructions.



Example using just AND: Take 1 tablet every morning and 2 tablets every evening.



Example using just THEN: Take 1 tablet every morning for 1 week THEN take 2 tablets every morning for 1 week.



Example using both: Take 1 tablet every morning AND 2 tablets every evening for 1 week THEN take 2 tablets every morning AND 3 tablets every evening for 1 week.

...  text 0..1stringDefinition:
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.


Comments:
Conformance Rule: When providing multiple dosage lines can be expressed individually. All dosage lines (full text content) must be concatenated into MedicationOrder.extension(renderedDosageInstruction) as PMS will not be forced to support the receipt of individual lines.



Usage Note: This is a string composed of any available discrete MedicationOrder.dosageInstruction child elements such as timing, asNeeded[x], siteCodeableConcept, route, dose[x], rate[x], and maxDosePerPeriod for each repetition sequence line.



Example: Prednisone; variable dosage instruction, or concurrent instructions (1 pill morning and 1 pill before bed) or sequential dosages (1 pill for 2 days, then 2 pills).

...  additionalInstructions 0..1Shared Health CodeableConcept Text RequiredBinding: (unbound) (example): Codes identifying additional instructions such as "take with water" or "avoid operating heavy machinery".


Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: When providing an additional instruction at the dosage line level (complex), this should be populated when appropriate.



Usage Note: It may be necessary for the EMR to parse instructions such as QHS (take at bedtime), into two data elements DOSAGE_TIMING_FREQUENCY = once a day and 'at bedtime' would be placed into this field.

....  text 1..1stringMax Length: 2500
Definition:
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.


Comments:
Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner

...  timing 0..1TimingDefinition:
The timing schedule on how the patient is to take the medication. The timing schedules allows many different expressions to be expressed. For example: Every 8 hours, Three times a day, 1/2 an hour before breakfast for 10 days from 17 Oct 2017 to 27 Oct 2017


Comments:
Conformance Rule: For EMRs that can support structured dosage instruction, this must be populated if prescriber specifies any of structured timing information. Anything that is populated as part of the structured timing information must also be part of the RENDERED_DOSAGE_INSTRUCTION.



Usage Note: An Excel spreadsheet providing guidance on how to populate dosage instructions can be found under 'Scope and Usage'.

....  event 0..1dateTimeDefinition:
Identifies specific times when the event occurs.

....  repeat 0..1Elementtim-3: Either frequency or when can exist, not both
tim-1: if there's a duration, there needs to be duration units
tim-2: if there's a period, there needs to be period units
tim-9: If there's an offset, there must be a when
tim-6: If there's a periodMax, there must be a period
tim-8: If there's a countMax, there must be a count
tim-7: If there's a durationMax, there must be a duration
tim-4: duration SHALL be a non-negative value
Definition:
A set of rules that describe when the event should occur.


Comments:
Conformance Rule: If an EMR cannot send discrete elements in all cases for timing.repeat element, this is acceptable as long as RENDERED_DOSAGE_INSTRUCTION captures the timing.

.....  bounds[x] 0..1Period, Shared Health Duration, RangeDefinition:
boundsPeriod defines the start and/or end date of the period over which the specified instruction should take place for a given dosage line. For example, if the prescriber wants a patient to start taking the medication starting the day before surgery, and the surgery is scheduled for Feb 16th 2019, the start date within bounds period would be Feb 15 2019. The end date can be included if the prescriber wants the patient to stop medication after a certain number of days. In the example above lets say the prescriber wants to the patient to stop the medication after 10 days the end date would Feb 26 2019.



boundsDuration defines the amount of time that the patient should be taking the specified instruction for a given dosage line. As an example, a prescription may call for taking 1-2 pills per day for 10 days. The boundsDuration would be 10 days.



boundsRange defines a minimum and maximum amount of time that the patient should be taking the specified instruction for a given dosage line. As an example, a prescriber may indicate that a patient should apply a cream 2 times per day for a minimum of 10 days but if the rash persists, continue applying for up to 14 days. In this case the minimum for boundsRange would be 10 days and the maximum for boundsRange would be 14 days.

.....  count 0..1integerDefinition:
count defines how many time the dosing activities should be repeated across all periods. For example, if a prescriber wants a patient to take 1 pill morning and night every day for 10 days, the dose is 1 pill, the frequency is 2 per day, the period is one day, and the count is 20 doses (corresponding to 10 days times 2 doses per day).


Comments:
If you have both bounds and count, then this should be understood as within the bounds period, until count times happens.

.....  countMax 0..1integerDefinition:
countMax defines the max number of doses that should be taken across all periods within a dosage line. countMax is only used when the count is expressed as a range of values. For example, if a prescriber wants a patient to take a dose of 2 pills per day for 7-10 days, the dose is 2 pills, the frequency is 1 dose per day, the period is 1 days, the count is 7 doses, and the countMax is 10 doses.

.....  duration 0..1decimalDefinition:
duration defines the amount of time it takes to provide a SINGLE dose of a medication to a patient. For most medications, duration is not relevant. However, one example that uses duration would be the application of a patch. The prescriber may instruct the patient to apply a patch for 10 hours each day for 10 days. In this case, the dose would be 1 patch, the duration would be 10 hours, the period would be 1 day, and the count would be 10 doses.


Comments:
For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

.....  durationMax 0..1decimalDefinition:
durationMax defines the maximum amount of time CAN/SHOULD take to provide a SINGLE dose of a medication to a patient. durationMax implies the usage of a range of values for the duration. For most medications, duration and durationMax is not relevant. However, one example that uses duration and durationMax would be the application of a patch for a range of time each day. The prescriber may instruct the patient to apply a patch for 10-12 hours each day for 10 days. In this case, the dose would be 1 patch, the duration would be 10 hours, the durationMax would be 12 hours, the period would be 1 day, and the count would be 10 doses.


Comments:
For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise).

.....  durationUnit 0..1codeBinding: x_TimeUnitsOfMeasure (20230710) (required)
Definition:
The units of time for the duration, in UCUM units.

.....  frequency 0..1integerDefinition:
frequency defines the number of times to apply a single dose of a medication within a particular period. For example, the prescriber may instruct the patient to take 1 tablet 3 times per day for 10 days. In this cases, the dose would be 1 tablet, the frequency would be 3 times, the period would be 1 day, and the count would be 30 doses.

.....  frequencyMax 0..1integerDefinition:
frequencyMax defines the maximum number of times to apply a single dose of a medication within a particular period. Using frequencyMax implies that the frequency is a range of values. For example, the prescriber may instruct the patient to take 1 tablet 3-4 times per day for 10 days. In this cases, the dose would be 1 tablet, the frequency would be 3 times, the frequencyMax would be 4 times, the period would be 1 day, and the count would be 30 doses.

.....  period 0..1decimalDefinition:
The period defines the amount of time over which the frequency of doses should occur. For example, the prescriber may instruct the patient to take 1 tablet every day for 10 days. In this case, the period is 1 day.

.....  periodMax 0..1decimalDefinition:
The periodMax defines the maximum amount of time over which the frequency of doses should occur. For example, the prescriber may instruct the patient to apply one patch every 48 to 72 hours and leave the patch on for 12 hour and do this for 1 month. In this case, the dose would be one patch, the frequency would be 1, the duration would be 12 hours, the period would be 48 hours, the periodMax would be 72 hours, and the boundPeriod would be a start day of today and an end date of 2 months from now.

.....  periodUnit 0..1codeBinding: x_TimeUnitsOfMeasure (20230710) (required)
Definition:
The units of time for the period in UCUM units.

...  asNeeded[x] 0..1boolean, CodeableConceptBinding: (unbound) (example): A 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.


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).


Comments:
Conformance Rule: This is ONLY populated when the medication is prescribed on an as needed (i.e. PRN) basis.



Conformance Rule: Set value = true



Conformance Rule: When this is specified, it is not acceptable to express the quantity exclusively as a duration/DAYS_SUPPLY. The DOSAGE_QUANTITY must be provided.



The CodeableConcept should not be used at this time. If it is present, treat it as though the boolean value is set to true.

...  site[x]
       (siteCodeableConcept)
0..1Shared Health CodeableConcept Required Text with optional codeBinding: PrescriptionAdministrationSite (20220331) (extensible)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: When providing a structured SIG, this should be populated when appropriate. If not structured, this should be part of the SIG (RENDERED_DOSAGE_INSTRUCTION)

...  route 0..1Shared Health CodeableConcept Required Text with optional codeBinding: PrescriptionRouteOfAdministration (20190415) (extensible)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: Coding should be populated if a code is available. However, text is always required.

...  dose[x] 0..1PrescribeIT® Drug Quantity for Administration, PrescribeIT® Drug RangeBinding: PrescriptionDoseQuantityUnit (20220331) (extensible)
Definition:
The amount of therapeutic or other substance given at one administration event.


Comments:
Conformance Rule: Could be sent as part of the dosage instruction. OR for those EMRs that can support it, this should be specified.

...  rate[x]
       (rateRatio)
0..1RatioDefinition:
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.


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.

....  numerator 1..1PrescribeIT® Drug Quantity for AdministrationBinding: PrescribedQuantityUnit (20220331) (extensible)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
Definition:
A measured or counted amount of a medication expressed as a value and human-readable string with optional coded units expressed in a local coding system


Comments:
Usage Note: Quantity is used throughout the messages. It may be a drug form (e.g. TAB) an administrable drug (e.g. PUFF) form or a unit of measure (e.g. mg).

....  denominator 1..1Shared Health Quantityqty-3: If a code for the unit is present, the system SHALL also be present
Definition:
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.


Comments:
This indicates the unit of time (e.g. per day, every 4 weeks, etc.)

...  maxDosePerPeriod 0..1RatioDefinition:
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.


Comments:
Conformance Rule: When providing a structured SIG, this should be populated when appropriate.

....  numerator 1..1PrescribeIT® Drug Quantity for AdministrationBinding: PrescribedQuantityUnit (20220331) (extensible)
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
Definition:
A measured or counted amount of a medication expressed as a value and human-readable string with optional coded units expressed in a local coding system


Comments:
Conformance Rule: Quantity is used throughout the messages. It may be a drug form (e.g. TAB) an adminstratable drug (e.g. PUFF) for or a unit of measure (e.g. mg). If this is provided it is mandatory to send a value from the PrescribeIT® Drug Quantity.

....  denominator 1..1Shared Health Quantityqty-3: If a code for the unit is present, the system SHALL also be present
Definition:
A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.


Comments:
This indicates the unit of time (e.g. per day, every 4 weeks, etc.)

This structure is derived from MedicationOrder

Summary

Mandatory: 8 elements (9 nested mandatory elements)
Must-Support: 52 elements
Fixed Value: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element MedicationOrder.identifier is sliced based on the value of pattern:type

Differential View

This structure is derived from MedicationOrder

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder S0..*MedicationOrderPrescription of medication to for patient
... id S1..1idLogical id of this artifact
... contained S1..1ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-medication-rendered-dosage S1..1stringRendered Dosage Instruction
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-rendered-dosage
... ext-medicationorder-protocol S0..10string, uri, Shared Health IdentifierProtocol, order set, guideline, etc.
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-protocol
... ext-medicationorder-treatment-type S0..1codeACU | CHRON
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-treatment-type
Binding: PrescriptionTreatmentCategory (20190415) (required)
... ext-medicationorder-supportinginfo S0..3Reference()Allergies, height, weight, etc.
URL: http://hl7.org/fhir/StructureDefinition/extension-MedicationRequest.supportingInfo profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-supportinginfo
... identifier S1..3(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:EMR-id S1..1PrescribeIT® Prescriber Prescription IdentifierEMR Prescription Identifier
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
.... identifier:DIS-id S0..2IdentifierDIS Order identifier
..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: RRI
..... system S0..1uriThe namespace for the identifier
..... value S1..1stringThe value that is unique
... status S1..1codeactive | on-hold | completed | entered-in-error | stopped | draft
Fixed Value: active
... medicationReference S1..1Reference(PrescribeIT® Medication) {c}A reference from one resource to another
... patient S1..1Reference(Shared Health Patient) {b}A reference from one resource to another
... reasonCode S0..5Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionIndicationForUse (20220331) (extensible)
.... text S1..1stringPlain text representation of the concept
... note S0..1AnnotationInformation about the prescription
.... text S1..1stringThe annotation - text content
Max Length: 2500
... dosageInstruction S0..*BackboneElementHow medication should be taken
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-medication-dosageinstruction-sequence S1..1integerSequence of dosage instruction
URL: http://hl7.org/fhir/StructureDefinition/extension-Dosage.sequence profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medication-dosageinstruction-sequence
.... ext-medicationorder-dosageinstruction-relationship S0..1codeAND | THEN
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dosageinstruction-relationship
Binding: PrescriptionDosageInstructionLineRelationship (20170626) (required)
.... text S0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions S0..1Shared Health CodeableConcept Text RequiredConcept - reference to a terminology or just text
..... text S1..1stringPlain text representation of the concept
.... timing S0..1TimingWhen medication should be administered
..... event S0..1dateTimeWhen the event occurs
..... repeat S0..1ElementWhen the event is to occur
...... bounds[x] S0..1Length/Range of lengths, or (Start and/or end) limits
....... boundsPeriodPeriod
....... boundsQuantityQuantity(Shared Health Duration)
....... boundsRangeRange
...... count S0..1integerNumber of times to repeat
...... countMax S0..1integerMaximum number of times to repeat
...... duration S0..1decimalHow long when it happens
...... durationMax S0..1decimalHow long when it happens (Max)
...... durationUnit S0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: x_TimeUnitsOfMeasure (20230710) (required)
...... frequency S0..1integerEvent occurs frequency times per period
...... frequencyMax S0..1integerEvent occurs up to frequencyMax times per period
...... period S0..1decimalEvent occurs frequency times per period
...... periodMax S0..1decimalUpper limit of period (3-4 hours)
...... periodUnit S0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: x_TimeUnitsOfMeasure (20230710) (required)
...... when 0..0
...... offset 0..0
.... asNeeded[x] S0..1boolean, CodeableConceptTake "as needed" (for x)
.... siteCodeableConcept S0..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionAdministrationSite (20220331) (extensible)
.... route S0..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionRouteOfAdministration (20190415) (extensible)
.... dose[x] S0..1Amount of medication per dose
Binding: PrescriptionDoseQuantityUnit (20220331) (extensible)
..... doseQuantityQuantity(PrescribeIT® Drug Quantity for Administration)
..... doseRangeRange(PrescribeIT® Drug Range)
.... rateRatio S0..1RatioAmount of medication per unit of time
..... numerator S1..1PrescribeIT® Drug Quantity for AdministrationQuantity of a medication
Binding: PrescribedQuantityUnit (20220331) (extensible)
..... denominator S1..1Shared Health QuantityA measured or measurable amount
.... maxDosePerPeriod S0..1RatioUpper limit on medication per unit of time
..... numerator S1..1PrescribeIT® Drug Quantity for AdministrationQuantity of a medication
Binding: PrescribedQuantityUnit (20220331) (extensible)
..... denominator S1..1Shared Health QuantityA measured or measurable amount
... dispenseRequest 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationOrder SΣ0..*MedicationOrderPrescription of medication to for patient
... id SΣ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained S1..1ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-medication-rendered-dosage S1..1stringRendered Dosage Instruction
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-rendered-dosage
... ext-medicationorder-protocol S0..10string, uri, Shared Health IdentifierProtocol, order set, guideline, etc.
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-protocol
... ext-medicationorder-treatment-type S0..1codeACU | CHRON
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-treatment-type
Binding: PrescriptionTreatmentCategory (20190415) (required)
... ext-medicationorder-supportinginfo S0..3Reference()Allergies, height, weight, etc.
URL: http://hl7.org/fhir/StructureDefinition/extension-MedicationRequest.supportingInfo profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-supportinginfo
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..3(Slice Definition)An identifier intended for computation
Slice: Unordered, Open by pattern:type
.... identifier:EMR-id S1..1PrescribeIT® Prescriber Prescription IdentifierEMR Prescription Identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... coding SΣ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system, value:code
....... coding:All Slices Content/Rules for all slices
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system SΣ1..1uriIdentity of the terminology system
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeSymbol in syntax defined by the system
........ display SΣ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
....... coding:placer SΣ0..*CodingCode defined by a terminology system
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/identifier-type
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
........ display SΣ0..1stringRepresentation defined by the system
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... system SΣI1..1uriThe namespace for the identifier
EMR-id-branch-2: This must be an OID ending in .2
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:DIS-id SΣ0..2IdentifierDIS Order identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


Required Pattern: At least the following
...... id0..1stringxml:id (or equivalent in JSON)
...... extension0..*ExtensionAdditional Content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringxml:id (or equivalent in JSON)
....... extension0..*ExtensionAdditional Content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/v2/0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: RRI
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ0..1uriThe namespace for the identifier
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeactive | on-hold | completed | entered-in-error | stopped | draft
Binding: MedicationOrderStatus (required): A code specifying the state of the prescribing event. Describes the lifecycle of the prescription.


Fixed Value: active
... medication[x] Σ1..1(Slice Definition)Medication to be taken
Slice: Unordered, Closed by type:$this
.... medication[x]:medicationReference SΣ1..1Reference(PrescribeIT® Medication) {c}A reference from one resource to another
... patient SΣ1..1Reference(Shared Health Patient) {b}A reference from one resource to another
... encounter Σ0..1Reference(Encounter)Created during encounter/admission/stay
... dateWritten Σ0..1dateTimeWhen prescription was authorized
... prescriber Σ0..1Reference(Practitioner)Who ordered the medication(s)
... reasonCode S0..5Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionIndicationForUse (20220331) (extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ0..1CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display SΣ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ1..1stringPlain text representation of the concept
Max Length: 2500
... reasonReference Σ0..*Reference(Condition)Condition that supports why the prescription is being written
... dateEnded Σ0..1dateTimeWhen prescription was stopped
... reasonEnded Σ0..1CodeableConceptWhy prescription was stopped
Binding: (unbound) (example): Codes indicating why the medication was terminated; e.g. Adverse reaction, medication change, issue resolved, etc.

... note SΣ0..1AnnotationInformation about the prescription
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text S1..1stringThe annotation - text content
Max Length: 2500
... dosageInstruction SΣ0..*BackboneElementHow medication should be taken
.... id 0..1idxml:id (or equivalent in JSON)
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-medication-dosageinstruction-sequence S1..1integerSequence of dosage instruction
URL: http://hl7.org/fhir/StructureDefinition/extension-Dosage.sequence profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medication-dosageinstruction-sequence
.... ext-medicationorder-dosageinstruction-relationship S0..1codeAND | THEN
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dosageinstruction-relationship
Binding: PrescriptionDosageInstructionLineRelationship (20170626) (required)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... text SΣ0..1stringFree text dosage instructions e.g. SIG
.... additionalInstructions S0..1Shared Health CodeableConcept Text RequiredConcept - reference to a terminology or just text
Binding: (unbound) (example): Codes identifying additional instructions such as "take with water" or "avoid operating heavy machinery".

..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding Σ0..*CodingCode defined by a terminology system
..... text SΣ1..1stringPlain text representation of the concept
Max Length: 2500
.... timing SΣ0..1TimingWhen medication should be administered
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... event SΣ0..1dateTimeWhen the event occurs
..... repeat SΣI0..1ElementWhen the event is to occur
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... bounds[x] SΣ0..1Length/Range of lengths, or (Start and/or end) limits
....... boundsPeriodPeriod
....... boundsQuantityQuantity(Shared Health Duration)
....... boundsRangeRange
...... count SΣ0..1integerNumber of times to repeat
...... countMax SΣ0..1integerMaximum number of times to repeat
...... duration SΣ0..1decimalHow long when it happens
...... durationMax SΣ0..1decimalHow long when it happens (Max)
...... durationUnit SΣ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: x_TimeUnitsOfMeasure (20230710) (required)
...... frequency SΣ0..1integerEvent occurs frequency times per period
...... frequencyMax SΣ0..1integerEvent occurs up to frequencyMax times per period
...... period SΣ0..1decimalEvent occurs frequency times per period
...... periodMax SΣ0..1decimalUpper limit of period (3-4 hours)
...... periodUnit SΣ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: x_TimeUnitsOfMeasure (20230710) (required)
..... code Σ0..1CodeableConceptQD | QOD | Q4H | Q6H | BID | TID | QID | AM | PM +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

.... asNeeded[x] SΣ0..1Take "as needed" (for x)
Binding: (unbound) (example): A 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.

..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site[x] Σ0..1(Slice Definition)Body site to administer to
Slice: Unordered, Closed by type:$this
Binding: SNOMED CT Anatomical Structure for Administration Site Codes (example): A coded concept describing the site location the medicine enters into or onto the body.

..... site[x]:siteCodeableConcept S0..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionAdministrationSite (20220331) (extensible)
.... route S0..1Shared Health CodeableConcept Required Text with optional codeConcept - reference to a terminology or just text
Binding: PrescriptionRouteOfAdministration (20190415) (extensible)
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: (unbound) (example): A coded concept describing the technique by which the medicine is administered.

.... dose[x] SΣ0..1Amount of medication per dose
Binding: PrescriptionDoseQuantityUnit (20220331) (extensible)
..... doseQuantityQuantity(PrescribeIT® Drug Quantity for Administration)
..... doseRangeRange(PrescribeIT® Drug Range)
.... rate[x] Σ0..1(Slice Definition)Amount of medication per unit of time
Slice: Unordered, Closed by type:$this
..... rate[x]:rateRatio SΣ0..1RatioAmount of medication per unit of time
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... numerator SI1..1PrescribeIT® Drug Quantity for AdministrationQuantity of a medication
Binding: PrescribedQuantityUnit (20220331) (extensible)
...... denominator SI1..1Shared Health QuantityA measured or measurable amount
.... maxDosePerPeriod SΣ0..1RatioUpper limit on medication per unit of time
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... numerator SI1..1PrescribeIT® Drug Quantity for AdministrationQuantity of a medication
Binding: PrescribedQuantityUnit (20220331) (extensible)
..... denominator SI1..1Shared Health QuantityA measured or measurable amount
... substitution Σ0..1BackboneElementAny restrictions on medication substitution
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ1..1CodeableConceptgeneric | formulary +
Binding: ActSubstanceAdminSubstitutionCode (example): A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription.

.... reason Σ0..1CodeableConceptWhy should (not) substitution be made
Binding: SubstanceAdminSubstitutionReason (example): A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed.

... priorPrescription Σ0..1Reference(MedicationOrder)An order/prescription that this supersedes

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
MedicationOrder.languagerequiredhttp://tools.ietf.org/html/bcp47
MedicationOrder.identifier:EMR-id.userequiredIdentifierUse
MedicationOrder.identifier:EMR-id.typeextensiblePattern: PLAC
MedicationOrder.identifier:DIS-id.userequiredIdentifierUse
MedicationOrder.identifier:DIS-id.typeextensiblePattern: RRI
MedicationOrder.statusrequiredFixed Value: active
MedicationOrder.reasonCodeextensiblePrescriptionIndicationForUse
MedicationOrder.reasonEndedexample
MedicationOrder.dosageInstruction.additionalInstructionsexample
MedicationOrder.dosageInstruction.timing.repeat.durationUnitrequiredx_TimeUnitsOfMeasure
MedicationOrder.dosageInstruction.timing.repeat.periodUnitrequiredx_TimeUnitsOfMeasure
MedicationOrder.dosageInstruction.timing.codepreferredTimingAbbreviation
MedicationOrder.dosageInstruction.asNeeded[x]example
MedicationOrder.dosageInstruction.site[x]exampleSNOMED CT Anatomical Structure for Administration Site Codes
MedicationOrder.dosageInstruction.site[x]:siteCodeableConceptextensiblePrescriptionAdministrationSite
MedicationOrder.dosageInstruction.routeextensiblePrescriptionRouteOfAdministration
MedicationOrder.dosageInstruction.methodexample
MedicationOrder.dosageInstruction.dose[x]extensiblePrescriptionDoseQuantityUnit
MedicationOrder.dosageInstruction.rate[x]:rateRatio.numeratorextensiblePrescribedQuantityUnit
MedicationOrder.dosageInstruction.maxDosePerPeriod.numeratorextensiblePrescribedQuantityUnit
MedicationOrder.substitution.typeexampleActSubstanceAdminSubstitutionCode
MedicationOrder.substitution.reasonexampleSubstanceAdminSubstitutionReason

Constraints

IdPathDetailsRequirements
EMR-id-branch-2MedicationOrder.identifier:EMR-id.systemThis must be an OID ending in .2
: $this.matches('^urn\\:oid\\:(\\d+\\.)+2$')
tim-3MedicationOrder.dosageInstruction.timing.repeatEither frequency or when can exist, not both
: ((period.exists() or frequency.exists()) and when.exists()).not()
tim-1MedicationOrder.dosageInstruction.timing.repeatif there's a duration, there needs to be duration units
: duration.empty() or durationUnit.exists()
tim-2MedicationOrder.dosageInstruction.timing.repeatif there's a period, there needs to be period units
: period.empty() or periodUnit.exists()
tim-9MedicationOrder.dosageInstruction.timing.repeatIf there's an offset, there must be a when
: offset.empty() or when.exists()
tim-6MedicationOrder.dosageInstruction.timing.repeatIf there's a periodMax, there must be a period
: periodMax.empty() or period.exists()
tim-8MedicationOrder.dosageInstruction.timing.repeatIf there's a countMax, there must be a count
: countMax.empty() or count.exists()
tim-7MedicationOrder.dosageInstruction.timing.repeatIf there's a durationMax, there must be a duration
: durationMax.empty() or duration.exists()
tim-4MedicationOrder.dosageInstruction.timing.repeatduration SHALL be a non-negative value
: duration.exists() implies duration >= 0
qty-3MedicationOrder.dosageInstruction.rate[x]:rateRatio.numeratorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1MedicationOrder.dosageInstruction.rate[x]:rateRatio.numeratorThe comparator is not used on a SimpleQuantity
: comparator.empty()
qty-3MedicationOrder.dosageInstruction.rate[x]:rateRatio.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
qty-3MedicationOrder.dosageInstruction.maxDosePerPeriod.numeratorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
sqty-1MedicationOrder.dosageInstruction.maxDosePerPeriod.numeratorThe comparator is not used on a SimpleQuantity
: comparator.empty()
qty-3MedicationOrder.dosageInstruction.maxDosePerPeriod.denominatorIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()