Visit the Canada Health Infoway website
Visit the FHIR website

CA Core+

cibuild   Canada flag
  • Index
  • Home
  • Business Context
    • Business Context
    • Relationship to PCHDCF
    • Relationship to Other Specifications
    • CA Core+ to CACDI Mapping
  • Technical Context
    • Technical Context
    • Artifact Status Summary
    • Profiling Conventions & Approach
    • General Guidance
    • Mapping Logic
    • Security And Privacy
  • Modules
    • Modules
    • Common Data Exchange
    • Workflows
  • FHIR Artifacts
    • FHIR Artifacts
    • Profiles
    • Extensions
    • Data Types
    • Terminology
    • Actors
    • Examples
    • Download
  • Change Log
    • Change Log
    • Specification Guidance
    • Copyrights
    • Known Issues & Future Development
    • Specification Feedback
    1. Index
    2. FHIR Artifacts
    3. Profiles
    4. Medication (CA-Core)

1.2.0-DFT - The specification is version 1.2.0-DFT of CA Core+ For a full list of available versions, see the Directory of published versions

Medication (CA-Core)

Many ValueSet and CodeSystem bindings in this guide link to resources hosted on the Canada Health Infoway Terminology Service (Ontoserver). If you are redirected to a login page: This is expected and you are being directed to Infoway’s secure environment. To access these resources: You’ll need an InfoCentral Account.

Links

Profile

medication-ca-core

Derived from

http://hl7.org/fhir/StructureDefinition/Medication

Examples

example-medication-ca-core, example-Medication-ca-core2

Description

This profile applies constraints to the Medication resource for CA Core+ to support representation of medication products in the pan-Canadian context.

References to this resource

MedicationRequestCACore, MedicationStatementCACore

CFMM: 2

Resource Content

  • Tree view
  • Overview
  • XML
  • JSON
MedicationCACore (Medication)CMedication
There are no (further) constraints on this element
Element id
Medication
Short description

Definition of a Medication

Definition

This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use.

Data type

Medication

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • script10.6: NewRx/MedicationPrescribed -or- RxFill/MedicationDispensed -or- RxHistoryResponse/MedicationDispensed -or- RxHistoryResponse/MedicationPrescribed
  • rim: ManufacturedProduct[classCode=ADMM]
idΣ0..1id
There are no (further) constraints on this element
Element id
Medication.id
Short description

Logical id of this artifact

Definition

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

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

id

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
metaΣ0..1Meta
There are no (further) constraints on this element
Element id
Medication.meta
Short description

Metadata about the resource

Definition

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

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id
Medication.implicitRules
Short description

A set of rules under which this content was created

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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
language0..1codeBinding
There are no (further) constraints on this element
Element id
Medication.language
Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions
MaxValueSetAllLanguages
Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
text0..1Narrative
There are no (further) constraints on this element
Element id
Medication.text
Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

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

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id
Medication.contained
Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

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

Comments

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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
extensionC0..*ExtensionElement id
Medication.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
strengthO C0..1Extension(string)Element id
Medication.extension:strength
Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

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.

Data type

Extension(string)

Extension URL

ExtMedicationStrengthDescription

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
modifierExtension?! C0..*Extension
There are no (further) constraints on this element
Element id
Medication.modifierExtension
Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
identifierΣ0..*Identifier
There are no (further) constraints on this element
Element id
Medication.identifier
Short description

Business identifier for this medication

Definition

Business identifier for this medication.

Comments

The serial number could be included as an identifier.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • rim: .id
codeO Σ1..1CodeableConceptCACoreBindingElement id
Medication.code
Short description

Concept - reference to a terminology or just text

Definition

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

Comments

The preferred binding on this element may continue to change as pCHDCF undergoes further refinement. The point-in-time materials provided by pCHDCF to create the profiles in this release recommends the use of the PrescriptionMedicinalProduct valueSet which uses a codeSystem canonical url that is heavily implemented in production but is not the preferred codeSystem (HC-CCDD) expressed in THO. This will be addressed through pCHDCF and is expected to resolve any current differences in other pan-Canadian specifications (e.g., PS-CA) that currently utilize the HC-CCDD valueSet.

Data type

CodeableConceptCACore

Binding

A coded concept that defines the type of a medication.

PrescriptionMedicinalProduct (preferred)

Additional bindings
  • LicensedNaturalHealthProducts (candidate)

    ValueSet for licensed natural health products

  • WhoAtcUvIps (candidate)

    per pCHDCF: Can be used for the international use case where a medication is not available in Canada and therefore does not appear in the recommended pan-Canadian value sets. ATC is the recommended supporting classification for reporting and analysis

  • PharmaceuticalBiologicProductAndSubstanceCode (candidate)

    per PCHDCF: The alternate value set can be used for the international use case where the medication is not available in Canada and therefore does not appear in the recommended pan-Canadian value sets

  • DINvs (candidate)

    ValueSet for DIN. A Drug Identification Number (DIN) is a computer-generated eight digit number assigned by Health Canada to a drug product prior to being marketed in Canada.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • script10.6: coding.code = //element(*,MedicationType)/DrugCoded/ProductCode coding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier coding.display = //element(*,MedicationType)/DrugDescription
  • w5: FiveWs.class
  • v2: RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code / RXC-2.1 Component Code
  • rim: .code
  • CACDI: Medication
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
id0..1string
There are no (further) constraints on this element
Element id
Medication.code.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Medication.code.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
codingΣ0..*CodingCACore
There are no (further) constraints on this element
Element id
Medication.code.coding
Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

Data type

CodingCACore

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id0..1string
There are no (further) constraints on this element
Element id
Medication.code.coding.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Medication.code.coding.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
systemΣ0..1uriElement id
Medication.code.coding.system
Short description

Identity of the terminology system

Definition

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

Requirements

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

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
  • CACDI: Drug Code System URI
versionΣ0..1string
There are no (further) constraints on this element
Element id
Medication.code.coding.version
Short description

Version of the system - if relevant

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.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
codeΣ0..1code
There are no (further) constraints on this element
Element id
Medication.code.coding.code
Short description

Symbol in syntax defined by the system

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

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
displayΣ0..1stringElement id
Medication.code.coding.display
Short description

Representation defined by the system

Definition

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

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • CACDI: Drug English Description
  • CACDI: Drug French Description
id0..1string
There are no (further) constraints on this element
Element id
Medication.code.coding.display.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Medication.code.coding.display.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
translationC0..*Extension(Complex)
There are no (further) constraints on this element
Element id
Medication.code.coding.display.extension:translation
Short description

Language Translation (Localization)

Alternate names

extensions, user content

Definition

Language translation from base language of resource to another language, used to provide translations for strings, including markdown. Generally, the type of the translation extension SHOULD match that of the element being extended.

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.

Data type

Extension(Complex)

Extension URL

Translation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • rim: ST.translation
value0..1System.String
There are no (further) constraints on this element
Element id
Medication.code.coding.display.value
Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

userSelectedΣ0..1boolean
There are no (further) constraints on this element
Element id
Medication.code.coding.userSelected
Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
textΣ0..1string
There are no (further) constraints on this element
Element id
Medication.code.text
Short description

Plain text representation of the concept

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.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
statusΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id
Medication.status
Short description

active | inactive | entered-in-error

Definition

A code to indicate if the medication is in active use.

Comments

This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status.

Data type

code

Binding

A coded concept defining if the medication is in active use.

Medication Status Codes (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .statusCode
manufacturerΣ C0..1Reference(Organization)
There are no (further) constraints on this element
Element id
Medication.manufacturer
Short description

Manufacturer of the item

Definition

Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • script10.6: no mapping
  • w5: FiveWs.actor
  • v2: RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name
  • rim: .player.scopingRole[typeCode=MANU].scoper
form0..1CodeableConceptCACoreBindingElement id
Medication.form
Short description

Concept - reference to a terminology or just text

Definition

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

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

CodeableConceptCACore

Binding

A coded concept defining the form of a medication.

PharmaceuticalDoseFormCode (preferred)

Additional bindings
  • PrescriptionDrugForm (candidate)

    ValueSet for the prescription's drug form

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • script10.6: coding.code = //element(*,DrugCodedType)/FormCode coding.system = //element(*,DrugCodedType)/FormSourceCode
  • v2: RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form
  • rim: .formCode
id0..1string
There are no (further) constraints on this element
Element id
Medication.form.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Medication.form.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
codingΣ0..*CodingCACore
There are no (further) constraints on this element
Element id
Medication.form.coding
Short description

A reference to a code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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.

Data type

CodingCACore

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
textSO Σ0..1stringElement id
Medication.form.text
Short description

Plain text representation of the concept

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.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Obligations
CodeActor
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
amountΣ C0..1Ratio
There are no (further) constraints on this element
Element id
Medication.amount
Short description

Amount of drug in package

Definition

Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).

Comments

The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.

Data type

Ratio

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
    (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: RTO
  • rim: .quantity
ingredient0..*BackboneElement
There are no (further) constraints on this element
Element id
Medication.ingredient
Short description

Active or inactive ingredient

Definition

Identifies a particular constituent of interest in the product.

Comments

The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .scopesRole[typeCode=INGR]
id0..1string
There are no (further) constraints on this element
Element id
Medication.ingredient.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Medication.ingredient.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Medication.ingredient.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
item[x]1..1Element id
Medication.ingredient.item[x]
Short description

The actual ingredient or content

Definition

The actual ingredient - either a substance (simple ingredient) or another medication of a medication.

Requirements

The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).

Slicing

Unordered, Open, by $this(Type)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • script10.6: coding.code = //element(*,MedicationType)/DrugCoded/ProductCode coding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier coding.display = //element(*,MedicationType)/DrugDescription
  • v2: RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code
  • rim: .player
itemReferenceReference(Medication | Substance)
There are no (further) constraints on this element
Data type

Reference(Medication | Substance)

itemCodeableConcept0..1CodeableConceptCACoreBindingElement id
Medication.ingredient.item[x]:itemCodeableConcept
Short description

Concept - reference to a terminology or just text

Definition

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

Requirements

The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

CodeableConceptCACore

Binding

DrugOrMedicamentSubstanceCode (preferred)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • script10.6: coding.code = //element(*,MedicationType)/DrugCoded/ProductCode coding.system = //element(*,MedicationType)/DrugCoded/ProductCodeQualifier coding.display = //element(*,MedicationType)/DrugDescription
  • v2: RXC-2-Component Code if medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code
  • rim: .player
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
isActive0..1boolean
There are no (further) constraints on this element
Element id
Medication.ingredient.isActive
Short description

Active ingredient indicator

Definition

Indication of whether this ingredient affects the therapeutic action of the drug.

Requirements

True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive).

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: NA
strengthC0..1Ratio
There are no (further) constraints on this element
Element id
Medication.ingredient.strength
Short description

Quantity of ingredient present

Definition

Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.

Comments

The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio.

Data type

Ratio

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
    (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: RTO
  • script10.6: //element(*,DrugCodedType)/Strength
  • v2: RXC-3-Component Amount & RXC-4-Component Units if medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units
  • rim: .quantity
batch0..1BackboneElement
There are no (further) constraints on this element
Element id
Medication.batch
Short description

Details about packaged medications

Definition

Information that only applies to packages (not products).

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • script10.6: no mapping
  • rim: .player[classCode=CONT]
id0..1string
There are no (further) constraints on this element
Element id
Medication.batch.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Medication.batch.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
modifierExtensionΣ ?! C0..*Extension
There are no (further) constraints on this element
Element id
Medication.batch.modifierExtension
Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
lotNumber0..1string
There are no (further) constraints on this element
Element id
Medication.batch.lotNumber
Short description

Identifier assigned to batch

Definition

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • script10.6: no mapping
  • v2: RXA-15 Substance Lot Number / RXG-19 Substance Lot Number
  • rim: .id
expirationDate0..1dateTime
There are no (further) constraints on this element
Element id
Medication.batch.expirationDate
Short description

When batch will expire

Definition

When this specific batch of product will expire.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • script10.6: no mapping
  • v2: RXA-16 Substance Expiration Date / RXG-20 Substance Expiration Date
  • rim: participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
MedicationCACore (Medication)Medication
There are no (further) constraints on this element
Data type

Medication

extension
There are no (further) constraints on this element
Element id
Medication.extension
Slicing

Unordered, Open, by url(Value)

strengthO0..1Extension(string)
There are no (further) constraints on this element
Element id
Medication.extension:strength
Data type

Extension(string)

Extension URL

ExtMedicationStrengthDescription

Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
codeO1..CodeableConceptCACoreBinding
There are no (further) constraints on this element
Element id
Medication.code
Comments

The preferred binding on this element may continue to change as pCHDCF undergoes further refinement. The point-in-time materials provided by pCHDCF to create the profiles in this release recommends the use of the PrescriptionMedicinalProduct valueSet which uses a codeSystem canonical url that is heavily implemented in production but is not the preferred codeSystem (HC-CCDD) expressed in THO. This will be addressed through pCHDCF and is expected to resolve any current differences in other pan-Canadian specifications (e.g., PS-CA) that currently utilize the HC-CCDD valueSet.

Data type

CodeableConceptCACore

Binding

PrescriptionMedicinalProduct (preferred)

Additional bindings
  • LicensedNaturalHealthProducts (candidate)

    ValueSet for licensed natural health products

  • WhoAtcUvIps (candidate)

    per pCHDCF: Can be used for the international use case where a medication is not available in Canada and therefore does not appear in the recommended pan-Canadian value sets. ATC is the recommended supporting classification for reporting and analysis

  • PharmaceuticalBiologicProductAndSubstanceCode (candidate)

    per PCHDCF: The alternate value set can be used for the international use case where the medication is not available in Canada and therefore does not appear in the recommended pan-Canadian value sets

  • DINvs (candidate)

    ValueSet for DIN. A Drug Identification Number (DIN) is a computer-generated eight digit number assigned by Health Canada to a drug product prior to being marketed in Canada.

Mappings
  • CACDI: Medication
Obligations
CodeActor
MAY:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
coding
There are no (further) constraints on this element
system
There are no (further) constraints on this element
Element id
Medication.code.coding.system
Mappings
  • CACDI: Drug Code System URI
display
There are no (further) constraints on this element
Element id
Medication.code.coding.display
Mappings
  • CACDI: Drug English Description
  • CACDI: Drug French Description
formCodeableConceptCACoreBinding
There are no (further) constraints on this element
Element id
Medication.form
Data type

CodeableConceptCACore

Binding

PharmaceuticalDoseFormCode (preferred)

Additional bindings
  • PrescriptionDrugForm (candidate)

    ValueSet for the prescription's drug form

textSO
There are no (further) constraints on this element
Element id
Medication.form.text
Obligations
CodeActor
SHALL:populate-if-knownhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer
SHALL:no-errorhttp://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer
ingredient
There are no (further) constraints on this element
item[x]
There are no (further) constraints on this element
Element id
Medication.ingredient.item[x]
Slicing

Unordered, Open, by $this(Type)

itemCodeableConcept0..1CodeableConceptCACoreBinding
There are no (further) constraints on this element
Element id
Medication.ingredient.item[x]:itemCodeableConcept
Data type

CodeableConceptCACore

Binding

DrugOrMedicamentSubstanceCode (preferred)

{{ren
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="medication-ca-core" />
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="2" />
</extension>
<url value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/medication-ca-core" />
<version value="1.1.0" />
<name value="MedicationCACore" />
<title value="Medication (CA-Core)" />
<status value="active" />
<experimental value="false" />
<date value="2025-03-06" />
<publisher value="Canada Health Infoway" />
<contact>
<name value="National Standards Release Centre" />
<telecom>
<system value="url" />
<value value="http://www.infoway-inforoute.ca" />
</telecom>
<telecom>
<system value="email" />
<value value="standards@infoway-inforoute.ca" />
</telecom>
</contact>
<description value="This profile applies constraints to the Medication resource for CA Core+ to support representation of medication products in the pan-Canadian context." />
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166" />
<code value="CA" />
</coding>
</jurisdiction>
<copyright value="Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="CACDI" />
<name value="Canadian Core Data for Interoperability (CACDI)" />
<comment value="Mapping for MedicationCACore to Canadian Core Data for Interoperability (CACDI)." />
</mapping>
<kind value="resource" />
<abstract value="false" />
<type value="Medication" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Medication" />
<derivation value="constraint" />
<differential>
<element id="Medication.extension">
<path value="Medication.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="Medication.extension:strength">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Medication.extension" />
<sliceName value="strength" />
<min value="0" />
<max value="1" />
<type>
<code value="Extension" />
<profile value="http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description" />
</type>
</element>
<element id="Medication.code">
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="MAY:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Medication.code" />
<comment value="The preferred binding on this element may continue to change as pCHDCF undergoes further refinement. The point-in-time materials provided by pCHDCF to create the profiles in this release recommends the use of the PrescriptionMedicinalProduct valueSet which uses a codeSystem canonical url that is heavily implemented in production but is not the preferred codeSystem (HC-CCDD) expressed in THO. This will be addressed through pCHDCF and is expected to resolve any current differences in other pan-Canadian specifications (e.g., PS-CA) that currently utilize the HC-CCDD valueSet." />
<min value="1" />
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
<binding>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/LicensedNaturalHealthProducts" />
</extension>
<extension url="documentation">
<valueMarkdown value="ValueSet for licensed natural health products" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips" />
</extension>
<extension url="documentation">
<valueMarkdown value="per pCHDCF: Can be used for the international use case where a medication is not available in Canada and therefore does not appear in the recommended pan-Canadian value sets. ATC is the recommended supporting classification for reporting and analysis" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticalbiologicproductandsubstancecode" />
</extension>
<extension url="documentation">
<valueMarkdown value="per PCHDCF: The alternate value set can be used for the international use case where the medication is not available in Canada and therefore does not appear in the recommended pan-Canadian value sets" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/DIN" />
</extension>
<extension url="documentation">
<valueMarkdown value="ValueSet for DIN. A Drug Identification Number (DIN) is a computer-generated eight digit number assigned by Health Canada to a drug product prior to being marketed in Canada." />
</extension>
</extension>
<strength value="preferred" />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct" />
</binding>
<mapping>
<identity value="CACDI" />
<map value="Medication" />
</mapping>
</element>
<element id="Medication.code.coding.system">
<path value="Medication.code.coding.system" />
<mapping>
<identity value="CACDI" />
<map value="Drug Code System URI" />
</mapping>
</element>
<element id="Medication.code.coding.display">
<path value="Medication.code.coding.display" />
<mapping>
<identity value="CACDI" />
<map value="Drug English Description" />
</mapping>
<mapping>
<identity value="CACDI" />
<map value="Drug French Description" />
</mapping>
</element>
<element id="Medication.form">
<path value="Medication.form" />
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
<binding>
<extension url="http://hl7.org/fhir/tools/StructureDefinition/additional-binding">
<extension url="purpose">
<valueCode value="candidate" />
</extension>
<extension url="valueSet">
<valueCanonical value="https://fhir.infoway-inforoute.ca/ValueSet/prescriptiondrugform" />
</extension>
<extension url="documentation">
<valueMarkdown value="ValueSet for the prescription's drug form" />
</extension>
</extension>
<strength value="preferred" />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticaldoseformcode" />
</binding>
</element>
<element id="Medication.form.text">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:populate-if-known" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/obligation">
<extension url="code">
<valueCode value="SHALL:no-error" />
</extension>
<extension url="actor">
<valueCanonical value="http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer" />
</extension>
</extension>
<path value="Medication.form.text" />
<mustSupport value="true" />
</element>
<element id="Medication.ingredient.item[x]">
<path value="Medication.ingredient.item[x]" />
<slicing>
<discriminator>
<type value="type" />
<path value="$this" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
</element>
<element id="Medication.ingredient.item[x]:itemCodeableConcept">
<path value="Medication.ingredient.item[x]" />
<sliceName value="itemCodeableConcept" />
<min value="0" />
<max value="1" />
<type>
<code value="CodeableConcept" />
<profile value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core" />
</type>
<binding>
<strength value="preferred" />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/drugormedicamentsubstancecode" />
</binding>
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "medication-ca-core",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}
],
"url": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/medication-ca-core",
"version": "1.1.0",
"name": "MedicationCACore",
"title": "Medication (CA-Core)",
"status": "active",
"experimental": false,
"date": "2025-03-06",
"publisher": "Canada Health Infoway",
"contact": [
{
"name": "National Standards Release Centre",
"telecom": [
{
"system": "url",
"value": "http://www.infoway-inforoute.ca"
},
{
"system": "email",
"value": "standards@infoway-inforoute.ca"
}
]
}
],
"description": "This profile applies constraints to the Medication resource for CA Core+ to support representation of medication products in the pan-Canadian context.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "CA"
}
]
}
],
"copyright": "Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "CACDI",
"name": "Canadian Core Data for Interoperability (CACDI)",
"comment": "Mapping for MedicationCACore to Canadian Core Data for Interoperability (CACDI)."
}
],
"kind": "resource",
"abstract": false,
"type": "Medication",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Medication.extension",
"path": "Medication.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "Medication.extension:strength",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Medication.extension",
"sliceName": "strength",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description"
]
}
]
},
{
"id": "Medication.code",
"extension": [
{
"extension": [
{
"url": "code",
"valueCode": "MAY:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Medication.code",
"comment": "The preferred binding on this element may continue to change as pCHDCF undergoes further refinement. The point-in-time materials provided by pCHDCF to create the profiles in this release recommends the use of the PrescriptionMedicinalProduct valueSet which uses a codeSystem canonical url that is heavily implemented in production but is not the preferred codeSystem (HC-CCDD) expressed in THO. This will be addressed through pCHDCF and is expected to resolve any current differences in other pan-Canadian specifications (e.g., PS-CA) that currently utilize the HC-CCDD valueSet.",
"min": 1,
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
"binding": {
"extension": [
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/LicensedNaturalHealthProducts"
},
{
"url": "documentation",
"valueMarkdown": "ValueSet for licensed natural health products"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
},
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"
},
{
"url": "documentation",
"valueMarkdown": "per pCHDCF: Can be used for the international use case where a medication is not available in Canada and therefore does not appear in the recommended pan-Canadian value sets. ATC is the recommended supporting classification for reporting and analysis"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
},
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticalbiologicproductandsubstancecode"
},
{
"url": "documentation",
"valueMarkdown": "per PCHDCF: The alternate value set can be used for the international use case where the medication is not available in Canada and therefore does not appear in the recommended pan-Canadian value sets"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
},
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/DIN"
},
{
"url": "documentation",
"valueMarkdown": "ValueSet for DIN. A Drug Identification Number (DIN) is a computer-generated eight digit number assigned by Health Canada to a drug product prior to being marketed in Canada."
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
}
],
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"
},
"mapping": [
{
"identity": "CACDI",
"map": "Medication"
}
]
},
{
"id": "Medication.code.coding.system",
"path": "Medication.code.coding.system",
"mapping": [
{
"identity": "CACDI",
"map": "Drug Code System URI"
}
]
},
{
"id": "Medication.code.coding.display",
"path": "Medication.code.coding.display",
"mapping": [
{
"identity": "CACDI",
"map": "Drug English Description"
},
{
"identity": "CACDI",
"map": "Drug French Description"
}
]
},
{
"id": "Medication.form",
"path": "Medication.form",
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
"binding": {
"extension": [
{
"extension": [
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/prescriptiondrugform"
},
{
"url": "documentation",
"valueMarkdown": "ValueSet for the prescription's drug form"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
}
],
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticaldoseformcode"
}
},
{
"id": "Medication.form.text",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:populate-if-known"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/producer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
},
{
"extension": [
{
"url": "code",
"valueCode": "SHALL:no-error"
},
{
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/consumer"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/obligation"
}
],
"path": "Medication.form.text",
"mustSupport": true
},
{
"id": "Medication.ingredient.item[x]",
"path": "Medication.ingredient.item[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
}
},
{
"id": "Medication.ingredient.item[x]:itemCodeableConcept",
"path": "Medication.ingredient.item[x]",
"sliceName": "itemCodeableConcept",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/codeableconcept-ca-core"
]
}
],
"binding": {
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/drugormedicamentsubstancecode"
}
}
]
}
}

Terminology bindings

PathConformanceValueSet
Medication.codepreferredhttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
Medication.formpreferredhttps://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticaldoseformcode
Medication.ingredient.item[x]:itemCodeableConceptpreferredhttps://fhir.infoway-inforoute.ca/ValueSet/drugormedicamentsubstancecode

Additional Terminology Bindings

These bindings may be used in lieu of the primary bindings in the table above.

PathConformanceAdditionalValueSet
Medication.codecandidatehttps://fhir.infoway-inforoute.ca/ValueSet/LicensedNaturalHealthProducts
Medication.formcandidatehttps://fhir.infoway-inforoute.ca/ValueSet/prescriptiondrugform

Mappings to CACDI

The following tables list how the data elements from CA Core+ map to CACDI. For more information visit Mapping Logic.

FHIR Profile ElementCACDI Element(s)
Medication.codeMedication
Medication.code.coding.systemDrug Code System URI
Medication.code.coding.displayDrug English Description, Drug French Description

Constraints

The following table lists constraints (from differential).

IG © based on FHIR R4 | Package project:CA-Core
Copyright © 2026 Canada Health Infoway. All rights reserved. Terms of Use & License Agreements. Privacy Policy.
HL7® and FHIR® are the registered trademarks of Health Level Seven International