3.54 StructureDefinition: PrescribeIT Prescription
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder
3.54.1 Scope and Usage
This profile is used in the following tasks:
- Task e140-m - Cancel RX Fill Request
- Task e161-m - RX Renewal Response - Denied
- Task e164-m - RX Renewal Response - Under Review
- Task e180-m - Deferred RX Fill Request
- Task p160-m - RX Renewal Create Request
An Excel spreadsheet providing guidance on how to populate dosage instructions can be found here.
3.54.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationOrder
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
MedicationOrder | 0..* | Definition: 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 p160-m - RX Renewal Create Request, this conveys the details of a single medication order for which the renewal is being requested. For Task e120-m - Renewal RX Fill Request, this conveys the medication order for which a fill is being requested. | |
id | 1..1 | id | Definition: 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..* | Resource | Definition: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments: Conformance Rule: This will be used to contain the Medication resource. No other resources should be 'contained'. |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (category) | 0..1 | Medication Order Category | Definition: Sub-categorizes medication prescriptions into drugs, devices, compounds, etc. May be used to apply sub-type-specific constraints Comments: Conformance Rule: If no appropriate code exists, provide details using the 'text' component. |
extension (renderedDosageInstruction) | 1..1 | Medication Rendered Dosage Instruction | Definition: A free form textual specification generated from the input specifications as created by the provider.This is made up of either an 'Ad-hoc instruction' or 'Textual rendition of the structured dosage lines', plus route, dosage unit, and other pertinent administration information specified by the provider. Comments: Usage Note: This is intended to provide all dosage instructions to the Pharmacist in a clear human-readable format. This field will be displayed to the Pharmacist upon receipt of the prescription. Note: This must be as clear as possible and must include all instructions because the EMR may not provide individual/structured dosage instructions. When the Prescription cannot be delivered electronically, the rendered dosage instruction will be printed on the fax and will be the only source of dosage information. It is recognized that very complex instructions may be conveyed as text only (not as structured data). Example: take 500 mg twice a day at breakfast and at lunch AND 250 mg once a day at bedtime - THEN (new dosage line)). If the EMR submits structured dosage instructions, this must be consistent with the textual instructions provided here. The PMS may ignore the structured frequency, or override it to align with the textual instructions. Example: the EMR may enter frequency (multiplier of the dose) in their system like this (2 qam and 3 qhs ), in the structured frequency. The textual instructions could say Take 2 tablets in the morning and 3 at bedtime. Conformance Rule: The rendered dosage instruction MUST contain ALL dosage instructions. This includes ALL child elements of dosage instruction, such as dosage quantity, dosage unit, frequency, etc) in human readable form and must be able to stand on its own. This field will include all of the information contained in the structured dosage as well as patient instructions (eg take with food, starting one day before dental appointment), assembled into one field and formatted as human-readable. Coded values codes should not be used (e.g. 'days' should be used instead of 'd', the code of PO as 'oral' ) Conformance Rule: MUST allow all printable characters and carriage return/line feeds. 5000 character max. 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 field, they can both be included here. |
extension (protocol) | 0..10 | Medication Order Protocol | Definition: Identifies the Protocol, Order set, Guideline or other definition that guided the creation of this prescription Comments: Conformance Rule: If EMR's support as a discrete data element, this should be populated; else it will be part of the Dispenser Instructions (MedicationOrder.note.text). If it is present, it must be displayed to the Pharmacist. Usage Note: To date, the only known use case is for LU codes. If sent as an identifier, no guidance yet exists on appropriate values for the 'system' component. |
extension (treatmentType) | 0..1 | Medication Order Treatment Type | Definition: Identifies whether this drug is for acute or chronic use Comments: Conformance Rule: Must be populated if known |
extension (supportingInformation) | 0..* | Medication Order Supporting Information | Definition: Additional information that relevant to the order. E.g. observations, allergies, etc. Comments: 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). Conformance Rule: All known patient allergies must be included in the Medication Order. |
extension (detectedIssue) | 0..* | Request-related Detected Issues | Definition: A set of managed and relevant detected issues that should be transmitted along with a prescription or order to provide context during the execution of that order. Comments: Usage Note: This is a reference to the resource which is used to convey Managed Detected Issues (DUR) |
extension (coverage) | 0..1 | Request-related Coverage (NOT SUPPORTED) | Definition: Identifies insurance coverage that may be relevant to fulfilling an order |
extension (pharmacyInstructions) | 0..1 | Request Dispenser Instructions | Definition: Provides additional instructions from the prescriber to the pharmacy or other dispenser Comments: Usage Note: To convey explicit instructions to the Pharmacist/dispenser related to this medication order. Usage Note: If the PMS solution is unable to display the entire instructions, then it is expected that the current solution has a fail-over process and will create a printout of the prescription. Conformance Rule: PMS solution must be able to print out the entire prescription with ALL dispensing instructions included on the printout. Minimum data elements can be based on the eFax model Conformance Rule: When 'compliance pack' is indicated on the prescription within the EMR, populate the pharmacist instruction/dispenser instructions with 'COMPLIANCE PACK REQUESTED' Usage Note: In the case where the prescriber indicates the concept of ‘do not adapt’ (meaning that the pharmacist should not alter the prescription based on the patient's weight as an example), this direction to the pharmacist should be conveyed in human language in this field. Conformance Rule: If a prescriber wishes to indicate that there is no substitution it must be included as part of the pharmacy instructions. Conformance Rule: LU Codes must be clearly conveyed as part of the Pharmacists Instructions. If vendors are programmitically mapping into this field, they should use a prefix of LU Code before the identifier. |
extension (over25dur) | 0..1 | Medication Order - Over 25 DUR | Definition: Indicates that the total number of managed DURs associated with the prescription exceeds the reporting limit of 25 Comments: Conformance Rule: Set value = true when there are more than 25 warnings returned in the EMR DUR system |
extension (monitoreddrug) | 0..1 | Medication Order - Monitored Drug | Definition: Allows prescribers to indicate that the prescription is for a 'Monitored Drug' (e.g. compound) value in the prescription message to the pharmacies Comments: Conformance Rule: The prescriber should have the ability to set this flag when the medication is a compound. The absence of this extension means (i.e. value=”false”) that this is not a monitored substance. Usage Note: Provinces may require prescribers to enter this value when a compound contains a monitored substance (e.g. narcotic) to support Prescription Drug Monitoring Programs (e.g. the Alberta Triplicate Prescription Program). |
extension (norenewals) | 0..1 | Medication Order - No Prescription Renewals | Definition: Indicates that the prescriber will not support renewals for this prescription Comments: Conformance Rule: The PMS should present a warning to the dispenser if they create a renewal request for a prescription that has this flag set to indicate 'no renewals'. The PMS should allow the renewal to be submitted along with an explanation as there may be exceptional circumstances. |
identifier | 1..3 | Shared Health Identifier | Slice: Unordered, Open by value: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..1 | PrescribeIT™ Prescriber Prescription Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. Comments: In the context of a net new prescription (e110, e120, e162, or e163), this identifier is generated by the EMR. The prescription number should be sent in the value element and should be an OID of the form [vendor root].[application instance node].2 expressed as a urn (e.g. urn:oid:2.16.840.1.113883.3.368.1234.2). In the context of a Renewal Request (p160), the prescription number for the prescription that is being requested to be renewed should be used for this element. In most cases, this will be a value that was originally generated by an EMR. However, in some cases (such as the renewal of a paper/fax prescription), there will be no EMR generated prescription number, and in this case, the PMS should generate a number. In the context of an Rx Response - Denied (e161), or an Rx Response - Under Review (e164), this element should be populated with the MedicationOrder.identifier(emr-id) provided in the Renewal Request (p160). In the context of a Cancel Rx Fill Request (e140), this element should be populated with the same Rx that was included in the original net new prescription message (e110, e120, e162, or e163). |
type | 1..1 | Shared Health CodeableConcept Code | Binding: Identifier Type Codes (extensible) 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..* | Coding | Slice: 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..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: |
code | 1..1 | code | 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). |
coding (placer) | 1..* | Coding | 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..1 | uri | Fixed 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..1 | code | Fixed 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 |
system | 1..1 | uri | 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. |
value | 1..1 | string | Example' 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. |
identifier (dis-id) | 0..2 | Identifier | Definition: External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system. Comments: Usage Note: When an e110-m, e120-m, e162-m or e163-m 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 are to use this identifier to record the dispense event against the correct DIS Prescription identifier. This element will not be present in the message transmitted from the EMR to the PrescribeIT™ Switch. There should only be 2 identifiers in the case of a border town such as Lloydminster where the DIS identifier in both provinces needs to be stored. |
type | 1..1 | Shared Health CodeableConcept Code | Binding: Identifier Type Codes (extensible) 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..1 | uri | 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. |
value | 1..1 | string | Example' 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..1 | code | Binding: MedicationOrderStatus (required) Fixed Value: active Definition: A code specifying the state of the order. Generally this will be active or completed state. Comments: Fixed value: active |
medicationReference | 1..1 | Reference(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. E.g. <reference value='#med'/> |
patient | 1..1 | Reference(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. |
dateWritten | 0..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date (and perhaps time) when the prescription was written. Comments: Conformance Rule: Must be either equal to or earlier then the MedicationOrder.dispenseRequest.valididityPeriod.start element. Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
prescriber | 1..1 | Reference(Shared Health Practitioner) {b} | Definition: A reference from one resource to another. Comments: Conformance Rule: When requesting that a prescription be filled or responding to a renewal request, this SHALL be the practitioner initiating the message. |
reasonCode | 0..5 | Shared Health CodeableConcept Required Text with optional code | Binding: PrescriptionIndicationForUse (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: In the case where the prescriber wants to send an Indication for Use that is not included in the value set the prescriber must be able to send a text value without a code. |
text | 1..1 | string | Max 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: Usage Note: When conveying the reason, this must be populated |
note | 0..1 | Annotation | Max Length: 2500 Definition: Extra information about the prescription that could not be conveyed by the other attributes. |
text | 1..1 | string | Definition: The text of the annotation. Comments: Usage Note: This is used as an additional pharmacy note that is unrelated to the dispensing instructions. Eg. Do not fill immediately, Patient is coming in on July 12th for Booster shot. Conformance Rule: PMS Vendors MUST display this to the pharmacist as it may contain important information. There could be Patient Instructions in here, inadvertently due to current prescribing behaviours. |
dosageInstruction | 0..* | BackboneElement | Definition: 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..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (sequence) | 1..1 | Medication Dosage Line Sequence | Definition: 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..1 | Medication Order Dosage Instruction Relationship | Definition: 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 third dosage line, etc.) this must be present for all dosage lines except for the FIRST dosage line. Conformance Rule: ANDs and THENs should not be mixed due to ambiguity of meaning. |
text | 0..1 | string | Definition: Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Comments: Conformance Rule: When providing multiple dosage lines can be expressed individually. All dosage lines (full text content) must be concatenated into the RENDERED_DOSAGE_INSTRUCTION as PMS will not be forced to support the receipt of individual lines. Usage Note: This is a string that is typically composed of the route, duration, dose, frequency, per 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..1 | Shared Health CodeableConcept Text | Binding: (unbound) (example) inv-1: Must have coding or text but not both 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. Usage Note: 'Coding' is not available, so 'Text' is expected to be used Usage Note: At this time there is no known coding system. Therefore ‘text’ will be used. |
coding | 0..* | Coding | 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..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: |
code | 1..1 | code | 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). |
text | 1..1 | string | Max Length: 5000 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: Very often the text is the same as a displayName of one of the codings. |
timing | 0..1 | Timing | Definition: 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'. |
repeat | 0..1 | Element | tim-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. |
boundsPeriod | 0..1 | Period | Definition: boundsPeriod defines the start and/or end date of the period over which all the periods should take place for a given dosage line. For example, if the prescriber wants to a patient to take one pill daily for 10 days, but the prescriber only wants the patient to start taking the pills one week from now, the start date for bounds period would be 10 days from now (if the script was being written on Feb 1st, 2018, the start date within bounds period would be Feb 10th). |
count | 0..1 | integer | Definition: 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..1 | integer | Definition: 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..1 | decimal | Definition: 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..1 | decimal | Definition: 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..1 | code | Binding: UnitsOfTime (required) Definition: The units of time for the duration, in UCUM units. Comments: Codes are from http://unitsofmeasure.org (h | d | wk | etc.) |
frequency | 0..1 | integer | Definition: 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..1 | integer | Definition: 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..1 | decimal | Definition: 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..1 | decimal | Definition: 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..1 | code | Binding: UnitsOfTime (required) Definition: The units of time for the period in UCUM units. Comments: Codes are from http://unitsofmeasure.org (h | d | wk | etc.) |
asNeeded[x] | 0..1 | boolean, CodeableConcept | Binding: (unbound) (example) 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. |
siteCodeableConcept | 0..1 | Shared Health CodeableConcept Required Text with optional code | Binding: PrescriptionAdministrationSite (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..1 | Shared Health CodeableConcept Required Text with optional code | Binding: PrescriptionRouteOfAdministration (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. Also specified for Multi-dosage lines. |
dose[x] | 0..1 | PrescribeIT Drug Quantity for Administration, PrescribeIT Drug Range | 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] | 0..1 | Ratio | Definition: Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. 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..1 | PrescribeIT Drug Quantity for Administration | 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..1 | Shared Health Quantity | qty-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..1 | Ratio | Definition: The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. Comments: Conformance Rule: When providing a structured SIG, this should be populated when appropriate. |
numerator | 1..1 | PrescribeIT Drug Quantity for Administration | 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..1 | Shared Health Quantity | qty-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.) |
dispenseRequest | 1..1 | BackboneElement | 1: Must have at least one of quantity and expectedSupplyDuration 3: Must have at least one of total prescribed quantity and total days supply Definition: Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department. |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (dispenseInterval) | 0..1 | Medication Order Dispense Interval | Definition: Optional Extensions Element - found in all resources. Comments: Indicates the minimum period of time that must pass between dispensing events. Conformance Rule: Only days are currently support as a measurement of dispenseInterval. Example: A prescriber instructs a patient to take 3 Tylenol 3 tablets every day as needed for pain for 90 days. However, the prescriber does not wish the patient to have more than 30 days supply at any given time so the prescriber instructs the pharmacist that the dispenseInterval is 30 days. The pharmacist then does 3 partial fills of 90 tablets (or 30 days supply) over the 90 day period. |
extension (trialEligibility) | 0..1 | Medication Order Trial Dispense Eligibility | Definition: Optional Extensions Element - found in all resources. Comments: Conformance Rule: If eligible for trial, this must be set to 'true' and presented to the Pharmacist. Conformance Rule: This is ONLY populated if it is for trial, else it is assumed not to be eligble. Note: Prescribers may include this information in notes. |
extension (firstFillInstructions) | 0..1 | Medication Order Dispense First Fill Instructions | 2: At least one of first fill quantity or first fill days supply must be specified Definition: Optional Extensions Element - found in all resources. Comments: Conformance Rule: If this is supported within the EMR as a discrete data element, this must be populated. (e.g. this could map to 'Must be filled within') Conformance Rule: First fill is only populated if required; if not populated, the general dispenseRequest instructions apply to all fills. You only specify an initial fill quantity if you have refills. Usage Note: There are times when a patient's drug plan limits what can be dispensed (i.e. 7 days initially as a trial). In this situation, the patient is informed that their drug plan only pays for 7 days. The pharmacist will ask the patient to sign the Rx that they have been informed are ok with changing the quantity to 7 days and then dispense the 7 days. The patient's file is updated to note that 7 days was dispensed as a trial period. After the initial 7 days, the patient will still have 353 tablets to be used. (90 tabs x 4 authorized fills = 360 tabs - 7 tabs dispensed as trial. |
extension (maxDispense) | 0..1 | Medication Order Max Dispense | Definition: Identifies the maximum quantity authorized to be dispensed at one time. Comments: Conformance Rule: If this is supported within the EMR as a discrete data element, this must be populated. Example: A prescriber instructs a patient to take 3 Tylenol 3 tablets every day as needed for pain for 90 days. However, the prescriber does not wish the patient to have more than 30 days supply at any given time so the prescriber instructs the pharmacist that the maxDispense is 90 tablets. The pharmacist then does 3 partial fills of 90 tablets (or 30 days supply) over the 90 day period. |
extension (totalPrescribedQuantity) | 0..1 | Medication Order Total Prescribed Quantity | Definition: Optional Extensions Element - found in all resources. Comments: Conformance Rule: The Total Prescribed Quantity is not mandatory but must be supplied if the value is entered by the user or can be calculated by the system. |
extension (totalDaysSupply) | 0..1 | Medication Order Total Prescribed Days Supply | Definition: Optional Extensions Element - found in all resources. Comments: Conformance Rule: Must be populated when the Total Days Supply is entered by the user or when the Total Days Supply can be calculated by the system. Conformance Rule: Code must be 'd' and system must be 'http://unitsofmeasure.org'. |
validityPeriod | 1..1 | Period | Definition: This indicates the validity period of a prescription (stale dating the Prescription). Comments: Conformance Rule: Must be either equal to or later then the MedicationOrder.dateWritten element. |
start | 1..1 | dateTime | Definition: The start of the period. The boundary is inclusive. Comments: Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
end | 0..1 | dateTime | Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Comments: Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
numberOfRepeatsAllowed | 0..1 | positiveInt | Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. Comments: Conformance Rule: This must be populated when the number of repeats is 1 or more. As this field only allows a positive integer, this is not populated if there are no refills allowed. Guidance: For narcotics, if this is incorrectly populated, the PMS could choose not to reject the message; rather they can adjust for the dispense. |
quantity | 0..1 | PrescribeIT Drug Quantity | 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: If days supply is NOT present, this MUST be populated. |
expectedSupplyDuration | 0..1 | Duration | Definition: Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. Comments: Conformance Rule: This maps to 'duration' in some EMR's. Must be populated when this is a discrete data element in the EMR; else this is sent as part of the textual description. Conformance Rule: If Fill Quantity is NOT populated, this must be present. |
value | 1..1 | decimal | Definition: The value of the measured amount. The value includes an implicit precision in the presentation of the value. Comments: The implicit precision in the value should always be honored. |
system | 1..1 | uri | Fixed Value: http://unitsofmeasure.org Definition: The identification of the system that provides the coded form of the unit. Comments: Fixed value: http://unitsofmeasure.org |
code | 1..1 | code | Fixed Value: d Definition: A computer processable form of the unit in some unit representation system. Comments: Fixed value: d |
priorPrescription | 0..1 | Reference(PrescribeIT Prescription) {r} | Definition: A link to a resource representing an earlier order or prescription that this order supersedes. Comments: When present with a prescription number, this must be in the same form as was present on the original prescription - generally with a system of OID of the form [vendor root].[application instance node].2 expressed as a urn (e.g. urn:oid:1.2.3.4). The 'value' element will contain the actual RX Number. Note that the system value must refer to the namespace of the system that created the original prescription, which may not always be the system performing the renewal. In the context of Task e120-m: Conformance Rule: This is mandatory and MUST be populated with the EMR generated eRX number (PRESCRIPTION_NUMBER) of the medication used as the basis for the new prescription for the same therapy. Its purpose is to identify the original prescription that drove the creation of this Renewal Fill Request. Note: This identifier may not be recognized by the PMS receiving this as it could have been a paper prescription or an ePrescription that was originally sent to another pharmacy. For transition period, from paper to electronic, there would not be an EMR-assigned number. In this case, EMR MUST populate with a value of 'NA' in the Identifier.value and omit the system. In the context of Task e140-m: This should include any prior prescription information that was included in the original prescription request from the EMR that is being cancelled. If the original EMR prescription request has this segment empty, then it should be empty for the e140-m. In the context Tasks e162-m and e163-m: Conformance Rule: This is mandatory and MUST be populated with the MedicationOrder.identifier as specified in the p160 being responded to. In the context of Task p160-m: Conformance Rule: The MedicationOrder transmitted in a p160 is the prior order that is being asked to be renewed. If this came in as an e110, priorPrescription will be absent. If this came in as an e120, priorPrescription will be present. If it was entered into the PMS as a paper or fax prescription, priorPrescription may not be known (in which case it will be absent), or may be set to 'NA' if the prescription was known to be a renewal, but the prescription identifier of the prior request is unknown). |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (identifier) | 0..1 | Referenced Requisition identifier | Definition: Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL Comments: When this is present, the reference is typically omitted 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. |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
valueIdentifier | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. Comments: When this is present, the reference is typically omitted |
display | 0..1 | string | Definition: Plain text narrative that identifies the resource in addition to the resource reference. Comments: This can be populated with the prescription number as a human-readable hint for downstream systems that don't recognize the extension. However, there is no known need for this element at present. |
This structure is derived from MedicationOrder
Summary
Mandatory: 12 elements (12 nested mandatory elements)
Must-Support: 82 elements
Fixed Value: 3 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://prescribeit.ca/fhir/StructureDefinition/profile-medication
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-patient
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-text-required-with-code
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-text
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-quantity-drug-admin
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-range-drug
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-quantity
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-quantity-drug
- http://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder
Extensions
This structure refers to these extensions:
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-category
- http://prescribeit.ca/fhir/StructureDefinition/ext-medication-rendered-dosage
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-protocol
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-treatment-type
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-supportinginfo
- http://prescribeit.ca/fhir/StructureDefinition/ext-request-detectedissue
- http://prescribeit.ca/fhir/StructureDefinition/ext-request-coverage
- http://prescribeit.ca/fhir/StructureDefinition/ext-request-dispenser-instructions
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-over-25-dur
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-monitored-drug
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-no-renewals
- http://prescribeit.ca/fhir/StructureDefinition/ext-medication-dosageinstruction-sequence
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dosageinstruction-relationship
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-interval
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-trial
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-first-fill
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-max
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-quantity
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-days-supply
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
Slices
This structure defines the following Slices:
- The element MedicationOrder.identifier is sliced based on the value of value:type
This structure is derived from MedicationOrder
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationOrder | SΣ | 0..* | Prescription of medication to for patient | |
id | SΣ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | S | 1..* | Resource | Contained, inline Resources |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-medicationorder-category | S | 0..1 | Shared Health CodeableConcept Text | Medication Order Category URL: http://hl7.org/fhir/StructureDefinition/extension-MedicationRequest.category profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-category Binding: PrescriptionType (extensible) |
ext-medication-rendered-dosage | S | 1..1 | string | Rendered Dosage Instruction URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-rendered-dosage |
ext-medicationorder-protocol | S | 0..10 | string, uri, Shared Health Identifier | Protocol, order set, guideline, etc. URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-protocol |
ext-medicationorder-treatment-type | S | 0..1 | code | ACU | CHRON URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-treatment-type Binding: PrescriptionTreatmentCategory (required) |
ext-medicationorder-supportinginfo | S | 0..* | Reference(PrescribeIT List - Allergies | PrescribeIT Pharmacy-related Observation) {b} | Allergies, height, weight, etc. URL: http://hl7.org/fhir/StructureDefinition/extension-MedicationRequest.supportingInfo profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-supportinginfo |
ext-request-detectedissue | S | 0..* | Reference(PrescribeIT DUR) {b} | Managed DUR and other issues URL: http://prescribeit.ca/fhir/StructureDefinition/ext-request-detectedissue |
ext-request-coverage | S | 0..1 | Reference(PrescribeIT Coverage (NOT SUPPORTED)) {b} | Insurance coverage URL: http://prescribeit.ca/fhir/StructureDefinition/ext-request-coverage |
ext-request-dispenser-instructions | S | 0..1 | string | Dispenser Instructions URL: http://prescribeit.ca/fhir/StructureDefinition/ext-request-dispenser-instructions |
ext-medicationorder-over-25-dur | S | 0..1 | boolean | More than 25 DURs? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-over-25-dur |
ext-medicationorder-monitored-drug | S | 0..1 | boolean | Monitored Drug? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-monitored-drug |
ext-medicationorder-no-renewals | S | 0..1 | boolean | No Prescription Renewals? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-no-renewals |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | Shared Health Identifier | An identifier intended for computation Slice: Unordered, Open by value:type | |
identifier | S | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | EMR Prescription ID |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/identifier-type","code":"PLAC"}]} |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
system | SΣ | 1..1 | uri | The 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..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
identifier | SΣ | 0..2 | Identifier | Drug Information System's order number |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"RRI"}]} |
system | SΣ | 0..1 | uri | The 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..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?!SΣ | 1..1 | code | active | on-hold | completed | entered-in-error | stopped | draft Binding: MedicationOrderStatus (required) Fixed Value: active |
medicationReference | SΣ | 1..1 | Reference(PrescribeIT Medication) {c} | A reference from one resource to another |
patient | SΣ | 1..1 | Reference(Shared Health Patient) {b} | A reference from one resource to another |
encounter | Σ | 0..1 | Reference(Encounter) | Created during encounter/admission/stay |
dateWritten | SΣI | 0..1 | dateTime | When prescription was authorized created-full: Must be at least a full date. i.e. yyyy-mm-dd |
prescriber | SΣ | 1..1 | Reference(Shared Health Practitioner) {b} | A reference from one resource to another |
reasonCode | S | 0..5 | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PrescriptionIndicationForUse (extensible) |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | SΣ | 1..1 | string | Plain text representation of the concept Max Length: 2500 |
reasonReference | Σ | 0..* | Reference(Condition) | Condition that supports why the prescription is being written |
dateEnded | Σ | 0..1 | dateTime | When prescription was stopped |
reasonEnded | Σ | 0..1 | CodeableConcept | Why prescription was stopped Binding: (unbound) (example) |
note | SΣ | 0..1 | Annotation | Information about the prescription Max Length: 2500 |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
author[x] | Σ | 0..1 | Reference(Practitioner | Patient | RelatedPerson), string | Individual responsible for the annotation |
time | Σ | 0..1 | dateTime | When the annotation was made |
text | S | 1..1 | string | The annotation - text content |
dosageInstruction | SΣ | 0..* | BackboneElement | How medication should be taken |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-medication-dosageinstruction-sequence | S | 1..1 | positiveInt | Sequence 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 | S | 0..1 | code | AND | THEN URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dosageinstruction-relationship Binding: PrescriptionDosageInstructionLineRelationship (required) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
text | SΣ | 0..1 | string | Free text dosage instructions e.g. SIG |
additionalInstructions | SI | 0..1 | Shared Health CodeableConcept Text | Concept - reference to a terminology or just text Binding: (unbound) (example) |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | SΣ | 1..1 | string | Plain text representation of the concept Max Length: 5000 |
timing | SΣ | 0..1 | Timing | When medication should be administered |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
event | Σ | 0..* | dateTime | When the event occurs |
repeat | SΣI | 0..1 | Element | When the event is to occur |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
boundsPeriod | SΣ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
count | SΣ | 0..1 | integer | Number of times to repeat |
countMax | SΣ | 0..1 | integer | Maximum number of times to repeat |
duration | SΣ | 0..1 | decimal | How long when it happens |
durationMax | SΣ | 0..1 | decimal | How long when it happens (Max) |
durationUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
frequency | SΣ | 0..1 | integer | Event occurs frequency times per period |
frequencyMax | SΣ | 0..1 | integer | Event occurs up to frequencyMax times per period |
period | SΣ | 0..1 | decimal | Event occurs frequency times per period |
periodMax | SΣ | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
code | Σ | 0..1 | CodeableConcept | QD | QOD | Q4H | Q6H | BID | TID | QID | AM | PM + Binding: TimingAbbreviation (preferred) |
asNeeded[x] | SΣ | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: (unbound) (example) |
siteCodeableConcept | S | 0..1 | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PrescriptionAdministrationSite (extensible) |
route | S | 0..1 | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PrescriptionRouteOfAdministration (extensible) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: (unbound) (example) |
dose[x] | SΣ | 0..1 | PrescribeIT Drug Quantity for Administration, PrescribeIT Drug Range | Amount of medication per dose |
rate[x] | SΣ | 0..1 | Ratio | Amount of medication per unit of time |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
numerator | SI | 1..1 | PrescribeIT Drug Quantity for Administration | Quantity of a medication |
denominator | SI | 1..1 | Shared Health Quantity | A measured or measurable amount |
maxDosePerPeriod | SΣ | 0..1 | Ratio | Upper limit on medication per unit of time |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
numerator | SI | 1..1 | PrescribeIT Drug Quantity for Administration | Quantity of a medication |
denominator | SI | 1..1 | Shared Health Quantity | A measured or measurable amount |
dispenseRequest | SΣI | 1..1 | BackboneElement | Medication supply authorization 1: Must have at least one of quantity and expectedSupplyDuration 3: Must have at least one of total prescribed quantity and total days supply |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-medicationorder-dispense-interval | S | 0..1 | Duration | Dispense interval URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-interval |
ext-medicationorder-dispense-trial | S | 0..1 | boolean | Trial fill authorized? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-trial |
ext-medicationorder-dispense-first-fill | SI | 0..1 | (Complex) | First fill instructions URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-first-fill 2: At least one of first fill quantity or first fill days supply must be specified |
ext-medicationorder-dispense-max | S | 0..1 | PrescribeIT Drug Quantity | Maximum prescribed quantity URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-max |
ext-medicationorder-total-quantity | S | 0..1 | PrescribeIT Drug Quantity | Total prescribed quantity URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-quantity |
ext-medicationorder-total-days-supply | S | 0..1 | Duration | Total prescribed days supply URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-days-supply |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
medicationCodeableConcept | 0..1 | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PrescriptionMedicinalProduct (extensible) | |
validityPeriod | SΣ | 1..1 | Period | Time period supply is authorized for |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
start | SΣI | 1..1 | dateTime | Starting time with inclusive boundary |
end | SΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
numberOfRepeatsAllowed | SΣ | 0..1 | positiveInt | Number of refills authorized |
quantity | SI | 0..1 | PrescribeIT Drug Quantity | Quantity of a medication |
expectedSupplyDuration | SΣ | 0..1 | Duration | Number of days supply per dispense |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | Σ | 0..1 | string | Unit representation |
system | SΣI | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: d |
substitution | Σ | 0..1 | BackboneElement | Any restrictions on medication substitution |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 1..1 | CodeableConcept | generic | formulary + Binding: ActSubstanceAdminSubstitutionCode (example) |
reason | Σ | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example) |
priorPrescription | SΣ | 0..1 | Reference(PrescribeIT Prescription) {r} | An order/prescription that this supersedes |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-reference-identifier | S | 0..1 | Shared Health Identifier | Referenced identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
valueIdentifier | S | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | An identifier intended for computation |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | SΣ | 0..1 | string | Text alternative for the resource |
Documentation for this format |
Grid View
This structure is derived from MedicationOrder
Name | Card. | Type | Constraints and Usage |
---|---|---|---|
MedicationOrder | 0..* | Definition: 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 p160-m - RX Renewal Create Request, this conveys the details of a single medication order for which the renewal is being requested. For Task e120-m - Renewal RX Fill Request, this conveys the medication order for which a fill is being requested. | |
id | 1..1 | id | Definition: 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..* | Resource | Definition: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments: Conformance Rule: This will be used to contain the Medication resource. No other resources should be 'contained'. |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (category) | 0..1 | Medication Order Category | Definition: Sub-categorizes medication prescriptions into drugs, devices, compounds, etc. May be used to apply sub-type-specific constraints Comments: Conformance Rule: If no appropriate code exists, provide details using the 'text' component. |
extension (renderedDosageInstruction) | 1..1 | Medication Rendered Dosage Instruction | Definition: A free form textual specification generated from the input specifications as created by the provider.This is made up of either an 'Ad-hoc instruction' or 'Textual rendition of the structured dosage lines', plus route, dosage unit, and other pertinent administration information specified by the provider. Comments: Usage Note: This is intended to provide all dosage instructions to the Pharmacist in a clear human-readable format. This field will be displayed to the Pharmacist upon receipt of the prescription. Note: This must be as clear as possible and must include all instructions because the EMR may not provide individual/structured dosage instructions. When the Prescription cannot be delivered electronically, the rendered dosage instruction will be printed on the fax and will be the only source of dosage information. It is recognized that very complex instructions may be conveyed as text only (not as structured data). Example: take 500 mg twice a day at breakfast and at lunch AND 250 mg once a day at bedtime - THEN (new dosage line)). If the EMR submits structured dosage instructions, this must be consistent with the textual instructions provided here. The PMS may ignore the structured frequency, or override it to align with the textual instructions. Example: the EMR may enter frequency (multiplier of the dose) in their system like this (2 qam and 3 qhs ), in the structured frequency. The textual instructions could say Take 2 tablets in the morning and 3 at bedtime. Conformance Rule: The rendered dosage instruction MUST contain ALL dosage instructions. This includes ALL child elements of dosage instruction, such as dosage quantity, dosage unit, frequency, etc) in human readable form and must be able to stand on its own. This field will include all of the information contained in the structured dosage as well as patient instructions (eg take with food, starting one day before dental appointment), assembled into one field and formatted as human-readable. Coded values codes should not be used (e.g. 'days' should be used instead of 'd', the code of PO as 'oral' ) Conformance Rule: MUST allow all printable characters and carriage return/line feeds. 5000 character max. 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 field, they can both be included here. |
extension (protocol) | 0..10 | Medication Order Protocol | Definition: Identifies the Protocol, Order set, Guideline or other definition that guided the creation of this prescription Comments: Conformance Rule: If EMR's support as a discrete data element, this should be populated; else it will be part of the Dispenser Instructions (MedicationOrder.note.text). If it is present, it must be displayed to the Pharmacist. Usage Note: To date, the only known use case is for LU codes. If sent as an identifier, no guidance yet exists on appropriate values for the 'system' component. |
extension (treatmentType) | 0..1 | Medication Order Treatment Type | Definition: Identifies whether this drug is for acute or chronic use Comments: Conformance Rule: Must be populated if known |
extension (supportingInformation) | 0..* | Medication Order Supporting Information | Definition: Additional information that relevant to the order. E.g. observations, allergies, etc. Comments: 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). Conformance Rule: All known patient allergies must be included in the Medication Order. |
extension (detectedIssue) | 0..* | Request-related Detected Issues | Definition: A set of managed and relevant detected issues that should be transmitted along with a prescription or order to provide context during the execution of that order. Comments: Usage Note: This is a reference to the resource which is used to convey Managed Detected Issues (DUR) |
extension (coverage) | 0..1 | Request-related Coverage (NOT SUPPORTED) | Definition: Identifies insurance coverage that may be relevant to fulfilling an order |
extension (pharmacyInstructions) | 0..1 | Request Dispenser Instructions | Definition: Provides additional instructions from the prescriber to the pharmacy or other dispenser Comments: Usage Note: To convey explicit instructions to the Pharmacist/dispenser related to this medication order. Usage Note: If the PMS solution is unable to display the entire instructions, then it is expected that the current solution has a fail-over process and will create a printout of the prescription. Conformance Rule: PMS solution must be able to print out the entire prescription with ALL dispensing instructions included on the printout. Minimum data elements can be based on the eFax model Conformance Rule: When 'compliance pack' is indicated on the prescription within the EMR, populate the pharmacist instruction/dispenser instructions with 'COMPLIANCE PACK REQUESTED' Usage Note: In the case where the prescriber indicates the concept of ‘do not adapt’ (meaning that the pharmacist should not alter the prescription based on the patient's weight as an example), this direction to the pharmacist should be conveyed in human language in this field. Conformance Rule: If a prescriber wishes to indicate that there is no substitution it must be included as part of the pharmacy instructions. Conformance Rule: LU Codes must be clearly conveyed as part of the Pharmacists Instructions. If vendors are programmitically mapping into this field, they should use a prefix of LU Code before the identifier. |
extension (over25dur) | 0..1 | Medication Order - Over 25 DUR | Definition: Indicates that the total number of managed DURs associated with the prescription exceeds the reporting limit of 25 Comments: Conformance Rule: Set value = true when there are more than 25 warnings returned in the EMR DUR system |
extension (monitoreddrug) | 0..1 | Medication Order - Monitored Drug | Definition: Allows prescribers to indicate that the prescription is for a 'Monitored Drug' (e.g. compound) value in the prescription message to the pharmacies Comments: Conformance Rule: The prescriber should have the ability to set this flag when the medication is a compound. The absence of this extension means (i.e. value=”false”) that this is not a monitored substance. Usage Note: Provinces may require prescribers to enter this value when a compound contains a monitored substance (e.g. narcotic) to support Prescription Drug Monitoring Programs (e.g. the Alberta Triplicate Prescription Program). |
extension (norenewals) | 0..1 | Medication Order - No Prescription Renewals | Definition: Indicates that the prescriber will not support renewals for this prescription Comments: Conformance Rule: The PMS should present a warning to the dispenser if they create a renewal request for a prescription that has this flag set to indicate 'no renewals'. The PMS should allow the renewal to be submitted along with an explanation as there may be exceptional circumstances. |
identifier | 1..3 | Shared Health Identifier | Slice: Unordered, Open by value: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..1 | PrescribeIT™ Prescriber Prescription Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. Comments: In the context of a net new prescription (e110, e120, e162, or e163), this identifier is generated by the EMR. The prescription number should be sent in the value element and should be an OID of the form [vendor root].[application instance node].2 expressed as a urn (e.g. urn:oid:2.16.840.1.113883.3.368.1234.2). In the context of a Renewal Request (p160), the prescription number for the prescription that is being requested to be renewed should be used for this element. In most cases, this will be a value that was originally generated by an EMR. However, in some cases (such as the renewal of a paper/fax prescription), there will be no EMR generated prescription number, and in this case, the PMS should generate a number. In the context of an Rx Response - Denied (e161), or an Rx Response - Under Review (e164), this element should be populated with the MedicationOrder.identifier(emr-id) provided in the Renewal Request (p160). In the context of a Cancel Rx Fill Request (e140), this element should be populated with the same Rx that was included in the original net new prescription message (e110, e120, e162, or e163). |
type | 1..1 | Shared Health CodeableConcept Code | Binding: Identifier Type Codes (extensible) 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..* | Coding | Slice: 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..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: |
code | 1..1 | code | 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). |
coding (placer) | 1..* | Coding | 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..1 | uri | Fixed 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..1 | code | Fixed 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 |
system | 1..1 | uri | 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. |
value | 1..1 | string | Example' 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. |
identifier (dis-id) | 0..2 | Identifier | Definition: External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records have to be tracked through an entire system. Comments: Usage Note: When an e110-m, e120-m, e162-m or e163-m 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 are to use this identifier to record the dispense event against the correct DIS Prescription identifier. This element will not be present in the message transmitted from the EMR to the PrescribeIT™ Switch. There should only be 2 identifiers in the case of a border town such as Lloydminster where the DIS identifier in both provinces needs to be stored. |
type | 1..1 | Shared Health CodeableConcept Code | Binding: Identifier Type Codes (extensible) 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..1 | uri | 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. |
value | 1..1 | string | Example' 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..1 | code | Binding: MedicationOrderStatus (required) Fixed Value: active Definition: A code specifying the state of the order. Generally this will be active or completed state. Comments: Fixed value: active |
medicationReference | 1..1 | Reference(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. E.g. <reference value='#med'/> |
patient | 1..1 | Reference(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. |
dateWritten | 0..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date (and perhaps time) when the prescription was written. Comments: Conformance Rule: Must be either equal to or earlier then the MedicationOrder.dispenseRequest.valididityPeriod.start element. Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
prescriber | 1..1 | Reference(Shared Health Practitioner) {b} | Definition: A reference from one resource to another. Comments: Conformance Rule: When requesting that a prescription be filled or responding to a renewal request, this SHALL be the practitioner initiating the message. |
reasonCode | 0..5 | Shared Health CodeableConcept Required Text with optional code | Binding: PrescriptionIndicationForUse (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: In the case where the prescriber wants to send an Indication for Use that is not included in the value set the prescriber must be able to send a text value without a code. |
text | 1..1 | string | Max 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: Usage Note: When conveying the reason, this must be populated |
note | 0..1 | Annotation | Max Length: 2500 Definition: Extra information about the prescription that could not be conveyed by the other attributes. |
text | 1..1 | string | Definition: The text of the annotation. Comments: Usage Note: This is used as an additional pharmacy note that is unrelated to the dispensing instructions. Eg. Do not fill immediately, Patient is coming in on July 12th for Booster shot. Conformance Rule: PMS Vendors MUST display this to the pharmacist as it may contain important information. There could be Patient Instructions in here, inadvertently due to current prescribing behaviours. |
dosageInstruction | 0..* | BackboneElement | Definition: 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..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (sequence) | 1..1 | Medication Dosage Line Sequence | Definition: 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..1 | Medication Order Dosage Instruction Relationship | Definition: 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 third dosage line, etc.) this must be present for all dosage lines except for the FIRST dosage line. Conformance Rule: ANDs and THENs should not be mixed due to ambiguity of meaning. |
text | 0..1 | string | Definition: Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Comments: Conformance Rule: When providing multiple dosage lines can be expressed individually. All dosage lines (full text content) must be concatenated into the RENDERED_DOSAGE_INSTRUCTION as PMS will not be forced to support the receipt of individual lines. Usage Note: This is a string that is typically composed of the route, duration, dose, frequency, per 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..1 | Shared Health CodeableConcept Text | Binding: (unbound) (example) inv-1: Must have coding or text but not both 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. Usage Note: 'Coding' is not available, so 'Text' is expected to be used Usage Note: At this time there is no known coding system. Therefore ‘text’ will be used. |
coding | 0..* | Coding | 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..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: |
code | 1..1 | code | 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). |
text | 1..1 | string | Max Length: 5000 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: Very often the text is the same as a displayName of one of the codings. |
timing | 0..1 | Timing | Definition: 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'. |
repeat | 0..1 | Element | tim-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. |
boundsPeriod | 0..1 | Period | Definition: boundsPeriod defines the start and/or end date of the period over which all the periods should take place for a given dosage line. For example, if the prescriber wants to a patient to take one pill daily for 10 days, but the prescriber only wants the patient to start taking the pills one week from now, the start date for bounds period would be 10 days from now (if the script was being written on Feb 1st, 2018, the start date within bounds period would be Feb 10th). |
count | 0..1 | integer | Definition: 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..1 | integer | Definition: 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..1 | decimal | Definition: 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..1 | decimal | Definition: 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..1 | code | Binding: UnitsOfTime (required) Definition: The units of time for the duration, in UCUM units. Comments: Codes are from http://unitsofmeasure.org (h | d | wk | etc.) |
frequency | 0..1 | integer | Definition: 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..1 | integer | Definition: 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..1 | decimal | Definition: 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..1 | decimal | Definition: 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..1 | code | Binding: UnitsOfTime (required) Definition: The units of time for the period in UCUM units. Comments: Codes are from http://unitsofmeasure.org (h | d | wk | etc.) |
asNeeded[x] | 0..1 | boolean, CodeableConcept | Binding: (unbound) (example) 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. |
siteCodeableConcept | 0..1 | Shared Health CodeableConcept Required Text with optional code | Binding: PrescriptionAdministrationSite (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..1 | Shared Health CodeableConcept Required Text with optional code | Binding: PrescriptionRouteOfAdministration (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. Also specified for Multi-dosage lines. |
dose[x] | 0..1 | PrescribeIT Drug Quantity for Administration, PrescribeIT Drug Range | 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] | 0..1 | Ratio | Definition: Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. 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..1 | PrescribeIT Drug Quantity for Administration | 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..1 | Shared Health Quantity | qty-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..1 | Ratio | Definition: The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. Comments: Conformance Rule: When providing a structured SIG, this should be populated when appropriate. |
numerator | 1..1 | PrescribeIT Drug Quantity for Administration | 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..1 | Shared Health Quantity | qty-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.) |
dispenseRequest | 1..1 | BackboneElement | 1: Must have at least one of quantity and expectedSupplyDuration 3: Must have at least one of total prescribed quantity and total days supply Definition: Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department. |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (dispenseInterval) | 0..1 | Medication Order Dispense Interval | Definition: Optional Extensions Element - found in all resources. Comments: Indicates the minimum period of time that must pass between dispensing events. Conformance Rule: Only days are currently support as a measurement of dispenseInterval. Example: A prescriber instructs a patient to take 3 Tylenol 3 tablets every day as needed for pain for 90 days. However, the prescriber does not wish the patient to have more than 30 days supply at any given time so the prescriber instructs the pharmacist that the dispenseInterval is 30 days. The pharmacist then does 3 partial fills of 90 tablets (or 30 days supply) over the 90 day period. |
extension (trialEligibility) | 0..1 | Medication Order Trial Dispense Eligibility | Definition: Optional Extensions Element - found in all resources. Comments: Conformance Rule: If eligible for trial, this must be set to 'true' and presented to the Pharmacist. Conformance Rule: This is ONLY populated if it is for trial, else it is assumed not to be eligble. Note: Prescribers may include this information in notes. |
extension (firstFillInstructions) | 0..1 | Medication Order Dispense First Fill Instructions | 2: At least one of first fill quantity or first fill days supply must be specified Definition: Optional Extensions Element - found in all resources. Comments: Conformance Rule: If this is supported within the EMR as a discrete data element, this must be populated. (e.g. this could map to 'Must be filled within') Conformance Rule: First fill is only populated if required; if not populated, the general dispenseRequest instructions apply to all fills. You only specify an initial fill quantity if you have refills. Usage Note: There are times when a patient's drug plan limits what can be dispensed (i.e. 7 days initially as a trial). In this situation, the patient is informed that their drug plan only pays for 7 days. The pharmacist will ask the patient to sign the Rx that they have been informed are ok with changing the quantity to 7 days and then dispense the 7 days. The patient's file is updated to note that 7 days was dispensed as a trial period. After the initial 7 days, the patient will still have 353 tablets to be used. (90 tabs x 4 authorized fills = 360 tabs - 7 tabs dispensed as trial. |
extension (maxDispense) | 0..1 | Medication Order Max Dispense | Definition: Identifies the maximum quantity authorized to be dispensed at one time. Comments: Conformance Rule: If this is supported within the EMR as a discrete data element, this must be populated. Example: A prescriber instructs a patient to take 3 Tylenol 3 tablets every day as needed for pain for 90 days. However, the prescriber does not wish the patient to have more than 30 days supply at any given time so the prescriber instructs the pharmacist that the maxDispense is 90 tablets. The pharmacist then does 3 partial fills of 90 tablets (or 30 days supply) over the 90 day period. |
extension (totalPrescribedQuantity) | 0..1 | Medication Order Total Prescribed Quantity | Definition: Optional Extensions Element - found in all resources. Comments: Conformance Rule: The Total Prescribed Quantity is not mandatory but must be supplied if the value is entered by the user or can be calculated by the system. |
extension (totalDaysSupply) | 0..1 | Medication Order Total Prescribed Days Supply | Definition: Optional Extensions Element - found in all resources. Comments: Conformance Rule: Must be populated when the Total Days Supply is entered by the user or when the Total Days Supply can be calculated by the system. Conformance Rule: Code must be 'd' and system must be 'http://unitsofmeasure.org'. |
validityPeriod | 1..1 | Period | Definition: This indicates the validity period of a prescription (stale dating the Prescription). Comments: Conformance Rule: Must be either equal to or later then the MedicationOrder.dateWritten element. |
start | 1..1 | dateTime | Definition: The start of the period. The boundary is inclusive. Comments: Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
end | 0..1 | dateTime | Definition: The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Comments: Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
numberOfRepeatsAllowed | 0..1 | positiveInt | Definition: An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. Comments: Conformance Rule: This must be populated when the number of repeats is 1 or more. As this field only allows a positive integer, this is not populated if there are no refills allowed. Guidance: For narcotics, if this is incorrectly populated, the PMS could choose not to reject the message; rather they can adjust for the dispense. |
quantity | 0..1 | PrescribeIT Drug Quantity | 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: If days supply is NOT present, this MUST be populated. |
expectedSupplyDuration | 0..1 | Duration | Definition: Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. Comments: Conformance Rule: This maps to 'duration' in some EMR's. Must be populated when this is a discrete data element in the EMR; else this is sent as part of the textual description. Conformance Rule: If Fill Quantity is NOT populated, this must be present. |
value | 1..1 | decimal | Definition: The value of the measured amount. The value includes an implicit precision in the presentation of the value. Comments: The implicit precision in the value should always be honored. |
system | 1..1 | uri | Fixed Value: http://unitsofmeasure.org Definition: The identification of the system that provides the coded form of the unit. Comments: Fixed value: http://unitsofmeasure.org |
code | 1..1 | code | Fixed Value: d Definition: A computer processable form of the unit in some unit representation system. Comments: Fixed value: d |
priorPrescription | 0..1 | Reference(PrescribeIT Prescription) {r} | Definition: A link to a resource representing an earlier order or prescription that this order supersedes. Comments: When present with a prescription number, this must be in the same form as was present on the original prescription - generally with a system of OID of the form [vendor root].[application instance node].2 expressed as a urn (e.g. urn:oid:1.2.3.4). The 'value' element will contain the actual RX Number. Note that the system value must refer to the namespace of the system that created the original prescription, which may not always be the system performing the renewal. In the context of Task e120-m: Conformance Rule: This is mandatory and MUST be populated with the EMR generated eRX number (PRESCRIPTION_NUMBER) of the medication used as the basis for the new prescription for the same therapy. Its purpose is to identify the original prescription that drove the creation of this Renewal Fill Request. Note: This identifier may not be recognized by the PMS receiving this as it could have been a paper prescription or an ePrescription that was originally sent to another pharmacy. For transition period, from paper to electronic, there would not be an EMR-assigned number. In this case, EMR MUST populate with a value of 'NA' in the Identifier.value and omit the system. In the context of Task e140-m: This should include any prior prescription information that was included in the original prescription request from the EMR that is being cancelled. If the original EMR prescription request has this segment empty, then it should be empty for the e140-m. In the context Tasks e162-m and e163-m: Conformance Rule: This is mandatory and MUST be populated with the MedicationOrder.identifier as specified in the p160 being responded to. In the context of Task p160-m: Conformance Rule: The MedicationOrder transmitted in a p160 is the prior order that is being asked to be renewed. If this came in as an e110, priorPrescription will be absent. If this came in as an e120, priorPrescription will be present. If it was entered into the PMS as a paper or fax prescription, priorPrescription may not be known (in which case it will be absent), or may be set to 'NA' if the prescription was known to be a renewal, but the prescription identifier of the prior request is unknown). |
extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
extension (identifier) | 0..1 | Referenced Requisition identifier | Definition: Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL Comments: When this is present, the reference is typically omitted 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. |
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
valueIdentifier | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. Comments: When this is present, the reference is typically omitted |
display | 0..1 | string | Definition: Plain text narrative that identifies the resource in addition to the resource reference. Comments: This can be populated with the prescription number as a human-readable hint for downstream systems that don't recognize the extension. However, there is no known need for this element at present. |
This structure is derived from MedicationOrder
Summary
Mandatory: 12 elements (12 nested mandatory elements)
Must-Support: 82 elements
Fixed Value: 3 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://prescribeit.ca/fhir/StructureDefinition/profile-medication
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-patient
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-text-required-with-code
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-text
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-quantity-drug-admin
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-range-drug
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-quantity
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-quantity-drug
- http://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder
Extensions
This structure refers to these extensions:
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-category
- http://prescribeit.ca/fhir/StructureDefinition/ext-medication-rendered-dosage
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-protocol
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-treatment-type
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-supportinginfo
- http://prescribeit.ca/fhir/StructureDefinition/ext-request-detectedissue
- http://prescribeit.ca/fhir/StructureDefinition/ext-request-coverage
- http://prescribeit.ca/fhir/StructureDefinition/ext-request-dispenser-instructions
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-over-25-dur
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-monitored-drug
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-no-renewals
- http://prescribeit.ca/fhir/StructureDefinition/ext-medication-dosageinstruction-sequence
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dosageinstruction-relationship
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-interval
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-trial
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-first-fill
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-max
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-quantity
- http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-days-supply
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
Slices
This structure defines the following Slices:
- The element MedicationOrder.identifier is sliced based on the value of value:type
Differential View
This structure is derived from MedicationOrder
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationOrder | SΣ | 0..* | Prescription of medication to for patient | |
id | SΣ | 1..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | S | 1..* | Resource | Contained, inline Resources |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-medicationorder-category | S | 0..1 | Shared Health CodeableConcept Text | Medication Order Category URL: http://hl7.org/fhir/StructureDefinition/extension-MedicationRequest.category profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-category Binding: PrescriptionType (extensible) |
ext-medication-rendered-dosage | S | 1..1 | string | Rendered Dosage Instruction URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-rendered-dosage |
ext-medicationorder-protocol | S | 0..10 | string, uri, Shared Health Identifier | Protocol, order set, guideline, etc. URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-protocol |
ext-medicationorder-treatment-type | S | 0..1 | code | ACU | CHRON URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-treatment-type Binding: PrescriptionTreatmentCategory (required) |
ext-medicationorder-supportinginfo | S | 0..* | Reference(PrescribeIT List - Allergies | PrescribeIT Pharmacy-related Observation) {b} | Allergies, height, weight, etc. URL: http://hl7.org/fhir/StructureDefinition/extension-MedicationRequest.supportingInfo profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-supportinginfo |
ext-request-detectedissue | S | 0..* | Reference(PrescribeIT DUR) {b} | Managed DUR and other issues URL: http://prescribeit.ca/fhir/StructureDefinition/ext-request-detectedissue |
ext-request-coverage | S | 0..1 | Reference(PrescribeIT Coverage (NOT SUPPORTED)) {b} | Insurance coverage URL: http://prescribeit.ca/fhir/StructureDefinition/ext-request-coverage |
ext-request-dispenser-instructions | S | 0..1 | string | Dispenser Instructions URL: http://prescribeit.ca/fhir/StructureDefinition/ext-request-dispenser-instructions |
ext-medicationorder-over-25-dur | S | 0..1 | boolean | More than 25 DURs? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-over-25-dur |
ext-medicationorder-monitored-drug | S | 0..1 | boolean | Monitored Drug? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-monitored-drug |
ext-medicationorder-no-renewals | S | 0..1 | boolean | No Prescription Renewals? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-no-renewals |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | Shared Health Identifier | An identifier intended for computation Slice: Unordered, Open by value:type | |
identifier | S | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | EMR Prescription ID |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/identifier-type","code":"PLAC"}]} |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code | |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | Σ | 0..1 | string | Plain text representation of the concept |
system | SΣ | 1..1 | uri | The 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..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
identifier | SΣ | 0..2 | Identifier | Drug Information System's order number |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://hl7.org/fhir/v2/0203","code":"RRI"}]} |
system | SΣ | 0..1 | uri | The 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..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?!SΣ | 1..1 | code | active | on-hold | completed | entered-in-error | stopped | draft Binding: MedicationOrderStatus (required) Fixed Value: active |
medicationReference | SΣ | 1..1 | Reference(PrescribeIT Medication) {c} | A reference from one resource to another |
patient | SΣ | 1..1 | Reference(Shared Health Patient) {b} | A reference from one resource to another |
encounter | Σ | 0..1 | Reference(Encounter) | Created during encounter/admission/stay |
dateWritten | SΣI | 0..1 | dateTime | When prescription was authorized created-full: Must be at least a full date. i.e. yyyy-mm-dd |
prescriber | SΣ | 1..1 | Reference(Shared Health Practitioner) {b} | A reference from one resource to another |
reasonCode | S | 0..5 | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PrescriptionIndicationForUse (extensible) |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | SΣ | 1..1 | string | Plain text representation of the concept Max Length: 2500 |
reasonReference | Σ | 0..* | Reference(Condition) | Condition that supports why the prescription is being written |
dateEnded | Σ | 0..1 | dateTime | When prescription was stopped |
reasonEnded | Σ | 0..1 | CodeableConcept | Why prescription was stopped Binding: (unbound) (example) |
note | SΣ | 0..1 | Annotation | Information about the prescription Max Length: 2500 |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
author[x] | Σ | 0..1 | Reference(Practitioner | Patient | RelatedPerson), string | Individual responsible for the annotation |
time | Σ | 0..1 | dateTime | When the annotation was made |
text | S | 1..1 | string | The annotation - text content |
dosageInstruction | SΣ | 0..* | BackboneElement | How medication should be taken |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-medication-dosageinstruction-sequence | S | 1..1 | positiveInt | Sequence 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 | S | 0..1 | code | AND | THEN URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dosageinstruction-relationship Binding: PrescriptionDosageInstructionLineRelationship (required) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
text | SΣ | 0..1 | string | Free text dosage instructions e.g. SIG |
additionalInstructions | SI | 0..1 | Shared Health CodeableConcept Text | Concept - reference to a terminology or just text Binding: (unbound) (example) |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | SΣ | 0..* | Coding | Code defined by a terminology system |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | SΣ | 1..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | SΣ | 1..1 | string | Plain text representation of the concept Max Length: 5000 |
timing | SΣ | 0..1 | Timing | When medication should be administered |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
event | Σ | 0..* | dateTime | When the event occurs |
repeat | SΣI | 0..1 | Element | When the event is to occur |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
boundsPeriod | SΣ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits |
count | SΣ | 0..1 | integer | Number of times to repeat |
countMax | SΣ | 0..1 | integer | Maximum number of times to repeat |
duration | SΣ | 0..1 | decimal | How long when it happens |
durationMax | SΣ | 0..1 | decimal | How long when it happens (Max) |
durationUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
frequency | SΣ | 0..1 | integer | Event occurs frequency times per period |
frequencyMax | SΣ | 0..1 | integer | Event occurs up to frequencyMax times per period |
period | SΣ | 0..1 | decimal | Event occurs frequency times per period |
periodMax | SΣ | 0..1 | decimal | Upper limit of period (3-4 hours) |
periodUnit | SΣ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required) |
code | Σ | 0..1 | CodeableConcept | QD | QOD | Q4H | Q6H | BID | TID | QID | AM | PM + Binding: TimingAbbreviation (preferred) |
asNeeded[x] | SΣ | 0..1 | boolean, CodeableConcept | Take "as needed" (for x) Binding: (unbound) (example) |
siteCodeableConcept | S | 0..1 | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PrescriptionAdministrationSite (extensible) |
route | S | 0..1 | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PrescriptionRouteOfAdministration (extensible) |
method | Σ | 0..1 | CodeableConcept | Technique for administering medication Binding: (unbound) (example) |
dose[x] | SΣ | 0..1 | PrescribeIT Drug Quantity for Administration, PrescribeIT Drug Range | Amount of medication per dose |
rate[x] | SΣ | 0..1 | Ratio | Amount of medication per unit of time |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
numerator | SI | 1..1 | PrescribeIT Drug Quantity for Administration | Quantity of a medication |
denominator | SI | 1..1 | Shared Health Quantity | A measured or measurable amount |
maxDosePerPeriod | SΣ | 0..1 | Ratio | Upper limit on medication per unit of time |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
numerator | SI | 1..1 | PrescribeIT Drug Quantity for Administration | Quantity of a medication |
denominator | SI | 1..1 | Shared Health Quantity | A measured or measurable amount |
dispenseRequest | SΣI | 1..1 | BackboneElement | Medication supply authorization 1: Must have at least one of quantity and expectedSupplyDuration 3: Must have at least one of total prescribed quantity and total days supply |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-medicationorder-dispense-interval | S | 0..1 | Duration | Dispense interval URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-interval |
ext-medicationorder-dispense-trial | S | 0..1 | boolean | Trial fill authorized? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-trial |
ext-medicationorder-dispense-first-fill | SI | 0..1 | (Complex) | First fill instructions URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-first-fill 2: At least one of first fill quantity or first fill days supply must be specified |
ext-medicationorder-dispense-max | S | 0..1 | PrescribeIT Drug Quantity | Maximum prescribed quantity URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-max |
ext-medicationorder-total-quantity | S | 0..1 | PrescribeIT Drug Quantity | Total prescribed quantity URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-quantity |
ext-medicationorder-total-days-supply | S | 0..1 | Duration | Total prescribed days supply URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-days-supply |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
medicationCodeableConcept | 0..1 | Shared Health CodeableConcept Required Text with optional code | Concept - reference to a terminology or just text Binding: PrescriptionMedicinalProduct (extensible) | |
validityPeriod | SΣ | 1..1 | Period | Time period supply is authorized for |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
start | SΣI | 1..1 | dateTime | Starting time with inclusive boundary |
end | SΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
numberOfRepeatsAllowed | SΣ | 0..1 | positiveInt | Number of refills authorized |
quantity | SI | 0..1 | PrescribeIT Drug Quantity | Quantity of a medication |
expectedSupplyDuration | SΣ | 0..1 | Duration | Number of days supply per dispense |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
value | SΣ | 1..1 | decimal | Numerical value (with implicit precision) |
unit | Σ | 0..1 | string | Unit representation |
system | SΣI | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org |
code | SΣ | 1..1 | code | Coded form of the unit Fixed Value: d |
substitution | Σ | 0..1 | BackboneElement | Any restrictions on medication substitution |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
type | Σ | 1..1 | CodeableConcept | generic | formulary + Binding: ActSubstanceAdminSubstitutionCode (example) |
reason | Σ | 0..1 | CodeableConcept | Why should (not) substitution be made Binding: SubstanceAdminSubstitutionReason (example) |
priorPrescription | SΣ | 0..1 | Reference(PrescribeIT Prescription) {r} | An order/prescription that this supersedes |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
ext-reference-identifier | S | 0..1 | Shared Health Identifier | Referenced identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
valueIdentifier | S | 1..1 | PrescribeIT™ Prescriber Prescription Identifier | An identifier intended for computation |
reference | ΣI | 0..1 | string | Relative, internal or absolute URL reference |
display | SΣ | 0..1 | string | Text alternative for the resource |
Documentation for this format |
Other representations of profile: Schematron
3.54.3 Terminology Bindings
Terminology Bindings
Path | Name | Conformance | ValueSet |
MedicationOrder.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
MedicationOrder.identifier.use | IdentifierUse | required | IdentifierUse |
MedicationOrder.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
MedicationOrder.identifier.use | IdentifierUse | required | IdentifierUse |
MedicationOrder.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
MedicationOrder.status | MedicationOrderStatus | required | MedicationOrderStatus |
MedicationOrder.reasonCode | PrescriptionIndicationForUse | extensible | PrescriptionIndicationForUse |
MedicationOrder.reasonEnded | ?ext | example | |
MedicationOrder.dosageInstruction.additionalInstructions | ?ext | example | |
MedicationOrder.dosageInstruction.timing.repeat.durationUnit | UnitsOfTime | required | UnitsOfTime |
MedicationOrder.dosageInstruction.timing.repeat.periodUnit | UnitsOfTime | required | UnitsOfTime |
MedicationOrder.dosageInstruction.timing.code | TimingAbbreviation | preferred | TimingAbbreviation |
MedicationOrder.dosageInstruction.asNeeded[x] | ?ext | example | |
MedicationOrder.dosageInstruction.siteCodeableConcept | PrescriptionAdministrationSite | extensible | PrescriptionAdministrationSite |
MedicationOrder.dosageInstruction.route | PrescriptionRouteOfAdministration | extensible | PrescriptionRouteOfAdministration |
MedicationOrder.dosageInstruction.method | ?ext | example | |
MedicationOrder.dispenseRequest.medicationCodeableConcept | PrescriptionMedicinalProduct | extensible | PrescriptionMedicinalProduct |
MedicationOrder.substitution.type | ActSubstanceAdminSubstitutionCode | example | ActSubstanceAdminSubstitutionCode |
MedicationOrder.substitution.reason | SubstanceAdminSubstitutionReason | example | SubstanceAdminSubstitutionReason |
3.54.4 Constraints
Constraints
Id | Path | Details | Requirements |
created-full | MedicationOrder.dateWritten | Must be at least a full date. i.e. yyyy-mm-dd : length()>=10 | |
inv-1 | MedicationOrder.dosageInstruction.additionalInstructions | Must have coding or text but not both : coding.exists() xor text.exists() | |
tim-3 | MedicationOrder.dosageInstruction.timing.repeat | Either frequency or when can exist, not both : ((period or frequency) and when).not() | |
tim-1 | MedicationOrder.dosageInstruction.timing.repeat | if there's a duration, there needs to be duration units : duration.empty() or durationUnit.exists() | |
tim-2 | MedicationOrder.dosageInstruction.timing.repeat | if there's a period, there needs to be period units : period.empty() or periodUnit.exists() | |
tim-9 | MedicationOrder.dosageInstruction.timing.repeat | If there's an offset, there must be a when : offset.empty() or when.exists() | |
tim-6 | MedicationOrder.dosageInstruction.timing.repeat | If there's a periodMax, there must be a period : periodMax.empty() or period.exists() | |
tim-8 | MedicationOrder.dosageInstruction.timing.repeat | If there's a countMax, there must be a count : countMax.empty() or count.exists() | |
tim-7 | MedicationOrder.dosageInstruction.timing.repeat | If there's a durationMax, there must be a duration : durationMax.empty() or duration.exists() | |
tim-4 | MedicationOrder.dosageInstruction.timing.repeat | duration SHALL be a non-negative value : duration.exists() implies duration >= 0 | |
qty-3 | MedicationOrder.dosageInstruction.rate[x].numerator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | MedicationOrder.dosageInstruction.rate[x].numerator | The comparator is not used on a SimpleQuantity : comparator.empty() | |
qty-3 | MedicationOrder.dosageInstruction.rate[x].denominator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
qty-3 | MedicationOrder.dosageInstruction.maxDosePerPeriod.numerator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | MedicationOrder.dosageInstruction.maxDosePerPeriod.numerator | The comparator is not used on a SimpleQuantity : comparator.empty() | |
qty-3 | MedicationOrder.dosageInstruction.maxDosePerPeriod.denominator | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
1 | MedicationOrder.dispenseRequest | Must have at least one of quantity and expectedSupplyDuration : (quantity.empty() and expectedSupplyDuration.empty()).not() | |
3 | MedicationOrder.dispenseRequest | Must have at least one of total prescribed quantity and total days supply : extension.where(url='http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-days-supply').exists() or extension.where(url='http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-quantity').exists() | |
qty-3 | MedicationOrder.dispenseRequest.quantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | MedicationOrder.dispenseRequest.quantity | The comparator is not used on a SimpleQuantity : comparator.empty() |