Canadian Baseline
1.1.0 - CI Build Canada flag

Canadian Baseline, published by HL7 Canada - FHIR Implementation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-Canada/ca-baseline/ and changes regularly. See the Directory of published versions

Resource Profile: Medication Profile

Official URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-medication Version: 1.1.0
Draft as of 2019-03-31 Computable Name: MedicationProfile

Proposed constraints and extensions on the Medication resource. Generated as a first step toward creating a set of Canadian Baseline FHIR profiles.

This profile was generated from HL7 StructureDefinition on 2019-03-28 and constrained during a review of US Core against Canadian sources. RxNorm is not used in Canada and the list of medicinal products available differs from the US, therefore PrescribeIT Medication Profile was used as a basis for this profile - with some significant differences due to structural differences between versions of FHIR.

Key differences from USCoreR4 Medication:

  • RxNorm is not used in Canada, replaced with a Canadian list of MedicationForm

Key differences from PrescribeIT Medication Profile:

  • Medication.id left with FHIR defaults
  • Medication.product element has been deleted from FHIR, used Medication.form, Medication.ingredient, Medication.amount instead of equiv. elements in Medication.product

Note:

  • medicationStrength, isRepresentative, and isActive extensions socialized in this profile and come from the PrescribeIT 2.0 specification
  • Medication.ingredient.item[x] is currently restricted in a manner consistent with the PrescribeIT Medication profile. « Question for Implementors: Is this preferable to providing references to other Medication (and potentially Substance) resources?
  • ON DHDR and HL7 v3 AdministerableMedicine appear to approach similar things differently than below.

Usage:

Formal Views of Profile Content

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

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Medication Profile
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... extension:medicationstrength 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description]] Socialized Optional Extension: Medication Strength
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description
... code S 1..1 CodeableConcept Codes that identify this medication
Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time.


Example DIN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-DIN"}]}
Example NPN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-NPN"}]}
Example CCDD: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"}]}
Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-uv-ips"}]}
Example WHO ATC IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"}]}
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... coding S 0..* Coding Code defined by a terminology system
..... extension:isRepresentative 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative]] Socialized Optional Extension: Code is Representative
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
.... text S 0..1 string Plain text representation of the concept
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform (preferred): TBD. This is a placeholder for a comprehensive valueset, which would be created and maintained by Canada Health Infoway.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.codepreferredhttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
Medication.formpreferredhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform
https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Medication Profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... extension:medicationstrength 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description]] Socialized Optional Extension: Medication Strength
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time.


Example DIN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-DIN"}]}
Example NPN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-NPN"}]}
Example CCDD: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"}]}
Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-uv-ips"}]}
Example WHO ATC IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"}]}
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... extension:isRepresentative 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative]] Socialized Optional Extension: Code is Representative
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization Profile) Manufacturer of the item
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform (preferred): TBD. This is a placeholder for a comprehensive valueset, which would be created and maintained by Canada Health Infoway.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codepreferredhttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform
https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Medication Profile
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... extension:medicationstrength 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description]] Socialized Optional Extension: Medication Strength
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time.


Example DIN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-DIN"}]}
Example NPN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-NPN"}]}
Example CCDD: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"}]}
Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-uv-ips"}]}
Example WHO ATC IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"}]}
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:isRepresentative 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative]] Socialized Optional Extension: Code is Representative
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization Profile) Manufacturer of the item
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform (preferred): TBD. This is a placeholder for a comprehensive valueset, which would be created and maintained by Canada Health Infoway.

... amount Σ 0..1 Ratio Amount of drug in package
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codepreferredhttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform
https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Medication

Differential View

This structure is derived from Medication

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Medication Profile
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... extension:medicationstrength 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description]] Socialized Optional Extension: Medication Strength
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description
... code S 1..1 CodeableConcept Codes that identify this medication
Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time.


Example DIN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-DIN"}]}
Example NPN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-NPN"}]}
Example CCDD: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"}]}
Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-uv-ips"}]}
Example WHO ATC IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"}]}
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... coding S 0..* Coding Code defined by a terminology system
..... extension:isRepresentative 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative]] Socialized Optional Extension: Code is Representative
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
.... text S 0..1 string Plain text representation of the concept
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform (preferred): TBD. This is a placeholder for a comprehensive valueset, which would be created and maintained by Canada Health Infoway.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Medication.codepreferredhttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
Medication.formpreferredhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform
https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Medication Profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... extension:medicationstrength 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description]] Socialized Optional Extension: Medication Strength
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time.


Example DIN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-DIN"}]}
Example NPN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-NPN"}]}
Example CCDD: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"}]}
Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-uv-ips"}]}
Example WHO ATC IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"}]}
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... extension:isRepresentative 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative]] Socialized Optional Extension: Code is Representative
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization Profile) Manufacturer of the item
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform (preferred): TBD. This is a placeholder for a comprehensive valueset, which would be created and maintained by Canada Health Infoway.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.codepreferredhttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform
https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Medication 0..* Medication Medication Profile
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... extension:medicationstrength 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description]] Socialized Optional Extension: Medication Strength
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier for this medication
... code SΣ 1..1 CodeableConcept Codes that identify this medication
Binding: https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (preferred): TBD. This is a placeholder for a comprehensive valueset, consisting of all Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) and Therapeutic Moiety (TM) codes, which would be created and maintained by Canada Health Infoway. Medicinal products for prescribing and dispensing in Canada. The content of this subset only contains commonly used medicinal products that are available for prescribing and dispensing in Canada. This content will expand to include all human medicinal products over time.


Example DIN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-DIN"}]}
Example NPN: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/CA-HC-NPN"}]}
Example CCDD: {"coding":[{"system":"https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"}]}
Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/medication-snomed-uv-ips"}]}
Example WHO ATC IPS: {"coding":[{"system":"http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"}]}
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:isRepresentative 0..1 ?gen-e1? [CanonicalType[http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative]] Socialized Optional Extension: Code is Representative
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-medication-code-representative
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... status ?!Σ 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ 0..1 Reference(Organization Profile) Manufacturer of the item
... form 0..1 CodeableConcept powder | tablets | capsule +
Binding: https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform (preferred): TBD. This is a placeholder for a comprehensive valueset, which would be created and maintained by Canada Health Infoway.

... amount Σ 0..1 Ratio Amount of drug in package
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 The actual ingredient or content
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance | Medication)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... batch 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lotNumber 0..1 string Identifier assigned to batch
.... expirationDate 0..1 dateTime When batch will expire

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Medication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Medication.codepreferredhttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct
Medication.statusrequiredMedication Status Codes
http://hl7.org/fhir/ValueSet/medication-status|4.0.1
from the FHIR Standard
Medication.formpreferredhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform
https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMedicationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMedicationIf 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-4errorMedicationIf 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-5errorMedicationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMedicationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Medication

 

Other representations of profile: CSV, Excel, Schematron