Draft as of 2025-02-14 |
Definitions for the multiple-prescription-extension extension.
Guidance on how to interpret the contents of this table can be found here
0. Extension | |
Definition | This FHIR Extension for multiple prescriptions adds details such as repetition count and time intervals for repeated medication orders to FHIR resources. Optional Extension Element - found in all resources. |
Short | MultiplePrescriptionOptional Extensions Element |
Control | 0..* This element is affected by the following invariants: ele-1 |
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()) |
2. Extension.extension | |
Definition | An Extension 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 | ExtensionAdditional 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 Extension.extension . The slices areUnordered and ClosedOpen, and can be differentiated using the following discriminators: |
4. Extension.extension:indicator | |
Slice Name | indicator |
Definition | An Extension |
Short | ExtensionAdditional content defined by implementations |
Control | 0..1* This element is affected by the following invariants: ele-1 |
Type | Extension |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
6. Extension.extension:indicator.extension | |
Definition | An Extension 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 | ExtensionAdditional 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..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 Extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
8. Extension.extension:indicator.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | indicator |
10. Extension.extension:indicator.value[x] | |
Definition | Indicator of whether the current prescription is part of a multiple prescription true - the current prescription is part of a multiple prescription false - the current prescription is not part of a multiple prescription Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Multiple Prescription IndicatorValue of extension |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | boolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time |
[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 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. Extension.extension:counter | |
Slice Name | counter |
Definition | An Extension |
Short | ExtensionAdditional content defined by implementations |
Control | 0..1* This element is affected by the following invariants: ele-1 |
Type | Extension |
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()) |
14. Extension.extension:counter.extension | |
Definition | An Extension 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 | ExtensionAdditional 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..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 Extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
16. Extension.extension:counter.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | counter |
18. Extension.extension:counter.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | Ratio, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. Extension.extension:counter.value[x].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 | 10..1 This element is affected by the following invariants: ele-1 |
Type | Quantity |
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()) |
22. Extension.extension:counter.value[x].numerator.value | |
Definition | The field serves to indicate which number in a series of multiple prescriptions it is. Example: "2" in "2 out of 4" The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Short | Multiple Prescription CounterNumerical 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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
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())) |
24. Extension.extension:counter.value[x].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..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())) |
26. Extension.extension:counter.value[x].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..01 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 | 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())) |
28. Extension.extension:counter.value[x].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 | 0..01 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 |
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())) |
30. Extension.extension:counter.value[x].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 | 0..01 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 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())) |
32. Extension.extension:counter.value[x].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 | 10..1 This element is affected by the following invariants: ele-1 |
Type | Quantity |
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()) |
34. Extension.extension:counter.value[x].denominator.value | |
Definition | The field serves to indicate the length of this series. Example: "4" in "2 out of 4" The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Short | Denominator of Multiple Prescription SeriesNumerical 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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
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())) |
36. Extension.extension:counter.value[x].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..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())) |
38. Extension.extension:counter.value[x].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..01 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 | 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())) |
40. Extension.extension:counter.value[x].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 | 0..01 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 |
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())) |
42. Extension.extension:counter.value[x].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 | 0..01 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 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())) |
44. Extension.extension:period | |
Slice Name | period |
Definition | An Extension |
Short | Zeitraum der EinlösefristAdditional content defined by implementations |
Control | 0..1* This element is affected by the following invariants: ele-1 |
Type | Extension |
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()) |
46. Extension.extension:period.extension | |
Definition | An Extension 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 | ExtensionAdditional 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..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 Extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
48. Extension.extension:period.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | period |
50. Extension.extension:period.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | Period, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) -limitationDateStart: Limitation of the date format to 10 characters YYYY-MM-DD ( start.toString().length()=10 )-limitationDateEnd: Limitation of the date format to 10 characters YYYY-MM-DD ( end.exists().not() or end.toString().length()=10 ) |
52. Extension.extension:period.value[x].start | |
Definition | Date from which the partial prescription of the multiple prescription can be redeemed The start of the period. The boundary is inclusive. |
Short | Start Date of the Prescription Redemption PeriodStarting time with inclusive boundary |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Control | 10..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 |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. Extension.extension:period.value[x].end | |
Definition | Date of the last redemption day for the partial prescription within the multiple prescription series. The issuer may specify a redemption period different from the one outlined in the Medicinal Products Prescription Ordinance (AMVV) 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 Date of the Prescription Redemption PeriodEnd 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 |
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())) |
56. Extension.extension:id | |
Slice Name | id |
Definition | An Extension |
Short | ExtensionAdditional content defined by implementations |
Control | 0..1* This element is affected by the following invariants: ele-1 |
Type | Extension |
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()) |
58. Extension.extension:id.extension | |
Definition | An Extension 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 | ExtensionAdditional 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..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 Extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
60. Extension.extension:id.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | id |
62. Extension.extension:id.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 10..1 This element is affected by the following invariants: ele-1 |
Type | Identifier, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. Extension.extension:id.value[x].use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. Extension.extension:id.value[x].type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Type | CodeableConcept |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. Extension.extension:id.value[x].system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | Specification as UUIDThe namespace for the identifier value |
Comments | Identifier.system is always case sensitive. |
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 | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Fixed Value | urn:ietf:rfc:3986 |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
70. Extension.extension:id.value[x].value | |
Definition | A unique ID that is identical across all partial prescriptions of a multiple prescription. The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Short | Multiple Prescription IDThe value that is unique |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
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 |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
72. Extension.extension:id.value[x].period | |
Definition | Time period during which identifier is/was valid for use. |
Short | Time period when id is/was valid for use |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | Period |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end)) |
74. Extension.extension:id.value[x].assigner | |
Definition | Organization that issued/manages the identifier. |
Short | Organization that issued id (may be just text) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | Reference(Organization) |
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'))) |
76. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/multiple-prescription-extension |
78. Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..01 This element is affected by the following invariants: ele-1 |
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
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())) |
Guidance on how to interpret the contents of this table can be found here
0. Extension | |
Definition | This FHIR Extension for multiple prescriptions adds details such as repetition count and time intervals for repeated medication orders to FHIR resources. |
Short | MultiplePrescription |
2. Extension.extension | |
Slicing | This element introduces a set of slices on Extension.extension . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
4. Extension.extension:indicator | |
Slice Name | indicator |
Control | 0..1 |
6. Extension.extension:indicator.extension | |
Control | 0..0 |
8. Extension.extension:indicator.url | |
Fixed Value | indicator |
10. Extension.extension:indicator.value[x] | |
Definition | Indicator of whether the current prescription is part of a multiple prescription true - the current prescription is part of a multiple prescription false - the current prescription is not part of a multiple prescription |
Short | Multiple Prescription Indicator |
Control | 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 |
12. Extension.extension:counter | |
Slice Name | counter |
Control | 0..1 |
14. Extension.extension:counter.extension | |
Control | 0..0 |
16. Extension.extension:counter.url | |
Fixed Value | counter |
18. Extension.extension:counter.value[x] | |
Control | 1..? |
Type | Ratio |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
20. Extension.extension:counter.value[x].numerator | |
Control | 1..? |
22. Extension.extension:counter.value[x].numerator.value | |
Definition | The field serves to indicate which number in a series of multiple prescriptions it is. Example: "2" in "2 out of 4" |
Short | Multiple Prescription Counter |
Control | 1..? |
24. Extension.extension:counter.value[x].numerator.comparator | |
Control | 0..0 |
26. Extension.extension:counter.value[x].numerator.unit | |
Control | 0..0 |
28. Extension.extension:counter.value[x].numerator.system | |
Control | 0..0 |
30. Extension.extension:counter.value[x].numerator.code | |
Control | 0..0 |
32. Extension.extension:counter.value[x].denominator | |
Control | 1..? |
34. Extension.extension:counter.value[x].denominator.value | |
Definition | The field serves to indicate the length of this series. Example: "4" in "2 out of 4" |
Short | Denominator of Multiple Prescription Series |
Control | 1..? |
36. Extension.extension:counter.value[x].denominator.comparator | |
Control | 0..0 |
38. Extension.extension:counter.value[x].denominator.unit | |
Control | 0..0 |
40. Extension.extension:counter.value[x].denominator.system | |
Control | 0..0 |
42. Extension.extension:counter.value[x].denominator.code | |
Control | 0..0 |
44. Extension.extension:period | |
Slice Name | period |
Short | Zeitraum der Einlösefrist |
Control | 0..1 |
46. Extension.extension:period.extension | |
Control | 0..0 |
48. Extension.extension:period.url | |
Fixed Value | period |
50. Extension.extension:period.value[x] | |
Control | 1..? |
Type | Period |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Invariants | -limitationDateStart: Limitation of the date format to 10 characters YYYY-MM-DD (start.toString().length()=10 )-limitationDateEnd: Limitation of the date format to 10 characters YYYY-MM-DD ( end.exists().not() or end.toString().length()=10 ) |
52. Extension.extension:period.value[x].start | |
Definition | Date from which the partial prescription of the multiple prescription can be redeemed |
Short | Start Date of the Prescription Redemption Period |
Control | 1..? |
54. Extension.extension:period.value[x].end | |
Definition | Date of the last redemption day for the partial prescription within the multiple prescription series. The issuer may specify a redemption period different from the one outlined in the Medicinal Products Prescription Ordinance (AMVV) |
Short | End Date of the Prescription Redemption Period |
56. Extension.extension:id | |
Slice Name | id |
Control | 0..1 |
58. Extension.extension:id.extension | |
Control | 0..0 |
60. Extension.extension:id.url | |
Fixed Value | id |
62. Extension.extension:id.value[x] | |
Control | 1..? |
Type | Identifier |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
64. Extension.extension:id.value[x].use | |
Control | 0..0 |
66. Extension.extension:id.value[x].type | |
Control | 0..0 |
68. Extension.extension:id.value[x].system | |
Short | Specification as UUID |
Fixed Value | urn:ietf:rfc:3986 |
70. Extension.extension:id.value[x].value | |
Definition | A unique ID that is identical across all partial prescriptions of a multiple prescription. |
Short | Multiple Prescription ID |
72. Extension.extension:id.value[x].period | |
Control | 0..0 |
74. Extension.extension:id.value[x].assigner | |
Control | 0..0 |
76. Extension.url | |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/multiple-prescription-extension |
78. Extension.value[x] | |
Control | 0..0 |
Guidance on how to interpret the contents of this table can be found here
0. Extension | |
Definition | This FHIR Extension for multiple prescriptions adds details such as repetition count and time intervals for repeated medication orders to FHIR resources. |
Short | MultiplePrescription |
Control | 0..* This element is affected by the following invariants: ele-1 |
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() ) |
2. Extension.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. |
4. Extension.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..* This element is affected by the following invariants: ele-1 |
Type | Extension |
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 Extension.extension . The slices areUnordered and Closed, and can be differentiated using the following discriminators: |
6. Extension.extension:indicator | |
Slice Name | indicator |
Definition | An Extension |
Short | Extension |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) |
8. Extension.extension:indicator.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. |
10. Extension.extension:indicator.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Extension |
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 Extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
12. Extension.extension:indicator.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | indicator |
14. Extension.extension:indicator.value[x] | |
Definition | Indicator of whether the current prescription is part of a multiple prescription true - the current prescription is part of a multiple prescription false - the current prescription is not part of a multiple prescription |
Short | Multiple Prescription Indicator |
Control | 1..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 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
16. Extension.extension:counter | |
Slice Name | counter |
Definition | An Extension |
Short | Extension |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension |
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() ) |
18. Extension.extension:counter.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. |
20. Extension.extension:counter.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Extension |
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 Extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
22. Extension.extension:counter.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | counter |
24. Extension.extension:counter.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 1..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] |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. Extension.extension:counter.value[x].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. |
28. Extension.extension:counter.value[x].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 |
Standard Status | Normative (from Normative) |
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 Extension.extension.value[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. Extension.extension:counter.value[x].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 | 1..1 This element is affected by the following invariants: ele-1 |
Type | Quantity |
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() ) |
32. Extension.extension:counter.value[x].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. |
34. Extension.extension:counter.value[x].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 |
Standard Status | Normative (from Normative) |
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 Extension.extension.value[x].numerator.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
36. Extension.extension:counter.value[x].numerator.value | |
Definition | The field serves to indicate which number in a series of multiple prescriptions it is. Example: "2" in "2 out of 4" |
Short | Multiple Prescription Counter |
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 |
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()) ) |
38. Extension.extension:counter.value[x].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..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()) ) |
40. Extension.extension:counter.value[x].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..0 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 | 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()) ) |
42. Extension.extension:counter.value[x].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 | 0..0 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 |
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()) ) |
44. Extension.extension:counter.value[x].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 | 0..0 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 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()) ) |
46. Extension.extension:counter.value[x].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 | 1..1 This element is affected by the following invariants: ele-1 |
Type | Quantity |
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() ) |
48. Extension.extension:counter.value[x].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. |
50. Extension.extension:counter.value[x].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 |
Standard Status | Normative (from Normative) |
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 Extension.extension.value[x].denominator.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
52. Extension.extension:counter.value[x].denominator.value | |
Definition | The field serves to indicate the length of this series. Example: "4" in "2 out of 4" |
Short | Denominator of Multiple Prescription Series |
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 |
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()) ) |
54. Extension.extension:counter.value[x].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..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()) ) |
56. Extension.extension:counter.value[x].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..0 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 | 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()) ) |
58. Extension.extension:counter.value[x].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 | 0..0 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 |
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()) ) |
60. Extension.extension:counter.value[x].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 | 0..0 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 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()) ) |
62. Extension.extension:period | |
Slice Name | period |
Definition | An Extension |
Short | Zeitraum der Einlösefrist |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension |
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() ) |
64. Extension.extension:period.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. |
66. Extension.extension:period.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Extension |
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 Extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
68. Extension.extension:period.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | period |
70. Extension.extension:period.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 1..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] |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )-limitationDateStart: Limitation of the date format to 10 characters YYYY-MM-DD ( start.toString().length()=10 )-limitationDateEnd: Limitation of the date format to 10 characters YYYY-MM-DD ( end.exists().not() or end.toString().length()=10 ) |
72. Extension.extension:period.value[x].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. Extension.extension:period.value[x].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 |
Standard Status | Normative (from Normative) |
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 Extension.extension.value[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
76. Extension.extension:period.value[x].start | |
Definition | Date from which the partial prescription of the multiple prescription can be redeemed |
Short | Start Date of the Prescription Redemption Period |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Control | 1..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 |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
78. Extension.extension:period.value[x].end | |
Definition | Date of the last redemption day for the partial prescription within the multiple prescription series. The issuer may specify a redemption period different from the one outlined in the Medicinal Products Prescription Ordinance (AMVV) |
Short | End Date of the Prescription Redemption Period |
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 |
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. Extension.extension:id | |
Slice Name | id |
Definition | An Extension |
Short | Extension |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension |
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() ) |
82. Extension.extension:id.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. |
84. Extension.extension:id.extension | |
Definition | An Extension |
Short | Extension |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Extension |
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 Extension.extension.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
86. Extension.extension:id.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | id |
88. Extension.extension:id.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Identifier |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
90. Extension.extension:id.value[x].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. |
92. Extension.extension:id.value[x].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 |
Standard Status | Normative (from Normative) |
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 Extension.extension.value[x].extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
94. Extension.extension:id.value[x].use | |
Definition | The purpose of this identifier. |
Short | usual | official | temp | secondary | old (If known) |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 )Identifies the purpose for this identifier, if known . |
Type | code |
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
96. Extension.extension:id.value[x].type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Short | Description of identifier |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type )A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Type | CodeableConcept |
Summary | true |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
98. Extension.extension:id.value[x].system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Short | Specification as UUID |
Comments | Identifier.system is always case sensitive. |
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 | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Fixed Value | urn:ietf:rfc:3986 |
Example | <br/><b>General</b>:http://www.acme.com/identifiers/patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
100. Extension.extension:id.value[x].value | |
Definition | A unique ID that is identical across all partial prescriptions of a multiple prescription. |
Short | Multiple Prescription ID |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
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 |
Example | <br/><b>General</b>:123456 |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
102. Extension.extension:id.value[x].period | |
Definition | Time period during which identifier is/was valid for use. |
Short | Time period when id is/was valid for use |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Period |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )per-1: If present, start SHALL have a lower value than end ( start.hasValue().not() or end.hasValue().not() or (start <= end) ) |
104. Extension.extension:id.value[x].assigner | |
Definition | Organization that issued/manages the identifier. |
Short | Organization that issued id (may be just text) |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Reference(Organization) |
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')) ) |
106. Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/multiple-prescription-extension |
108. Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Short | Value of extension |
Control | 0..0 This element is affected by the following invariants: ele-1 |
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
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()) ) |