Profiles & Operations Index > Profile: Medication
Profile: Medication
Simplifier project page: Medication
Derived from: Medication (R4)
Canonical_URL | Profile_Status | Profile_Version | FHIR_Version |
---|---|---|---|
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-consumer-profile-Medication | draft | 1.0.0 | 4.0.1 |
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
Medication | S I | Medication | There are no (further) constraints on this element Element IdMedication Definition of a Medication DefinitionThis 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.
| |
id | S Σ | 0..1 | System.String | There are no (further) constraints on this element Element IdMedication.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. System.String |
extension | I | 0..* | Extension | Element IdMedication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
MedicationStrength | S I | 0..1 | Extension(string) | Element IdMedication.extension:MedicationStrength Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. DHDR: Dispensed Drug Strength 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. http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-medication-strength Constraints
|
compoundIndicator | S I | 0..1 | Extension(boolean) | Element IdMedication.extension:compoundIndicator Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. DHDR: Compound Indicator 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. http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-compound-indicator Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdMedication.identifier Business identifier for this medication DefinitionBusiness identifier for this medication. The serial number could be included as an identifier.
|
code | S Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedication.code Codes that identify this medication DefinitionA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). A coded concept that defines the type of a medication. SNOMEDCTMedicationCodes (example)Constraints
|
coding | S Σ | 1..8 | Coding | Element IdMedication.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by system(Value), code(Value) Constraints
|
drugIdentifier | S Σ | 1..1 | Coding | Element IdMedication.code.coding:drugIdentifier Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Drug Identification Number (DIN). Number issued by Health Canada for drugs that can be legally marketed in Canada. In absence of DINs, Product Identification Numbers (PINs) may be provided instead. Note: A future release would also support CCDD Manufactured Product codes Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugIdentifier.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. DHDR: The identification of the code system that defines the meaning of the symbol in the code. URI of Health Canada DIN or Ontario Provincial PIN or Local Insurance PIN In a future release, also URI of CCDD Manufactured Product http://hl7.org/fhir/NamingSystem/ca-hc-din "http://ehealthontario.ca/fhir/NamingSystem/ca-on-provincial-pin" "http://ehealthontario.ca/fhir/NamingSystem/ca-on-local-pin" Need to be unambiguous about the source of the definition of the symbol. 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.
http://hl7.org/fhir/NamingSystem/ca-hc-din
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugIdentifier.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | Element IdMedication.code.coding:drugIdentifier.code Symbol in syntax defined by the system DefinitionA 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). DHDR: DIN/PIN of the dispensed drug or pharmacy service. Symbol in syntax defined by the system In a future release, also Manufactured Product code from CCDD. Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 1..1 | string | Element IdMedication.code.coding:drugIdentifier.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. DHDR: Brand name. Brand/display name of the dispensed drug or pharmacy service. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugIdentifier.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
drugGeneric | S Σ | 0..1 | Coding | Element IdMedication.code.coding:drugGeneric Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Drug Name (Generic). Non-proprietary name or generic name of the drug dispensed. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugGeneric.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://ehealthontario.ca/fhir/NamingSystem/ca-drug-gen-name
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
drugClass | S Σ | 0..3 | Coding | Element IdMedication.code.coding:drugClass Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Therapeutic Classification Name. Pharmacologic-therapeutic classification of the dispensed drug or pharmacy service, used to group interchangeable drug products. Based on American Hospital Formulary Service (AHFS) Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugClass.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://ehealthontario.ca/fhir/NamingSystem/ca-on-drug-class-ahfs
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugClass.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | codeBinding | Element IdMedication.code.coding:drugClass.code Symbol in syntax defined by the system DefinitionA 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). Subset Defining URL : https://tgateway.infoway-inforoute.ca/vs/drugclassification Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size https://fhir.infoway-inforoute.ca/ValueSet/drugclassification (required) Constraints
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugClass.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugClass.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
drugSubclass | S Σ | 0..3 | Coding | Element IdMedication.code.coding:drugSubclass Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Therapeutic Sub-Classification Name. Pharmacologic-therapeutic sub-classification of the dispensed drug or pharmacy service Based on American Hospital Formulary Service (AHFS) Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugSubclass.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://ehealthontario.ca/fhir/NamingSystem/ca-on-drug-subclass-ahfs
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugSubclass.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | codeBinding | Element IdMedication.code.coding:drugSubclass.code Symbol in syntax defined by the system DefinitionA 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). Subset Defining URL : https://tgateway.infoway-inforoute.ca/vs/drugsubclassification Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size https://fhir.infoway-inforoute.ca/ValueSet/drugsubclassification (required) Constraints
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugSubclass.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugSubclass.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedication.status active | inactive | entered-in-error DefinitionA code to indicate if the medication is in active use. 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. A coded concept defining if the medication is in active use. Medication Status Codes (required)Constraints
|
manufacturer | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdMedication.manufacturer Manufacturer of the item DefinitionDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. 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.
|
form | S | 0..1 | CodeableConcept | Element IdMedication.form powder | tablets | capsule + DefinitionDescribes the form of the item. Powder; tablets; capsule. When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. DHDR: Drug Dosage Form. Form of the drug dispensed (e.g. tablet, capsule, injection). Dosage information is presented as a text rather than a code/system pair. A coded concept defining the form of a medication. SNOMEDCTFormCodes (example)Constraints
|
coding | S Σ | 1..1 | CodingBinding | Element IdMedication.form.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Subset Defining URL: https://tgateway.infoway-inforoute.ca/vs/prescriptiondrugform Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. PrescriptionDrugForm (required) Constraints
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdMedication.form.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.form.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element IdMedication.form.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.form.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.form.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 1..1 | string | Element IdMedication.form.text Plain text representation of the concept DefinitionA 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. 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. DHDR: Plain text 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, e.g. “Inj Sol” E.g., a combination of abbreviations: https://tgateway.infoway-inforoute.ca/vs/drugdosageformabbreviations Very often the text is the same as a displayName of one of the codings.
|
amount | Σ I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedication.amount Amount of drug in package DefinitionSpecific 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.). 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.
|
ingredient | 0..* | BackboneElement | There are no (further) constraints on this element Element IdMedication.ingredient Active or inactive ingredient DefinitionIdentifies a particular constituent of interest in the product. 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.
| |
item[x] | 1..1 | There are no (further) constraints on this element Element IdMedication.ingredient.item[x] The actual ingredient or content DefinitionThe actual ingredient - either a substance (simple ingredient) or another medication of a medication. The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
| ||
itemCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
itemReference | Reference(Substance | Medication) | There are no (further) constraints on this element Data Type | ||
isActive | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.ingredient.isActive Active ingredient indicator DefinitionIndication of whether this ingredient affects the therapeutic action of the drug. 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).
| |
strength | I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedication.ingredient.strength Quantity of ingredient present DefinitionSpecifies 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. 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.
|
batch | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdMedication.batch Details about packaged medications DefinitionInformation that only applies to packages (not products).
| |
lotNumber | 0..1 | string | There are no (further) constraints on this element Element IdMedication.batch.lotNumber Identifier assigned to batch DefinitionThe assigned lot number of a batch of the specified product. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
expirationDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedication.batch.expirationDate When batch will expire DefinitionWhen this specific batch of product will expire.
|
Hybrid View
Medication | S I | Medication | There are no (further) constraints on this element Element IdMedication Definition of a Medication DefinitionThis 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.
| |
id | S Σ | 0..1 | System.String | There are no (further) constraints on this element Element IdMedication.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. System.String |
extension | I | 0..* | Extension | Element IdMedication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
MedicationStrength | S I | 0..1 | Extension(string) | Element IdMedication.extension:MedicationStrength Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. DHDR: Dispensed Drug Strength 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. http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-medication-strength Constraints
|
compoundIndicator | S I | 0..1 | Extension(boolean) | Element IdMedication.extension:compoundIndicator Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. DHDR: Compound Indicator 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. http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-compound-indicator Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdMedication.identifier Business identifier for this medication DefinitionBusiness identifier for this medication. The serial number could be included as an identifier.
|
code | S Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedication.code Codes that identify this medication DefinitionA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). A coded concept that defines the type of a medication. SNOMEDCTMedicationCodes (example)Constraints
|
coding | S Σ | 1..8 | Coding | Element IdMedication.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by system(Value), code(Value) Constraints
|
drugIdentifier | S Σ | 1..1 | Coding | Element IdMedication.code.coding:drugIdentifier Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Drug Identification Number (DIN). Number issued by Health Canada for drugs that can be legally marketed in Canada. In absence of DINs, Product Identification Numbers (PINs) may be provided instead. Note: A future release would also support CCDD Manufactured Product codes Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugIdentifier.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. DHDR: The identification of the code system that defines the meaning of the symbol in the code. URI of Health Canada DIN or Ontario Provincial PIN or Local Insurance PIN In a future release, also URI of CCDD Manufactured Product http://hl7.org/fhir/NamingSystem/ca-hc-din "http://ehealthontario.ca/fhir/NamingSystem/ca-on-provincial-pin" "http://ehealthontario.ca/fhir/NamingSystem/ca-on-local-pin" Need to be unambiguous about the source of the definition of the symbol. 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.
http://hl7.org/fhir/NamingSystem/ca-hc-din
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugIdentifier.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | Element IdMedication.code.coding:drugIdentifier.code Symbol in syntax defined by the system DefinitionA 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). DHDR: DIN/PIN of the dispensed drug or pharmacy service. Symbol in syntax defined by the system In a future release, also Manufactured Product code from CCDD. Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 1..1 | string | Element IdMedication.code.coding:drugIdentifier.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. DHDR: Brand name. Brand/display name of the dispensed drug or pharmacy service. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugIdentifier.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
drugGeneric | S Σ | 0..1 | Coding | Element IdMedication.code.coding:drugGeneric Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Drug Name (Generic). Non-proprietary name or generic name of the drug dispensed. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugGeneric.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://ehealthontario.ca/fhir/NamingSystem/ca-drug-gen-name
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
drugClass | S Σ | 0..3 | Coding | Element IdMedication.code.coding:drugClass Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Therapeutic Classification Name. Pharmacologic-therapeutic classification of the dispensed drug or pharmacy service, used to group interchangeable drug products. Based on American Hospital Formulary Service (AHFS) Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugClass.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://ehealthontario.ca/fhir/NamingSystem/ca-on-drug-class-ahfs
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugClass.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | codeBinding | Element IdMedication.code.coding:drugClass.code Symbol in syntax defined by the system DefinitionA 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). Subset Defining URL : https://tgateway.infoway-inforoute.ca/vs/drugclassification Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size https://fhir.infoway-inforoute.ca/ValueSet/drugclassification (required) Constraints
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugClass.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugClass.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
drugSubclass | S Σ | 0..3 | Coding | Element IdMedication.code.coding:drugSubclass Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Therapeutic Sub-Classification Name. Pharmacologic-therapeutic sub-classification of the dispensed drug or pharmacy service Based on American Hospital Formulary Service (AHFS) Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugSubclass.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://ehealthontario.ca/fhir/NamingSystem/ca-on-drug-subclass-ahfs
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugSubclass.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | codeBinding | Element IdMedication.code.coding:drugSubclass.code Symbol in syntax defined by the system DefinitionA 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). Subset Defining URL : https://tgateway.infoway-inforoute.ca/vs/drugsubclassification Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size https://fhir.infoway-inforoute.ca/ValueSet/drugsubclassification (required) Constraints
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugSubclass.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugSubclass.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedication.status active | inactive | entered-in-error DefinitionA code to indicate if the medication is in active use. 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. A coded concept defining if the medication is in active use. Medication Status Codes (required)Constraints
|
manufacturer | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdMedication.manufacturer Manufacturer of the item DefinitionDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. 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.
|
form | S | 0..1 | CodeableConcept | Element IdMedication.form powder | tablets | capsule + DefinitionDescribes the form of the item. Powder; tablets; capsule. When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. DHDR: Drug Dosage Form. Form of the drug dispensed (e.g. tablet, capsule, injection). Dosage information is presented as a text rather than a code/system pair. A coded concept defining the form of a medication. SNOMEDCTFormCodes (example)Constraints
|
coding | S Σ | 1..1 | CodingBinding | Element IdMedication.form.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Subset Defining URL: https://tgateway.infoway-inforoute.ca/vs/prescriptiondrugform Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. PrescriptionDrugForm (required) Constraints
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdMedication.form.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.form.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element IdMedication.form.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.form.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.form.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 1..1 | string | Element IdMedication.form.text Plain text representation of the concept DefinitionA 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. 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. DHDR: Plain text 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, e.g. “Inj Sol” E.g., a combination of abbreviations: https://tgateway.infoway-inforoute.ca/vs/drugdosageformabbreviations Very often the text is the same as a displayName of one of the codings.
|
amount | Σ I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedication.amount Amount of drug in package DefinitionSpecific 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.). 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.
|
ingredient | 0..* | BackboneElement | There are no (further) constraints on this element Element IdMedication.ingredient Active or inactive ingredient DefinitionIdentifies a particular constituent of interest in the product. 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.
| |
item[x] | 1..1 | There are no (further) constraints on this element Element IdMedication.ingredient.item[x] The actual ingredient or content DefinitionThe actual ingredient - either a substance (simple ingredient) or another medication of a medication. The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
| ||
itemCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
itemReference | Reference(Substance | Medication) | There are no (further) constraints on this element Data Type | ||
isActive | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.ingredient.isActive Active ingredient indicator DefinitionIndication of whether this ingredient affects the therapeutic action of the drug. 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).
| |
strength | I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedication.ingredient.strength Quantity of ingredient present DefinitionSpecifies 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. 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.
|
batch | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdMedication.batch Details about packaged medications DefinitionInformation that only applies to packages (not products).
| |
lotNumber | 0..1 | string | There are no (further) constraints on this element Element IdMedication.batch.lotNumber Identifier assigned to batch DefinitionThe assigned lot number of a batch of the specified product. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
expirationDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedication.batch.expirationDate When batch will expire DefinitionWhen this specific batch of product will expire.
|
Snapshot View
Medication | S I | Medication | There are no (further) constraints on this element Element IdMedication Definition of a Medication DefinitionThis 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.
| |
id | S Σ | 0..1 | System.String | There are no (further) constraints on this element Element IdMedication.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. System.String |
extension | I | 0..* | Extension | Element IdMedication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Constraints
|
MedicationStrength | S I | 0..1 | Extension(string) | Element IdMedication.extension:MedicationStrength Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. DHDR: Dispensed Drug Strength 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. http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-medication-strength Constraints
|
compoundIndicator | S I | 0..1 | Extension(boolean) | Element IdMedication.extension:compoundIndicator Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. DHDR: Compound Indicator 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. http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-compound-indicator Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdMedication.identifier Business identifier for this medication DefinitionBusiness identifier for this medication. The serial number could be included as an identifier.
|
code | S Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element IdMedication.code Codes that identify this medication DefinitionA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). A coded concept that defines the type of a medication. SNOMEDCTMedicationCodes (example)Constraints
|
coding | S Σ | 1..8 | Coding | Element IdMedication.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by system(Value), code(Value) Constraints
|
drugIdentifier | S Σ | 1..1 | Coding | Element IdMedication.code.coding:drugIdentifier Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Drug Identification Number (DIN). Number issued by Health Canada for drugs that can be legally marketed in Canada. In absence of DINs, Product Identification Numbers (PINs) may be provided instead. Note: A future release would also support CCDD Manufactured Product codes Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugIdentifier.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. DHDR: The identification of the code system that defines the meaning of the symbol in the code. URI of Health Canada DIN or Ontario Provincial PIN or Local Insurance PIN In a future release, also URI of CCDD Manufactured Product http://hl7.org/fhir/NamingSystem/ca-hc-din "http://ehealthontario.ca/fhir/NamingSystem/ca-on-provincial-pin" "http://ehealthontario.ca/fhir/NamingSystem/ca-on-local-pin" Need to be unambiguous about the source of the definition of the symbol. 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.
http://hl7.org/fhir/NamingSystem/ca-hc-din
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugIdentifier.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | Element IdMedication.code.coding:drugIdentifier.code Symbol in syntax defined by the system DefinitionA 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). DHDR: DIN/PIN of the dispensed drug or pharmacy service. Symbol in syntax defined by the system In a future release, also Manufactured Product code from CCDD. Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 1..1 | string | Element IdMedication.code.coding:drugIdentifier.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. DHDR: Brand name. Brand/display name of the dispensed drug or pharmacy service. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugIdentifier.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
drugGeneric | S Σ | 0..1 | Coding | Element IdMedication.code.coding:drugGeneric Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Drug Name (Generic). Non-proprietary name or generic name of the drug dispensed. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugGeneric.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://ehealthontario.ca/fhir/NamingSystem/ca-drug-gen-name
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugGeneric.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
drugClass | S Σ | 0..3 | Coding | Element IdMedication.code.coding:drugClass Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Therapeutic Classification Name. Pharmacologic-therapeutic classification of the dispensed drug or pharmacy service, used to group interchangeable drug products. Based on American Hospital Formulary Service (AHFS) Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugClass.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://ehealthontario.ca/fhir/NamingSystem/ca-on-drug-class-ahfs
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugClass.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | codeBinding | Element IdMedication.code.coding:drugClass.code Symbol in syntax defined by the system DefinitionA 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). Subset Defining URL : https://tgateway.infoway-inforoute.ca/vs/drugclassification Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size https://fhir.infoway-inforoute.ca/ValueSet/drugclassification (required) Constraints
|
display | S Σ | 1..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugClass.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugClass.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
drugSubclass | S Σ | 0..3 | Coding | Element IdMedication.code.coding:drugSubclass Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. DHDR: Therapeutic Sub-Classification Name. Pharmacologic-therapeutic sub-classification of the dispensed drug or pharmacy service Based on American Hospital Formulary Service (AHFS) Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 1..1 | uriFixed Value | Element IdMedication.code.coding:drugSubclass.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
https://ehealthontario.ca/fhir/NamingSystem/ca-on-drug-subclass-ahfs
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugSubclass.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | codeBinding | Element IdMedication.code.coding:drugSubclass.code Symbol in syntax defined by the system DefinitionA 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). Subset Defining URL : https://tgateway.infoway-inforoute.ca/vs/drugsubclassification Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size https://fhir.infoway-inforoute.ca/ValueSet/drugsubclassification (required) Constraints
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.coding:drugSubclass.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.code.coding:drugSubclass.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
status | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdMedication.status active | inactive | entered-in-error DefinitionA code to indicate if the medication is in active use. 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. A coded concept defining if the medication is in active use. Medication Status Codes (required)Constraints
|
manufacturer | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdMedication.manufacturer Manufacturer of the item DefinitionDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. 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.
|
form | S | 0..1 | CodeableConcept | Element IdMedication.form powder | tablets | capsule + DefinitionDescribes the form of the item. Powder; tablets; capsule. When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. DHDR: Drug Dosage Form. Form of the drug dispensed (e.g. tablet, capsule, injection). Dosage information is presented as a text rather than a code/system pair. A coded concept defining the form of a medication. SNOMEDCTFormCodes (example)Constraints
|
coding | S Σ | 1..1 | CodingBinding | Element IdMedication.form.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Subset Defining URL: https://tgateway.infoway-inforoute.ca/vs/prescriptiondrugform Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. PrescriptionDrugForm (required) Constraints
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element IdMedication.form.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. 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.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.form.coding.version Version of the system - if relevant DefinitionThe 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. 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.
|
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element IdMedication.form.coding.code Symbol in syntax defined by the system DefinitionA 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). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdMedication.form.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.form.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. 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.
|
text | S Σ | 1..1 | string | Element IdMedication.form.text Plain text representation of the concept DefinitionA 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. 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. DHDR: Plain text 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, e.g. “Inj Sol” E.g., a combination of abbreviations: https://tgateway.infoway-inforoute.ca/vs/drugdosageformabbreviations Very often the text is the same as a displayName of one of the codings.
|
amount | Σ I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedication.amount Amount of drug in package DefinitionSpecific 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.). 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.
|
ingredient | 0..* | BackboneElement | There are no (further) constraints on this element Element IdMedication.ingredient Active or inactive ingredient DefinitionIdentifies a particular constituent of interest in the product. 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.
| |
item[x] | 1..1 | There are no (further) constraints on this element Element IdMedication.ingredient.item[x] The actual ingredient or content DefinitionThe actual ingredient - either a substance (simple ingredient) or another medication of a medication. The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base).
| ||
itemCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data Type | ||
itemReference | Reference(Substance | Medication) | There are no (further) constraints on this element Data Type | ||
isActive | 0..1 | boolean | There are no (further) constraints on this element Element IdMedication.ingredient.isActive Active ingredient indicator DefinitionIndication of whether this ingredient affects the therapeutic action of the drug. 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).
| |
strength | I | 0..1 | Ratio | There are no (further) constraints on this element Element IdMedication.ingredient.strength Quantity of ingredient present DefinitionSpecifies 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. 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.
|
batch | 0..1 | BackboneElement | There are no (further) constraints on this element Element IdMedication.batch Details about packaged medications DefinitionInformation that only applies to packages (not products).
| |
lotNumber | 0..1 | string | There are no (further) constraints on this element Element IdMedication.batch.lotNumber Identifier assigned to batch DefinitionThe assigned lot number of a batch of the specified product. Note that FHIR strings SHALL NOT exceed 1MB in size
| |
expirationDate | 0..1 | dateTime | There are no (further) constraints on this element Element IdMedication.batch.expirationDate When batch will expire DefinitionWhen this specific batch of product will expire.
|
Table View
Medication | .. | |
Medication.id | .. | |
Medication.extension | 0.. | |
Medication.extension | Extension | 0.. |
Medication.extension | Extension | 0.. |
Medication.code | 1.. | |
Medication.code.coding | 1..8 | |
Medication.code.coding | 1..1 | |
Medication.code.coding.system | 1.. | |
Medication.code.coding.code | 1.. | |
Medication.code.coding.display | 1.. | |
Medication.code.coding | ..1 | |
Medication.code.coding.system | 1.. | |
Medication.code.coding.display | 1.. | |
Medication.code.coding | ..3 | |
Medication.code.coding.system | 1.. | |
Medication.code.coding.code | 1.. | |
Medication.code.coding.display | 1.. | |
Medication.code.coding | ..3 | |
Medication.code.coding.system | 1.. | |
Medication.code.coding.code | 1.. | |
Medication.code.coding.display | .. | |
Medication.form | .. | |
Medication.form.coding | 1..1 | |
Medication.form.coding.system | 1.. | |
Medication.form.coding.code | 1.. | |
Medication.form.coding.display | .. | |
Medication.form.text | 1.. |
JSON View
{ "resourceType": "StructureDefinition", "id": "9de0a159-f64e-4a20-8f98-96d1ef353015", "meta": { "lastUpdated": "2022-02-18T19:41:38.913+00:00" }, "text": { "status": "empty", --- We have skipped the narrative for better readability of the resource --- }, "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-consumer-profile-Medication", "version": "1.0.0", "name": "Medication", "status": "draft", "date": "2022-02-18", "description": "This resource is used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Medication", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication", "derivation": "constraint", "differential": { "element": [ { "id": "Medication", "path": "Medication", "mustSupport": true }, { "id": "Medication.id", "path": "Medication.id", "mustSupport": true }, { "id": "Medication.extension", "path": "Medication.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "Medication.extension:MedicationStrength", "path": "Medication.extension", "sliceName": "MedicationStrength", "min": 0, "type": [ { "code": "Extension", "profile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-medication-strength" ] } ] }, { "id": "Medication.extension:compoundIndicator", "path": "Medication.extension", "sliceName": "compoundIndicator", "min": 0, "type": [ { "code": "Extension", "profile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-compound-indicator" ] } ] }, { "id": "Medication.code", "path": "Medication.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding", "path": "Medication.code.coding", "slicing": { "discriminator": [ { "type": "value", "path": "system" }, { "type": "value", "path": "code" } ], "rules": "open" }, "min": 1, "max": "8", "mustSupport": true }, { "id": "Medication.code.coding:drugIdentifier", "path": "Medication.code.coding", "sliceName": "drugIdentifier", "definition": "A reference to a code defined by a terminology system.\n\nDHDR: Drug Identification Number (DIN). Number issued by Health Canada for drugs that can be legally marketed in Canada.\nIn absence of DINs, Product Identification Numbers (PINs) may be provided instead.\nNote: A future release would also support CCDD Manufactured Product codes", "min": 1, "max": "1", "mustSupport": true }, { "id": "Medication.code.coding:drugIdentifier.system", "path": "Medication.code.coding.system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.\n\nDHDR: The identification of the code system that defines the meaning of the symbol in the code.\nURI of Health Canada DIN or Ontario Provincial PIN or Local Insurance PIN\n\nIn a future release, also URI of CCDD Manufactured Product\n\n\nhttp://hl7.org/fhir/NamingSystem/ca-hc-din \n\"http://ehealthontario.ca/fhir/NamingSystem/ca-on-provincial-pin\" \n\"http://ehealthontario.ca/fhir/NamingSystem/ca-on-local-pin\"", "min": 1, "fixedUri": "http://hl7.org/fhir/NamingSystem/ca-hc-din", "mustSupport": true }, { "id": "Medication.code.coding:drugIdentifier.code", "path": "Medication.code.coding.code", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).\n\nDHDR: DIN/PIN of the dispensed drug or pharmacy service. Symbol in syntax defined by the system\n\nIn a future release, also Manufactured Product code from CCDD.", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:drugIdentifier.display", "path": "Medication.code.coding.display", "definition": "A representation of the meaning of the code in the system, following the rules of the system.\n\nDHDR: Brand name. Brand/display name of the dispensed drug or pharmacy service.", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:drugGeneric", "path": "Medication.code.coding", "sliceName": "drugGeneric", "definition": "A reference to a code defined by a terminology system.\n\nDHDR: Drug Name (Generic). Non-proprietary name or generic name of the drug dispensed.", "max": "1", "mustSupport": true }, { "id": "Medication.code.coding:drugGeneric.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "https://ehealthontario.ca/fhir/NamingSystem/ca-drug-gen-name", "mustSupport": true }, { "id": "Medication.code.coding:drugGeneric.display", "path": "Medication.code.coding.display", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:drugClass", "path": "Medication.code.coding", "sliceName": "drugClass", "definition": "A reference to a code defined by a terminology system.\n\nDHDR: Therapeutic Classification Name. Pharmacologic-therapeutic classification of the dispensed drug or pharmacy service, used to group interchangeable drug products.\nBased on American Hospital Formulary Service (AHFS)", "max": "3", "mustSupport": true }, { "id": "Medication.code.coding:drugClass.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "https://ehealthontario.ca/fhir/NamingSystem/ca-on-drug-class-ahfs", "mustSupport": true }, { "id": "Medication.code.coding:drugClass.code", "path": "Medication.code.coding.code", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).\n\nSubset Defining URL : https://tgateway.infoway-inforoute.ca/vs/drugclassification", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/drugclassification" } }, { "id": "Medication.code.coding:drugClass.display", "path": "Medication.code.coding.display", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:drugSubclass", "path": "Medication.code.coding", "sliceName": "drugSubclass", "definition": "A reference to a code defined by a terminology system.\n\nDHDR: Therapeutic Sub-Classification Name. Pharmacologic-therapeutic sub-classification of the dispensed drug or pharmacy service\n\nBased on American Hospital Formulary Service (AHFS)", "max": "3", "mustSupport": true }, { "id": "Medication.code.coding:drugSubclass.system", "path": "Medication.code.coding.system", "min": 1, "fixedUri": "https://ehealthontario.ca/fhir/NamingSystem/ca-on-drug-subclass-ahfs", "mustSupport": true }, { "id": "Medication.code.coding:drugSubclass.code", "path": "Medication.code.coding.code", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).\n\nSubset Defining URL : https://tgateway.infoway-inforoute.ca/vs/drugsubclassification", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/drugsubclassification" } }, { "id": "Medication.code.coding:drugSubclass.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.form", "path": "Medication.form", "comment": "When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.\n\nDHDR: Drug Dosage Form. Form of the drug dispensed (e.g. tablet, capsule, injection). Dosage information is presented as a text rather than a code/system pair.", "mustSupport": true }, { "id": "Medication.form.coding", "path": "Medication.form.coding", "definition": "A reference to a code defined by a terminology system.\n\nSubset Defining URL: https://tgateway.infoway-inforoute.ca/vs/prescriptiondrugform", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/prescriptiondrugform" } }, { "id": "Medication.form.coding.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.form.text", "path": "Medication.form.text", "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.\n\nDHDR: Plain text 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, e.g. “Inj Sol”\nE.g., a combination of abbreviations: https://tgateway.infoway-inforoute.ca/vs/drugdosageformabbreviations", "min": 1, "mustSupport": true } ] } }
Usage
The Medication Resource describes a medication and pharmacy service from the DHDR
Notes
.code
- sliced coding element
code.coding:drugIdentifier
is the madatory slice. Drug Identification Number (DIN). Number issued by Health Canada for drugs that can be legally marketed in Canada. In absence of DINs, Product Identification Numbers (PINs) may be provided instead.code.coding:drugIdentifier.system
the identification of the code system that defines the meaning of the symbol in the code. URI of Health Canada DIN or Ontario Provincial PINcode.coding:drugIdentifier.code
DIN/PIN of the dispensed drug or pharmacy service. Symbol in syntax defined by the systemcode.coding:drugIdentifier.display
brand/display name is type of pharmacy servicecode.coding:drugGeneric
generic name is description of pharmacy servicecode.coding:drugClass
Therapeutic Classification Name. Pharmacologic-therapeutic classification of the dispensed drug or pharmacy service, used to group interchangeable drug products. Based on American Hospital Formulary Service (AHFS)code.coding:drugSubclass
Therapeutic Sub-Classification Name. Pharmacologic-therapeutic sub-classification of the dispensed drug or pharmacy service. Based on American Hospital Formulary Service (AHFS)
.form
- indicates the form of the drug dispensed (e.g. tablet, capsule, injection). Dosage information is presented as a text rather than a code/system pair
form.text
this element indicates plain text 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, e.g. “Inj Sol” E.g., a combination of abbreviations: https://tgateway.infoway-inforoute.ca/vs/drugdosageformabbreviations