3.55.6 StructureDefinition: PrescribeIT New Prescription - Detailed Descriptions
Definitions for the profile-medicationorder-new Profile.
MedicationOrder | |
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. |
Control | 0..* |
Must Support | true |
Alternate Names | Prescription |
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. |
Max Length | 0 |
MedicationOrder.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 1..1 |
Type | id |
Must Support | true |
Comments | Usage Note: This will usually be a GUID and is assigned by the sending application. |
Max Length | 0 |
MedicationOrder.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Max Length | 0 |
MedicationOrder.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
Max Length | 0 |
MedicationOrder.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Max Length | 0 |
MedicationOrder.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
Max Length | 0 |
MedicationOrder.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 1..* |
Type | Resource |
Must Support | true |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | Conformance Rule: This will be used to contain the Medication resource. No other resources should be 'contained'. |
Max Length | 0 |
MedicationOrder.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Must Support | true |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-category]]) | |
Definition | Sub-categorizes medication prescriptions into drugs, devices, compounds, etc. May be used to apply sub-type-specific constraints |
Control | 0..1 |
Type | Extension(Medication Order Category) (Extension Type: CodeableConcept(Shared Health CodeableConcept Text)) |
Must Support | true |
Comments | Conformance Rule: If no appropriate code exists, provide details using the 'text' component. |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-rendered-dosage]]) | |
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. |
Control | 1..1 |
Type | Extension(Medication Rendered Dosage Instruction) (Extension Type: string) |
Must Support | true |
Requirements | Allows the provider to verify the codified structured dosage information entered and ensure that the exploded instruction is consistent with the intended instructions. Also useful in bringing back administration instructions on query responses. This is mandatory as dosage instructions must always be available in rendered form. |
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. |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-protocol]]) | |
Definition | Identifies the Protocol, Order set, Guideline or other definition that guided the creation of this prescription |
Control | 0..10 |
Type | Extension(Medication Order Protocol) (Extension Type: Choice of: string, uri, Identifier(Shared Health Identifier)) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-treatment-type]]) | |
Definition | Identifies whether this drug is for acute or chronic use |
Control | 0..1 |
Type | Extension(Medication Order Treatment Type) (Extension Type: code) |
Must Support | true |
Comments | Conformance Rule: Must be populated if known |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-supportinginfo]]) | |
Definition | Additional information that relevant to the order. E.g. observations, allergies, etc. |
Control | 0..* |
Type | Extension(Medication Order Supporting Information) (Extension Type: Reference(Shared Health Reference)(PrescribeIT List - Allergies | PrescribeIT Pharmacy-related Observation)) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-request-detectedissue]]) | |
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. |
Control | 0..* |
Type | Extension(Request-related Detected Issues) (Extension Type: Reference(Shared Health Reference)(PrescribeIT DUR)) |
Must Support | true |
Comments | Usage Note: This is a reference to the resource which is used to convey Managed Detected Issues (DUR) |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-request-coverage]]) | |
Definition | Identifies insurance coverage that may be relevant to fulfilling an order |
Control | 0..1 |
Type | Extension(Request-related Coverage (NOT SUPPORTED)) (Extension Type: Reference(Shared Health Reference)(PrescribeIT Coverage (NOT SUPPORTED))) |
Must Support | true |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-request-dispenser-instructions]]) | |
Definition | Provides additional instructions from the prescriber to the pharmacy or other dispenser |
Control | 0..1 |
Type | Extension(Request Dispenser Instructions) (Extension Type: string) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-over-25-dur]]) | |
Definition | Indicates that the total number of managed DURs associated with the prescription exceeds the reporting limit of 25 |
Control | 0..1 |
Type | Extension(Medication Order - Over 25 DUR) (Extension Type: boolean) |
Must Support | true |
Comments | Conformance Rule: Set value = true when there are more than 25 warnings returned in the EMR DUR system |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-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 |
Control | 0..1 |
Type | Extension(Medication Order - Monitored Drug) (Extension Type: boolean) |
Must Support | true |
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). |
Max Length | 0 |
MedicationOrder.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-no-renewals]]) | |
Definition | Indicates that the prescriber will not support renewals for this prescription |
Control | 0..1 |
Type | Extension(Medication Order - No Prescription Renewals) (Extension Type: boolean) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.identifier | |
Definition | A technical identifier - identifies some entity uniquely and unambiguously. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..3 |
Type | Identifier(Shared Health Identifier) |
Must Support | true |
Comments | These are the identifiers assigned by the EMR and, in some cases, by the DIS. |
Max Length | 0 |
MedicationOrder.identifier(emr-id) | |
Definition | A technical identifier - identifies some entity uniquely and unambiguously. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier(PrescribeIT™ Prescriber Prescription Identifier) |
Must Support | true |
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). |
Max Length | 0 |
MedicationOrder.identifier.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | Identifies the purpose for this identifier, if known . The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Max Length | 0 |
MedicationOrder.identifier.type | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept(Shared Health CodeableConcept Code) |
Must Support | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | - |
Max Length | 0 |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/identifier-type"/> <code value="PLAC"/> </coding> </valueCodeableConcept> |
MedicationOrder.identifier.type.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.identifier.type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.identifier.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..* |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
Max Length | 0 |
MedicationOrder.identifier.type.coding.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.identifier.type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.identifier.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | - |
Max Length | 0 |
MedicationOrder.identifier.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Max Length | 0 |
MedicationOrder.identifier.type.coding.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). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Max Length | 0 |
MedicationOrder.identifier.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Max Length | 0 |
MedicationOrder.identifier.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Max Length | 0 |
MedicationOrder.identifier.type.coding(placer) | |
Definition | A reference to a code defined by a terminology system. |
Control | 1..* |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
Max Length | 0 |
MedicationOrder.identifier.type.coding.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.identifier.type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.identifier.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | Fixed value: http://hl7.org/fhir/identifier-type |
Max Length | 0 |
Fixed Value | http://hl7.org/fhir/identifier-type |
MedicationOrder.identifier.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Max Length | 0 |
MedicationOrder.identifier.type.coding.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). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Comments | Fixed value: PLAC |
Max Length | 0 |
Fixed Value | PLAC |
MedicationOrder.identifier.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Max Length | 0 |
MedicationOrder.identifier.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Max Length | 0 |
MedicationOrder.identifier.type.text | |
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. |
Control | 0..1 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Max Length | 0 |
MedicationOrder.identifier.system | |
Definition | Establishes the namespace in which set of possible id values is unique. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Max Length | 0 |
Example | General:http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
MedicationOrder.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | string |
Must Support | true |
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. |
Max Length | 0 |
Example | General:123456 |
MedicationOrder.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Max Length | 0 |
MedicationOrder.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Reference(Organization) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Max Length | 0 |
MedicationOrder.identifier(dis-id) | |
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. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..2 |
Type | Identifier |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.identifier.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | Identifies the purpose for this identifier, if known . The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Max Length | 0 |
MedicationOrder.identifier.type | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable |
Type | CodeableConcept(Shared Health CodeableConcept Code) |
Must Support | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | - |
Max Length | 0 |
Pattern Value | <valueCodeableConcept xmlns="http://hl7.org/fhir"> <coding> <system value="http://hl7.org/fhir/v2/0203"/> <code value="RRI"/> </coding> </valueCodeableConcept> |
MedicationOrder.identifier.system | |
Definition | Establishes the namespace in which set of possible id values is unique. |
Control | 0..1 |
Type | uri |
Must Support | true |
Requirements | There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Max Length | 0 |
Example | General:http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
MedicationOrder.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Control | 1..1 |
Type | string |
Must Support | true |
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. |
Max Length | 0 |
Example | General:123456 |
MedicationOrder.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Max Length | 0 |
MedicationOrder.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Reference(Organization) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Max Length | 0 |
MedicationOrder.status | |
Definition | A code specifying the state of the order. Generally this will be active or completed state. |
Control | 1..1 |
Binding | A code specifying the state of the prescribing event. Describes the lifecycle of the prescription. The codes SHALL be taken from MedicationOrderStatus |
Type | code |
Is Modifier | true |
Must Support | true |
Comments | Fixed value: active |
Max Length | 0 |
Fixed Value | active |
MedicationOrder.medicationReference | |
Definition | A reference from one resource to another. |
Control | 1..1 |
Type | Reference(Shared Health Reference)(PrescribeIT Medication) |
Must Support | true |
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'/> |
Max Length | 0 |
MedicationOrder.patient | |
Definition | A reference from one resource to another. |
Control | 1..1 |
Type | Reference(Shared Health Reference)(Shared Health Patient) |
Must Support | true |
Comments | Usage Note: This must point to the patient associated with the message. |
Max Length | 0 |
MedicationOrder.encounter | |
Definition | A link to a resource that identifies the particular occurrence of contact between patient and health care provider. |
Control | 0..1 |
Type | Reference(Encounter) |
Comments | SubstanceAdministration->component->EncounterEvent. |
Max Length | 0 |
MedicationOrder.dateWritten | |
Definition | The date (and perhaps time) when the prescription was written. |
Control | 0..1 |
Type | dateTime |
Must Support | true |
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). |
Max Length | 0 |
Invariants | Defined on this element created-full: Must be at least a full date. i.e. yyyy-mm-dd (: length()>=10) |
MedicationOrder.prescriber | |
Definition | A reference from one resource to another. |
Control | 1..1 |
Type | Reference(Shared Health Reference)(Shared Health Practitioner) |
Must Support | true |
Comments | Conformance Rule: When requesting that a prescription be filled or responding to a renewal request, this SHALL be the practitioner initiating the message. |
Max Length | 0 |
MedicationOrder.reasonCode | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 0..5 |
Binding | The codes SHALL be taken from PrescriptionIndicationForUse; other codes may be used where these codes are not suitable |
Type | CodeableConcept(Shared Health CodeableConcept Required Text with optional code) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.reasonCode.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.reasonCode.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.reasonCode.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
Max Length | 0 |
MedicationOrder.reasonCode.coding.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.reasonCode.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.reasonCode.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | - |
Max Length | 0 |
MedicationOrder.reasonCode.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Max Length | 0 |
MedicationOrder.reasonCode.coding.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). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Max Length | 0 |
MedicationOrder.reasonCode.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Max Length | 0 |
MedicationOrder.reasonCode.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Max Length | 0 |
MedicationOrder.reasonCode.text | |
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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Usage Note: When conveying the reason, this must be populated |
Max Length | 2500 |
MedicationOrder.reasonReference | |
Definition | Condition that supports why the prescription is being written. |
Control | 0..* |
Type | Reference(Condition) |
Max Length | 0 |
MedicationOrder.dateEnded | |
Definition | The date (and perhaps time) when the prescription was stopped. |
Control | 0..1 |
Type | dateTime |
Max Length | 0 |
MedicationOrder.reasonEnded | |
Definition | The reason why the prescription was stopped, if it was. |
Control | 0..1 |
Binding | Codes indicating why the medication was terminated; e.g. Adverse reaction, medication change, issue resolved, etc. |
Type | CodeableConcept |
Max Length | 0 |
MedicationOrder.note | |
Definition | Extra information about the prescription that could not be conveyed by the other attributes. |
Control | 0..1 |
Type | Annotation |
Must Support | true |
Max Length | 2500 |
MedicationOrder.note.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.note.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.note.author[x] | |
Definition | The individual responsible for making the annotation. |
Control | 0..1 |
Type | Choice of: Reference(Practitioner | Patient | RelatedPerson), string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Max Length | 0 |
MedicationOrder.note.time | |
Definition | Indicates when this particular annotation was made. |
Control | 0..1 |
Type | dateTime |
Max Length | 0 |
MedicationOrder.note.text | |
Definition | The text of the annotation. |
Control | 1..1 |
Type | string |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dosageInstruction | |
Definition | Indicates how the medication is to be used by the patient. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
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 RENDEREDDOSAGEINSTRUCTION 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. |
Max Length | 0 |
MedicationOrder.dosageInstruction.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dosageInstruction.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Must Support | true |
Max Length | 0 |
MedicationOrder.dosageInstruction.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-dosageinstruction-sequence]]) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 1..1 |
Type | Extension(Medication Dosage Line Sequence) (Extension Type: integer(positiveInt)) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dosageInstruction.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dosageinstruction-relationship]]) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..1 |
Type | Extension(Medication Order Dosage Instruction Relationship) (Extension Type: code) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dosageInstruction.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dosageInstruction.text | |
Definition | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. |
Control | 0..1 |
Type | string |
Must Support | true |
Comments | Conformance Rule: When providing multiple dosage lines can be expressed individually. All dosage lines (full text content) must be concatenated into the RENDEREDDOSAGEINSTRUCTION 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). |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 0..1 |
Binding | Codes identifying additional instructions such as "take with water" or "avoid operating heavy machinery". |
Type | CodeableConcept(Shared Health CodeableConcept Text) |
Must Support | true |
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 DOSAGETIMINGFREQUENCY = 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. |
Max Length | 0 |
Invariants | Defined on this element inv-1: Must have coding or text but not both (: coding.exists() xor text.exists()) |
MedicationOrder.dosageInstruction.additionalInstructions.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
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. |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.coding.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | - |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.coding.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). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Max Length | 0 |
MedicationOrder.dosageInstruction.additionalInstructions.text | |
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. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Max Length | 5000 |
MedicationOrder.dosageInstruction.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 |
Control | 0..1 |
Type | Timing |
Must Support | true |
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 RENDEREDDOSAGEINSTRUCTION. Usage Note: An Excel spreadsheet providing guidance on how to populate dosage instructions can be found under 'Scope and Usage'. |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.event | |
Definition | Identifies specific times when the event occurs. |
Control | 0..* |
Type | dateTime |
Requirements | In an MAR, for instance, you need to take a general specification, and turn it into a precise specification. |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat | |
Definition | A set of rules that describe when the event should occur. |
Control | 0..1 |
Type | Element |
Must Support | true |
Requirements | Many timing schedules are determined by regular repetitions. |
Comments | Conformance Rule: If an EMR cannot send discrete elements in all cases for timing.repeat element, this is acceptable as long as RENDEREDDOSAGEINSTRUCTION captures the timing. |
Max Length | 0 |
Invariants | Defined on this element tim-1: if there's a duration, there needs to be duration units (: duration.empty() or durationUnit.exists()) tim-2: if there's a period, there needs to be period units (: period.empty() or periodUnit.exists()) tim-3: Either frequency or when can exist, not both (: ((period or frequency) and when).not()) tim-4: duration SHALL be a non-negative value (: duration.exists() implies duration >= 0) tim-6: If there's a periodMax, there must be a period (: periodMax.empty() or period.exists()) tim-7: If there's a durationMax, there must be a duration (: durationMax.empty() or duration.exists()) tim-8: If there's a countMax, there must be a count (: countMax.empty() or count.exists()) tim-9: If there's an offset, there must be a when (: offset.empty() or when.exists()) |
MedicationOrder.dosageInstruction.timing.repeat.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.boundsPeriod | |
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). |
Control | 0..1 |
Type | Period |
Must Support | true |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.count | |
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). |
Control | 0..1 |
Type | integer |
Must Support | true |
Requirements | Repetitions may be limited by end time or total occurrences. |
Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.countMax | |
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. |
Control | 0..1 |
Type | integer |
Must Support | true |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.duration | |
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. |
Control | 0..1 |
Type | decimal |
Must Support | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
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). |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.durationMax | |
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. |
Control | 0..1 |
Type | decimal |
Must Support | true |
Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
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). |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.durationUnit | |
Definition | The units of time for the duration, in UCUM units. |
Control | 0..1 |
Binding | A unit of time (units from UCUM). The codes SHALL be taken from UnitsOfTime |
Type | code |
Must Support | true |
Comments | Codes are from http://unitsofmeasure.org (h | d | wk | etc.) |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.frequency | |
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. |
Control | 0..1 |
Type | integer |
Must Support | true |
Max Length | 0 |
Default Value | 1 |
MedicationOrder.dosageInstruction.timing.repeat.frequencyMax | |
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. |
Control | 0..1 |
Type | integer |
Must Support | true |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.period | |
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. |
Control | 0..1 |
Type | decimal |
Must Support | true |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.periodMax | |
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. |
Control | 0..1 |
Type | decimal |
Must Support | true |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.periodUnit | |
Definition | The units of time for the period in UCUM units. |
Control | 0..1 |
Binding | A unit of time (units from UCUM). The codes SHALL be taken from UnitsOfTime |
Type | code |
Must Support | true |
Comments | Codes are from http://unitsofmeasure.org (h | d | wk | etc.) |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.when | |
Definition | A real world event that the occurrence of the event should be tied to. |
Control | 0..0 |
Binding | Real world event that the relating to the schedule. The codes SHALL be taken from EventTiming |
Type | code |
Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
Comments | Use "additionalInstructions" instead |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.repeat.offset | |
Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. |
Control | 0..0 |
Type | unsignedInt |
Comments | Use "additionalInstructions" instead |
Max Length | 0 |
MedicationOrder.dosageInstruction.timing.code | |
Definition | A code for the timing pattern. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing. |
Control | 0..1 |
Binding | Code for a known / defined timing pattern. The codes SHOULD be taken from TimingAbbreviation |
Type | CodeableConcept |
Comments | BID etc are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or the a structured representation should be used (in this case, specifying the two event times). |
Max Length | 0 |
MedicationOrder.dosageInstruction.asNeeded[x] | |
Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). |
Control | 0..1 |
Binding | A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. |
Type | Choice of: boolean, CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
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/DAYSSUPPLY. The DOSAGEQUANTITY 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. |
Max Length | 0 |
MedicationOrder.dosageInstruction.siteCodeableConcept | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 0..1 |
Binding | The codes SHALL be taken from PrescriptionAdministrationSite; other codes may be used where these codes are not suitable |
Type | CodeableConcept(Shared Health CodeableConcept Required Text with optional code) |
Must Support | true |
Comments | Conformance Rule: When providing a structured SIG, this should be populated when appropriate. If not structured, this should be part of the SIG (RENDEREDDOSAGEINSTRUCTION) |
Max Length | 0 |
MedicationOrder.dosageInstruction.route | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 0..1 |
Binding | The codes SHALL be taken from PrescriptionRouteOfAdministration; other codes may be used where these codes are not suitable |
Type | CodeableConcept(Shared Health CodeableConcept Required Text with optional code) |
Must Support | true |
Comments | Conformance Rule: Coding should be populated if a code is available. However, text is always required. Also specified for Multi-dosage lines. |
Max Length | 0 |
MedicationOrder.dosageInstruction.method | |
Definition | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. |
Control | 0..1 |
Binding | A coded concept describing the technique by which the medicine is administered. |
Type | CodeableConcept |
Comments | Terminologies used often pre-coordinate this term with the route and or form of administration. |
Max Length | 0 |
MedicationOrder.dosageInstruction.dose[x] | |
Definition | The amount of therapeutic or other substance given at one administration event. |
Control | 0..1 |
Type | Choice of: Quantity(PrescribeIT Drug Quantity for Administration), Range(PrescribeIT Drug Range) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
Comments | Conformance Rule: Could be sent as part of the dosage instruction. OR for those EMRs that can support it, this should be specified. |
Max Length | 0 |
MedicationOrder.dosageInstruction.rate[x] | |
Definition | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. |
Control | 0..1 |
Type | Ratio |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dosageInstruction.rate[x].id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dosageInstruction.rate[x].extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dosageInstruction.rate[x].numerator | |
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 |
Control | 1..1 |
Type | Quantity(PrescribeIT Drug Quantity for Administration) |
Must Support | true |
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). |
Max Length | 0 |
Invariants | Defined on this element qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty()) |
MedicationOrder.dosageInstruction.rate[x].denominator | |
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. |
Control | 1..1 |
Type | Quantity(Shared Health Quantity) |
Must Support | true |
Comments | This indicates the unit of time (e.g. per day, every 4 weeks, etc.) |
Max Length | 0 |
Invariants | Defined on this element qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) |
MedicationOrder.dosageInstruction.maxDosePerPeriod | |
Definition | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. |
Control | 0..1 |
Type | Ratio |
Must Support | true |
Comments | Conformance Rule: When providing a structured SIG, this should be populated when appropriate. |
Max Length | 0 |
MedicationOrder.dosageInstruction.maxDosePerPeriod.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dosageInstruction.maxDosePerPeriod.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dosageInstruction.maxDosePerPeriod.numerator | |
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 |
Control | 1..1 |
Type | Quantity(PrescribeIT Drug Quantity for Administration) |
Must Support | true |
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. |
Max Length | 0 |
Invariants | Defined on this element qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty()) |
MedicationOrder.dosageInstruction.maxDosePerPeriod.denominator | |
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. |
Control | 1..1 |
Type | Quantity(Shared Health Quantity) |
Must Support | true |
Comments | This indicates the unit of time (e.g. per day, every 4 weeks, etc.) |
Max Length | 0 |
Invariants | Defined on this element qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) |
MedicationOrder.dispenseRequest | |
Definition | Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Max Length | 0 |
Invariants | Defined on this element 1: Must have at least one of quantity and expectedSupplyDuration (: (quantity.empty() and expectedSupplyDuration.empty()).not()) 3: 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()) |
MedicationOrder.dispenseRequest.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dispenseRequest.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Must Support | true |
Max Length | 0 |
MedicationOrder.dispenseRequest.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-interval]]) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..1 |
Type | Extension(Medication Order Dispense Interval) (Extension Type: Quantity(Duration)) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dispenseRequest.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-trial]]) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..1 |
Type | Extension(Medication Order Trial Dispense Eligibility) (Extension Type: boolean) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dispenseRequest.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-first-fill]]) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..1 |
Type | Extension(Medication Order Dispense First Fill Instructions) (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta) |
Must Support | true |
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. |
Max Length | 0 |
Invariants | Defined on this element 2: At least one of first fill quantity or first fill days supply must be specified (: extension.where(url='quantity').exists() or extension.where(url='supplyDuration').exists()) |
MedicationOrder.dispenseRequest.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-dispense-max]]) | |
Definition | Identifies the maximum quantity authorized to be dispensed at one time. |
Control | 0..1 |
Type | Extension(Medication Order Max Dispense) (Extension Type: Quantity(PrescribeIT Drug Quantity)) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dispenseRequest.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-quantity]]) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..1 |
Type | Extension(Medication Order Total Prescribed Quantity) (Extension Type: Quantity(PrescribeIT Drug Quantity)) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dispenseRequest.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medicationorder-total-days-supply]]) | |
Definition | Optional Extensions Element - found in all resources. |
Control | 0..1 |
Type | Extension(Medication Order Total Prescribed Days Supply) (Extension Type: Quantity(Duration)) |
Must Support | true |
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'. |
Max Length | 0 |
MedicationOrder.dispenseRequest.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dispenseRequest.medicationCodeableConcept | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 0..1 |
Binding | The codes SHALL be taken from PrescriptionMedicinalProduct; other codes may be used where these codes are not suitable |
Type | CodeableConcept(Shared Health CodeableConcept Required Text with optional code) |
Comments | Conformance Rule: This element is used to represent the medication ordered. A 'code' (Canadian Clinical Drug Data Set, or DIN or NPN) must be accompanied by 'text' when prescribing. For compounds, a code is not used and the description will be sent as 'text'. A representative DIN or an NPN may also be used if a CCDD code is not available. This has an extensible binding meaning that the CCDD code system should be used but if a code is not available, vendors may also submit a code from the DIN or NPN code system. (Eventually CCDD will encompass all DINs and NPNs.)
|
Max Length | 0 |
MedicationOrder.dispenseRequest.validityPeriod | |
Definition | This indicates the validity period of a prescription (stale dating the Prescription). |
Control | 1..1 |
Type | Period |
Must Support | true |
Requirements | Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription. |
Comments | Conformance Rule: Must be either equal to or later then the MedicationOrder.dateWritten element. |
Max Length | 0 |
MedicationOrder.dispenseRequest.validityPeriod.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dispenseRequest.validityPeriod.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dispenseRequest.validityPeriod.start | |
Definition | The start of the period. The boundary is inclusive. |
Control | 1..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
Must Support | true |
Comments | Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
Max Length | 0 |
MedicationOrder.dispenseRequest.validityPeriod.end | |
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. |
Control | 0..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
Must Support | true |
Comments | Must be a full date and time with timezone (i.e. yyyy-mm-dd-HH:mm:ss.SSS-ZZZZZ). |
Max Length | 0 |
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
MedicationOrder.dispenseRequest.numberOfRepeatsAllowed | |
Definition | An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. |
Control | 0..1 |
Type | positiveInt |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dispenseRequest.quantity | |
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 |
Control | 0..1 |
Type | Quantity(PrescribeIT Drug Quantity) |
Must Support | true |
Comments | Conformance Rule: If days supply is NOT present, this MUST be populated. |
Max Length | 0 |
Invariants | Defined on this element qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty()) |
MedicationOrder.dispenseRequest.expectedSupplyDuration | |
Definition | Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. |
Control | 0..1 |
Type | Quantity(Duration) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.dispenseRequest.expectedSupplyDuration.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.dispenseRequest.expectedSupplyDuration.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.dispenseRequest.expectedSupplyDuration.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Control | 1..1 |
Type | decimal |
Must Support | true |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | The implicit precision in the value should always be honored. |
Max Length | 0 |
MedicationOrder.dispenseRequest.expectedSupplyDuration.comparator | |
Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
Control | 0..0 |
Binding | How the Quantity should be understood and represented. The codes SHALL be taken from QuantityComparator |
Type | code |
Is Modifier | true |
Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Max Length | 0 |
Meaning if Missing | If there is no comparator, then there is no modification of the value |
MedicationOrder.dispenseRequest.expectedSupplyDuration.unit | |
Definition | A human-readable form of the unit. |
Control | 0..1 |
Type | string |
Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
Max Length | 0 |
MedicationOrder.dispenseRequest.expectedSupplyDuration.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Control | 1..1 This element is affected by the following invariants: qty-3 |
Type | uri |
Must Support | true |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | Fixed value: http://unitsofmeasure.org |
Max Length | 0 |
Fixed Value | http://unitsofmeasure.org |
MedicationOrder.dispenseRequest.expectedSupplyDuration.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
Comments | Fixed value: d |
Max Length | 0 |
Fixed Value | d |
MedicationOrder.substitution | |
Definition | Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done. |
Control | 0..1 |
Type | BackboneElement |
Max Length | 0 |
MedicationOrder.substitution.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.substitution.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.substitution.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
MedicationOrder.substitution.type | |
Definition | A code signifying whether a different drug should be dispensed from what was prescribed. |
Control | 1..1 |
Binding | A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription. For example codes, see ActSubstanceAdminSubstitutionCode |
Type | CodeableConcept |
Max Length | 0 |
MedicationOrder.substitution.reason | |
Definition | Indicates the reason for the substitution, or why substitution must or must not be performed. |
Control | 0..1 |
Binding | A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed. For example codes, see SubstanceAdminSubstitutionReason |
Type | CodeableConcept |
Max Length | 0 |
MedicationOrder.priorPrescription | |
Definition | A link to a resource representing an earlier order or prescription that this order supersedes. |
Control | 0..0 |
Type | Reference(PrescribeIT Prescription) |
Must Support | true |
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). |
Max Length | 0 |
MedicationOrder.priorPrescription.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.priorPrescription.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Must Support | true |
Max Length | 0 |
MedicationOrder.priorPrescription.extension ([CanonicalType[http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier]]) | |
Definition | Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL |
Control | 0..1 |
Type | Extension(Referenced Requisition identifier) (Extension Type: Identifier(Shared Health Identifier)) |
Must Support | true |
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. |
Max Length | 0 |
MedicationOrder.priorPrescription.extension.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
MedicationOrder.priorPrescription.extension.extension(extension) | |
Definition | An Extension |
Control | 0..0 |
Type | Extension |
MedicationOrder.priorPrescription.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Must Support | true |
Comments | Fixed value: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier |
Max Length | 0 |
Fixed Value | http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier |
MedicationOrder.priorPrescription.extension.valueIdentifier | |
Definition | A technical identifier - identifies some entity uniquely and unambiguously. |
Control | 1..1 |
Type | Identifier(PrescribeIT™ Prescriber Prescription Identifier) |
Must Support | true |
Comments | When this is present, the reference is typically omitted |
Max Length | 0 |
MedicationOrder.priorPrescription.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 This element is affected by the following invariants: ref-1 |
Type | string |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Max Length | 0 |
MedicationOrder.priorPrescription.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
Must Support | true |
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. |
Max Length | 0 |