Canadian Baseline
1.1.0 - CI Build
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
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:
Key differences from PrescribeIT Medication Profile:
Note:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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":"http://hl7.org/fhir/NamingSystem/ca-hc-din"}]} Example NPN: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-hc-npn"}]} Example CCDD: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/hc-CCDD"}]} Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://snomed.info/sct"}]} Example WHO ATC IPS: {"coding":[{"system":"http://www.whocc.no/atc"}]} |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
coding | S | 0..* | Coding | Code defined by a terminology system |
Slices for extension | Content/Rules for all slices | |||
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 |
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. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.code | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct | |
Medication.form | preferred | https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugformhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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":"http://hl7.org/fhir/NamingSystem/ca-hc-din"}]} Example NPN: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-hc-npn"}]} Example CCDD: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/hc-CCDD"}]} Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://snomed.info/sct"}]} Example WHO ATC IPS: {"coding":[{"system":"http://www.whocc.no/atc"}]} |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
coding | SΣ | 0..* | Coding | Code defined by a terminology system |
Slices for extension | Content/Rules for all slices | |||
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. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.code | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct | |
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard | |
Medication.form | preferred | https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugformhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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-4 | error | Medication | 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-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
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":"http://hl7.org/fhir/NamingSystem/ca-hc-din"}]} Example NPN: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-hc-npn"}]} Example CCDD: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/hc-CCDD"}]} Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://snomed.info/sct"}]} Example WHO ATC IPS: {"coding":[{"system":"http://www.whocc.no/atc"}]} | ||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Medication.code | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct | ||||
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard | ||||
Medication.form | preferred | https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugformhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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-4 | error | Medication | 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-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Medication
Summary
Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Medication
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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":"http://hl7.org/fhir/NamingSystem/ca-hc-din"}]} Example NPN: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-hc-npn"}]} Example CCDD: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/hc-CCDD"}]} Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://snomed.info/sct"}]} Example WHO ATC IPS: {"coding":[{"system":"http://www.whocc.no/atc"}]} |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
coding | S | 0..* | Coding | Code defined by a terminology system |
Slices for extension | Content/Rules for all slices | |||
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 |
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. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.code | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct | |
Medication.form | preferred | https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugformhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
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 | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
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":"http://hl7.org/fhir/NamingSystem/ca-hc-din"}]} Example NPN: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-hc-npn"}]} Example CCDD: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/hc-CCDD"}]} Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://snomed.info/sct"}]} Example WHO ATC IPS: {"coding":[{"system":"http://www.whocc.no/atc"}]} |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
coding | SΣ | 0..* | Coding | Code defined by a terminology system |
Slices for extension | Content/Rules for all slices | |||
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. | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.code | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct | |
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard | |
Medication.form | preferred | https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugformhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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-4 | error | Medication | 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-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
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":"http://hl7.org/fhir/NamingSystem/ca-hc-din"}]} Example NPN: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-hc-npn"}]} Example CCDD: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/hc-CCDD"}]} Example SNOMED CT (Medications) - IPS: {"coding":[{"system":"http://snomed.info/sct"}]} Example WHO ATC IPS: {"coding":[{"system":"http://www.whocc.no/atc"}]} | ||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Medication.code | preferred | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproducthttps://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct | ||||
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard | ||||
Medication.form | preferred | https://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugformhttps://fhir.infoway-inforoute.ca/ValueSet/dispensabledrugform |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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-4 | error | Medication | 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-5 | error | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Medication
Summary
Mandatory: 1 element(2 nested mandatory elements)
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron