MII IG Kerndatensatz-Modul Molekulares Tumorboard
2026.0.0 - release
Unknown region code '276'
MII IG Kerndatensatz-Modul Molekulares Tumorboard, published by Medizininformatik-Initiative. This guide is not an authorized publication; it is the continuous build for version 2026.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medizininformatik-initiative/kerndatensatzmodul-molekulares-tumorboard/ and changes regularly. See the Directory of published versions
| Active as of 2026-02-09 |
Definitions for the mii-pr-mtb-systemtherapie-medication-statement resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. MedicationStatement | |
| Definition | A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information. |
| Short | Record of medication being taken by a patient |
| Comments | When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error. |
| Control | 0..* |
| Is Modifier | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) |
| 2. MedicationStatement.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 | idstring |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| 4. MedicationStatement.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 This element is affected by the following invariants: ele-1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. MedicationStatement.meta.source | |
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
| Short | Identifies where the resource comes from |
| 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 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. MedicationStatement.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. 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..* This element is affected by the following invariants: ele-1 |
| Type | canonical(StructureDefinition, StructureDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. MedicationStatement.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. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| 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())) |
| 12. MedicationStatement.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| 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..* This element is affected by the following invariants: ele-1 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on MedicationStatement.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 14. MedicationStatement.identifier | |
| Definition | Ein Identifikator für den Medikationseintrag Identifiers associated with this Medication Statement that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. |
| Short | IdentifikatorExternal identifier |
| Comments | This is a business identifier, not a resource identifier. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. MedicationStatement.basedOn | |
| Definition | Ein Plan oder eine Anforderung, die durch den Medikationseintrag erfüllt wird. A plan, proposal or order that is fulfilled in whole or in part by this event. |
| Short | Therapieplan oder TherapieempfehlungFulfils plan, proposal or order |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Reference(CarePlan, MedicationRequest, MedicationRequest, CarePlan, ServiceRequest) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 18. MedicationStatement.partOf | |
| Definition | Ein größeres Ereignis, von dem dieses spezielle Ereignis ein Bestandteil oder Schritt ist. A larger event of which this particular event is a component or step. |
| Short | Teil vonPart of referenced event |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 10..* This element is affected by the following invariants: ele-1 |
| Type | Reference(MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Observation, MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Observation) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Requirements | This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| Slicing | This element introduces a set of slices on MedicationStatement.partOf. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. MedicationStatement.partOf:systemischeTherapie | |
| Slice Name | systemischeTherapie |
| Definition | Ein größeres Ereignis, von dem dieses spezielle Ereignis ein Bestandteil oder Schritt ist. A larger event of which this particular event is a component or step. |
| Short | Teil vonPart of referenced event |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | Reference(MII PR Onkologie Systemische Therapie, MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Observation) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 22. MedicationStatement.status | |
| Definition | aktiv | abgeschlossen | Eingabe fehlerhaft | intendiert | gestoppt | pausiert | unbekannt| nicht eingenommen A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally, this will be active or completed. |
| Short | Statusactive | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken |
| Comments | MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1)A coded concept indicating the current status of a MedicationStatement. |
| Type | code |
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. MedicationStatement.category | |
| Definition | Eine Kategorie, die dem Medikationseintrag zugeordnet ist. Indicates where the medication is expected to be consumed or administered. |
| Short | KategorieType of medication usage |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHOULD be taken from Medication usage category codeshttp://hl7.org/fhir/ValueSet/medication-statement-category|4.0.1 (preferred to http://hl7.org/fhir/ValueSet/medication-statement-category)A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. MedicationStatement.category.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 | 0..* This element is affected by the following invariants: ele-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())) |
| Slicing | This element introduces a set of slices on MedicationStatement.category.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 28. MedicationStatement.category.coding:usageCategory | |
| Slice Name | usageCategory |
| Definition | Kategorie, die den Anwendungsbereich des Medikationseintrags beschreibt. A reference to a code defined by a terminology system. |
| Short | Kategorie AnwendungsbereichCode 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..* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see Medication usage category codes (required to http://hl7.org/fhir/ValueSet/medication-statement-category) |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. MedicationStatement.category.coding:contextCode | |
| Slice Name | contextCode |
| Definition | ambulanter Kontakt | stationärer Aufenthalt | stationäre Aufnahme | stationäre Entlassung A reference to a code defined by a terminology system. |
| Short | Kategorie KontextCode 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* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see MII VS Medikation Fallkontext (required to https://www.medizininformatik-initiative.de/fhir/core/modul-medikation/ValueSet/fallkontext) |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. MedicationStatement.medication[x] | |
| Definition | Medikation, welche Gegenstand des Eintrags ist. Code oder Referenz auf Medication-Objekt. Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
| Short | MedikationWhat medication was taken |
| Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes|4.0.1 (example to http://hl7.org/fhir/ValueSet/medication-codes)A coded concept identifying the substance or product being taken. |
| Type | Choice of: CodeableConcept, Reference(Medication, Medication) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| 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 MedicationStatement.medication[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. MedicationStatement.medication[x]:medicationReference | |
| Slice Name | medicationReference |
| Definition | Referenz auf eine Medication-Ressource. Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
| Short | Medikation ReferenzWhat medication was taken |
| Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. |
| Control | 01..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(MII PR Medikation Medication, Medication), CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. MedicationStatement.medication[x]:medicationCodeableConcept | |
| Slice Name | medicationCodeableConcept |
| Definition | Code für das Medikament, welches Gegenstand des Eintrags ist. Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications. |
| Short | Medikation CodeWhat medication was taken |
| Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes|4.0.1 (example to http://hl7.org/fhir/ValueSet/medication-codes)A coded concept identifying the substance or product being taken. |
| Type | CodeableConcept, Reference(Medication) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. MedicationStatement.medication[x]:medicationCodeableConcept.coding | |
| Definition | Wirkstoff / Substanz der systemischen onkologischen Medikation gemäß 16.4 oBDS 2021. A reference to a code defined by a terminology system. |
| Short | Wirkstoff der systemischen MedikationCode 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..* This element is affected by the following invariants: ele-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())) |
| Slicing | This element introduces a set of slices on MedicationStatement.medication[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer | |
| Slice Name | Pharmazentralnummer |
| Definition | Ein Verweis auf einen von der Pharmazentralnummer definierten Code A reference to a code defined by a terminology system. |
| Short | PZN CodeCode 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..* This element is affected by the following invariants: ele-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. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.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 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 44. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.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 |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 46. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe | |
| Slice Name | atcClassDe |
| Definition | Ein Verweis auf einen von der deutschen Fassung der Anatomisch-Therapeutisch-Chemischen Klassifikation definierten Code A reference to a code defined by a terminology system. |
| Short | ATC Klassifikation deutsche VersionCode 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..* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see MII VS Medikation ATC (required to https://www.medizininformatik-initiative.de/fhir/core/modul-medikation/ValueSet/mii-vs-medikation-atc) |
| 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. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.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 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 50. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.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 |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 52. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn | |
| Slice Name | atcClassEn |
| Definition | Ein Verweis auf einen von der WHO Anatomisch-Therapeutisch-Chemischen Klassifikation definierten Code A reference to a code defined by a terminology system. |
| Short | Anatomical Therapeutic Chemical Classification SystemCode 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..* This element is affected by the following invariants: ele-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. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.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 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.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 |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 58. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII | |
| Slice Name | UNII |
| Definition | Ein Unique Ingredient Identifier (UNII) aus dem Global Substance Registration System der amerikanischen Food & Drug Administration A reference to a code defined by a terminology system. |
| Short | Unique Ingredient IdentifierCode 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..* This element is affected by the following invariants: ele-1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see MII VS Onkologie Systemische Therapie Substanzen (UNII) (extensible to https://www.medizininformatik-initiative.de/fhir/ext/modul-onko/ValueSet/mii-vs-onko-systemische-therapie-substanzen-unii) |
| 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. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII.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 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 62. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII.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 |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 64. MedicationStatement.medication[x]:medicationCodeableConcept.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 | 0..1 This element is affected by the following invariants: ele-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())) |
| 66. MedicationStatement.subject | |
| Definition | The person, animal or group who is/was taking the medication. |
| Short | Who is/was taking the medication |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Patient, Patient, Group) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 68. MedicationStatement.context | |
| Definition | Fall oder Kontakt in Verbindung mit dem Medikationseintrag The encounter or episode of care that establishes the context for this MedicationStatement. |
| Short | KontextEncounter / Episode associated with MedicationStatement |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Encounter, EpisodeOfCare, Encounter, EpisodeOfCare) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 70. MedicationStatement.effective[x] | |
| Definition | Die Zeitspanne, in der angegeben wird, dass der Patient das Medikament eingenommen hat oder einnehmen wird. The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No). |
| Short | Zeitpunkt oder ZeitraumThe date/time or interval when the medication is/was/will be taken |
| Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | Choice of: dateTime, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| 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 MedicationStatement.effective[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 72. MedicationStatement.effective[x]:effectiveDateTime | |
| Slice Name | effectiveDateTime |
| Definition | Der Zeitpunkt, an dem der Patient das Medikament eingenommen hat oder einnehmen wird. The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No). |
| Short | ZeitpunktThe date/time or interval when the medication is/was/will be taken |
| Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | dateTime, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. MedicationStatement.effective[x]:effectivePeriod | |
| Slice Name | effectivePeriod |
| Definition | Der Zeitraum, in dem der Patient das Medikament eingenommen hat oder einnehmen wird. The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationStatement.taken element is No). |
| Short | ZeitraumThe date/time or interval when the medication is/was/will be taken |
| Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Period, dateTime |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. MedicationStatement.effective[x]:effectivePeriod.start | |
| Definition | Startdatum der systemischen Medikation gemäß 16.7 oBDS 2021. The start of the period. The boundary is inclusive. |
| Short | Startdatum der systemischen MedikationStarting time with inclusive boundary |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. MedicationStatement.effective[x]:effectivePeriod.end | |
| Definition | Enddatum der systemischen Medikation gemäß 16.9 oBDS 2021. The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Short | Enddatum der systemischen MedikationEnd time with inclusive boundary, if not ongoing |
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. MedicationStatement.dateAsserted | |
| Definition | Das Datum, an dem der Medikationseintrag von der Informationsquelle bestätigt wurde. The date when the medication statement was asserted by the information source. |
| Short | Datum BestätigungWhen the statement was asserted? |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. MedicationStatement.informationSource | |
| Definition | Die Person oder Organisation, die die Information über die Einnahme dieses Medikaments bereitgestellt hat. The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g. Claim or MedicationRequest. |
| Short | InformationsquellePerson or organization that provided the information about the taking of this medication |
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Reference(Patient, Practitioner, PractitionerRole, RelatedPerson, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Organization) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 84. MedicationStatement.reasonCode | |
| Definition | Grund für den Medikationseintrag als Code. A reason for why the medication is being/was taken. |
| Short | Grund CodeReason for why the medication is being/was taken |
| Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code|4.0.1 (example to http://hl7.org/fhir/ValueSet/condition-code)A coded concept identifying why the medication is being taken. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. MedicationStatement.reasonReference | |
| Definition | Grund für den Medikationseintrag als Referenz auf Condition- oder Observation-Ressource. Condition or observation that supports why the medication is being/was taken. |
| Short | Grund ReferenzCondition or observation that supports why the medication is being/was taken |
| Comments | This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Reference(Condition, Observation, DiagnosticReport, Condition, Observation, DiagnosticReport) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) |
| 88. MedicationStatement.note | |
| Definition | Zusätzliche Informationen zum Medikationseintrag als Freitext. Provides extra information about the medication statement that is not conveyed by the other attributes. |
| Short | HinweisFurther information about the statement |
| Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Annotation |
| Is Modifier | false |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 90. MedicationStatement.note.text | |
| Definition | Protokoll der systemischen Medikation gemäß 16.6 oBDS 2021. The text of the annotation in markdown format. |
| Short | ProtokollThe annotation - text content (as markdown) |
| Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 92. MedicationStatement.dosage | |
| Definition | Details zur Dosierung des Medikamentes. Indicates how the medication is/was or should be taken by the patient. |
| Short | DosierungDetails of how medication is/was taken or should be taken |
| Comments | The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest. |
| Control | 0..1* This element is affected by the following invariants: ele-1 |
| Type | Dosage(Dosage DE) |
| Is Modifier | false |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) DosageStructuredOrFreeTextWarning: Die Dosierungsangabe darf entweder nur als Freitext oder nur als vollständige strukturierte Information erfolgen — eine Mischung ist nicht erlaubt. ( (%resource.ofType(MedicationRequest).dosageInstruction |
ofType(MedicationDispense).dosageInstruction |
ofType(MedicationStatement).dosage).all(
(text.exists() and timing.empty() and doseAndRate.empty()) or
(text.empty() and (timing.exists() or doseAndRate.exists()))
))DosageStructuredRequiresBoth: Wenn eine strukturierte Dosierungsangabe erfolgt, müssen sowohl timing als auch doseAndRate angegeben werden. ( (%resource.ofType(MedicationRequest).dosageInstruction |
ofType(MedicationDispense).dosageInstruction |
ofType(MedicationStatement).dosage).all(
(timing.exists() implies doseAndRate.exists()) and
(doseAndRate.exists() implies timing.exists())
))DosageDoseUnitSameCode: Die Dosiereinheit muss über alle Dosierungen gleich sein. ( (%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
doseAndRate.exists() implies
(
%resource.dosageInstruction.doseAndRate.dose.ofType(Quantity).code |
%resource.dosageInstruction.doseAndRate.dose.ofType(Range).low.code |
%resource.dosageInstruction.doseAndRate.dose.ofType(Range).high.code
).distinct().count() = 1
))DosageWarnungViererschemaInText: Hinweis: In Dosage.text wurde ein Viererschema (z. B. 1-1-1-1) erkannt. Bitte prüfen, ob dies strukturiert abgebildet werden kann. ( text.exists() implies text.matches('.*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\d+.*').not())FreeTextSingleDosageOnlyWarning: Wenn eine Dosierung als reiner Freitext angegeben ist, soll nur genau ein Dosage-Element existieren. ( (
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).exists(text.exists() and timing.empty() and doseAndRate.empty())
)
implies
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).count() = 1
))dsg-1: If present, dosage must include free text or structured data ( text.exists() or doseAndRate.exists()) |
| 94. MedicationStatement.dosage.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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..* This element is affected by the following invariants: ele-1 |
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 96. MedicationStatement.dosage.sequence | |
| Definition | Indicates the order in which the dosage instructions should be applied or interpreted. |
| Short | The order of the dosage instructions |
| Comments | 32 bit number; for values larger than this, use decimal |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | integer |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 98. MedicationStatement.dosage.text | |
| Definition | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf'. Als Quelle dient hier ausschließlich der Arzt oder Apotheker Free text dosage instructions e.g. SIG. |
| Short | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf'Free text dosage instructions e.g. SIG |
| Comments | Die Freitextdosierung sollte nur angegeben werden, wenn aufgrund der Komplexität keine strukturierte Dosierung möglich ist, um widersprüchliche Anweisungen zu vermeiden. |
| Control | 0..1 This element is affected by the following invariants: ele-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 | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 100. MedicationStatement.dosage.timing | |
| Definition | Wann das Medikament verabreicht werden soll. When medication should be administered. |
| Short | Wann das Medikament verabreicht werden sollWhen medication should be administered |
| Comments | Um widersprüchliche Anweisungen zu vermeiden, ist entweder Dosage.timing oder Dosage.text zu befüllen. Falls eine strukturierte Dosierung als Text abgebildet werden soll ist dafür die GeneratedDosageInstructionsMeta Extension zu verwenden. This attribute might not always be populated while the Dosage.text is expected to be populated. If both are populated, then the Dosage.text should reflect the content of the Dosage.timing. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Timing(Timing DE) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 102. MedicationStatement.dosage.timing.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| 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..* This element is affected by the following invariants: ele-1 |
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 104. MedicationStatement.dosage.timing.event | |
| Definition | Identifies specific times when the event occurs. |
| Short | When the event occurs |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 106. MedicationStatement.dosage.timing.repeat | |
| Definition | Eine Menge von Regeln, die beschreiben, wann das Ereignis geplant ist. A set of rules that describe when the event is scheduled. |
| Short | Wann das Ereignis stattfinden sollWhen the event is to occur |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Element |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Many timing schedules are determined by regular repetitions. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) ( offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())))tim-5: period SHALL be a non-negative value ( period.exists() implies period >= 0)tim-6: If there's a periodMax, there must be a period ( periodMax.empty() or period.exists())tim-7: If there's a durationMax, there must be a duration ( durationMax.empty() or duration.exists())tim-8: If there's a countMax, there must be a count ( countMax.empty() or count.exists())tim-1: if there's a duration, there needs to be duration units ( duration.empty() or durationUnit.exists())tim-10: If there's a timeOfDay, there cannot be a when, or vice versa ( timeOfDay.empty() or when.empty())tim-2: if there's a period, there needs to be period units ( period.empty() or periodUnit.exists())tim-4: duration SHALL be a non-negative value ( duration.exists() implies duration >= 0)TimingSingleDosageForTimeOfDay: Wenn nur timeOfDay verwendet wird und täglich dosiert wird, ist die Angabe in einem einzigen Dosage-Element zu modellieren. Mehrere Dosage-Elemente sind nur zulässig, wenn sich die Dosis (Wert) unterscheidet. ( (
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.empty() and
timing.repeat.timeOfDay.exists() and
timing.repeat.when.empty() and
(timing.repeat.period.exists() and timing.repeat.period = 1) and
(timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
)
implies
(
(
(
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).where(
timing.repeat.dayOfWeek.empty() and timing.repeat.timeOfDay.exists() and timing.repeat.when.empty() and (timing.repeat.period.exists() and timing.repeat.period = 1) and (timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
).count() = 1
)
or
(
(
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).where(
timing.repeat.dayOfWeek.empty() and timing.repeat.timeOfDay.exists() and timing.repeat.when.empty() and (timing.repeat.period.exists() and timing.repeat.period = 1) and (timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
).doseAndRate.dose.ofType(Quantity).value.distinct().count() > 1
)
)
))TimingSingleDosageForWhen: Wenn nur when verwendet wird und täglich dosiert wird, ist die Angabe in einem einzigen Dosage-Element zu modellieren. Mehrere Dosage-Elemente sind nur zulässig, wenn sich die Dosis (Wert) unterscheidet. ( (
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.empty() and
timing.repeat.when.exists() and
timing.repeat.timeOfDay.empty() and
(timing.repeat.period.exists() and timing.repeat.period = 1) and
(timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
)
implies
(
(
(
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).where(
timing.repeat.dayOfWeek.empty() and timing.repeat.when.exists() and timing.repeat.timeOfDay.empty() and (timing.repeat.period.exists() and timing.repeat.period = 1) and (timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
).count() = 1
)
or
(
(
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).where(
timing.repeat.dayOfWeek.empty() and timing.repeat.when.exists() and timing.repeat.timeOfDay.empty() and (timing.repeat.period.exists() and timing.repeat.period = 1) and (timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
).doseAndRate.dose.ofType(Quantity).value.distinct().count() > 1
)
)
))TimingBoundsUnitMatchesCode: boundsDuration.unit muss zur UCUM boundsDuration.code passen (z. B. 'Woche(n)' nur mit code='wk'). ( bounds.ofType(Duration).exists().not() or (
(
bounds.ofType(Duration).code = 'd'
implies
(
bounds.ofType(Duration).unit = 'Tag(e)' or
bounds.ofType(Duration).unit = 'Tag' or
bounds.ofType(Duration).unit = 'Tage'
)
) and (
bounds.ofType(Duration).code = 'wk'
implies
(
bounds.ofType(Duration).unit = 'Woche(n)' or
bounds.ofType(Duration).unit = 'Woche' or
bounds.ofType(Duration).unit = 'Wochen'
)
) and (
bounds.ofType(Duration).code = 'mo'
implies
(
bounds.ofType(Duration).unit = 'Monat(e)' or
bounds.ofType(Duration).unit = 'Monat' or
bounds.ofType(Duration).unit = 'Monate'
)
) and (
bounds.ofType(Duration).code = 'a'
implies
(
bounds.ofType(Duration).unit = 'Jahr(e)' or
bounds.ofType(Duration).unit = 'Jahr' or
bounds.ofType(Duration).unit = 'Jahre'
)
)
))tim-1: if there's a duration, there needs to be duration units (duration.empty() or durationUnit.exists()) tim-2: if there's a period, there needs to be period units (period.empty() or periodUnit.exists()) tim-4: duration SHALL be a non-negative value (duration.exists() implies duration >= 0) tim-5: period SHALL be a non-negative value (period.exists() implies period >= 0) tim-6: If there's a periodMax, there must be a period (periodMax.empty() or period.exists()) tim-7: If there's a durationMax, there must be a duration (durationMax.empty() or duration.exists()) tim-8: If there's a countMax, there must be a count (countMax.empty() or count.exists()) tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) (offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not()))) tim-10: If there's a timeOfDay, there cannot be a when, or vice versa (timeOfDay.empty() or when.empty()) |
| 108. MedicationStatement.dosage.timing.repeat.bounds[x] | |
| Definition | Entweder eine Dauer für die Länge des Zeitplans, ein Bereich möglicher Längen oder äußere Begrenzungen für Start- und/oder Endgrenzen des Zeitplans. Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
| Short | Länge/Bereich der Längen oder (Start- und/oder End-)GrenzenLength/Range of lengths, or (Start and/or end) limits |
| Comments | tbd |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Choice of: Duration, Range, Period |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| 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 MedicationStatement.dosage.timing.repeat.bounds[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 110. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration | |
| Slice Name | boundsDuration |
| Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
| Short | Dauer der Dosieranweisung ausgedrückt in UCUM-EinheitenLength/Range of lengths, or (Start and/or end) limits |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Duration, Period, Range |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 112. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 114. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.comparator | |
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 116. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 118. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | UCUM-Einheit für die DauerSystem that defines coded unit form |
| Comments | Die UCUM-Einheit für die Dauer, z. B. d für Tag, h für Stunde, min für Minute. |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Fixed Value | http://unitsofmeasure.org |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 120. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 122. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange | |
| Slice Name | boundsRange |
| Definition | Entweder eine Dauer für die Länge des Zeitplans, ein Bereich möglicher Längen oder äußere Begrenzungen für Start- und/oder Endgrenzen des Zeitplans. Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
| Short | Länge/Bereich der Längen oder (Start- und/oder End-)GrenzenLength/Range of lengths, or (Start and/or end) limits |
| Comments | tbd |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Range, Period, Duration |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 124. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low | |
| Definition | The low limit. The boundary is inclusive. |
| Short | Low limit |
| Comments | If the low element is missing, the low boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity(SimpleQuantity, SimpleQuantity) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 126. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 128. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.comparator | |
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 130. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 132. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 134. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 136. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high | |
| Definition | The high limit. The boundary is inclusive. |
| Short | High limit |
| Comments | If the high element is missing, the high boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity(SimpleQuantity, SimpleQuantity) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 138. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 140. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.comparator | |
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 142. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 144. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 146. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 148. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod | |
| Slice Name | boundsPeriod |
| Definition | Entweder eine Dauer für die Länge des Zeitplans, ein Bereich möglicher Längen oder äußere Begrenzungen für Start- und/oder Endgrenzen des Zeitplans. Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. |
| Short | Länge/Bereich der Längen oder (Start- und/oder End-)GrenzenLength/Range of lengths, or (Start and/or end) limits |
| Comments | tbd |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Period, Duration, Range |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 150. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.start | |
| Definition | The start of the period. The boundary is inclusive. |
| Short | Starting time with inclusive boundary |
| Comments | If the low element is missing, the meaning is that the low boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 152. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.end | |
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
| Short | End time with inclusive boundary, if not ongoing |
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 154. MedicationStatement.dosage.timing.repeat.count | |
| Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. |
| Short | Number of times to repeat |
| Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Repetitions may be limited by end time or total occurrences. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 156. MedicationStatement.dosage.timing.repeat.countMax | |
| Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. |
| Short | Maximum number of times to repeat |
| Comments | 32 bit number; for values larger than this, use decimal |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 158. MedicationStatement.dosage.timing.repeat.duration | |
| Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. |
| Short | How long when it happens |
| Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 160. MedicationStatement.dosage.timing.repeat.durationMax | |
| Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. |
| Short | How long when it happens (Max) |
| Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Some activities are not instantaneous and need to be maintained for a period of time. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 162. MedicationStatement.dosage.timing.repeat.durationUnit | |
| Definition | The units of time for the duration, in UCUM units. |
| Short | s | min | h | d | wk | mo | a - unit of time (UCUM) |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1)A unit of time (units from UCUM). |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 164. MedicationStatement.dosage.timing.repeat.frequency | |
| Definition | Die Anzahl der Wiederholungen innerhalb des angegebenen Zeitraums. Falls frequencyMax vorhanden ist, gibt dieses Element die Untergrenze des zulässigen Bereichs der Häufigkeit an. The number of times to repeat the action within the specified period. If frequencyMax is present, this element indicates the lower bound of the allowed range of the frequency. |
| Short | Ereignis tritt frequency-mal pro Zeitraum aufEvent occurs frequency times per period |
| Comments | 32 bit number; for values larger than this, use decimal |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Meaning if Missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 166. MedicationStatement.dosage.timing.repeat.frequencyMax | |
| Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. |
| Short | Event occurs up to frequencyMax times per period |
| Comments | 32 bit number; for values larger than this, use decimal |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 168. MedicationStatement.dosage.timing.repeat.period | |
| Definition | Gibt die Zeitspanne an, über die die Wiederholungen stattfinden sollen; z. B. um „3-mal täglich“ auszudrücken, wäre 3 die Häufigkeit und „1 Tag“ der Zeitraum. Falls periodMax vorhanden ist, gibt dieses Element die Untergrenze des zulässigen Bereichs der Zeitspanne an. Indicates the duration of time over which repetitions are to occur; e.g. to express "3 times per day", 3 would be the frequency and "1 day" would be the period. If periodMax is present, this element indicates the lower bound of the allowed range of the period length. |
| Short | Ereignis tritt frequency-mal pro Zeitraum aufEvent occurs frequency times per period |
| Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 170. MedicationStatement.dosage.timing.repeat.periodMax | |
| Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. |
| Short | Upper limit of period (3-4 hours) |
| Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 172. MedicationStatement.dosage.timing.repeat.periodUnit | |
| Definition | Die Zeiteinheit für den Zeitraum, in UCUM-Einheiten. The units of time for the period in UCUM units. |
| Short | s | min | h | d | wk | mo | a - Zeiteinheit (UCUM)s | min | h | d | wk | mo | a - unit of time (UCUM) |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from UnitsOfTimehttp://hl7.org/fhir/ValueSet/units-of-time|4.0.1 (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1)A unit of time (units from UCUM). |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 174. MedicationStatement.dosage.timing.repeat.dayOfWeek | |
| Definition | Wenn ein oder mehrere Wochentage angegeben sind, findet die Aktion nur an den angegebenen Tagen statt. If one or more days of week is provided, then the action happens only on the specified day(s). |
| Short | mon | tue | wed | thu | fri | sat | sun |
| Comments | Wenn keine Tage angegeben sind, wird angenommen, dass die Aktion an jedem Tag wie sonst angegeben stattfindet. If no days are specified, the action is assumed to happen every day as otherwise specified. The elements frequency and period cannot be used as well as dayOfWeek. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 176. MedicationStatement.dosage.timing.repeat.timeOfDay | |
| Definition | Angegebene Tageszeit, zu der die Aktion stattfinden soll. Specified time of day for action to take place. |
| Short | Tageszeit für die AktionTime of day for action |
| Comments | Wenn eine Tageszeit angegeben ist, wird angenommen, dass die Aktion jeden Tag (ggf. gefiltert durch dayOfWeek) zu den angegebenen Zeiten stattfindet. When time of day is specified, it is inferred that the action happens every day (as filtered by dayofWeek) on the specified times. The elements when, frequency and period cannot be used as well as timeOfDay. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | time |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 178. MedicationStatement.dosage.timing.repeat.when | |
| Definition | Ein ungefährer Zeitraum während des Tages, der möglicherweise mit einem Ereignis des täglichen Lebens verknüpft ist und angibt, wann die Aktion stattfinden soll. An approximate time period during the day, potentially linked to an event of daily living that indicates when the action should occur. |
| Short | Code für den Zeitraum des AuftretensCode for time period of occurrence |
| Comments | Wenn mehr als ein Ereignis angegeben ist, bezieht sich das Ereignis auf die Vereinigung der angegebenen Ereignisse. When more than one event is listed, the event is tied to the union of the specified events. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from EventTiminghttp://hl7.org/fhir/ValueSet/event-timing|4.0.1 (required to http://hl7.org/fhir/ValueSet/event-timing|4.0.1)Real world event relating to the schedule. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 180. MedicationStatement.dosage.timing.repeat.offset | |
| Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. |
| Short | Minutes from event (before or after) |
| Comments | 32 bit number; for values larger than this, use decimal |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | unsignedInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 182. MedicationStatement.dosage.asNeeded[x] | |
| Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). |
| Short | Take "as needed" (for x) |
| Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1 (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason)A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. |
| Type | Choice of: boolean, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| 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 MedicationStatement.dosage.asNeeded[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 184. MedicationStatement.dosage.asNeeded[x]:asNeededBoolean | |
| Slice Name | asNeededBoolean |
| Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). |
| Short | Take "as needed" (for x) |
| Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | boolean, CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 186. MedicationStatement.dosage.asNeeded[x]:asNeededCodeableConcept | |
| Slice Name | asNeededCodeableConcept |
| Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). |
| Short | Take "as needed" (for x) |
| Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason|4.0.1 (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason)A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. |
| Type | CodeableConcept, boolean |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 188. MedicationStatement.dosage.site | |
| Definition | Körperstelle, an der das Medikament verabreicht wurde/wird oder werden soll. Body site to administer to. |
| Short | VerabreichungsortBody site to administer to |
| Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codes|4.0.1 (example to http://hl7.org/fhir/ValueSet/approach-site-codes)A coded concept describing the site location the medicine enters into or onto the body. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | A coded specification of the anatomic site where the medication first enters the body. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 190. MedicationStatement.dosage.site.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 | 0..* This element is affected by the following invariants: ele-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())) |
| Slicing | This element introduces a set of slices on MedicationStatement.dosage.site.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 192. MedicationStatement.dosage.site.coding:SNOMED | |
| Slice Name | SNOMED |
| Definition | Ein Verweis auf einen von SNOMED CT definierten Code A reference to a code defined by a terminology system. |
| Short | SNOMED CT CodeCode 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..* This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see For codes, see Target Site - IPS ![]() (example to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips)target site IPS |
| 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. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 194. MedicationStatement.dosage.site.coding:SNOMED.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 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 196. MedicationStatement.dosage.site.coding:SNOMED.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 |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 198. MedicationStatement.dosage.route | |
| Definition | Der Weg, auf dem das Medikament verabreicht wurde/wird oder werden soll. How drug should enter body. |
| Short | VerabreichungswegHow drug should enter body |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codes|4.0.1 (example to http://hl7.org/fhir/ValueSet/route-codes)A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 200. MedicationStatement.dosage.route.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 | 0..* This element is affected by the following invariants: ele-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())) |
| Slicing | This element introduces a set of slices on MedicationStatement.dosage.route.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 202. MedicationStatement.dosage.route.coding:EDQM | |
| Slice Name | EDQM |
| Definition | Ein Verweis auf einen durch EDQM Standard Terms definierten Code A reference to a code defined by a terminology system. |
| Short | EDQM CodeCode 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* This element is affected by the following invariants: ele-1 |
| Binding | The codes SHOULD be taken from For codes, see Medicine EDQM Route of Administration - IPS (preferred to http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration)EDQM Standard Terms |
| 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. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 204. MedicationStatement.dosage.route.coding:EDQM.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 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 206. MedicationStatement.dosage.route.coding:EDQM.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 |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 208. MedicationStatement.dosage.route.coding:SNOMED | |
| Slice Name | SNOMED |
| Definition | Ein Verweis auf einen von SNOMED CT definierten Code A reference to a code defined by a terminology system. |
| Short | SNOMED CT CodeCode 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* This element is affected by the following invariants: ele-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. |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 210. MedicationStatement.dosage.route.coding:SNOMED.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 This element is affected by the following invariants: ele-1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 212. MedicationStatement.dosage.route.coding:SNOMED.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 |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 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())) |
| 214. MedicationStatement.dosage.doseAndRate | |
| Definition | Die verabreichte Menge des Medikaments. The amount of medication administered. |
| Short | Menge des verabreichten MedikamentsAmount of medication administered |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Element |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 216. MedicationStatement.dosage.doseAndRate.type | |
| Definition | Die Dosisdichte gibt an ob und in welchem Ausmass eine Dosisreduktion vorliegt. The kind of dose or rate specified, for example, ordered or calculated. |
| Short | DosisdichteThe kind of dose or rate specified |
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | For example codes, see DoseAndRateTypehttp://hl7.org/fhir/ValueSet/dose-rate-type|4.0.1 (example to http://hl7.org/fhir/ValueSet/dose-rate-type)The kind of dose or rate specified. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | If the type is not populated, assume to be "ordered". |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 218. MedicationStatement.dosage.doseAndRate.dose[x] | |
| Definition | Amount of medication per dose. |
| Short | Amount of medication per dose |
| Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Choice of: Range, Quantity(SimpleQuantity, SimpleQuantity) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Requirements | The amount of therapeutic or other substance given at one administration event. |
| 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 MedicationStatement.dosage.doseAndRate.dose[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 220. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity | |
| Slice Name | doseQuantity |
| Definition | Menge des Medikaments pro Dosis. Amount of medication per dose. |
| Short | Menge des Medikaments pro DosisAmount of medication per dose |
| Comments | Beachten Sie, dass dies die Menge des angegebenen Medikaments angibt, nicht die Menge für die einzelnen Wirkstoffe. Jede Wirkstoffmenge kann in der Medication-Ressource kommuniziert werden. Zum Beispiel, wenn man angeben möchte, dass eine Tablette 375 mg enthält und die Dosis eine Tablette beträgt, kann man die Medication-Ressource verwenden, um zu dokumentieren, dass die Tablette aus 375 mg des Wirkstoffs XYZ besteht. Alternativ, wenn die Dosis 375 mg beträgt, muss man möglicherweise nur angeben, dass es sich um eine Tablette handelt. Bei einer Infusion wie Dopamin, bei der 400 mg Dopamin in 500 ml einer Infusionslösung gemischt werden, würde dies alles in der Medication-Ressource kommuniziert werden. Wenn die Verabreichung nicht als sofortig vorgesehen ist (Rate ist vorhanden oder Timing hat eine Dauer), kann dies angegeben werden, um die Gesamtmenge anzugeben, die über den im Zeitplan angegebenen Zeitraum verabreicht werden soll, z. B. 500 ml in der Dosis, wobei Timing verwendet wird, um anzugeben, dass dies über 4 Stunden erfolgen soll. Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from For codes, see Dosage DoseQuantity ValueSet (required to http://ig.fhir.de/igs/medication/ValueSet/DosageDoseQuantityDE) |
| Type | Quantity(SimpleQuantity, SimpleQuantity), Range |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | The amount of therapeutic or other substance given at one administration event. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 222. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 224. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.comparator | |
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 226. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 228. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 230. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 232. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange | |
| Slice Name | doseRange |
| Definition | Amount of medication per dose. |
| Short | Amount of medication per dose |
| Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Range, Quantity(SimpleQuantity) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | The amount of therapeutic or other substance given at one administration event. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 234. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low | |
| Definition | The low limit. The boundary is inclusive. |
| Short | Low limit |
| Comments | If the low element is missing, the low boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity(SimpleQuantity, SimpleQuantity) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 236. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 238. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.comparator | |
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 240. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 242. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 244. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 246. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high | |
| Definition | The high limit. The boundary is inclusive. |
| Short | High limit |
| Comments | If the high element is missing, the high boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity(SimpleQuantity, SimpleQuantity) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 248. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 250. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.comparator | |
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 252. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 254. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 256. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 258. MedicationStatement.dosage.doseAndRate.rate[x] | |
| Definition | Amount of medication per unit of time. |
| Short | Amount of medication per unit of time |
| Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Choice of: Ratio, Range, Quantity(SimpleQuantity, SimpleQuantity) |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
| 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 MedicationStatement.dosage.doseAndRate.rate[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 260. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio | |
| Slice Name | rateRatio |
| Definition | Amount of medication per unit of time. |
| Short | Amount of medication per unit of time |
| Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Ratio, Quantity(SimpleQuantity), Range |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 262. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator | |
| Definition | The value of the numerator. |
| Short | Numerator value |
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists()) |
| 264. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 266. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.comparator | |
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 268. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 270. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 272. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 274. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator | |
| Definition | The value of the denominator. |
| Short | Denominator value |
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists()) |
| 276. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 278. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.comparator | |
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 280. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 282. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 284. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 286. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange | |
| Slice Name | rateRange |
| Definition | Amount of medication per unit of time. |
| Short | Amount of medication per unit of time |
| Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Range, Quantity(SimpleQuantity), Ratio |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 288. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low | |
| Definition | The low limit. The boundary is inclusive. |
| Short | Low limit |
| Comments | If the low element is missing, the low boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity(SimpleQuantity, SimpleQuantity) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 290. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 292. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.comparator | |
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 294. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 296. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 298. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 300. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high | |
| Definition | The high limit. The boundary is inclusive. |
| Short | High limit |
| Comments | If the high element is missing, the high boundary is not known. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity(SimpleQuantity, SimpleQuantity) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 302. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 304. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.comparator | |
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 306. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 308. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 310. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 312. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity | |
| Slice Name | rateQuantity |
| Definition | The comparator is not used on a SimpleQuantity Amount of medication per unit of time. |
| Short | A fixed quantity (no comparator)Amount of medication per unit of time |
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity(SimpleQuantity, SimpleQuantity), Ratio, Range |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 314. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 316. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.comparator | |
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 318. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 320. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 322. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 324. MedicationStatement.dosage.maxDosePerPeriod | |
| Definition | Upper limit on medication per unit of time. |
| Short | Upper limit on medication per unit of time |
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day". |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Ratio |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. |
| 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())) |
| 326. MedicationStatement.dosage.maxDosePerPeriod.numerator | |
| Definition | The value of the numerator. |
| Short | Numerator value |
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists()) |
| 328. MedicationStatement.dosage.maxDosePerPeriod.numerator.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 330. MedicationStatement.dosage.maxDosePerPeriod.numerator.comparator | |
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 332. MedicationStatement.dosage.maxDosePerPeriod.numerator.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 334. MedicationStatement.dosage.maxDosePerPeriod.numerator.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 336. MedicationStatement.dosage.maxDosePerPeriod.numerator.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 338. MedicationStatement.dosage.maxDosePerPeriod.denominator | |
| Definition | The value of the denominator. |
| Short | Denominator value |
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists()) |
| 340. MedicationStatement.dosage.maxDosePerPeriod.denominator.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 342. MedicationStatement.dosage.maxDosePerPeriod.denominator.comparator | |
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 344. MedicationStatement.dosage.maxDosePerPeriod.denominator.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 346. MedicationStatement.dosage.maxDosePerPeriod.denominator.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 348. MedicationStatement.dosage.maxDosePerPeriod.denominator.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 350. MedicationStatement.dosage.maxDosePerAdministration | |
| Definition | Upper limit on medication per administration. |
| Short | Upper limit on medication per administration |
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Quantity(SimpleQuantity, SimpleQuantity) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) |
| 352. MedicationStatement.dosage.maxDosePerAdministration.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Short | Numerical value (with implicit precision) |
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Precision is handled implicitly in almost all cases of measurement. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 354. MedicationStatement.dosage.maxDosePerAdministration.comparator | |
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. |
| Short | < | <= | >= | > - how to understand the value |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..01 This element is affected by the following invariants: ele-1 |
| Binding | The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 356. MedicationStatement.dosage.maxDosePerAdministration.unit | |
| Definition | A human-readable form of the unit. |
| Short | Unit representation |
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
| Control | 0..1 This element is affected by the following invariants: ele-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 | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 358. MedicationStatement.dosage.maxDosePerAdministration.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Short | System that defines coded unit form |
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
| Control | 10..1 This element is affected by the following invariants: ele-1, qty-3 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need to know the system that defines the coded form of the unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 360. MedicationStatement.dosage.maxDosePerAdministration.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Short | Coded form of the unit |
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. |
| Control | 10..1 This element is affected by the following invariants: ele-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. MedicationStatement | |
| 2. MedicationStatement.dosage | |
| Control | 0..1 |
| 4. MedicationStatement.dosage.doseAndRate | |
| 6. MedicationStatement.dosage.doseAndRate.type | |
| Definition | Die Dosisdichte gibt an ob und in welchem Ausmass eine Dosisreduktion vorliegt. |
| Short | Dosisdichte |
| Must Support | true |
| 8. MedicationStatement.dosage.doseAndRate.type.coding | |
| 10. MedicationStatement.dosage.doseAndRate.type.coding.system | |
| Pattern Value | https://www.medizininformatik-initiative.de/fhir/ext/modul-mtb/CodeSystem/mii-cs-mtb-dosisdichte |
| 12. MedicationStatement.dosage.doseAndRate.type.coding.code | |
| Binding | The codes SHALL be taken from MII VS Dosisdichte (required to https://www.medizininformatik-initiative.de/fhir/ext/modul-mtb/ValueSet/mii-vs-mtb-dosisdichte) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. MedicationStatement | |||||
| Definition | A record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information. | ||||
| Short | Record of medication being taken by a patient | ||||
| Comments | When interpreting a medicationStatement, the value of the status and NotTaken needed to be considered: MedicationStatement.status + MedicationStatement.wasNotTaken Status=Active + NotTaken=T = Not currently taking Status=Completed + NotTaken=T = Not taken in the past Status=Intended + NotTaken=T = No intention of taking Status=Active + NotTaken=F = Taking, but not as prescribed Status=Active + NotTaken=F = Taking Status=Intended +NotTaken= F = Will be taking (not started) Status=Completed + NotTaken=F = Taken in past Status=In Error + NotTaken=N/A = In Error. | ||||
| Control | 0..* | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty()) | ||||
| 2. MedicationStatement.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 | ||||
| Must Support | true | ||||
| Summary | true | ||||
| 4. MedicationStatement.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 This element is affected by the following invariants: ele-1 | ||||
| Type | Meta | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. MedicationStatement.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 8. MedicationStatement.meta.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. MedicationStatement.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
| Short | Version specific identifier | ||||
| 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 This element is affected by the following invariants: ele-1 | ||||
| Type | id | ||||
| 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())) | ||||
| 12. MedicationStatement.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| 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 This element is affected by the following invariants: ele-1 | ||||
| Type | instant | ||||
| 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())) | ||||
| 14. MedicationStatement.meta.source | |||||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
| Short | Identifies where the resource comes from | ||||
| 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 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 16. MedicationStatement.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..* This element is affected by the following invariants: ele-1 | ||||
| Type | canonical(StructureDefinition) | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 18. MedicationStatement.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| 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 | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. MedicationStatement.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| 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 | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. MedicationStatement.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. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| 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. MedicationStatement.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 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. MedicationStatement.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 This element is affected by the following invariants: ele-1 | ||||
| Type | Narrative | ||||
| 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. MedicationStatement.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 | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 30. MedicationStatement.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. MedicationStatement.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| 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()) | ||||
| Slicing | This element introduces a set of slices on MedicationStatement.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 34. MedicationStatement.identifier | |||||
| Definition | Ein Identifikator für den Medikationseintrag | ||||
| Short | Identifikator | ||||
| Comments | This is a business identifier, not a resource identifier. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Identifier | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. MedicationStatement.basedOn | |||||
| Definition | Ein Plan oder eine Anforderung, die durch den Medikationseintrag erfüllt wird. | ||||
| Short | Therapieplan oder Therapieempfehlung | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(CarePlan, MedicationRequest) | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 38. MedicationStatement.partOf | |||||
| Definition | Ein größeres Ereignis, von dem dieses spezielle Ereignis ein Bestandteil oder Schritt ist. | ||||
| Short | Teil von | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 1..* This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(MedicationAdministration, MedicationDispense, MedicationStatement, Procedure, Observation) | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Requirements | This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| Slicing | This element introduces a set of slices on MedicationStatement.partOf. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 40. MedicationStatement.partOf:systemischeTherapie | |||||
| Slice Name | systemischeTherapie | ||||
| Definition | Ein größeres Ereignis, von dem dieses spezielle Ereignis ein Bestandteil oder Schritt ist. | ||||
| Short | Teil von | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(MII PR Onkologie Systemische Therapie) | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | This should not be used when indicating which resource a MedicationStatement has been derived from. If that is the use case, then MedicationStatement.derivedFrom should be used. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 42. MedicationStatement.status | |||||
| Definition | aktiv | abgeschlossen | Eingabe fehlerhaft | intendiert | gestoppt | pausiert | unbekannt| nicht eingenommen | ||||
| Short | Status | ||||
| Comments | MedicationStatement is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationStatement.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the medication statement itself (for example, entered in error). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Medication Status Codes (required to http://hl7.org/fhir/ValueSet/medication-statement-status|4.0.1)A coded concept indicating the current status of a MedicationStatement. | ||||
| Type | code | ||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. MedicationStatement.statusReason | |||||
| Definition | Captures the reason for the current state of the MedicationStatement. | ||||
| Short | Reason for current status | ||||
| Comments | This is generally only used for "exception" statuses such as "not-taken", "on-hold", "cancelled" or "entered-in-error". The reason for performing the event at all is captured in reasonCode, not here. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTDrugTherapyStatusCodes (example to http://hl7.org/fhir/ValueSet/reason-medication-status-codes)A coded concept indicating the reason for the status of the statement. | ||||
| Type | CodeableConcept | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. MedicationStatement.category | |||||
| Definition | Eine Kategorie, die dem Medikationseintrag zugeordnet ist. | ||||
| Short | Kategorie | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from Medication usage category codes (preferred to http://hl7.org/fhir/ValueSet/medication-statement-category)A coded concept identifying where the medication included in the MedicationStatement is expected to be consumed or administered. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. MedicationStatement.category.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 50. MedicationStatement.category.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.category.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 52. MedicationStatement.category.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 | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| 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 MedicationStatement.category.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 54. MedicationStatement.category.coding:usageCategory | |||||
| Slice Name | usageCategory | ||||
| Definition | Kategorie, die den Anwendungsbereich des Medikationseintrags beschreibt. | ||||
| Short | Kategorie Anwendungsbereich | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Medication usage category codes (required to http://hl7.org/fhir/ValueSet/medication-statement-category) | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. MedicationStatement.category.coding:contextCode | |||||
| Slice Name | contextCode | ||||
| Definition | ambulanter Kontakt | stationärer Aufenthalt | stationäre Aufnahme | stationäre Entlassung | ||||
| Short | Kategorie Kontext | ||||
| 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 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from MII VS Medikation Fallkontext (required to https://www.medizininformatik-initiative.de/fhir/core/modul-medikation/ValueSet/fallkontext) | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 58. MedicationStatement.category.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 | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 60. MedicationStatement.medication[x] | |||||
| Definition | Medikation, welche Gegenstand des Eintrags ist. Code oder Referenz auf Medication-Objekt. | ||||
| Short | Medikation | ||||
| Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTMedicationCodes (example to http://hl7.org/fhir/ValueSet/medication-codes)A coded concept identifying the substance or product being taken. | ||||
| Type | Choice of: CodeableConcept, Reference(Medication) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| 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 MedicationStatement.medication[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 62. MedicationStatement.medication[x]:medicationReference | |||||
| Slice Name | medicationReference | ||||
| Definition | Referenz auf eine Medication-Ressource. | ||||
| Short | Medikation Referenz | ||||
| Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(MII PR Medikation Medication) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 64. MedicationStatement.medication[x]:medicationCodeableConcept | |||||
| Slice Name | medicationCodeableConcept | ||||
| Definition | Code für das Medikament, welches Gegenstand des Eintrags ist. | ||||
| Short | Medikation Code | ||||
| Comments | If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example, if you require form or lot number, then you must reference the Medication resource. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTMedicationCodes (example to http://hl7.org/fhir/ValueSet/medication-codes)A coded concept identifying the substance or product being taken. | ||||
| Type | CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 66. MedicationStatement.medication[x]:medicationCodeableConcept.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 68. MedicationStatement.medication[x]:medicationCodeableConcept.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.medication[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 70. MedicationStatement.medication[x]:medicationCodeableConcept.coding | |||||
| Definition | Wirkstoff / Substanz der systemischen onkologischen Medikation gemäß 16.4 oBDS 2021. | ||||
| Short | Wirkstoff der systemischen Medikation | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| 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())) | ||||
| Slicing | This element introduces a set of slices on MedicationStatement.medication[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 72. MedicationStatement.medication[x]:medicationCodeableConcept.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 74. MedicationStatement.medication[x]:medicationCodeableConcept.coding.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.medication[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 76. MedicationStatement.medication[x]:medicationCodeableConcept.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 | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| 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())) | ||||
| 78. MedicationStatement.medication[x]:medicationCodeableConcept.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version 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 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 80. MedicationStatement.medication[x]:medicationCodeableConcept.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| 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())) | ||||
| 82. MedicationStatement.medication[x]:medicationCodeableConcept.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 84. MedicationStatement.medication[x]:medicationCodeableConcept.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If 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 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 86. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer | |||||
| Slice Name | Pharmazentralnummer | ||||
| Definition | Ein Verweis auf einen von der Pharmazentralnummer definierten Code | ||||
| Short | PZN Code | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 88. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 90. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.medication[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 92. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.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 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 94. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version 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 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 96. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 98. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 100. MedicationStatement.medication[x]:medicationCodeableConcept.coding:Pharmazentralnummer.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If 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 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 102. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe | |||||
| Slice Name | atcClassDe | ||||
| Definition | Ein Verweis auf einen von der deutschen Fassung der Anatomisch-Therapeutisch-Chemischen Klassifikation definierten Code | ||||
| Short | ATC Klassifikation deutsche Version | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from MII VS Medikation ATC (required to https://www.medizininformatik-initiative.de/fhir/core/modul-medikation/ValueSet/mii-vs-medikation-atc) | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 104. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 106. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.medication[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 108. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.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 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 110. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version 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 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 112. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 114. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 116. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassDe.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If 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 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 118. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn | |||||
| Slice Name | atcClassEn | ||||
| Definition | Ein Verweis auf einen von der WHO Anatomisch-Therapeutisch-Chemischen Klassifikation definierten Code | ||||
| Short | Anatomical Therapeutic Chemical Classification 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 120. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 122. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.medication[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 124. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.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 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 126. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version 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 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 128. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 130. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 132. MedicationStatement.medication[x]:medicationCodeableConcept.coding:atcClassEn.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If 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 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 134. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII | |||||
| Slice Name | UNII | ||||
| Definition | Ein Unique Ingredient Identifier (UNII) aus dem Global Substance Registration System der amerikanischen Food & Drug Administration | ||||
| Short | Unique Ingredient Identifier | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from MII VS Onkologie Systemische Therapie Substanzen (UNII) (extensible to https://www.medizininformatik-initiative.de/fhir/ext/modul-onko/ValueSet/mii-vs-onko-systemische-therapie-substanzen-unii) | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 136. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 138. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.medication[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 140. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII.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 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 142. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version 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 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 144. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 146. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 148. MedicationStatement.medication[x]:medicationCodeableConcept.coding:UNII.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If 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 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 150. MedicationStatement.medication[x]:medicationCodeableConcept.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 | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 152. MedicationStatement.subject | |||||
| Definition | The person, animal or group who is/was taking the medication. | ||||
| Short | Who is/was taking the medication | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Patient) | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 154. MedicationStatement.context | |||||
| Definition | Fall oder Kontakt in Verbindung mit dem Medikationseintrag | ||||
| Short | Kontext | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Encounter, EpisodeOfCare) | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 156. MedicationStatement.effective[x] | |||||
| Definition | Die Zeitspanne, in der angegeben wird, dass der Patient das Medikament eingenommen hat oder einnehmen wird. | ||||
| Short | Zeitpunkt oder Zeitraum | ||||
| Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Choice of: dateTime, Period | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| 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 MedicationStatement.effective[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 158. MedicationStatement.effective[x]:effectiveDateTime | |||||
| Slice Name | effectiveDateTime | ||||
| Definition | Der Zeitpunkt, an dem der Patient das Medikament eingenommen hat oder einnehmen wird. | ||||
| Short | Zeitpunkt | ||||
| Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | dateTime | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 160. MedicationStatement.effective[x]:effectivePeriod | |||||
| Slice Name | effectivePeriod | ||||
| Definition | Der Zeitraum, in dem der Patient das Medikament eingenommen hat oder einnehmen wird. | ||||
| Short | Zeitraum | ||||
| Comments | This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Statements. If the medication is still being taken at the time the statement is recorded, the "end" date will be omitted. The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 162. MedicationStatement.effective[x]:effectivePeriod.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 164. MedicationStatement.effective[x]:effectivePeriod.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.effective[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 166. MedicationStatement.effective[x]:effectivePeriod.start | |||||
| Definition | Startdatum der systemischen Medikation gemäß 16.7 oBDS 2021. | ||||
| Short | Startdatum der systemischen Medikation | ||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 168. MedicationStatement.effective[x]:effectivePeriod.end | |||||
| Definition | Enddatum der systemischen Medikation gemäß 16.9 oBDS 2021. | ||||
| Short | Enddatum der systemischen Medikation | ||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 170. MedicationStatement.dateAsserted | |||||
| Definition | Das Datum, an dem der Medikationseintrag von der Informationsquelle bestätigt wurde. | ||||
| Short | Datum Bestätigung | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 172. MedicationStatement.informationSource | |||||
| Definition | Die Person oder Organisation, die die Information über die Einnahme dieses Medikaments bereitgestellt hat. | ||||
| Short | Informationsquelle | ||||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Patient, Practitioner, PractitionerRole, RelatedPerson, Organization) | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 174. MedicationStatement.derivedFrom | |||||
| Definition | Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement. | ||||
| Short | Additional supporting information | ||||
| Comments | Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationStatement comes from creating a MedicationStatement from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationStatement from. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Resource) | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 176. MedicationStatement.reasonCode | |||||
| Definition | Grund für den Medikationseintrag als Code. | ||||
| Short | Grund Code | ||||
| Comments | This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see Condition/Problem/DiagnosisCodes (example to http://hl7.org/fhir/ValueSet/condition-code)A coded concept identifying why the medication is being taken. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 178. MedicationStatement.reasonReference | |||||
| Definition | Grund für den Medikationseintrag als Referenz auf Condition- oder Observation-Ressource. | ||||
| Short | Grund Referenz | ||||
| Comments | This is a reference to a condition that is the reason why the medication is being/was taken. If only a code exists, use reasonForUseCode. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Reference(Condition, Observation, DiagnosticReport) | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ref-1: SHALL have a contained resource if a local reference is provided ( reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))) | ||||
| 180. MedicationStatement.note | |||||
| Definition | Zusätzliche Informationen zum Medikationseintrag als Freitext. | ||||
| Short | Hinweis | ||||
| Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Annotation | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 182. MedicationStatement.note.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 184. MedicationStatement.note.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.note.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 186. MedicationStatement.note.author[x] | |||||
| Definition | The individual responsible for making the annotation. | ||||
| Short | Individual responsible for the annotation | ||||
| Comments | Organization is used when there's no need for specific attribution as to who made the comment. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Choice of: Reference(Practitioner, Patient, RelatedPerson, Organization), string | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| 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())) | ||||
| 188. MedicationStatement.note.time | |||||
| Definition | Indicates when this particular annotation was made. | ||||
| Short | When the annotation was made | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | dateTime | ||||
| 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())) | ||||
| 190. MedicationStatement.note.text | |||||
| Definition | Protokoll der systemischen Medikation gemäß 16.6 oBDS 2021. | ||||
| Short | Protokoll | ||||
| Comments | Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | markdown | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 192. MedicationStatement.dosage | |||||
| Definition | Details zur Dosierung des Medikamentes. | ||||
| Short | Dosierung | ||||
| Comments | The dates included in the dosage on a Medication Statement reflect the dates for a given dose. For example, "from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily." It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Statement is derived from a MedicationRequest. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Dosage(Dosage DE) | ||||
| Must Support | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))DosageStructuredOrFreeTextWarning: Die Dosierungsangabe darf entweder nur als Freitext oder nur als vollständige strukturierte Information erfolgen — eine Mischung ist nicht erlaubt. ( (%resource.ofType(MedicationRequest).dosageInstruction |
ofType(MedicationDispense).dosageInstruction |
ofType(MedicationStatement).dosage).all(
(text.exists() and timing.empty() and doseAndRate.empty()) or
(text.empty() and (timing.exists() or doseAndRate.exists()))
))DosageStructuredRequiresBoth: Wenn eine strukturierte Dosierungsangabe erfolgt, müssen sowohl timing als auch doseAndRate angegeben werden. ( (%resource.ofType(MedicationRequest).dosageInstruction |
ofType(MedicationDispense).dosageInstruction |
ofType(MedicationStatement).dosage).all(
(timing.exists() implies doseAndRate.exists()) and
(doseAndRate.exists() implies timing.exists())
))DosageDoseUnitSameCode: Die Dosiereinheit muss über alle Dosierungen gleich sein. ( (%resource.ofType(MedicationRequest).dosageInstruction | ofType(MedicationDispense).dosageInstruction | ofType(MedicationStatement).dosage).all(
doseAndRate.exists() implies
(
%resource.dosageInstruction.doseAndRate.dose.ofType(Quantity).code |
%resource.dosageInstruction.doseAndRate.dose.ofType(Range).low.code |
%resource.dosageInstruction.doseAndRate.dose.ofType(Range).high.code
).distinct().count() = 1
))DosageWarnungViererschemaInText: Hinweis: In Dosage.text wurde ein Viererschema (z. B. 1-1-1-1) erkannt. Bitte prüfen, ob dies strukturiert abgebildet werden kann. ( text.exists() implies text.matches('.*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\s*\\d+\\s*[-–]\\d+.*').not())FreeTextSingleDosageOnlyWarning: Wenn eine Dosierung als reiner Freitext angegeben ist, soll nur genau ein Dosage-Element existieren. ( (
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).exists(text.exists() and timing.empty() and doseAndRate.empty())
)
implies
(
(%resource.ofType(MedicationRequest).dosageInstruction |
%resource.ofType(MedicationDispense).dosageInstruction |
%resource.ofType(MedicationStatement).dosage
).count() = 1
))dsg-1: If present, dosage must include free text or structured data ( text.exists() or doseAndRate.exists()) | ||||
| 194. MedicationStatement.dosage.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 196. MedicationStatement.dosage.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 198. MedicationStatement.dosage.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| 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()) | ||||
| 200. MedicationStatement.dosage.sequence | |||||
| Definition | Indicates the order in which the dosage instructions should be applied or interpreted. | ||||
| Short | The order of the dosage instructions | ||||
| Comments | 32 bit number; for values larger than this, use decimal | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | If the sequence number of multiple Dosages is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the Dosages are intended to be sequential. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 202. MedicationStatement.dosage.text | |||||
| Definition | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf'. Als Quelle dient hier ausschließlich der Arzt oder Apotheker | ||||
| Short | Freitext-Dosierungsanweisungen, z. B. 'Maximal 3x täglich 1 Stück bei Bedarf' | ||||
| Comments | Die Freitextdosierung sollte nur angegeben werden, wenn aufgrund der Komplexität keine strukturierte Dosierung möglich ist, um widersprüchliche Anweisungen zu vermeiden. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. Additional information about administration or preparation of the medication should be included as text. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 204. MedicationStatement.dosage.additionalInstruction | |||||
| Definition | Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). | ||||
| Short | Supplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness" | ||||
| Comments | Information about administration or preparation of the medication (e.g. "infuse as rapidly as possibly via intraperitoneal port" or "immediately following drug x") should be populated in dosage.text. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTAdditionalDosageInstructions (example to http://hl7.org/fhir/ValueSet/additional-instruction-codes)A coded concept identifying additional instructions such as "take with water" or "avoid operating heavy machinery". | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | Additional instruction is intended to be coded, but where no code exists, the element could include text. For example, "Swallow with plenty of water" which might or might not be coded. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 206. MedicationStatement.dosage.patientInstruction | |||||
| Definition | Instructions in terms that are understood by the patient or consumer. | ||||
| Short | Patient or consumer oriented instructions | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 208. MedicationStatement.dosage.timing | |||||
| Definition | Wann das Medikament verabreicht werden soll. | ||||
| Short | Wann das Medikament verabreicht werden soll | ||||
| Comments | Um widersprüchliche Anweisungen zu vermeiden, ist entweder Dosage.timing oder Dosage.text zu befüllen. Falls eine strukturierte Dosierung als Text abgebildet werden soll ist dafür die GeneratedDosageInstructionsMeta Extension zu verwenden. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Timing(Timing DE) | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | The timing schedule for giving the medication to the patient. This data type allows many different expressions. For example: "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 210. MedicationStatement.dosage.timing.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 212. MedicationStatement.dosage.timing.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.timing.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 214. MedicationStatement.dosage.timing.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| 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()) | ||||
| 216. MedicationStatement.dosage.timing.event | |||||
| Definition | Identifies specific times when the event occurs. | ||||
| Short | When the event occurs | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | In a Medication Administration Record, for instance, you need to take a general specification, and turn it into a precise specification. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 218. MedicationStatement.dosage.timing.repeat | |||||
| Definition | Eine Menge von Regeln, die beschreiben, wann das Ereignis geplant ist. | ||||
| Short | Wann das Ereignis stattfinden soll | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Element | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Many timing schedules are determined by regular repetitions. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))tim-9: If there's an offset, there must be a when (and not C, CM, CD, CV) ( offset.empty() or (when.exists() and ((when in ('C' | 'CM' | 'CD' | 'CV')).not())))tim-5: period SHALL be a non-negative value ( period.exists() implies period >= 0)tim-6: If there's a periodMax, there must be a period ( periodMax.empty() or period.exists())tim-7: If there's a durationMax, there must be a duration ( durationMax.empty() or duration.exists())tim-8: If there's a countMax, there must be a count ( countMax.empty() or count.exists())tim-1: if there's a duration, there needs to be duration units ( duration.empty() or durationUnit.exists())tim-10: If there's a timeOfDay, there cannot be a when, or vice versa ( timeOfDay.empty() or when.empty())tim-2: if there's a period, there needs to be period units ( period.empty() or periodUnit.exists())tim-4: duration SHALL be a non-negative value ( duration.exists() implies duration >= 0)TimingSingleDosageForTimeOfDay: Wenn nur timeOfDay verwendet wird und täglich dosiert wird, ist die Angabe in einem einzigen Dosage-Element zu modellieren. Mehrere Dosage-Elemente sind nur zulässig, wenn sich die Dosis (Wert) unterscheidet. ( (
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.empty() and
timing.repeat.timeOfDay.exists() and
timing.repeat.when.empty() and
(timing.repeat.period.exists() and timing.repeat.period = 1) and
(timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
)
implies
(
(
(
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).where(
timing.repeat.dayOfWeek.empty() and timing.repeat.timeOfDay.exists() and timing.repeat.when.empty() and (timing.repeat.period.exists() and timing.repeat.period = 1) and (timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
).count() = 1
)
or
(
(
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).where(
timing.repeat.dayOfWeek.empty() and timing.repeat.timeOfDay.exists() and timing.repeat.when.empty() and (timing.repeat.period.exists() and timing.repeat.period = 1) and (timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
).doseAndRate.dose.ofType(Quantity).value.distinct().count() > 1
)
)
))TimingSingleDosageForWhen: Wenn nur when verwendet wird und täglich dosiert wird, ist die Angabe in einem einzigen Dosage-Element zu modellieren. Mehrere Dosage-Elemente sind nur zulässig, wenn sich die Dosis (Wert) unterscheidet. ( (
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).all(
(
timing.repeat.dayOfWeek.empty() and
timing.repeat.when.exists() and
timing.repeat.timeOfDay.empty() and
(timing.repeat.period.exists() and timing.repeat.period = 1) and
(timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
)
implies
(
(
(
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).where(
timing.repeat.dayOfWeek.empty() and timing.repeat.when.exists() and timing.repeat.timeOfDay.empty() and (timing.repeat.period.exists() and timing.repeat.period = 1) and (timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
).count() = 1
)
or
(
(
%resource.ofType(MedicationRequest).dosageInstruction
| %resource.ofType(MedicationDispense).dosageInstruction
| %resource.ofType(MedicationStatement).dosage
).where(
timing.repeat.dayOfWeek.empty() and timing.repeat.when.exists() and timing.repeat.timeOfDay.empty() and (timing.repeat.period.exists() and timing.repeat.period = 1) and (timing.repeat.periodUnit.exists() and timing.repeat.periodUnit = 'd')
).doseAndRate.dose.ofType(Quantity).value.distinct().count() > 1
)
)
))TimingBoundsUnitMatchesCode: boundsDuration.unit muss zur UCUM boundsDuration.code passen (z. B. 'Woche(n)' nur mit code='wk'). ( bounds.ofType(Duration).exists().not() or (
(
bounds.ofType(Duration).code = 'd'
implies
(
bounds.ofType(Duration).unit = 'Tag(e)' or
bounds.ofType(Duration).unit = 'Tag' or
bounds.ofType(Duration).unit = 'Tage'
)
) and (
bounds.ofType(Duration).code = 'wk'
implies
(
bounds.ofType(Duration).unit = 'Woche(n)' or
bounds.ofType(Duration).unit = 'Woche' or
bounds.ofType(Duration).unit = 'Wochen'
)
) and (
bounds.ofType(Duration).code = 'mo'
implies
(
bounds.ofType(Duration).unit = 'Monat(e)' or
bounds.ofType(Duration).unit = 'Monat' or
bounds.ofType(Duration).unit = 'Monate'
)
) and (
bounds.ofType(Duration).code = 'a'
implies
(
bounds.ofType(Duration).unit = 'Jahr(e)' or
bounds.ofType(Duration).unit = 'Jahr' or
bounds.ofType(Duration).unit = 'Jahre'
)
)
)) | ||||
| 220. MedicationStatement.dosage.timing.repeat.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 222. MedicationStatement.dosage.timing.repeat.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.timing.repeat.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 224. MedicationStatement.dosage.timing.repeat.bounds[x] | |||||
| Definition | Entweder eine Dauer für die Länge des Zeitplans, ein Bereich möglicher Längen oder äußere Begrenzungen für Start- und/oder Endgrenzen des Zeitplans. | ||||
| Short | Länge/Bereich der Längen oder (Start- und/oder End-)Grenzen | ||||
| Comments | tbd | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Choice of: Duration, Range, Period | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| 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 MedicationStatement.dosage.timing.repeat.bounds[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 226. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration | |||||
| Slice Name | boundsDuration | ||||
| Definition | Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule. | ||||
| Short | Dauer der Dosieranweisung ausgedrückt in UCUM-Einheiten | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Duration | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 228. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 230. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.timing.repeat.bounds[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 232. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 234. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.comparator | |||||
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 236. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 238. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | UCUM-Einheit für die Dauer | ||||
| Comments | Die UCUM-Einheit für die Dauer, z. B. d für Tag, h für Stunde, min für Minute. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Fixed Value | http://unitsofmeasure.org | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 240. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsDuration.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 242. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange | |||||
| Slice Name | boundsRange | ||||
| Definition | Entweder eine Dauer für die Länge des Zeitplans, ein Bereich möglicher Längen oder äußere Begrenzungen für Start- und/oder Endgrenzen des Zeitplans. | ||||
| Short | Länge/Bereich der Längen oder (Start- und/oder End-)Grenzen | ||||
| Comments | tbd | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Range | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 244. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 246. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.timing.repeat.bounds[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 248. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low | |||||
| Definition | The low limit. The boundary is inclusive. | ||||
| Short | Low limit | ||||
| Comments | If the low element is missing, the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 250. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 252. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.timing.repeat.bounds[x].low.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 254. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 256. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.comparator | |||||
| Definition | Not allowed to be used in this context | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 258. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 260. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 262. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.low.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 264. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high | |||||
| Definition | The high limit. The boundary is inclusive. | ||||
| Short | High limit | ||||
| Comments | If the high element is missing, the high boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 266. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 268. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.timing.repeat.bounds[x].high.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 270. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 272. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.comparator | |||||
| Definition | Not allowed to be used in this context | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 274. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 276. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 278. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsRange.high.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 280. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod | |||||
| Slice Name | boundsPeriod | ||||
| Definition | Entweder eine Dauer für die Länge des Zeitplans, ein Bereich möglicher Längen oder äußere Begrenzungen für Start- und/oder Endgrenzen des Zeitplans. | ||||
| Short | Länge/Bereich der Längen oder (Start- und/oder End-)Grenzen | ||||
| Comments | tbd | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Period | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 282. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 284. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.timing.repeat.bounds[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 286. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.start | |||||
| Definition | The start of the period. The boundary is inclusive. | ||||
| Short | Starting time with inclusive boundary | ||||
| Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 288. MedicationStatement.dosage.timing.repeat.bounds[x]:boundsPeriod.end | |||||
| Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. | ||||
| Short | End time with inclusive boundary, if not ongoing | ||||
| Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1, per-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 290. MedicationStatement.dosage.timing.repeat.count | |||||
| Definition | A total count of the desired number of repetitions across the duration of the entire timing specification. If countMax is present, this element indicates the lower bound of the allowed range of count values. | ||||
| Short | Number of times to repeat | ||||
| Comments | If you have both bounds and count, then this should be understood as within the bounds period, until count times happens. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Repetitions may be limited by end time or total occurrences. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 292. MedicationStatement.dosage.timing.repeat.countMax | |||||
| Definition | If present, indicates that the count is a range - so to perform the action between [count] and [countMax] times. | ||||
| Short | Maximum number of times to repeat | ||||
| Comments | 32 bit number; for values larger than this, use decimal | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 294. MedicationStatement.dosage.timing.repeat.duration | |||||
| Definition | How long this thing happens for when it happens. If durationMax is present, this element indicates the lower bound of the allowed range of the duration. | ||||
| Short | How long when it happens | ||||
| Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Some activities are not instantaneous and need to be maintained for a period of time. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 296. MedicationStatement.dosage.timing.repeat.durationMax | |||||
| Definition | If present, indicates that the duration is a range - so to perform the action between [duration] and [durationMax] time length. | ||||
| Short | How long when it happens (Max) | ||||
| Comments | For some events the duration is part of the definition of the event (e.g. IV infusions, where the duration is implicit in the specified quantity and rate). For others, it's part of the timing specification (e.g. exercise). | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Some activities are not instantaneous and need to be maintained for a period of time. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 298. MedicationStatement.dosage.timing.repeat.durationUnit | |||||
| Definition | The units of time for the duration, in UCUM units. | ||||
| Short | s | min | h | d | wk | mo | a - unit of time (UCUM) | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from UnitsOfTime (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1)A unit of time (units from UCUM). | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 300. MedicationStatement.dosage.timing.repeat.frequency | |||||
| Definition | Die Anzahl der Wiederholungen innerhalb des angegebenen Zeitraums. Falls frequencyMax vorhanden ist, gibt dieses Element die Untergrenze des zulässigen Bereichs der Häufigkeit an. | ||||
| Short | Ereignis tritt frequency-mal pro Zeitraum auf | ||||
| Comments | 32 bit number; for values larger than this, use decimal | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Meaning if Missing | If no frequency is stated, the assumption is that the event occurs once per period, but systems SHOULD always be specific about this | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 302. MedicationStatement.dosage.timing.repeat.frequencyMax | |||||
| Definition | If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range. | ||||
| Short | Event occurs up to frequencyMax times per period | ||||
| Comments | 32 bit number; for values larger than this, use decimal | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 304. MedicationStatement.dosage.timing.repeat.period | |||||
| Definition | Gibt die Zeitspanne an, über die die Wiederholungen stattfinden sollen; z. B. um „3-mal täglich“ auszudrücken, wäre 3 die Häufigkeit und „1 Tag“ der Zeitraum. Falls periodMax vorhanden ist, gibt dieses Element die Untergrenze des zulässigen Bereichs der Zeitspanne an. | ||||
| Short | Ereignis tritt frequency-mal pro Zeitraum auf | ||||
| Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 306. MedicationStatement.dosage.timing.repeat.periodMax | |||||
| Definition | If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as "do this once every 3-5 days. | ||||
| Short | Upper limit of period (3-4 hours) | ||||
| Comments | Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger) | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 308. MedicationStatement.dosage.timing.repeat.periodUnit | |||||
| Definition | Die Zeiteinheit für den Zeitraum, in UCUM-Einheiten. | ||||
| Short | s | min | h | d | wk | mo | a - Zeiteinheit (UCUM) | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from UnitsOfTime (required to http://hl7.org/fhir/ValueSet/units-of-time|4.0.1)A unit of time (units from UCUM). | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 310. MedicationStatement.dosage.timing.repeat.dayOfWeek | |||||
| Definition | Wenn ein oder mehrere Wochentage angegeben sind, findet die Aktion nur an den angegebenen Tagen statt. | ||||
| Short | mon | tue | wed | thu | fri | sat | sun | ||||
| Comments | Wenn keine Tage angegeben sind, wird angenommen, dass die Aktion an jedem Tag wie sonst angegeben stattfindet. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from DaysOfWeek (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1) | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 312. MedicationStatement.dosage.timing.repeat.timeOfDay | |||||
| Definition | Angegebene Tageszeit, zu der die Aktion stattfinden soll. | ||||
| Short | Tageszeit für die Aktion | ||||
| Comments | Wenn eine Tageszeit angegeben ist, wird angenommen, dass die Aktion jeden Tag (ggf. gefiltert durch dayOfWeek) zu den angegebenen Zeiten stattfindet. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | time | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 314. MedicationStatement.dosage.timing.repeat.when | |||||
| Definition | Ein ungefährer Zeitraum während des Tages, der möglicherweise mit einem Ereignis des täglichen Lebens verknüpft ist und angibt, wann die Aktion stattfinden soll. | ||||
| Short | Code für den Zeitraum des Auftretens | ||||
| Comments | Wenn mehr als ein Ereignis angegeben ist, bezieht sich das Ereignis auf die Vereinigung der angegebenen Ereignisse. | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from EventTiming (required to http://hl7.org/fhir/ValueSet/event-timing|4.0.1)Real world event relating to the schedule. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Timings are frequently determined by occurrences such as waking, eating and sleep. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 316. MedicationStatement.dosage.timing.repeat.offset | |||||
| Definition | The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event. | ||||
| Short | Minutes from event (before or after) | ||||
| Comments | 32 bit number; for values larger than this, use decimal | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | unsignedInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 318. MedicationStatement.dosage.timing.code | |||||
| Definition | A code for the timing schedule (or just text in code.text). Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code). | ||||
| Short | BID | TID | QID | AM | PM | QD | QOD | + | ||||
| Comments | BID etc. are defined as 'at institutionally specified times'. For example, an institution may choose that BID is "always at 7am and 6pm". If it is inappropriate for this choice to be made, the code BID should not be used. Instead, a distinct organization-specific code should be used in place of the HL7-defined BID code and/or a structured representation should be used (in this case, specifying the two event times). | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from TimingAbbreviation (preferred to http://hl7.org/fhir/ValueSet/timing-abbreviation)Code for a known / defined timing pattern. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 320. MedicationStatement.dosage.asNeeded[x] | |||||
| Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). | ||||
| Short | Take "as needed" (for x) | ||||
| Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason)A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | ||||
| Type | Choice of: boolean, CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| 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 MedicationStatement.dosage.asNeeded[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 322. MedicationStatement.dosage.asNeeded[x]:asNeededBoolean | |||||
| Slice Name | asNeededBoolean | ||||
| Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). | ||||
| Short | Take "as needed" (for x) | ||||
| Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 324. MedicationStatement.dosage.asNeeded[x]:asNeededCodeableConcept | |||||
| Slice Name | asNeededCodeableConcept | ||||
| Definition | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). | ||||
| Short | Take "as needed" (for x) | ||||
| Comments | Can express "as needed" without a reason by setting the Boolean = True. In this case the CodeableConcept is not populated. Or you can express "as needed" with a reason by including the CodeableConcept. In this case the Boolean is assumed to be True. If you set the Boolean to False, then the dose is given according to the schedule and is not "prn" or "as needed". | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTMedicationAsNeededReasonCodes (example to http://hl7.org/fhir/ValueSet/medication-as-needed-reason)A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example "pain", "30 minutes prior to sexual intercourse", "on flare-up" etc. | ||||
| Type | CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 326. MedicationStatement.dosage.site | |||||
| Definition | Körperstelle, an der das Medikament verabreicht wurde/wird oder werden soll. | ||||
| Short | Verabreichungsort | ||||
| Comments | If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example to http://hl7.org/fhir/ValueSet/approach-site-codes)A coded concept describing the site location the medicine enters into or onto the body. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | A coded specification of the anatomic site where the medication first enters the body. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 328. MedicationStatement.dosage.site.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 330. MedicationStatement.dosage.site.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.site.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 332. MedicationStatement.dosage.site.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 | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| 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())) | ||||
| Slicing | This element introduces a set of slices on MedicationStatement.dosage.site.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 334. MedicationStatement.dosage.site.coding:SNOMED | |||||
| Slice Name | SNOMED | ||||
| Definition | Ein Verweis auf einen von SNOMED CT definierten Code | ||||
| Short | SNOMED CT Code | ||||
| 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..* This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see Target Site - IPS ![]() (example to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips)target site IPS | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 336. MedicationStatement.dosage.site.coding:SNOMED.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 338. MedicationStatement.dosage.site.coding:SNOMED.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.site.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 340. MedicationStatement.dosage.site.coding:SNOMED.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 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 342. MedicationStatement.dosage.site.coding:SNOMED.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version 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 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 344. MedicationStatement.dosage.site.coding:SNOMED.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 346. MedicationStatement.dosage.site.coding:SNOMED.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 348. MedicationStatement.dosage.site.coding:SNOMED.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If 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 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 350. MedicationStatement.dosage.site.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 | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 352. MedicationStatement.dosage.route | |||||
| Definition | Der Weg, auf dem das Medikament verabreicht wurde/wird oder werden soll. | ||||
| Short | Verabreichungsweg | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTRouteCodes (example to http://hl7.org/fhir/ValueSet/route-codes)A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 354. MedicationStatement.dosage.route.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 356. MedicationStatement.dosage.route.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.route.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 358. MedicationStatement.dosage.route.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 | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| 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())) | ||||
| Slicing | This element introduces a set of slices on MedicationStatement.dosage.route.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 360. MedicationStatement.dosage.route.coding:EDQM | |||||
| Slice Name | EDQM | ||||
| Definition | Ein Verweis auf einen durch EDQM Standard Terms definierten Code | ||||
| Short | EDQM Code | ||||
| 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 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHOULD be taken from Medicine EDQM Route of Administration - IPS (preferred to http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration)EDQM Standard Terms | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 362. MedicationStatement.dosage.route.coding:EDQM.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 364. MedicationStatement.dosage.route.coding:EDQM.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.route.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 366. MedicationStatement.dosage.route.coding:EDQM.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 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 368. MedicationStatement.dosage.route.coding:EDQM.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version 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 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 370. MedicationStatement.dosage.route.coding:EDQM.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 372. MedicationStatement.dosage.route.coding:EDQM.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 374. MedicationStatement.dosage.route.coding:EDQM.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If 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 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 376. MedicationStatement.dosage.route.coding:SNOMED | |||||
| Slice Name | SNOMED | ||||
| Definition | Ein Verweis auf einen von SNOMED CT definierten Code | ||||
| Short | SNOMED CT Code | ||||
| 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 This element is affected by the following invariants: ele-1 | ||||
| Type | Coding | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 378. MedicationStatement.dosage.route.coding:SNOMED.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 380. MedicationStatement.dosage.route.coding:SNOMED.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.route.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 382. MedicationStatement.dosage.route.coding:SNOMED.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 This element is affected by the following invariants: ele-1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 384. MedicationStatement.dosage.route.coding:SNOMED.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version 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 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 386. MedicationStatement.dosage.route.coding:SNOMED.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| 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())) | ||||
| 388. MedicationStatement.dosage.route.coding:SNOMED.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 | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 390. MedicationStatement.dosage.route.coding:SNOMED.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If 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 This element is affected by the following invariants: ele-1 | ||||
| Type | boolean | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 392. MedicationStatement.dosage.route.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 | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| 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())) | ||||
| 394. MedicationStatement.dosage.method | |||||
| Definition | Technique for administering medication. | ||||
| Short | Technique for administering medication | ||||
| Comments | Terminologies used often pre-coordinate this term with the route and or form of administration. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see SNOMEDCTAdministrationMethodCodes (example to http://hl7.org/fhir/ValueSet/administration-method-codes)A coded concept describing the technique by which the medicine is administered. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 396. MedicationStatement.dosage.doseAndRate | |||||
| Definition | Die verabreichte Menge des Medikaments. | ||||
| Short | Menge des verabreichten Medikaments | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Element | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 398. MedicationStatement.dosage.doseAndRate.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 400. MedicationStatement.dosage.doseAndRate.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 402. MedicationStatement.dosage.doseAndRate.type | |||||
| Definition | Die Dosisdichte gibt an ob und in welchem Ausmass eine Dosisreduktion vorliegt. | ||||
| Short | Dosisdichte | ||||
| Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | For example codes, see DoseAndRateType (example to http://hl7.org/fhir/ValueSet/dose-rate-type)The kind of dose or rate specified. | ||||
| Type | CodeableConcept | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | If the type is not populated, assume to be "ordered". | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 404. MedicationStatement.dosage.doseAndRate.type.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 | ||||
| 406. MedicationStatement.dosage.doseAndRate.type.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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 | ||||
| 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 MedicationStatement.dosage.doseAndRate.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 408. MedicationStatement.dosage.doseAndRate.type.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 | 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())) | ||||
| 410. MedicationStatement.dosage.doseAndRate.type.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 | ||||
| 412. MedicationStatement.dosage.doseAndRate.type.coding.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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 | ||||
| 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 MedicationStatement.dosage.doseAndRate.type.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 414. MedicationStatement.dosage.doseAndRate.type.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 | 0..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. | ||||
| Pattern Value | https://www.medizininformatik-initiative.de/fhir/ext/modul-mtb/CodeSystem/mii-cs-mtb-dosisdichte | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 416. MedicationStatement.dosage.doseAndRate.type.coding.version | |||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
| Short | Version 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 | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 418. MedicationStatement.dosage.doseAndRate.type.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 | 0..1 | ||||
| Binding | The codes SHALL be taken from MII VS Dosisdichte (required to https://www.medizininformatik-initiative.de/fhir/ext/modul-mtb/ValueSet/mii-vs-mtb-dosisdichte) | ||||
| 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())) | ||||
| 420. MedicationStatement.dosage.doseAndRate.type.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())) | ||||
| 422. MedicationStatement.dosage.doseAndRate.type.coding.userSelected | |||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
| Short | If 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 | ||||
| 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())) | ||||
| 424. MedicationStatement.dosage.doseAndRate.type.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 | 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 | 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())) | ||||
| 426. MedicationStatement.dosage.doseAndRate.dose[x] | |||||
| Definition | Amount of medication per dose. | ||||
| Short | Amount of medication per dose | ||||
| Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Choice of: Range, Quantity(SimpleQuantity) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Requirements | The amount of therapeutic or other substance given at one administration event. | ||||
| 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 MedicationStatement.dosage.doseAndRate.dose[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 428. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity | |||||
| Slice Name | doseQuantity | ||||
| Definition | Menge des Medikaments pro Dosis. | ||||
| Short | Menge des Medikaments pro Dosis | ||||
| Comments | Beachten Sie, dass dies die Menge des angegebenen Medikaments angibt, nicht die Menge für die einzelnen Wirkstoffe. Jede Wirkstoffmenge kann in der Medication-Ressource kommuniziert werden. Zum Beispiel, wenn man angeben möchte, dass eine Tablette 375 mg enthält und die Dosis eine Tablette beträgt, kann man die Medication-Ressource verwenden, um zu dokumentieren, dass die Tablette aus 375 mg des Wirkstoffs XYZ besteht. Alternativ, wenn die Dosis 375 mg beträgt, muss man möglicherweise nur angeben, dass es sich um eine Tablette handelt. Bei einer Infusion wie Dopamin, bei der 400 mg Dopamin in 500 ml einer Infusionslösung gemischt werden, würde dies alles in der Medication-Ressource kommuniziert werden. Wenn die Verabreichung nicht als sofortig vorgesehen ist (Rate ist vorhanden oder Timing hat eine Dauer), kann dies angegeben werden, um die Gesamtmenge anzugeben, die über den im Zeitplan angegebenen Zeitraum verabreicht werden soll, z. B. 500 ml in der Dosis, wobei Timing verwendet wird, um anzugeben, dass dies über 4 Stunden erfolgen soll. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from Dosage DoseQuantity ValueSet (required to http://ig.fhir.de/igs/medication/ValueSet/DosageDoseQuantityDE) | ||||
| Type | Quantity(SimpleQuantity) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | The amount of therapeutic or other substance given at one administration event. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 430. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 432. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.dose[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 434. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 436. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.comparator | |||||
| Definition | Not allowed to be used in this context | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 438. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 440. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 442. MedicationStatement.dosage.doseAndRate.dose[x]:doseQuantity.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 444. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange | |||||
| Slice Name | doseRange | ||||
| Definition | Amount of medication per dose. | ||||
| Short | Amount of medication per dose | ||||
| Comments | Note that this specifies the quantity of the specified medication, not the quantity for each active ingredient(s). Each ingredient amount can be communicated in the Medication resource. For example, if one wants to communicate that a tablet was 375 mg, where the dose was one tablet, you can use the Medication resource to document that the tablet was comprised of 375 mg of drug XYZ. Alternatively if the dose was 375 mg, then you may only need to use the Medication resource to indicate this was a tablet. If the example were an IV such as dopamine and you wanted to communicate that 400mg of dopamine was mixed in 500 ml of some IV solution, then this would all be communicated in the Medication resource. If the administration is not intended to be instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount to be administered over the period of time as indicated by the schedule e.g. 500 ml in dose, with timing used to convey that this should be done over 4 hours. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Range | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | The amount of therapeutic or other substance given at one administration event. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 446. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 448. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.dose[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 450. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low | |||||
| Definition | The low limit. The boundary is inclusive. | ||||
| Short | Low limit | ||||
| Comments | If the low element is missing, the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 452. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 454. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.dose[x].low.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 456. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 458. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.comparator | |||||
| Definition | Not allowed to be used in this context | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 460. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 462. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 464. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.low.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 466. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high | |||||
| Definition | The high limit. The boundary is inclusive. | ||||
| Short | High limit | ||||
| Comments | If the high element is missing, the high boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 468. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 470. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.dose[x].high.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 472. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 474. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.comparator | |||||
| Definition | Not allowed to be used in this context | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 476. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 478. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 480. MedicationStatement.dosage.doseAndRate.dose[x]:doseRange.high.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 482. MedicationStatement.dosage.doseAndRate.rate[x] | |||||
| Definition | Amount of medication per unit of time. | ||||
| Short | Amount of medication per unit of time | ||||
| Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Choice of: Ratio, Range, Quantity(SimpleQuantity) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||||
| 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 MedicationStatement.dosage.doseAndRate.rate[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 484. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio | |||||
| Slice Name | rateRatio | ||||
| Definition | Amount of medication per unit of time. | ||||
| Short | Amount of medication per unit of time | ||||
| Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Ratio | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 486. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 488. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.rate[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 490. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator | |||||
| Definition | The value of the numerator. | ||||
| Short | Numerator value | ||||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists()) | ||||
| 492. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 494. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.rate[x].numerator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 496. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 498. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.comparator | |||||
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 500. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 502. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 504. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.numerator.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 506. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator | |||||
| Definition | The value of the denominator. | ||||
| Short | Denominator value | ||||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists()) | ||||
| 508. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 510. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.rate[x].denominator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 512. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 514. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.comparator | |||||
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 516. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 518. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 520. MedicationStatement.dosage.doseAndRate.rate[x]:rateRatio.denominator.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 522. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange | |||||
| Slice Name | rateRange | ||||
| Definition | Amount of medication per unit of time. | ||||
| Short | Amount of medication per unit of time | ||||
| Comments | It is possible to supply both a rate and a doseQuantity to provide full details about how the medication is to be administered and supplied. If the rate is intended to change over time, depending on local rules/regulations, each change should be captured as a new version of the MedicationRequest with an updated rate, or captured with a new MedicationRequest with the new rate. It is possible to specify a rate over time (for example, 100 ml/hour) using either the rateRatio and rateQuantity. The rateQuantity approach requires systems to have the capability to parse UCUM grammer where ml/hour is included rather than a specific ratio where the time is specified as the denominator. Where a rate such as 500ml over 2 hours is specified, the use of rateRatio may be more semantically correct than specifying using a rateQuantity of 250 mg/hour. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Range | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 524. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 526. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.rate[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 528. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low | |||||
| Definition | The low limit. The boundary is inclusive. | ||||
| Short | Low limit | ||||
| Comments | If the low element is missing, the low boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 530. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 532. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.rate[x].low.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 534. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 536. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.comparator | |||||
| Definition | Not allowed to be used in this context | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 538. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 540. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 542. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.low.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 544. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high | |||||
| Definition | The high limit. The boundary is inclusive. | ||||
| Short | High limit | ||||
| Comments | If the high element is missing, the high boundary is not known. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 546. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 548. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.rate[x].high.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 550. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 552. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.comparator | |||||
| Definition | Not allowed to be used in this context | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 554. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 556. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 558. MedicationStatement.dosage.doseAndRate.rate[x]:rateRange.high.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 560. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity | |||||
| Slice Name | rateQuantity | ||||
| Definition | The comparator is not used on a SimpleQuantity | ||||
| Short | A fixed quantity (no comparator) | ||||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 562. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 564. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.doseAndRate.rate[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 566. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 568. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.comparator | |||||
| Definition | Not allowed to be used in this context | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 570. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 572. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 574. MedicationStatement.dosage.doseAndRate.rate[x]:rateQuantity.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 576. MedicationStatement.dosage.maxDosePerPeriod | |||||
| Definition | Upper limit on medication per unit of time. | ||||
| Short | Upper limit on medication per unit of time | ||||
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example "2 tablets every 4 hours to a maximum of 8/day". | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Ratio | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours. | ||||
| 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())) | ||||
| 578. MedicationStatement.dosage.maxDosePerPeriod.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 580. MedicationStatement.dosage.maxDosePerPeriod.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.maxDosePerPeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 582. MedicationStatement.dosage.maxDosePerPeriod.numerator | |||||
| Definition | The value of the numerator. | ||||
| Short | Numerator value | ||||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists()) | ||||
| 584. MedicationStatement.dosage.maxDosePerPeriod.numerator.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 586. MedicationStatement.dosage.maxDosePerPeriod.numerator.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.maxDosePerPeriod.numerator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 588. MedicationStatement.dosage.maxDosePerPeriod.numerator.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 590. MedicationStatement.dosage.maxDosePerPeriod.numerator.comparator | |||||
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 592. MedicationStatement.dosage.maxDosePerPeriod.numerator.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 594. MedicationStatement.dosage.maxDosePerPeriod.numerator.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 596. MedicationStatement.dosage.maxDosePerPeriod.numerator.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 598. MedicationStatement.dosage.maxDosePerPeriod.denominator | |||||
| Definition | The value of the denominator. | ||||
| Short | Denominator value | ||||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists()) | ||||
| 600. MedicationStatement.dosage.maxDosePerPeriod.denominator.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 602. MedicationStatement.dosage.maxDosePerPeriod.denominator.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.maxDosePerPeriod.denominator.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 604. MedicationStatement.dosage.maxDosePerPeriod.denominator.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 606. MedicationStatement.dosage.maxDosePerPeriod.denominator.comparator | |||||
| Definition | How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 608. MedicationStatement.dosage.maxDosePerPeriod.denominator.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 610. MedicationStatement.dosage.maxDosePerPeriod.denominator.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 612. MedicationStatement.dosage.maxDosePerPeriod.denominator.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 614. MedicationStatement.dosage.maxDosePerAdministration | |||||
| Definition | Upper limit on medication per administration. | ||||
| Short | Upper limit on medication per administration | ||||
| Comments | This is intended for use as an adjunct to the dosage when there is an upper cap. For example, a body surface area related dose with a maximum amount, such as 1.5 mg/m2 (maximum 2 mg) IV over 5 – 10 minutes would have doseQuantity of 1.5 mg/m2 and maxDosePerAdministration of 2 mg. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | The maximum total quantity of a therapeutic substance that may be administered to a subject per administration. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||
| 616. MedicationStatement.dosage.maxDosePerAdministration.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 | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 618. MedicationStatement.dosage.maxDosePerAdministration.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension | ||||
| 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 MedicationStatement.dosage.maxDosePerAdministration.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 620. MedicationStatement.dosage.maxDosePerAdministration.value | |||||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||||
| Short | Numerical value (with implicit precision) | ||||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 622. MedicationStatement.dosage.maxDosePerAdministration.comparator | |||||
| Definition | Not allowed to be used in this context | ||||
| Short | < | <= | >= | > - how to understand the value | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..0 This element is affected by the following invariants: ele-1 | ||||
| Binding | The codes SHALL be taken from QuantityComparator (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)How the Quantity should be understood and represented. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 624. MedicationStatement.dosage.maxDosePerAdministration.unit | |||||
| Definition | A human-readable form of the unit. | ||||
| Short | Unit representation | ||||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 626. MedicationStatement.dosage.maxDosePerAdministration.system | |||||
| Definition | The identification of the system that provides the coded form of the unit. | ||||
| Short | System that defines coded unit form | ||||
| Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1, qty-3 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need to know the system that defines the coded form of the unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 628. MedicationStatement.dosage.maxDosePerAdministration.code | |||||
| Definition | A computer processable form of the unit in some unit representation system. | ||||
| Short | Coded form of the unit | ||||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 630. MedicationStatement.dosage.maxDosePerLifetime | |||||
| Definition | Upper limit on medication per lifetime of the patient. | ||||
| Short | Upper limit on medication per lifetime of the patient | ||||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))qty-3: If a code for the unit is present, the system SHALL also be present ( code.empty() or system.exists())sqty-1: The comparator is not used on a SimpleQuantity ( comparator.empty()) | ||||