CH EMED EPR
2.0.0-ci-build - ci-build
CH EMED EPR, published by CARA. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CARA-ch/ch-emed-epr/ and changes regularly. See the Directory of published versions
Draft as of 2024-12-20 |
Definitions for the ch-emed-epr-medication-medicationdispense resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Medication | |
2. Medication.meta | |
4. Medication.meta.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
6. Medication.meta.versionId | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
8. Medication.meta.lastUpdated | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
10. Medication.meta.source | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
12. Medication.meta.security | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
14. Medication.meta.tag | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
16. Medication.implicitRules | |
Comments | ...All modifiers SHALL be documented in the profile, in order to be usable. |
Control | 0..0 |
18. Medication.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
20. Medication.modifierExtension | |
Comments | ...All modifiers SHALL be documented in the profile, in order to be usable. |
Control | 0..0 |
22. Medication.code | |
Short | Codes that identify this medication. GTIN or ATC code SHOULD be specified. See also treatment guidance page. |
Control | 1..? |
24. Medication.code.id | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
26. Medication.code.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
28. Medication.code.coding:GTIN | |
Slice Name | GTIN |
Control | 0..1 |
30. Medication.code.coding:GTIN.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
32. Medication.code.coding:GTIN.version | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Note | This is a business version Id, not a resource version Id (see discussion) |
Standard Status | Draft (from Draft) |
34. Medication.code.coding:GTIN.userSelected | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
36. Medication.code.coding:ATC | |
Slice Name | ATC |
Control | 0..1 |
38. Medication.code.coding:ATC.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
40. Medication.code.coding:ATC.version | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Note | This is a business version Id, not a resource version Id (see discussion) |
Standard Status | Draft (from Draft) |
42. Medication.code.coding:ATC.userSelected | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
44. Medication.status | |
Pattern Value | active |
46. Medication.manufacturer | |
Type | Reference(CH EMED EPR Organization) |
48. Medication.form | |
50. Medication.form.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
52. Medication.form.coding | |
54. Medication.form.coding.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
56. Medication.form.coding.version | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Note | This is a business version Id, not a resource version Id (see discussion) |
Standard Status | Draft (from Draft) |
58. Medication.form.coding.userSelected | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
60. Medication.form.text | |
Control | 1..? |
62. Medication.ingredient | |
Short | Ingredients SHOULD be specified. See also treatment guidance page. |
64. Medication.ingredient.id | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
66. Medication.ingredient.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
68. Medication.ingredient.modifierExtension | |
Comments | ...All modifiers SHALL be documented in the profile, in order to be usable. |
Control | 0..0 |
70. Medication.ingredient.item[x]:itemCodeableConcept | |
Slice Name | itemCodeableConcept |
Type | CodeableConcept |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
72. Medication.ingredient.item[x]:itemCodeableConcept.id | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
74. Medication.ingredient.item[x]:itemCodeableConcept.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
76. Medication.batch | |
78. Medication.batch.id | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
80. Medication.batch.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. |
Short | ✕ This element is not supported |
Standard Status | Draft (from Draft) |
82. Medication.batch.modifierExtension | |
Comments | ...All modifiers SHALL be documented in the profile, in order to be usable. |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here
0. Medication | |
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
Short | CH EMED Medication (MedicationDispense)Definition of a Medication |
Control | 0..* |
Is Modifier | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) ch-emed-med-1: Medication or ingredient name has to be specified ( code.text.exists() or ingredient.item.text.exists() ) |
2. Medication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Short | A set of rules under which this content was created |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. All modifiers SHALL be documented in the profile, in order to be usable. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Control | 0..01 |
Type | uri |
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Medication.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ✕ This element is not supportedAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Standard Status | Draft (from Trial Use) |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
6. Medication.modifierExtension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | ExtensionExtensions that cannot be ignored |
Comments | All modifiers SHALL be documented in the profile, in order to be usable. 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
8. Medication.code | |
Definition | A 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. |
Short | Codes that identify this medication. GTIN or ATC code SHOULD be specified. See also treatment guidance page. |
Comments | 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). |
Control | 10..1 |
Binding | For example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes (example to http://hl7.org/fhir/ValueSet/medication-codes )A coded concept that defines the type of a medication. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. Medication.code.id | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | ✕ This element is not supportedUnique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Standard Status | Draft (from Trial Use) |
Summary | false |
12. Medication.code.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ✕ This element is not supportedAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Standard Status | Draft (from Trial Use) |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Medication.code.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
14. Medication.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code of the medicationCode defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. 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. |
Control | 0..* |
Type | Coding |
Is Modifier | false |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Medication.code.coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. Medication.code.coding:GTIN | |
Slice Name | GTIN |
Definition | A reference to a code defined by a terminology system. |
Short | GTIN for Swiss productsCode defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. 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. |
Control | 0..1* |
Type | Coding |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Medication.code.coding:GTIN.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ✕ This element is not supportedAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Standard Status | Draft (from Trial Use) |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Medication.code.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. Medication.code.coding:GTIN.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Global Trade Item Number (GS1)Identity of the terminology system |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Fixed Value | urn:oid:2.51.1.1 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. Medication.code.coding:GTIN.version | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Short | ✕ This element is not supportedVersion of the system - if relevant |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Standard Status | Draft (from Trial Use) |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. Medication.code.coding:GTIN.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). |
Short | Symbol in syntax defined by the system |
Control | 10..1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. Medication.code.coding:GTIN.userSelected | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Short | ✕ This element is not supportedIf this coding was chosen directly by the user |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Standard Status | Draft (from Trial Use) |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. Medication.code.coding:ATC | |
Slice Name | ATC |
Definition | A reference to a code defined by a terminology system. |
Short | ATC for foreign productsCode defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. 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. |
Control | 0..1* |
Type | Coding |
Is Modifier | false |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. Medication.code.coding:ATC.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ✕ This element is not supportedAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Standard Status | Draft (from Trial Use) |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Medication.code.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
32. Medication.code.coding:ATC.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Anatomical Therapeutic Chemical (ATC) ClassificationIdentity of the terminology system |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Fixed Value | http://www.whocc.no/atc |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. Medication.code.coding:ATC.version | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Short | ✕ This element is not supportedVersion of the system - if relevant |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Standard Status | Draft (from Trial Use) |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. Medication.code.coding:ATC.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). |
Short | Symbol in syntax defined by the system |
Control | 10..1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. Medication.code.coding:ATC.userSelected | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Short | ✕ This element is not supportedIf this coding was chosen directly by the user |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Standard Status | Draft (from Trial Use) |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. Medication.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Medication namePlain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. Medication.status | |
Definition | A code to indicate if the medication is in active use. |
Short | active | inactive | entered-in-error |
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. |
Control | 0..1 |
Binding | The codes SHALL be taken from Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/medication-status|4.0.1 )A coded concept defining if the medication is in active use. |
Type | code |
Is Modifier | true because This element changes the interpretation of all descriptive attributes. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Pattern Value | active |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. Medication.manufacturer | |
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
Short | Manufacturer of the item |
Control | 0..1 |
Type | Reference(CH EMED EPR Organization, Organization) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. Medication.form | |
Definition | Describes the form of the item. Powder; tablets; capsule. |
Short | Galenic formpowder | tablets | capsule + |
Comments | 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. |
Control | 0..1 |
Binding | The codes SHALL be taken from For example codes, see EDQM - Pharmaceutical Dose Formhttp://hl7.org/fhir/ValueSet/medication-form-codes (required to http://fhir.ch/ig/ch-term/ValueSet/edqm-pharmaceuticaldoseform ) |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
48. Medication.form.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ✕ This element is not supportedAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Standard Status | Draft (from Trial Use) |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Medication.form.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
50. Medication.form.coding | |
Definition | A reference to a code defined by a terminology system. |
Short | Code defined by a terminology system |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. 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. |
Control | 10..* |
Type | Coding |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. Medication.form.coding.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ✕ This element is not supportedAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Standard Status | Draft (from Trial Use) |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Medication.form.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
54. Medication.form.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Short | Identity of the terminology system |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Control | 10..1 |
Type | uri |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
56. Medication.form.coding.version | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Short | ✕ This element is not supportedVersion of the system - if relevant |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Note | This is a business version Id, not a resource version Id (see discussion) |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Standard Status | Draft (from Trial Use) |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. Medication.form.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). |
Short | Symbol in syntax defined by the system |
Control | 10..1 |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Need to refer to a particular code in the system. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
60. Medication.form.coding.userSelected | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Short | ✕ This element is not supportedIf this coding was chosen directly by the user |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Control | 0..1 |
Type | boolean |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Standard Status | Draft (from Trial Use) |
Summary | true |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
62. Medication.form.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Plain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. Medication.amount | |
Definition | A relationship of two Quantity values - expressed as a numerator and a denominator. Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
Short | Package sizeAmount of drug in package |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | Ratio(CH EMED Ratio with EMED Units) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ( (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) ) |
66. Medication.ingredient | |
Definition | Identifies a particular constituent of interest in the product. |
Short | Ingredients SHOULD be specified. See also treatment guidance page.Active or inactive ingredient |
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. Medication.ingredient.id | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | ✕ This element is not supportedUnique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Standard Status | Draft (from Trial Use) |
Summary | false |
70. Medication.ingredient.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ✕ This element is not supportedAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Standard Status | Draft (from Trial Use) |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
72. Medication.ingredient.modifierExtension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short | ExtensionExtensions that cannot be ignored even if unrecognized |
Comments | All modifiers SHALL be documented in the profile, in order to be usable. 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. |
Control | 0..0* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
74. Medication.ingredient.item[x] | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Short | The actual ingredient or content |
Control | 1..1 |
Binding | The codes SHOULD be taken from For codes, see ActivePharmaceuticalIngredient (preferred to http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient ) |
Type | CodeableConcept, Reference(Substance, Medication) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on Medication.ingredient.item[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
76. Medication.ingredient.item[x]:itemCodeableConcept | |
Slice Name | itemCodeableConcept |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Short | The actual ingredient or content |
Control | 01..1 |
Binding | The codes SHOULD be taken from For codes, see ActivePharmaceuticalIngredient (preferred to http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient ) |
Type | CodeableConcept, Reference(Substance, Medication) |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Is Modifier | false |
Summary | false |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
78. Medication.ingredient.item[x]:itemCodeableConcept.id | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | ✕ This element is not supportedUnique id for inter-element referencing |
Control | 0..1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Standard Status | Draft (from Trial Use) |
Summary | false |
80. Medication.ingredient.item[x]:itemCodeableConcept.extension | |
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Short | ✕ This element is not supportedAdditional content defined by implementations |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Standard Status | Draft (from Trial Use) |
Summary | false |
Alternate Names | extensions, user content |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on Medication.ingredient.item[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
82. Medication.ingredient.item[x]:itemCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Short | Ingredient namePlain text representation of the concept |
Comments | Very often the text is the same as a displayName of one of the codings. |
Control | 10..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
84. Medication.ingredient.strength | |
Definition | A relationship of two Quantity values - expressed as a numerator and a denominator. Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
Short | Dose per unitQuantity of ingredient present |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Ratio(CH EMED Ratio with EMED Units) |
Is Modifier | false |
Must Support | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ( (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) ) |
Guidance on how to interpret the contents of this table can be found here
0. Medication | |||||
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. | ||||
Short | CH EMED Medication (MedicationDispense) | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() )ch-emed-med-1: Medication or ingredient name has to be specified ( code.text.exists() or ingredient.item.text.exists() ) | ||||
2. Medication.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. Medication.meta | |||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. Medication.meta.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
8. Medication.meta.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Medication.meta.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
10. Medication.meta.versionId | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. Medication.meta.lastUpdated | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
14. Medication.meta.source | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
16. Medication.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Short | Profiles this resource claims to conform to | ||||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
Control | 0..* | ||||
Type | canonical(StructureDefinition) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
18. Medication.meta.security | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Control | 0..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels )Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
20. Medication.meta.tag | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Control | 0..* | ||||
Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags )Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
22. Medication.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Short | A set of rules under which this content was created | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. All modifiers SHALL be documented in the profile, in order to be usable. | ||||
Control | 0..0 | ||||
Type | uri | ||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. Medication.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. Medication.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Short | Text summary of the resource, for human interpretation | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. Medication.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Short | Contained, inline Resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
30. Medication.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
32. Medication.modifierExtension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Comments | All modifiers SHALL be documented in the profile, in order to be usable. | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
34. Medication.identifier | |||||
Definition | Business identifier for this medication. | ||||
Short | Business identifier for this medication | ||||
Comments | The serial number could be included as an identifier. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. Medication.code | |||||
Definition | A 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. | ||||
Short | Codes that identify this medication. GTIN or ATC code SHOULD be specified. See also treatment guidance page. | ||||
Comments | 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). | ||||
Control | 1..1 | ||||
Binding | For example codes, see SNOMEDCTMedicationCodes (example to http://hl7.org/fhir/ValueSet/medication-codes )A coded concept that defines the type of a medication. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
38. Medication.code.id | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
40. Medication.code.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Medication.code.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
42. Medication.code.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code of the medication | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. 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. | ||||
Control | 0..* | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on Medication.code.coding . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
44. Medication.code.coding:GTIN | |||||
Slice Name | GTIN | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | GTIN for Swiss products | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. 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. | ||||
Control | 0..1 | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
46. Medication.code.coding:GTIN.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
48. Medication.code.coding:GTIN.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Medication.code.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
50. Medication.code.coding:GTIN.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Short | Global Trade Item Number (GS1) | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Fixed Value | urn:oid:2.51.1.1 | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. Medication.code.coding:GTIN.version | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. Medication.code.coding:GTIN.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). | ||||
Short | Symbol in syntax defined by the system | ||||
Control | 1..1 | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. Medication.code.coding:GTIN.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Short | Representation defined by the system | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. Medication.code.coding:GTIN.userSelected | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
60. Medication.code.coding:ATC | |||||
Slice Name | ATC | ||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | ATC for foreign products | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. 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. | ||||
Control | 0..1 | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
62. Medication.code.coding:ATC.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
64. Medication.code.coding:ATC.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Medication.code.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
66. Medication.code.coding:ATC.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Short | Anatomical Therapeutic Chemical (ATC) Classification | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Fixed Value | http://www.whocc.no/atc | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
68. Medication.code.coding:ATC.version | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. Medication.code.coding:ATC.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). | ||||
Short | Symbol in syntax defined by the system | ||||
Control | 1..1 | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
72. Medication.code.coding:ATC.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Short | Representation defined by the system | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
74. Medication.code.coding:ATC.userSelected | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
76. Medication.code.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Short | Medication name | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
78. Medication.status | |||||
Definition | A code to indicate if the medication is in active use. | ||||
Short | active | inactive | entered-in-error | ||||
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Medication Status Codes (required to http://hl7.org/fhir/ValueSet/medication-status|4.0.1 )A coded concept defining if the medication is in active use. | ||||
Type | code | ||||
Is Modifier | true because This element changes the interpretation of all descriptive attributes. | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Pattern Value | active | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
80. Medication.manufacturer | |||||
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. | ||||
Short | Manufacturer of the item | ||||
Control | 0..1 | ||||
Type | Reference(CH EMED EPR Organization) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
82. Medication.form | |||||
Definition | Describes the form of the item. Powder; tablets; capsule. | ||||
Short | Galenic form | ||||
Comments | 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. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from EDQM - Pharmaceutical Dose Form (required to http://fhir.ch/ig/ch-term/ValueSet/edqm-pharmaceuticaldoseform ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
84. Medication.form.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
86. Medication.form.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Medication.form.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
88. Medication.form.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Code defined by a terminology system | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. 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. | ||||
Control | 1..* | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
90. Medication.form.coding.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
92. Medication.form.coding.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Medication.form.coding.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
94. Medication.form.coding.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Short | Identity of the terminology system | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
96. Medication.form.coding.version | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Note | This is a business version Id, not a resource version Id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
98. Medication.form.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). | ||||
Short | Symbol in syntax defined by the system | ||||
Control | 1..1 | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
100. Medication.form.coding.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Short | Representation defined by the system | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
102. Medication.form.coding.userSelected | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | true | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
104. Medication.form.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Short | Plain text representation of the concept | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
106. Medication.amount | |||||
Definition | A relationship of two Quantity values - expressed as a numerator and a denominator. | ||||
Short | Package size | ||||
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Ratio(CH EMED Ratio with EMED Units) | ||||
Is Modifier | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ( (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) ) | ||||
108. Medication.ingredient | |||||
Definition | Identifies a particular constituent of interest in the product. | ||||
Short | Ingredients SHOULD be specified. See also treatment guidance page. | ||||
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
110. Medication.ingredient.id | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
112. Medication.ingredient.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
114. Medication.ingredient.modifierExtension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Comments | All modifiers SHALL be documented in the profile, in order to be usable. | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
116. Medication.ingredient.item[x] | |||||
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. | ||||
Short | The actual ingredient or content | ||||
Control | 1..1 | ||||
Binding | The codes SHOULD be taken from ActivePharmaceuticalIngredient (preferred to http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient ) | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
Slicing | This element introduces a set of slices on Medication.ingredient.item[x] . The slices areUnordered and Closed, and can be differentiated using the following discriminators: | ||||
118. Medication.ingredient.item[x]:itemCodeableConcept | |||||
Slice Name | itemCodeableConcept | ||||
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. | ||||
Short | The actual ingredient or content | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from ActivePharmaceuticalIngredient (preferred to http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient ) | ||||
Type | CodeableConcept | ||||
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
120. Medication.ingredient.item[x]:itemCodeableConcept.id | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
122. Medication.ingredient.item[x]:itemCodeableConcept.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
Slicing | This element introduces a set of slices on Medication.ingredient.item[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
124. Medication.ingredient.item[x]:itemCodeableConcept.coding | |||||
Definition | A reference to a code defined by a terminology system. | ||||
Short | Ingredients coded with SNOMED CT | ||||
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. 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. | ||||
Control | 0..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from ActivePharmaceuticalIngredient (extensible to http://fhir.ch/ig/ch-term/ValueSet/ActivePharmaceuticalIngredient ) | ||||
Type | Coding | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
126. Medication.ingredient.item[x]:itemCodeableConcept.text | |||||
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
Short | Ingredient name | ||||
Comments | Very often the text is the same as a displayName of one of the codings. | ||||
Control | 1..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
128. Medication.ingredient.isActive | |||||
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. | ||||
Short | Active ingredient indicator | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
130. Medication.ingredient.strength | |||||
Definition | A relationship of two Quantity values - expressed as a numerator and a denominator. | ||||
Short | Dose per unit | ||||
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Ratio(CH EMED Ratio with EMED Units) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )rat-1: Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present ( (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists()) ) | ||||
132. Medication.batch | |||||
Definition | Information that only applies to packages (not products). | ||||
Short | Details about packaged medications | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
134. Medication.batch.id | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
136. Medication.batch.extension | |||||
Definition | Implementers should not set or read this element. This element is only kept as optional to allow submission of documents that would contain a value, since those documents are still readable by others. The meaning of this element is undefined in this profile. | ||||
Short | ✕ This element is not supported | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Standard Status | Draft (from Trial Use) | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
138. Medication.batch.modifierExtension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Comments | All modifiers SHALL be documented in the profile, in order to be usable. | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||
140. Medication.batch.lotNumber | |||||
Definition | The assigned lot number of a batch of the specified product. | ||||
Short | Identifier assigned to batch | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
142. Medication.batch.expirationDate | |||||
Definition | When this specific batch of product will expire. | ||||
Short | When batch will expire | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |