PrescribeIT™ Specification and Guide Version 2.0 Revision F

 

Definitions for the profile-medication Profile.

Medication
Definition

This resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.

Control0..*
Must Supporttrue
Max Length0
Medication.id
Definition

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

Control1..1
Typeid
Must Supporttrue
Comments

Conformance Rule: Usage Note: This will usually be a GUID and is assigned by the sending application. Ideally it should be consistent for all messages referencing this same set of coverage information.

Conformance Rule: This is a unique id for the medication resource within the containing (medicationOrder). This can be as simple as '#med', or a vendor may choose to use a UUID'

Max Length0
Medication.meta
Definition

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

Control0..1
TypeMeta
Max Length0
Medication.implicitRules
Definition

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

Control0..1
Typeuri
Is Modifiertrue
Comments

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

Max Length0
Medication.language
Definition

The base language in which the resource is written.

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

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

Max Length0
Medication.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

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

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

Max Length0
Medication.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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

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

Max Length0
Medication.extension
Definition

An Extension

Control0..*
TypeExtension
Must Supporttrue
Max Length0
Medication.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description]])
Definition

Provides a textual description of the strength of the active ingredient(s) in the medication

Control0..1
TypeExtension(Medication Strength Description) (Extension Type: string)
Must Supporttrue
Comments

Conformance Rule: This field will be required when prescribing at the Representative DIN or CCDD-TM levels. Otherwise, it is expected that the strength will be conveyed as part of the drug name (Medication.code.text).

Max Length0
Medication.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

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

Max Length0
Medication.code
Definition

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

Control1..1
BindingThe codes SHALL be taken from PrescriptionMedicinalProduct; other codes may be used where these codes are not suitable
TypeCodeableConcept(Shared Health CodeableConcept Required Text with optional code)
Must Supporttrue
Comments

Conformance Rule: This element is used to represent the medication ordered or dispensed. A 'code' (Canadian Clinical Drug Data Set, or DIN or NPN) must be accompanied by 'text' when presribing. For compounds, a code is not used and the description will be sent as 'text'. A DIN, 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.)

Code systems that are acceptable in the message are: CCDD - https://fhir.infoway-inforoute.ca/CodeSystem/canadianclinicaldrugdataset DIN - http://hl7.org/fhir/NamingSystem/ca-hc-din NPN - http://hl7.org/fhir/NamingSystem/ca-hc-npn

EMRs and PMSs must support sending and receiving all levels of drug terminology defined in the Canadian Clinical Drug Data (CCDD) Set including: Therapeutic Moiety (TM), Non-proprietary Therapeutic Product (NTP), Manufactured Product (MP) as well as Device NTP for devices. In cases where an appropriate Canadian Clinical Drug Data Set value is not yet available within the point-of-service system, the system can send a DIN or Natural Product Number (NPN) or a DIN with the (isRepresentative) value set to 'true'.

If no drug code (TM, NTP, MP, or DIN) is available in the point of service system, only then should the system send the drug name as text without a code. The pharmacy system must always display the textual name of the medication or non-medication provided in the message to the user when displaying the prescription. This represents the name of the medication or non-medication (e.g. device) as seen by the prescriber at the time of prescribing.

The pharmacy system may use the drug coding (TM, NTP, MP, DIN, NPN or representative DIN) to display to the user the list of products that can be dispensed.

In the context of the dispense notification, this conveys the product that what was dispensed.

Max Length0
Medication.code.id
Definition

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

Control0..1
Typeid
Max Length0
Medication.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

Max Length0
Medication.code.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Conformance Rule: Within ‘Coding’, ‘code’, 'system' and ‘display’ must be populated.

Max Length0
Medication.code.coding.id
Definition

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

Control0..1
Typeid
Max Length0
Medication.code.coding.extension
Definition

An Extension

Control0..*
TypeExtension
Must Supporttrue
Max Length0
Medication.code.coding.extension ([CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative]])
Definition

If set to true, indicates that the medication code sent was chosen as a "representative" code of a drug picked at a more general level. I.e. The user didn't actually choose this specific code. The intended constraints around what drug should be supplied are conveyed by the request's substitution rules.

Control0..1
TypeExtension(Medication Code is Representative) (Extension Type: boolean)
Must Supporttrue
Comments

Usage Note: Below the Grid View, we have provided a business scenario to provide further guidance and clarity on the intended use.

Conformance Rule: If prescribing by Generic Name, a (representative) DIN must be present in the message and this boolean must be 'true'.

Usage Note: PMS will ONLY interpret the ingredients from the representative DIN.

Usage Note: Upon receipt of a prescription, the PMS will look at this field. If 'true', then this is a representative DIN. The PMS my choose to use this as a means to automatically filter and present a list of possible DINs/ appropriate medication . The prescribed dosage (e.g. 20 mg) and route will also be considered. Once presented with a list, the pharmacist can select a medication from this list or may select another generic equivalent with the same prescribed dosage.

Usage in the EMR: The representative DIN is chosen by the EMR (not the prescriber) based on the drug and route that is entered by the prescriber.

Note: This concept does NOT exist today; pharmacists dispense based on the generic name. Its use within PrescribeIT™ is to allow for automation as it provides a codified value to represent what the prescriber wants. This may assist the pharmacist in dispensing.

Conformance Rule: If the case where a prescriber selects a DIN and flags it as a representative DIN, the prescriber must also enter a strength and strength unit of measure and may optionally enter a prescription drug form.

Max Length0
Medication.code.coding.system
Definition

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

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

-

Max Length0
Medication.code.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
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 Length0
Medication.code.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).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Max Length0
Medication.code.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
Typestring
Must Supporttrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Usage Rule: Generally, coding can be DIN, CCDD, or representative DIN. When the code is from CCDD it should be the display name from the terminology gateway. When the coding is a DIN or a representative DIN, then it should be the display name as it was seen in the sending system by the prescriber.

When dealing with compounds, display the description of the compound as it was displayed in the sending system for the prescriber.

Max Length1000
Medication.code.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).

Control0..1
Typeboolean
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 Length0
Medication.code.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.

Control1..1
Typestring
Must Supporttrue
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

Conformance Rule: This must be displayed to the Pharmacist

Conformance Rule: Official name recorded and selected by the prescriber. This MUST be the name of the medication or non-medication as seen by the prescriber at the time of prescribing. This MUST be displayed to the pharmacist and MUST be stored as part of the electronic prescription. Note: If representative DIN was used, it is expected that this name will be the generic name, as selected by the prescriber.

Conformance Rule: TEXT element is mandatory on the prescription.

Max Length1000
Medication.isBrand
Definition

Set to true if the item is attributable to a specific manufacturer.

Control0..1
Typeboolean
Max Length0
Medication.manufacturer
Definition

Describes the details of the manufacturer.

Control0..1
TypeReference(Organization)
Max Length0
Medication.product
Definition

Information that only applies to products (not packages).

Control0..1
TypeBackboneElement
Must Supporttrue
Comments

Refer to child elements for detail

Max Length0
Medication.product.id
Definition

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

Control0..1
Typeid
Max Length0
Medication.product.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

Max Length0
Medication.product.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

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

Max Length0
Medication.product.form
Definition

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

Control0..1
BindingThe codes SHALL be taken from PrescriptionDrugForm; other codes may be used where these codes are not suitable
TypeCodeableConcept(Shared Health CodeableConcept Required Text with optional code)
Must Supporttrue
Comments

Usage Notes: The prescription drug form is optional to send to PrescribeIT™ but is required in some provinces in order to meet the prescribing standards set out by the College of Physicians and Surgeons. As a result the EMR must support allowing the prescriber to send a prescription drug form when the drug form is not specified by the drug identifier (e.g. for compounds, drugs prescribed using a Therapeutic Moiety or Representative DIN).

Conformance Rule: A Code must be supplied if one is available from the PrescriptionDrugForm subset. If the user picks a prescription drug form that does not have a code in the PrescriptionDrugForm subset, only then can text be supplied without a code.

Max Length0
Medication.product.ingredient
Definition

Identifies a particular constituent of interest in the product.

Control0..*
TypeBackboneElement
Must Supporttrue
Comments

Future Support Only: For compounds, only the textual description (supplied in Medication.code.coding.display) is mandatory. This will be used to convey pertinent information about the ingredients.

Note: If specified at some point in the future, the ingredients need not be a complete list; usually only active ingredients are listed.

Max Length0
Medication.product.ingredient.id
Definition

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

Control0..1
Typeid
Max Length0
Medication.product.ingredient.extension
Definition

An Extension

Control0..*
TypeExtension
Must Supporttrue
Max Length0
Medication.product.ingredient.extension ([CanonicalType[http://hl7.org/fhir/StructureDefinition/medication-isActiveIngredient]])
Definition

Flag indicating whether the ingredient is active or inactive.

Control1..1
TypeExtension(Active ingredient indicator) (Extension Type: boolean)
Must Supporttrue
Max Length0
Medication.product.ingredient.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

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

Max Length0
Medication.product.ingredient.itemCodeableConcept
Definition

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

Control1..1
BindingThe codes SHALL be taken from PrescriptionMedicinalProduct; other codes may be used where these codes are not suitable
TypeCodeableConcept(Shared Health CodeableConcept Required Text with optional code)
Must Supporttrue
Comments

Future: This will be used in future to convey the individual codified ingredients contained within a compounded product for the purpose of identifying compounds that contain monitored ingredients (i.e. methadone powder).

Max Length0
Medication.product.ingredient.amount
Definition

Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet.

Control0..1
TypeRatio
Must Supporttrue
Comments

Future use

Max Length0
Medication.product.ingredient.amount.id
Definition

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

Control0..1
Typeid
Max Length0
Medication.product.ingredient.amount.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

Max Length0
Medication.product.ingredient.amount.numerator
Definition

The value of the numerator.

Control1..1
TypeQuantity
Must Supporttrue
Comments

Future use

Max Length0
Medication.product.ingredient.amount.denominator
Definition

The value of the denominator.

Control1..1
TypeQuantity
Must Supporttrue
Comments

Future: When used at some point in the future, this is the dosage unit or base quantity that contains the specified ingredient amount (e.g. 1 Tablet, 10ml)

Max Length0
Medication.product.batch
Definition

Information about a group of medication produced or packaged from one production run.

Control0..*
TypeBackboneElement
Max Length0
Medication.product.batch.id
Definition

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

Control0..1
Typeid
Max Length0
Medication.product.batch.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

Max Length0
Medication.product.batch.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

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

Max Length0
Medication.product.batch.lotNumber
Definition

The assigned lot number of a batch of the specified product.

Control0..1
Typestring
Max Length0
Medication.product.batch.expirationDate
Definition

When this specific batch of product will expire.

Control0..1
TypedateTime
Max Length0
Medication.package
Definition

Information that only applies to packages (not products).

Control0..1
TypeBackboneElement
Max Length0
Medication.package.id
Definition

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

Control0..1
Typeid
Max Length0
Medication.package.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

Max Length0
Medication.package.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

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

Max Length0
Medication.package.container
Definition

The kind of container that this package comes as.

Control0..1
BindingKind of container a medication package is packaged in
For example codes, see SNOMED CT Form Codes
TypeCodeableConcept
Max Length0
Medication.package.content
Definition

A set of components that go to make up the described item.

Control0..*
TypeBackboneElement
Max Length0
Medication.package.content.id
Definition

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

Control0..1
Typeid
Max Length0
Medication.package.content.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

Max Length0
Medication.package.content.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

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

Max Length0
Medication.package.content.item[x]
Definition

Identifies one of the items in the package.

Control1..1
TypeChoice of: CodeableConcept, Reference(Medication)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Max Length0
Medication.package.content.amount
Definition

The amount of the product that is in the package.

Control0..1
TypeQuantity(SimpleQuantity)
Max Length0