EPAMedication
Das EPAMedication
-Profil wird verwendet um detaillierte Informationen über Medikamente innerhalb von Gesundheitssystemen darzustellen. Es umfasst wesentliche Details wie den Typ, die Inhaltsstoffe, den Hersteller und die physische Form des Medikaments. Diese Ressource ist entscheidend für die Verwaltung von medikamentenbezogenen Daten über verschiedene Gesundheitsanwendungen hinweg und gewährleistet Konsistenz und Genauigkeit beim Austausch von Medikamenteninformationen.
Profil für gemeinsame Datengrundlage im ePA Medication Service
Diese Profile dienen als gemeinsame Datengrundlage aller Inhalte im ePA Medication Service. Jeder Inhalt innerhalb dieses Datenraumes muss konfrom zu diesen Profilen sein, um auch eine Nachnutzung in anderen ePA-Kontexten oder anderen Spezifikationen gewährleisten zu können.
EPAMedication (Medication) | I | Medication | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | S | 0..* | EPAMedicationPharmaceuticalProduct, EPAMedicationPZNIngredient |
extension | I | 0..* | Extension |
rxPrescriptionProcessIdentifier | I | 0..1 | Extension(RxPrescriptionProcessIdentifier) |
epaDispensationIdentifier | I | 0..1 | Extension(EPADispensationIdentifier) |
isVaccine | I | 0..1 | Extension(boolean) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueBoolean | boolean | ||
drugCategory | I | 0..1 | Extension(Coding) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
normSizeCode | I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 0..1 | Binding |
valueCode | code | ||
packaging | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
manufacturingInstructions | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
type | S I | 0..1 | Extension(Coding) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
EPAMedicationUniqueIdentifier | Σ | 0..1 | EPAMedicationUniqueIdentifierPattern |
RxOriginatorProcessIdentifier | Σ | 0..1 | RxOriginatorProcessIdentifierPattern |
code | S Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
pzn | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
atc-de | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
ask | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
snomed | Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
status | S Σ ?! | 0..1 | codeBinding |
manufacturer | S Σ I | 0..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | S Σ | 1..1 | string |
form | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
edqm | S Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
snomed | Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
kbvDarreichungsform | S Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
amount | S Σ I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
numerator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
packagingSize | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
totalQuantity | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 0..1 | code |
denominator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 0..1 | code |
ingredient | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
darreichungsform | I | 0..1 | Extension(string) |
modifierExtension | Σ ?! I | 0..* | Extension |
item[x] | S | 1..1 | |
itemCodeableConcept | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
ask | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
atc-de | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
snomed | Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
pzn | Σ | 0..0 | CodingPattern |
text | S Σ | 0..1 | string |
itemReference | S | 0..1 | Reference(Medication) |
isActive | 0..1 | boolean | |
strength | S I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
amountText | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
numerator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
denominator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
batch | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | dateTime |
Medication | |
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Medication.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Medication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Medication.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) 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. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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). |
Invariants |
|
Mappings |
|
Medication.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
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. |
Invariants |
|
Mappings |
|
Medication.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | EPAMedicationPharmaceuticalProduct, EPAMedicationPZNIngredient |
Must Support | True |
Alias | inline resources, anonymous resources, contained 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. |
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:rxPrescriptionProcessIdentifier | |
Definition | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems. |
Cardinality | 0...1 |
Type | Extension(RxPrescriptionProcessIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:epaDispensationIdentifier | |
Definition | This extension is used to track the dispensation identifier for non-rx use-cases |
Cardinality | 0...1 |
Type | Extension(EPADispensationIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine | |
Definition | Indicator of whether this is a vaccine. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:isVaccine.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension |
Mappings |
|
Medication.extension:isVaccine.value[x] | |
Definition | Indicator of whether this is a vaccine.. false - no vaccine (default value) true - vaccine |
Cardinality | 1...1 |
Type | boolean |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory | |
Definition | Extension for indicating the medication category. |
Cardinality | 0...1 |
Type | Extension(Coding) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension |
Mappings |
|
Medication.extension:drugCategory.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPADrugCategoryVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].code | |
Definition | Drug Category |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode | |
Definition | Description of the therapy-appropriate package size (e.g., N1) |
Cardinality | 0...1 |
Type | Extension(code) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:normSizeCode.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://fhir.de/StructureDefinition/normgroesse |
Mappings |
|
Medication.extension:normSizeCode.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | code |
Binding | KBV_VS_SFHIR_KBV_NORMGROESSE (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:packaging | |
Definition | Information on the packaging of a formulation. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:packaging.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:packaging.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:packaging.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension |
Mappings |
|
Medication.extension:packaging.value[x] | |
Definition | Information on transport containers or packaging for a formulation. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:manufacturingInstructions.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension |
Mappings |
|
Medication.extension:manufacturingInstructions.value[x] | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:type | |
Definition | Extension for EPAMedication types |
Cardinality | 0...1 |
Type | Extension(Coding) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.identifier | |
Definition | Business identifier for this medication. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.identifier:EPAMedicationUniqueIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | EPAMedicationUniqueIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" } |
Mappings |
|
Medication.identifier:RxOriginatorProcessIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | RxOriginatorProcessIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" } |
Mappings |
|
Medication.code | |
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept that defines the type of a medication. |
Must Support | True |
Summary | True |
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). |
Invariants |
|
Mappings |
|
Medication.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.code.coding:pzn.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ifa/pzn |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.code.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.code.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | EPAMedicationSNOMEDCTVS (extensible) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.status | |
Definition | A code to indicate if the medication is in active use. |
Cardinality | 0...1 |
Type | code |
Binding | A coded concept defining if the medication is in active use. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. |
Invariants |
|
Mappings |
|
Medication.manufacturer | |
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Comments | Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer. |
Invariants |
|
Mappings |
|
Medication.manufacturer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.manufacturer.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.manufacturer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Medication.manufacturer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Medication.manufacturer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Medication.manufacturer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Medication.form | |
Definition | Describes the form of the item. Powder; tablets; capsule. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept defining the form of a medication. |
Must Support | True |
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. |
Invariants |
|
Mappings |
|
Medication.form.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://standardterms.edqm.eu" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://standardterms.edqm.eu |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | EPAMedicineFormSNOMEDCTVS (preferred) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" } |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.amount | |
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Summary | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.amount.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator | |
Definition | The value of the numerator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.value[x] | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.value[x] | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.amount.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient | |
Definition | Identifies a particular constituent of interest in the product. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. |
Invariants |
|
Mappings |
|
Medication.ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.extension:darreichungsform | |
Definition | Dosage form of an ingredient in a formulation. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x] | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | EPASubstanceSNOMEDCTVS (preferred) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...0 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemReference | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...1 |
Type | Reference(Medication) |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.isActive | |
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. |
Cardinality | 0...1 |
Type | boolean |
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength | |
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.extension:amountText.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension |
Mappings |
|
Medication.ingredient.strength.extension:amountText.value[x] | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator | |
Definition | The value of the numerator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.batch | |
Definition | Information that only applies to packages (not products). |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Medication.batch.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.batch.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.batch.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.batch.lotNumber | |
Definition | The assigned lot number of a batch of the specified product. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.batch.expirationDate | |
Definition | When this specific batch of product will expire. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-medication" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" /> <version value="1.1.1" /> <name value="EPAMedication" /> <title value="EPA Medication" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Defines the medication resource for the Medication Service in the ePA system." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Medication" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Medication" /> <derivation value="constraint" /> <differential> <element id="Medication"> <path value="Medication" /> <constraint> <key value="epa-med-1" /> <severity value="error" /> <human value="Medication code, name, or ingredients must be specified" /> <expression value="code.exists() or ingredient.exists()" /> <source value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" /> </constraint> <constraint> <key value="epa-med-2" /> <severity value="error" /> <human value="Extemporaneous preparation medications and 'Kombipackungen' have to reference their components via .ingredient.itemReference" /> <expression value="extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '1208954007').exists() or form.coding.where(code = 'KPG').exists() implies ingredient.item.ofType(Reference).exists()" /> <source value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" /> </constraint> <constraint> <key value="epa-med-3" /> <severity value="error" /> <human value="Medicinal product medications (Fertigarzneimittel) are not allowed to reference other medications via .ingredient.itemReference" /> <expression value="extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '781405001').exists() and form.coding.where(code = 'KPG').exists().not() implies ingredient.item.ofType(Reference).exists().not()" /> <source value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" /> </constraint> </element> <element id="Medication.meta"> <path value="Medication.meta" /> <mustSupport value="true" /> </element> <element id="Medication.meta.versionId"> <path value="Medication.meta.versionId" /> <mustSupport value="true" /> </element> <element id="Medication.meta.lastUpdated"> <path value="Medication.meta.lastUpdated" /> <mustSupport value="true" /> </element> <element id="Medication.contained"> <path value="Medication.contained" /> <short value="Contains PZN Ingredients for Compounding Medications & PharmaceuticalProducts in case of a 'Kombipackung'" /> <type> <code value="Medication" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" /> </type> <mustSupport value="true" /> </element> <element id="Medication.extension:rxPrescriptionProcessIdentifier"> <path value="Medication.extension" /> <sliceName value="rxPrescriptionProcessIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension" /> </type> </element> <element id="Medication.extension:epaDispensationIdentifier"> <path value="Medication.extension" /> <sliceName value="epaDispensationIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/dispensation-identifier-extension" /> </type> </element> <element id="Medication.extension:isVaccine"> <path value="Medication.extension" /> <sliceName value="isVaccine" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension" /> </type> </element> <element id="Medication.extension:isVaccine.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:drugCategory"> <path value="Medication.extension" /> <sliceName value="drugCategory" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension" /> </type> </element> <element id="Medication.extension:drugCategory.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:drugCategory.value[x].system"> <path value="Medication.extension.value[x].system" /> <mustSupport value="true" /> </element> <element id="Medication.extension:drugCategory.value[x].code"> <path value="Medication.extension.value[x].code" /> <mustSupport value="true" /> </element> <element id="Medication.extension:normSizeCode"> <path value="Medication.extension" /> <sliceName value="normSizeCode" /> <short value="Package size according to N-designation" /> <definition value="Description of the therapy-appropriate package size (e.g., N1)" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.de/StructureDefinition/normgroesse" /> </type> </element> <element id="Medication.extension:normSizeCode.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:packaging"> <path value="Medication.extension" /> <sliceName value="packaging" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension" /> </type> </element> <element id="Medication.extension:packaging.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:manufacturingInstructions"> <path value="Medication.extension" /> <sliceName value="manufacturingInstructions" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension" /> </type> </element> <element id="Medication.extension:manufacturingInstructions.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:type"> <path value="Medication.extension" /> <sliceName value="type" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension" /> </type> <mustSupport value="true" /> </element> <element id="Medication.identifier"> <path value="Medication.identifier" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Medication.identifier:EPAMedicationUniqueIdentifier"> <path value="Medication.identifier" /> <sliceName value="EPAMedicationUniqueIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-unique-identifier" /> </type> <patternIdentifier> <system value="https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" /> </patternIdentifier> </element> <element id="Medication.identifier:RxOriginatorProcessIdentifier"> <path value="Medication.identifier" /> <sliceName value="RxOriginatorProcessIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-originator-process-identifier" /> </type> <patternIdentifier> <system value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" /> </patternIdentifier> </element> <element id="Medication.code"> <path value="Medication.code" /> <short value="Medication in coded form or as free text if necessary" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding"> <path value="Medication.code.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn"> <path value="Medication.code.coding" /> <sliceName value="pzn" /> <min value="0" /> <max value="1" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ifa/pzn" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.version"> <path value="Medication.code.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de"> <path value="Medication.code.coding" /> <sliceName value="atc-de" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/bfarm/atc" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask"> <path value="Medication.code.coding" /> <sliceName value="ask" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ask" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed"> <path value="Medication.code.coding" /> <sliceName value="snomed" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://snomed.info/sct" /> </patternCoding> <binding> <strength value="extensible" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medication-snomed-ct-vs" /> </binding> </element> <element id="Medication.code.coding:snomed.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.version"> <path value="Medication.code.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.text"> <path value="Medication.code.text" /> <mustSupport value="true" /> </element> <element id="Medication.status"> <path value="Medication.status" /> <short value="Status of Medication Information" /> <mustSupport value="true" /> </element> <element id="Medication.manufacturer"> <path value="Medication.manufacturer" /> <short value="Manufacturer of the Medication" /> <comment value="Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer." /> <mustSupport value="true" /> </element> <element id="Medication.manufacturer.display"> <path value="Medication.manufacturer.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form"> <path value="Medication.form" /> <short value="Form of Dispensing" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding"> <path value="Medication.form.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.form.coding:edqm"> <path value="Medication.form.coding" /> <sliceName value="edqm" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://standardterms.edqm.eu" /> </patternCoding> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform" /> </binding> </element> <element id="Medication.form.coding:edqm.system"> <path value="Medication.form.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:edqm.code"> <path value="Medication.form.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:edqm.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed"> <path value="Medication.form.coding" /> <sliceName value="snomed" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://snomed.info/sct" /> </patternCoding> <binding> <strength value="preferred" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medicine-form-snomed-ct-vs" /> </binding> </element> <element id="Medication.form.coding:snomed.system"> <path value="Medication.form.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.version"> <path value="Medication.form.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.code"> <path value="Medication.form.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:kbvDarreichungsform"> <path value="Medication.form.coding" /> <sliceName value="kbvDarreichungsform" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" /> </patternCoding> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM" /> </binding> </element> <element id="Medication.form.coding:kbvDarreichungsform.system"> <path value="Medication.form.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:kbvDarreichungsform.code"> <path value="Medication.form.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:kbvDarreichungsform.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.amount"> <path value="Medication.amount" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator"> <path value="Medication.amount.numerator" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.amount.numerator.extension:packagingSize"> <path value="Medication.amount.numerator.extension" /> <sliceName value="packagingSize" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension" /> </type> </element> <element id="Medication.amount.numerator.extension:packagingSize.value[x]"> <path value="Medication.amount.numerator.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.extension:totalQuantity"> <path value="Medication.amount.numerator.extension" /> <sliceName value="totalQuantity" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension" /> </type> </element> <element id="Medication.amount.numerator.extension:totalQuantity.value[x]"> <path value="Medication.amount.numerator.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.value"> <path value="Medication.amount.numerator.value" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.unit"> <path value="Medication.amount.numerator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.system"> <path value="Medication.amount.numerator.system" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.code"> <path value="Medication.amount.numerator.code" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator"> <path value="Medication.amount.denominator" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.amount.denominator.value"> <path value="Medication.amount.denominator.value" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator.unit"> <path value="Medication.amount.denominator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator.system"> <path value="Medication.amount.denominator.system" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator.code"> <path value="Medication.amount.denominator.code" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient"> <path value="Medication.ingredient" /> <short value="Information on Components (Rezeptur)" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.extension:darreichungsform"> <path value="Medication.ingredient.extension" /> <sliceName value="darreichungsform" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension" /> </type> </element> <element id="Medication.ingredient.item[x]"> <path value="Medication.ingredient.item[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemCodeableConcept" /> <short value="Component in coded form or, if necessary, as free text" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding"> <path value="Medication.ingredient.item[x].coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="ask" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ask" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system"> <path value="Medication.ingredient.item[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.code"> <path value="Medication.ingredient.item[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="atc-de" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/bfarm/atc" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system"> <path value="Medication.ingredient.item[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.code"> <path value="Medication.ingredient.item[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="snomed" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://snomed.info/sct" /> </patternCoding> <binding> <strength value="preferred" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs" /> </binding> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system"> <path value="Medication.ingredient.item[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.version"> <path value="Medication.ingredient.item[x].coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.code"> <path value="Medication.ingredient.item[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="pzn" /> <min value="0" /> <max value="0" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ifa/pzn" /> </patternCoding> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.text"> <path value="Medication.ingredient.item[x].text" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemReference"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemReference" /> <short value="Restricted EPAMedicationPZNIngredient & EPAMedicationPharmaceuticalProduct only" /> <min value="0" /> <max value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Medication" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.isActive"> <path value="Medication.ingredient.isActive" /> <short value="Is it an active ingredient?" /> </element> <element id="Medication.ingredient.strength"> <path value="Medication.ingredient.strength" /> <short value="Strength" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.extension:amountText"> <path value="Medication.ingredient.strength.extension" /> <sliceName value="amountText" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension" /> </type> </element> <element id="Medication.ingredient.strength.extension:amountText.value[x]"> <path value="Medication.ingredient.strength.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator"> <path value="Medication.ingredient.strength.numerator" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.ingredient.strength.numerator.value"> <path value="Medication.ingredient.strength.numerator.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.unit"> <path value="Medication.ingredient.strength.numerator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.system"> <path value="Medication.ingredient.strength.numerator.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.system.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.numerator.system.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.numerator.system.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.ingredient.strength.numerator.code"> <path value="Medication.ingredient.strength.numerator.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.code.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.numerator.code.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.numerator.code.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.ingredient.strength.denominator"> <path value="Medication.ingredient.strength.denominator" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.ingredient.strength.denominator.value"> <path value="Medication.ingredient.strength.denominator.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.unit"> <path value="Medication.ingredient.strength.denominator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.system"> <path value="Medication.ingredient.strength.denominator.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.system.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.denominator.system.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.denominator.system.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.ingredient.strength.denominator.code"> <path value="Medication.ingredient.strength.denominator.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.code.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.denominator.code.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.denominator.code.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.batch"> <path value="Medication.batch" /> <short value="Batch Information" /> </element> <element id="Medication.batch.lotNumber"> <path value="Medication.batch.lotNumber" /> <short value="Batch Number" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-medication", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication", "version": "1.1.1", "name": "EPAMedication", "title": "EPA Medication", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Defines the medication resource for the Medication Service in the ePA system.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Medication", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication", "derivation": "constraint", "differential": { "element": [ { "id": "Medication", "path": "Medication", "constraint": [ { "key": "epa-med-1", "severity": "error", "human": "Medication code, name, or ingredients must be specified", "expression": "code.exists() or ingredient.exists()", "source": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" }, { "key": "epa-med-2", "severity": "error", "human": "Extemporaneous preparation medications and 'Kombipackungen' have to reference their components via .ingredient.itemReference", "expression": "extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '1208954007').exists() or form.coding.where(code = 'KPG').exists() implies ingredient.item.ofType(Reference).exists()", "source": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" }, { "key": "epa-med-3", "severity": "error", "human": "Medicinal product medications (Fertigarzneimittel) are not allowed to reference other medications via .ingredient.itemReference", "expression": "extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '781405001').exists() and form.coding.where(code = 'KPG').exists().not() implies ingredient.item.ofType(Reference).exists().not()", "source": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" } ] }, { "id": "Medication.meta", "path": "Medication.meta", "mustSupport": true }, { "id": "Medication.meta.versionId", "path": "Medication.meta.versionId", "mustSupport": true }, { "id": "Medication.meta.lastUpdated", "path": "Medication.meta.lastUpdated", "mustSupport": true }, { "id": "Medication.contained", "path": "Medication.contained", "short": "Contains PZN Ingredients for Compounding Medications & PharmaceuticalProducts in case of a 'Kombipackung'", "type": [ { "code": "Medication", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product", "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" ] } ], "mustSupport": true }, { "id": "Medication.extension:rxPrescriptionProcessIdentifier", "path": "Medication.extension", "sliceName": "rxPrescriptionProcessIdentifier", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension" ] } ] }, { "id": "Medication.extension:epaDispensationIdentifier", "path": "Medication.extension", "sliceName": "epaDispensationIdentifier", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/dispensation-identifier-extension" ] } ] }, { "id": "Medication.extension:isVaccine", "path": "Medication.extension", "sliceName": "isVaccine", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension" ] } ] }, { "id": "Medication.extension:isVaccine.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:drugCategory", "path": "Medication.extension", "sliceName": "drugCategory", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension" ] } ] }, { "id": "Medication.extension:drugCategory.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:drugCategory.value[x].system", "path": "Medication.extension.value[x].system", "mustSupport": true }, { "id": "Medication.extension:drugCategory.value[x].code", "path": "Medication.extension.value[x].code", "mustSupport": true }, { "id": "Medication.extension:normSizeCode", "path": "Medication.extension", "sliceName": "normSizeCode", "short": "Package size according to N-designation", "definition": "Description of the therapy-appropriate package size (e.g., N1)", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.de/StructureDefinition/normgroesse" ] } ] }, { "id": "Medication.extension:normSizeCode.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:packaging", "path": "Medication.extension", "sliceName": "packaging", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension" ] } ] }, { "id": "Medication.extension:packaging.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:manufacturingInstructions", "path": "Medication.extension", "sliceName": "manufacturingInstructions", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension" ] } ] }, { "id": "Medication.extension:manufacturingInstructions.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:type", "path": "Medication.extension", "sliceName": "type", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension" ] } ], "mustSupport": true }, { "id": "Medication.identifier", "path": "Medication.identifier", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" } }, { "id": "Medication.identifier:EPAMedicationUniqueIdentifier", "path": "Medication.identifier", "sliceName": "EPAMedicationUniqueIdentifier", "min": 0, "max": "1", "type": [ { "code": "Identifier", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-unique-identifier" ] } ], "patternIdentifier": { "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" } }, { "id": "Medication.identifier:RxOriginatorProcessIdentifier", "path": "Medication.identifier", "sliceName": "RxOriginatorProcessIdentifier", "min": 0, "max": "1", "type": [ { "code": "Identifier", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-originator-process-identifier" ] } ], "patternIdentifier": { "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" } }, { "id": "Medication.code", "path": "Medication.code", "short": "Medication in coded form or as free text if necessary", "mustSupport": true }, { "id": "Medication.code.coding", "path": "Medication.code.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "mustSupport": true }, { "id": "Medication.code.coding:pzn", "path": "Medication.code.coding", "sliceName": "pzn", "min": 0, "max": "1", "patternCoding": { "system": "http://fhir.de/CodeSystem/ifa/pzn" }, "mustSupport": true }, { "id": "Medication.code.coding:pzn.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:pzn.version", "path": "Medication.code.coding.version", "mustSupport": true }, { "id": "Medication.code.coding:pzn.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:pzn.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:atc-de", "path": "Medication.code.coding", "sliceName": "atc-de", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/bfarm/atc" }, "mustSupport": true }, { "id": "Medication.code.coding:atc-de.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:atc-de.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:atc-de.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:ask", "path": "Medication.code.coding", "sliceName": "ask", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/ask" }, "mustSupport": true }, { "id": "Medication.code.coding:ask.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:ask.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:ask.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:snomed", "path": "Medication.code.coding", "sliceName": "snomed", "min": 0, "max": "*", "patternCoding": { "system": "http://snomed.info/sct" }, "binding": { "strength": "extensible", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medication-snomed-ct-vs" } }, { "id": "Medication.code.coding:snomed.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:snomed.version", "path": "Medication.code.coding.version", "mustSupport": true }, { "id": "Medication.code.coding:snomed.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:snomed.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.text", "path": "Medication.code.text", "mustSupport": true }, { "id": "Medication.status", "path": "Medication.status", "short": "Status of Medication Information", "mustSupport": true }, { "id": "Medication.manufacturer", "path": "Medication.manufacturer", "short": "Manufacturer of the Medication", "comment": "Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer.", "mustSupport": true }, { "id": "Medication.manufacturer.display", "path": "Medication.manufacturer.display", "min": 1, "mustSupport": true }, { "id": "Medication.form", "path": "Medication.form", "short": "Form of Dispensing", "mustSupport": true }, { "id": "Medication.form.coding", "path": "Medication.form.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "mustSupport": true }, { "id": "Medication.form.coding:edqm", "path": "Medication.form.coding", "sliceName": "edqm", "min": 0, "max": "*", "patternCoding": { "system": "http://standardterms.edqm.eu" }, "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform" } }, { "id": "Medication.form.coding:edqm.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:edqm.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:edqm.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.form.coding:snomed", "path": "Medication.form.coding", "sliceName": "snomed", "min": 0, "max": "*", "patternCoding": { "system": "http://snomed.info/sct" }, "binding": { "strength": "preferred", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medicine-form-snomed-ct-vs" } }, { "id": "Medication.form.coding:snomed.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:snomed.version", "path": "Medication.form.coding.version", "mustSupport": true }, { "id": "Medication.form.coding:snomed.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:snomed.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.form.coding:kbvDarreichungsform", "path": "Medication.form.coding", "sliceName": "kbvDarreichungsform", "min": 0, "max": "*", "patternCoding": { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" }, "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM" } }, { "id": "Medication.form.coding:kbvDarreichungsform.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:kbvDarreichungsform.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:kbvDarreichungsform.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.amount", "path": "Medication.amount", "mustSupport": true }, { "id": "Medication.amount.numerator", "path": "Medication.amount.numerator", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.amount.numerator.extension:packagingSize", "path": "Medication.amount.numerator.extension", "sliceName": "packagingSize", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension" ] } ] }, { "id": "Medication.amount.numerator.extension:packagingSize.value[x]", "path": "Medication.amount.numerator.extension.value[x]", "mustSupport": true }, { "id": "Medication.amount.numerator.extension:totalQuantity", "path": "Medication.amount.numerator.extension", "sliceName": "totalQuantity", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension" ] } ] }, { "id": "Medication.amount.numerator.extension:totalQuantity.value[x]", "path": "Medication.amount.numerator.extension.value[x]", "mustSupport": true }, { "id": "Medication.amount.numerator.value", "path": "Medication.amount.numerator.value", "mustSupport": true }, { "id": "Medication.amount.numerator.unit", "path": "Medication.amount.numerator.unit", "mustSupport": true }, { "id": "Medication.amount.numerator.system", "path": "Medication.amount.numerator.system", "mustSupport": true }, { "id": "Medication.amount.numerator.code", "path": "Medication.amount.numerator.code", "mustSupport": true }, { "id": "Medication.amount.denominator", "path": "Medication.amount.denominator", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.amount.denominator.value", "path": "Medication.amount.denominator.value", "mustSupport": true }, { "id": "Medication.amount.denominator.unit", "path": "Medication.amount.denominator.unit", "mustSupport": true }, { "id": "Medication.amount.denominator.system", "path": "Medication.amount.denominator.system", "mustSupport": true }, { "id": "Medication.amount.denominator.code", "path": "Medication.amount.denominator.code", "mustSupport": true }, { "id": "Medication.ingredient", "path": "Medication.ingredient", "short": "Information on Components (Rezeptur)", "mustSupport": true }, { "id": "Medication.ingredient.extension:darreichungsform", "path": "Medication.ingredient.extension", "sliceName": "darreichungsform", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension" ] } ] }, { "id": "Medication.ingredient.item[x]", "path": "Medication.ingredient.item[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept", "path": "Medication.ingredient.item[x]", "sliceName": "itemCodeableConcept", "short": "Component in coded form or, if necessary, as free text", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding", "path": "Medication.ingredient.item[x].coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask", "path": "Medication.ingredient.item[x].coding", "sliceName": "ask", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/ask" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system", "path": "Medication.ingredient.item[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.code", "path": "Medication.ingredient.item[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de", "path": "Medication.ingredient.item[x].coding", "sliceName": "atc-de", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/bfarm/atc" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system", "path": "Medication.ingredient.item[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.code", "path": "Medication.ingredient.item[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed", "path": "Medication.ingredient.item[x].coding", "sliceName": "snomed", "min": 0, "max": "*", "patternCoding": { "system": "http://snomed.info/sct" }, "binding": { "strength": "preferred", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system", "path": "Medication.ingredient.item[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.version", "path": "Medication.ingredient.item[x].coding.version", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.code", "path": "Medication.ingredient.item[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn", "path": "Medication.ingredient.item[x].coding", "sliceName": "pzn", "min": 0, "max": "0", "patternCoding": { "system": "http://fhir.de/CodeSystem/ifa/pzn" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.text", "path": "Medication.ingredient.item[x].text", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemReference", "path": "Medication.ingredient.item[x]", "sliceName": "itemReference", "short": "Restricted EPAMedicationPZNIngredient & EPAMedicationPharmaceuticalProduct only", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Medication" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.isActive", "path": "Medication.ingredient.isActive", "short": "Is it an active ingredient?" }, { "id": "Medication.ingredient.strength", "path": "Medication.ingredient.strength", "short": "Strength", "mustSupport": true }, { "id": "Medication.ingredient.strength.extension:amountText", "path": "Medication.ingredient.strength.extension", "sliceName": "amountText", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension" ] } ] }, { "id": "Medication.ingredient.strength.extension:amountText.value[x]", "path": "Medication.ingredient.strength.extension.value[x]", "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator", "path": "Medication.ingredient.strength.numerator", "min": 1, "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.ingredient.strength.numerator.value", "path": "Medication.ingredient.strength.numerator.value", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.unit", "path": "Medication.ingredient.strength.numerator.unit", "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.system", "path": "Medication.ingredient.strength.numerator.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.system.extension:dataAbsentReason", "path": "Medication.ingredient.strength.numerator.system.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.numerator.system.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.ingredient.strength.numerator.code", "path": "Medication.ingredient.strength.numerator.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.code.extension:dataAbsentReason", "path": "Medication.ingredient.strength.numerator.code.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.numerator.code.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.ingredient.strength.denominator", "path": "Medication.ingredient.strength.denominator", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.ingredient.strength.denominator.value", "path": "Medication.ingredient.strength.denominator.value", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.unit", "path": "Medication.ingredient.strength.denominator.unit", "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.system", "path": "Medication.ingredient.strength.denominator.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.system.extension:dataAbsentReason", "path": "Medication.ingredient.strength.denominator.system.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.denominator.system.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.ingredient.strength.denominator.code", "path": "Medication.ingredient.strength.denominator.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.code.extension:dataAbsentReason", "path": "Medication.ingredient.strength.denominator.code.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.denominator.code.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.batch", "path": "Medication.batch", "short": "Batch Information" }, { "id": "Medication.batch.lotNumber", "path": "Medication.batch.lotNumber", "short": "Batch Number" } ] } }
Profile für Kombipackungen und PZN-Rezepturen
Für die Anwendungsfälle von Kombipackungen und PZN-Rezepturen werden separate Profile als Ingredient verwendet. Die FHIR-Ressourcen dieser Profile werden innerhalb der EPAMedication als contained genutzt.
Profil: EPA Pharmaceutical Product Medication
EPAMedicationPharmaceuticalProduct (Medication) | I | Medication | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..0 | Resource | |
extension | I | 0..* | Extension |
rxPrescriptionProcessIdentifier | I | 0..1 | Extension(RxPrescriptionProcessIdentifier) |
epaDispensationIdentifier | I | 0..1 | Extension(EPADispensationIdentifier) |
isVaccine | I | 0..1 | Extension(boolean) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueBoolean | boolean | ||
drugCategory | I | 0..1 | Extension(Coding) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
normSizeCode | I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 0..1 | Binding |
valueCode | code | ||
packaging | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
manufacturingInstructions | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
type | S I | 0..1 | Extension(Coding) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
EPAMedicationUniqueIdentifier | Σ | 0..1 | EPAMedicationUniqueIdentifierPattern |
RxOriginatorProcessIdentifier | Σ | 0..1 | RxOriginatorProcessIdentifierPattern |
code | S Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..* | Coding |
pzn | S Σ | 0..0 | CodingPattern |
atc-de | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
ask | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
snomed | Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
product-key | S Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
status | S Σ ?! | 0..1 | codeBinding |
manufacturer | S Σ I | 0..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | S Σ | 1..1 | string |
form | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
edqm | S Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
snomed | Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
kbvDarreichungsform | S Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
amount | S Σ I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
numerator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
packagingSize | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
totalQuantity | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 0..1 | code |
denominator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 0..1 | code |
ingredient | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
darreichungsform | I | 0..1 | Extension(string) |
modifierExtension | Σ ?! I | 0..* | Extension |
item[x] | S | 1..1 | |
itemCodeableConcept | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
ask | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
atc-de | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
snomed | Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
pzn | Σ | 0..0 | CodingPattern |
text | S Σ | 0..1 | string |
itemReference | S | 0..0 | Reference(Medication) |
isActive | 0..1 | boolean | |
strength | S I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
amountText | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
numerator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
denominator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
batch | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | dateTime |
Medication | |
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Medication.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Medication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Medication.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) 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. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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). |
Invariants |
|
Mappings |
|
Medication.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
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. |
Invariants |
|
Mappings |
|
Medication.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...0 |
Type | Resource |
Alias | inline resources, anonymous resources, contained 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. |
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:rxPrescriptionProcessIdentifier | |
Definition | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems. |
Cardinality | 0...1 |
Type | Extension(RxPrescriptionProcessIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:epaDispensationIdentifier | |
Definition | This extension is used to track the dispensation identifier for non-rx use-cases |
Cardinality | 0...1 |
Type | Extension(EPADispensationIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine | |
Definition | Indicator of whether this is a vaccine. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:isVaccine.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension |
Mappings |
|
Medication.extension:isVaccine.value[x] | |
Definition | Indicator of whether this is a vaccine.. false - no vaccine (default value) true - vaccine |
Cardinality | 1...1 |
Type | boolean |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory | |
Definition | Extension for indicating the medication category. |
Cardinality | 0...1 |
Type | Extension(Coding) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension |
Mappings |
|
Medication.extension:drugCategory.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPADrugCategoryVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].code | |
Definition | Drug Category |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode | |
Definition | Description of the therapy-appropriate package size (e.g., N1) |
Cardinality | 0...1 |
Type | Extension(code) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:normSizeCode.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://fhir.de/StructureDefinition/normgroesse |
Mappings |
|
Medication.extension:normSizeCode.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | code |
Binding | KBV_VS_SFHIR_KBV_NORMGROESSE (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:packaging | |
Definition | Information on the packaging of a formulation. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:packaging.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:packaging.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:packaging.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension |
Mappings |
|
Medication.extension:packaging.value[x] | |
Definition | Information on transport containers or packaging for a formulation. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:manufacturingInstructions.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension |
Mappings |
|
Medication.extension:manufacturingInstructions.value[x] | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:type | |
Definition | Extension for EPAMedication types |
Cardinality | 0...1 |
Type | Extension(Coding) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension: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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension: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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:type.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension |
Mappings |
|
Medication.extension:type.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAMedicationTypePharmaceuticalProductVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.identifier | |
Definition | Business identifier for this medication. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.identifier:EPAMedicationUniqueIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | EPAMedicationUniqueIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" } |
Mappings |
|
Medication.identifier:RxOriginatorProcessIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | RxOriginatorProcessIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" } |
Mappings |
|
Medication.code | |
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept that defines the type of a medication. |
Must Support | True |
Summary | True |
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). |
Invariants |
|
Mappings |
|
Medication.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...0 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.code.coding:pzn.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ifa/pzn |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.code.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.code.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | EPAMedicationSNOMEDCTVS (extensible) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "https://terminologieserver.bfarm.de/fhir/CodeSystem/arzneimittel-referenzdaten-pharmazeutisches-produkt" } |
Mappings |
|
Medication.code.coding:product-key.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:product-key.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | https://terminologieserver.bfarm.de/fhir/CodeSystem/arzneimittel-referenzdaten-pharmazeutisches-produkt |
Mappings |
|
Medication.code.coding:product-key.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.status | |
Definition | A code to indicate if the medication is in active use. |
Cardinality | 0...1 |
Type | code |
Binding | A coded concept defining if the medication is in active use. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. |
Invariants |
|
Mappings |
|
Medication.manufacturer | |
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Comments | Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer. |
Invariants |
|
Mappings |
|
Medication.manufacturer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.manufacturer.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.manufacturer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Medication.manufacturer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Medication.manufacturer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Medication.manufacturer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Medication.form | |
Definition | Describes the form of the item. Powder; tablets; capsule. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept defining the form of a medication. |
Must Support | True |
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. |
Invariants |
|
Mappings |
|
Medication.form.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://standardterms.edqm.eu" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://standardterms.edqm.eu |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | EPAMedicineFormSNOMEDCTVS (preferred) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" } |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.amount | |
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Summary | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.amount.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator | |
Definition | The value of the numerator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.value[x] | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.value[x] | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.amount.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient | |
Definition | Identifies a particular constituent of interest in the product. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. |
Invariants |
|
Mappings |
|
Medication.ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.extension:darreichungsform | |
Definition | Dosage form of an ingredient in a formulation. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x] | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | EPASubstanceSNOMEDCTVS (preferred) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...0 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemReference | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...0 |
Type | Reference(Medication) |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.isActive | |
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. |
Cardinality | 0...1 |
Type | boolean |
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength | |
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.extension:amountText.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension |
Mappings |
|
Medication.ingredient.strength.extension:amountText.value[x] | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator | |
Definition | The value of the numerator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.batch | |
Definition | Information that only applies to packages (not products). |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Medication.batch.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.batch.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.batch.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.batch.lotNumber | |
Definition | The assigned lot number of a batch of the specified product. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.batch.expirationDate | |
Definition | When this specific batch of product will expire. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-medication-pharmaceutical-product" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product" /> <version value="1.1.1" /> <name value="EPAMedicationPharmaceuticalProduct" /> <title value="EPA Pharmaceutical Product Medication" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Defines the medication resource for a component of a 'Kombipackung' for the Medication Service in the ePA system. These profiles are intended to inherit from EPAMedication, but due to tooling issues, this inheritance cannot currently be implemented." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Medication" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Medication" /> <derivation value="constraint" /> <differential> <element id="Medication"> <path value="Medication" /> <constraint> <key value="epa-med-1" /> <severity value="error" /> <human value="Medication code, name, or ingredients must be specified" /> <expression value="code.exists() or ingredient.exists()" /> <source value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product" /> </constraint> <constraint> <key value="epa-med-2" /> <severity value="error" /> <human value="Extemporaneous preparation medications and 'Kombipackungen' have to reference their components via .ingredient.itemReference" /> <expression value="extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '1208954007').exists() or form.coding.where(code = 'KPG').exists() implies ingredient.item.ofType(Reference).exists()" /> <source value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product" /> </constraint> <constraint> <key value="epa-med-3" /> <severity value="error" /> <human value="Medicinal product medications (Fertigarzneimittel) are not allowed to reference other medications via .ingredient.itemReference" /> <expression value="extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '781405001').exists() and form.coding.where(code = 'KPG').exists().not() implies ingredient.item.ofType(Reference).exists().not()" /> <source value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product" /> </constraint> </element> <element id="Medication.meta"> <path value="Medication.meta" /> <mustSupport value="true" /> </element> <element id="Medication.meta.versionId"> <path value="Medication.meta.versionId" /> <mustSupport value="true" /> </element> <element id="Medication.meta.lastUpdated"> <path value="Medication.meta.lastUpdated" /> <mustSupport value="true" /> </element> <element id="Medication.contained"> <path value="Medication.contained" /> <max value="0" /> </element> <element id="Medication.extension:rxPrescriptionProcessIdentifier"> <path value="Medication.extension" /> <sliceName value="rxPrescriptionProcessIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension" /> </type> </element> <element id="Medication.extension:epaDispensationIdentifier"> <path value="Medication.extension" /> <sliceName value="epaDispensationIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/dispensation-identifier-extension" /> </type> </element> <element id="Medication.extension:isVaccine"> <path value="Medication.extension" /> <sliceName value="isVaccine" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension" /> </type> </element> <element id="Medication.extension:isVaccine.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:drugCategory"> <path value="Medication.extension" /> <sliceName value="drugCategory" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension" /> </type> </element> <element id="Medication.extension:drugCategory.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:drugCategory.value[x].system"> <path value="Medication.extension.value[x].system" /> <mustSupport value="true" /> </element> <element id="Medication.extension:drugCategory.value[x].code"> <path value="Medication.extension.value[x].code" /> <mustSupport value="true" /> </element> <element id="Medication.extension:normSizeCode"> <path value="Medication.extension" /> <sliceName value="normSizeCode" /> <short value="Package size according to N-designation" /> <definition value="Description of the therapy-appropriate package size (e.g., N1)" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.de/StructureDefinition/normgroesse" /> </type> </element> <element id="Medication.extension:normSizeCode.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:packaging"> <path value="Medication.extension" /> <sliceName value="packaging" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension" /> </type> </element> <element id="Medication.extension:packaging.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:manufacturingInstructions"> <path value="Medication.extension" /> <sliceName value="manufacturingInstructions" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension" /> </type> </element> <element id="Medication.extension:manufacturingInstructions.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:type"> <path value="Medication.extension" /> <sliceName value="type" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension" /> </type> <mustSupport value="true" /> </element> <element id="Medication.extension:type.value[x]"> <path value="Medication.extension.value[x]" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medication-type-pharmaceutical-product-vs" /> </binding> </element> <element id="Medication.identifier"> <path value="Medication.identifier" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Medication.identifier:EPAMedicationUniqueIdentifier"> <path value="Medication.identifier" /> <sliceName value="EPAMedicationUniqueIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-unique-identifier" /> </type> <patternIdentifier> <system value="https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" /> </patternIdentifier> </element> <element id="Medication.identifier:RxOriginatorProcessIdentifier"> <path value="Medication.identifier" /> <sliceName value="RxOriginatorProcessIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-originator-process-identifier" /> </type> <patternIdentifier> <system value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" /> </patternIdentifier> </element> <element id="Medication.code"> <path value="Medication.code" /> <short value="Medication in coded form or as free text if necessary" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding"> <path value="Medication.code.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn"> <path value="Medication.code.coding" /> <sliceName value="pzn" /> <min value="0" /> <max value="0" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ifa/pzn" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.version"> <path value="Medication.code.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de"> <path value="Medication.code.coding" /> <sliceName value="atc-de" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/bfarm/atc" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask"> <path value="Medication.code.coding" /> <sliceName value="ask" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ask" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed"> <path value="Medication.code.coding" /> <sliceName value="snomed" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://snomed.info/sct" /> </patternCoding> <binding> <strength value="extensible" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medication-snomed-ct-vs" /> </binding> </element> <element id="Medication.code.coding:snomed.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.version"> <path value="Medication.code.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:product-key"> <path value="Medication.code.coding" /> <sliceName value="product-key" /> <min value="1" /> <max value="1" /> <patternCoding> <system value="https://terminologieserver.bfarm.de/fhir/CodeSystem/arzneimittel-referenzdaten-pharmazeutisches-produkt" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:product-key.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:product-key.version"> <path value="Medication.code.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:product-key.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:product-key.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.text"> <path value="Medication.code.text" /> <mustSupport value="true" /> </element> <element id="Medication.status"> <path value="Medication.status" /> <short value="Status of Medication Information" /> <mustSupport value="true" /> </element> <element id="Medication.manufacturer"> <path value="Medication.manufacturer" /> <short value="Manufacturer of the Medication" /> <comment value="Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer." /> <mustSupport value="true" /> </element> <element id="Medication.manufacturer.display"> <path value="Medication.manufacturer.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form"> <path value="Medication.form" /> <short value="Form of Dispensing" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding"> <path value="Medication.form.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.form.coding:edqm"> <path value="Medication.form.coding" /> <sliceName value="edqm" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://standardterms.edqm.eu" /> </patternCoding> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform" /> </binding> </element> <element id="Medication.form.coding:edqm.system"> <path value="Medication.form.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:edqm.code"> <path value="Medication.form.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:edqm.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed"> <path value="Medication.form.coding" /> <sliceName value="snomed" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://snomed.info/sct" /> </patternCoding> <binding> <strength value="preferred" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medicine-form-snomed-ct-vs" /> </binding> </element> <element id="Medication.form.coding:snomed.system"> <path value="Medication.form.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.version"> <path value="Medication.form.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.code"> <path value="Medication.form.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:kbvDarreichungsform"> <path value="Medication.form.coding" /> <sliceName value="kbvDarreichungsform" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" /> </patternCoding> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM" /> </binding> </element> <element id="Medication.form.coding:kbvDarreichungsform.system"> <path value="Medication.form.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:kbvDarreichungsform.code"> <path value="Medication.form.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:kbvDarreichungsform.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.amount"> <path value="Medication.amount" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator"> <path value="Medication.amount.numerator" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.amount.numerator.extension:packagingSize"> <path value="Medication.amount.numerator.extension" /> <sliceName value="packagingSize" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension" /> </type> </element> <element id="Medication.amount.numerator.extension:packagingSize.value[x]"> <path value="Medication.amount.numerator.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.extension:totalQuantity"> <path value="Medication.amount.numerator.extension" /> <sliceName value="totalQuantity" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension" /> </type> </element> <element id="Medication.amount.numerator.extension:totalQuantity.value[x]"> <path value="Medication.amount.numerator.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.value"> <path value="Medication.amount.numerator.value" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.unit"> <path value="Medication.amount.numerator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.system"> <path value="Medication.amount.numerator.system" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.code"> <path value="Medication.amount.numerator.code" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator"> <path value="Medication.amount.denominator" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.amount.denominator.value"> <path value="Medication.amount.denominator.value" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator.unit"> <path value="Medication.amount.denominator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator.system"> <path value="Medication.amount.denominator.system" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator.code"> <path value="Medication.amount.denominator.code" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient"> <path value="Medication.ingredient" /> <short value="Information on Components (Rezeptur)" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.extension:darreichungsform"> <path value="Medication.ingredient.extension" /> <sliceName value="darreichungsform" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension" /> </type> </element> <element id="Medication.ingredient.item[x]"> <path value="Medication.ingredient.item[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemCodeableConcept" /> <short value="Component in coded form or, if necessary, as free text" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding"> <path value="Medication.ingredient.item[x].coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="ask" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ask" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system"> <path value="Medication.ingredient.item[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.code"> <path value="Medication.ingredient.item[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="atc-de" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/bfarm/atc" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system"> <path value="Medication.ingredient.item[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.code"> <path value="Medication.ingredient.item[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="snomed" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://snomed.info/sct" /> </patternCoding> <binding> <strength value="preferred" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs" /> </binding> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system"> <path value="Medication.ingredient.item[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.version"> <path value="Medication.ingredient.item[x].coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.code"> <path value="Medication.ingredient.item[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="pzn" /> <min value="0" /> <max value="0" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ifa/pzn" /> </patternCoding> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.text"> <path value="Medication.ingredient.item[x].text" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemReference"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemReference" /> <short value="EPA Medication Pharmaceutical Product can't have child Medications" /> <min value="0" /> <max value="0" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Medication" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.isActive"> <path value="Medication.ingredient.isActive" /> <short value="Is it an active ingredient?" /> </element> <element id="Medication.ingredient.strength"> <path value="Medication.ingredient.strength" /> <short value="Strength" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.extension:amountText"> <path value="Medication.ingredient.strength.extension" /> <sliceName value="amountText" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension" /> </type> </element> <element id="Medication.ingredient.strength.extension:amountText.value[x]"> <path value="Medication.ingredient.strength.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator"> <path value="Medication.ingredient.strength.numerator" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.ingredient.strength.numerator.value"> <path value="Medication.ingredient.strength.numerator.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.unit"> <path value="Medication.ingredient.strength.numerator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.system"> <path value="Medication.ingredient.strength.numerator.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.system.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.numerator.system.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.numerator.system.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.ingredient.strength.numerator.code"> <path value="Medication.ingredient.strength.numerator.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.code.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.numerator.code.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.numerator.code.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.ingredient.strength.denominator"> <path value="Medication.ingredient.strength.denominator" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.ingredient.strength.denominator.value"> <path value="Medication.ingredient.strength.denominator.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.unit"> <path value="Medication.ingredient.strength.denominator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.system"> <path value="Medication.ingredient.strength.denominator.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.system.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.denominator.system.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.denominator.system.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.ingredient.strength.denominator.code"> <path value="Medication.ingredient.strength.denominator.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.code.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.denominator.code.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.denominator.code.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.batch"> <path value="Medication.batch" /> <short value="Batch Information" /> </element> <element id="Medication.batch.lotNumber"> <path value="Medication.batch.lotNumber" /> <short value="Batch Number" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-medication-pharmaceutical-product", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product", "version": "1.1.1", "name": "EPAMedicationPharmaceuticalProduct", "title": "EPA Pharmaceutical Product Medication", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Defines the medication resource for a component of a 'Kombipackung' for the Medication Service in the ePA system. These profiles are intended to inherit from EPAMedication, but due to tooling issues, this inheritance cannot currently be implemented.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Medication", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication", "derivation": "constraint", "differential": { "element": [ { "id": "Medication", "path": "Medication", "constraint": [ { "key": "epa-med-1", "severity": "error", "human": "Medication code, name, or ingredients must be specified", "expression": "code.exists() or ingredient.exists()", "source": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product" }, { "key": "epa-med-2", "severity": "error", "human": "Extemporaneous preparation medications and 'Kombipackungen' have to reference their components via .ingredient.itemReference", "expression": "extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '1208954007').exists() or form.coding.where(code = 'KPG').exists() implies ingredient.item.ofType(Reference).exists()", "source": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product" }, { "key": "epa-med-3", "severity": "error", "human": "Medicinal product medications (Fertigarzneimittel) are not allowed to reference other medications via .ingredient.itemReference", "expression": "extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '781405001').exists() and form.coding.where(code = 'KPG').exists().not() implies ingredient.item.ofType(Reference).exists().not()", "source": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product" } ] }, { "id": "Medication.meta", "path": "Medication.meta", "mustSupport": true }, { "id": "Medication.meta.versionId", "path": "Medication.meta.versionId", "mustSupport": true }, { "id": "Medication.meta.lastUpdated", "path": "Medication.meta.lastUpdated", "mustSupport": true }, { "id": "Medication.contained", "path": "Medication.contained", "max": "0" }, { "id": "Medication.extension:rxPrescriptionProcessIdentifier", "path": "Medication.extension", "sliceName": "rxPrescriptionProcessIdentifier", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension" ] } ] }, { "id": "Medication.extension:epaDispensationIdentifier", "path": "Medication.extension", "sliceName": "epaDispensationIdentifier", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/dispensation-identifier-extension" ] } ] }, { "id": "Medication.extension:isVaccine", "path": "Medication.extension", "sliceName": "isVaccine", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension" ] } ] }, { "id": "Medication.extension:isVaccine.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:drugCategory", "path": "Medication.extension", "sliceName": "drugCategory", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension" ] } ] }, { "id": "Medication.extension:drugCategory.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:drugCategory.value[x].system", "path": "Medication.extension.value[x].system", "mustSupport": true }, { "id": "Medication.extension:drugCategory.value[x].code", "path": "Medication.extension.value[x].code", "mustSupport": true }, { "id": "Medication.extension:normSizeCode", "path": "Medication.extension", "sliceName": "normSizeCode", "short": "Package size according to N-designation", "definition": "Description of the therapy-appropriate package size (e.g., N1)", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.de/StructureDefinition/normgroesse" ] } ] }, { "id": "Medication.extension:normSizeCode.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:packaging", "path": "Medication.extension", "sliceName": "packaging", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension" ] } ] }, { "id": "Medication.extension:packaging.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:manufacturingInstructions", "path": "Medication.extension", "sliceName": "manufacturingInstructions", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension" ] } ] }, { "id": "Medication.extension:manufacturingInstructions.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:type", "path": "Medication.extension", "sliceName": "type", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension" ] } ], "mustSupport": true }, { "id": "Medication.extension:type.value[x]", "path": "Medication.extension.value[x]", "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medication-type-pharmaceutical-product-vs" } }, { "id": "Medication.identifier", "path": "Medication.identifier", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" } }, { "id": "Medication.identifier:EPAMedicationUniqueIdentifier", "path": "Medication.identifier", "sliceName": "EPAMedicationUniqueIdentifier", "min": 0, "max": "1", "type": [ { "code": "Identifier", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-unique-identifier" ] } ], "patternIdentifier": { "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" } }, { "id": "Medication.identifier:RxOriginatorProcessIdentifier", "path": "Medication.identifier", "sliceName": "RxOriginatorProcessIdentifier", "min": 0, "max": "1", "type": [ { "code": "Identifier", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-originator-process-identifier" ] } ], "patternIdentifier": { "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" } }, { "id": "Medication.code", "path": "Medication.code", "short": "Medication in coded form or as free text if necessary", "mustSupport": true }, { "id": "Medication.code.coding", "path": "Medication.code.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:pzn", "path": "Medication.code.coding", "sliceName": "pzn", "min": 0, "max": "0", "patternCoding": { "system": "http://fhir.de/CodeSystem/ifa/pzn" }, "mustSupport": true }, { "id": "Medication.code.coding:pzn.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:pzn.version", "path": "Medication.code.coding.version", "mustSupport": true }, { "id": "Medication.code.coding:pzn.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:pzn.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:atc-de", "path": "Medication.code.coding", "sliceName": "atc-de", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/bfarm/atc" }, "mustSupport": true }, { "id": "Medication.code.coding:atc-de.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:atc-de.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:atc-de.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:ask", "path": "Medication.code.coding", "sliceName": "ask", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/ask" }, "mustSupport": true }, { "id": "Medication.code.coding:ask.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:ask.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:ask.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:snomed", "path": "Medication.code.coding", "sliceName": "snomed", "min": 0, "max": "*", "patternCoding": { "system": "http://snomed.info/sct" }, "binding": { "strength": "extensible", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medication-snomed-ct-vs" } }, { "id": "Medication.code.coding:snomed.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:snomed.version", "path": "Medication.code.coding.version", "mustSupport": true }, { "id": "Medication.code.coding:snomed.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:snomed.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:product-key", "path": "Medication.code.coding", "sliceName": "product-key", "min": 1, "max": "1", "patternCoding": { "system": "https://terminologieserver.bfarm.de/fhir/CodeSystem/arzneimittel-referenzdaten-pharmazeutisches-produkt" }, "mustSupport": true }, { "id": "Medication.code.coding:product-key.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:product-key.version", "path": "Medication.code.coding.version", "mustSupport": true }, { "id": "Medication.code.coding:product-key.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:product-key.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.text", "path": "Medication.code.text", "mustSupport": true }, { "id": "Medication.status", "path": "Medication.status", "short": "Status of Medication Information", "mustSupport": true }, { "id": "Medication.manufacturer", "path": "Medication.manufacturer", "short": "Manufacturer of the Medication", "comment": "Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer.", "mustSupport": true }, { "id": "Medication.manufacturer.display", "path": "Medication.manufacturer.display", "min": 1, "mustSupport": true }, { "id": "Medication.form", "path": "Medication.form", "short": "Form of Dispensing", "mustSupport": true }, { "id": "Medication.form.coding", "path": "Medication.form.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "mustSupport": true }, { "id": "Medication.form.coding:edqm", "path": "Medication.form.coding", "sliceName": "edqm", "min": 0, "max": "*", "patternCoding": { "system": "http://standardterms.edqm.eu" }, "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform" } }, { "id": "Medication.form.coding:edqm.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:edqm.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:edqm.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.form.coding:snomed", "path": "Medication.form.coding", "sliceName": "snomed", "min": 0, "max": "*", "patternCoding": { "system": "http://snomed.info/sct" }, "binding": { "strength": "preferred", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medicine-form-snomed-ct-vs" } }, { "id": "Medication.form.coding:snomed.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:snomed.version", "path": "Medication.form.coding.version", "mustSupport": true }, { "id": "Medication.form.coding:snomed.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:snomed.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.form.coding:kbvDarreichungsform", "path": "Medication.form.coding", "sliceName": "kbvDarreichungsform", "min": 0, "max": "*", "patternCoding": { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" }, "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM" } }, { "id": "Medication.form.coding:kbvDarreichungsform.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:kbvDarreichungsform.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:kbvDarreichungsform.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.amount", "path": "Medication.amount", "mustSupport": true }, { "id": "Medication.amount.numerator", "path": "Medication.amount.numerator", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.amount.numerator.extension:packagingSize", "path": "Medication.amount.numerator.extension", "sliceName": "packagingSize", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension" ] } ] }, { "id": "Medication.amount.numerator.extension:packagingSize.value[x]", "path": "Medication.amount.numerator.extension.value[x]", "mustSupport": true }, { "id": "Medication.amount.numerator.extension:totalQuantity", "path": "Medication.amount.numerator.extension", "sliceName": "totalQuantity", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension" ] } ] }, { "id": "Medication.amount.numerator.extension:totalQuantity.value[x]", "path": "Medication.amount.numerator.extension.value[x]", "mustSupport": true }, { "id": "Medication.amount.numerator.value", "path": "Medication.amount.numerator.value", "mustSupport": true }, { "id": "Medication.amount.numerator.unit", "path": "Medication.amount.numerator.unit", "mustSupport": true }, { "id": "Medication.amount.numerator.system", "path": "Medication.amount.numerator.system", "mustSupport": true }, { "id": "Medication.amount.numerator.code", "path": "Medication.amount.numerator.code", "mustSupport": true }, { "id": "Medication.amount.denominator", "path": "Medication.amount.denominator", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.amount.denominator.value", "path": "Medication.amount.denominator.value", "mustSupport": true }, { "id": "Medication.amount.denominator.unit", "path": "Medication.amount.denominator.unit", "mustSupport": true }, { "id": "Medication.amount.denominator.system", "path": "Medication.amount.denominator.system", "mustSupport": true }, { "id": "Medication.amount.denominator.code", "path": "Medication.amount.denominator.code", "mustSupport": true }, { "id": "Medication.ingredient", "path": "Medication.ingredient", "short": "Information on Components (Rezeptur)", "mustSupport": true }, { "id": "Medication.ingredient.extension:darreichungsform", "path": "Medication.ingredient.extension", "sliceName": "darreichungsform", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension" ] } ] }, { "id": "Medication.ingredient.item[x]", "path": "Medication.ingredient.item[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept", "path": "Medication.ingredient.item[x]", "sliceName": "itemCodeableConcept", "short": "Component in coded form or, if necessary, as free text", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding", "path": "Medication.ingredient.item[x].coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask", "path": "Medication.ingredient.item[x].coding", "sliceName": "ask", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/ask" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system", "path": "Medication.ingredient.item[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.code", "path": "Medication.ingredient.item[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de", "path": "Medication.ingredient.item[x].coding", "sliceName": "atc-de", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/bfarm/atc" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system", "path": "Medication.ingredient.item[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.code", "path": "Medication.ingredient.item[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed", "path": "Medication.ingredient.item[x].coding", "sliceName": "snomed", "min": 0, "max": "*", "patternCoding": { "system": "http://snomed.info/sct" }, "binding": { "strength": "preferred", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system", "path": "Medication.ingredient.item[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.version", "path": "Medication.ingredient.item[x].coding.version", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.code", "path": "Medication.ingredient.item[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn", "path": "Medication.ingredient.item[x].coding", "sliceName": "pzn", "min": 0, "max": "0", "patternCoding": { "system": "http://fhir.de/CodeSystem/ifa/pzn" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.text", "path": "Medication.ingredient.item[x].text", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemReference", "path": "Medication.ingredient.item[x]", "sliceName": "itemReference", "short": "EPA Medication Pharmaceutical Product can't have child Medications", "min": 0, "max": "0", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Medication" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.isActive", "path": "Medication.ingredient.isActive", "short": "Is it an active ingredient?" }, { "id": "Medication.ingredient.strength", "path": "Medication.ingredient.strength", "short": "Strength", "mustSupport": true }, { "id": "Medication.ingredient.strength.extension:amountText", "path": "Medication.ingredient.strength.extension", "sliceName": "amountText", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension" ] } ] }, { "id": "Medication.ingredient.strength.extension:amountText.value[x]", "path": "Medication.ingredient.strength.extension.value[x]", "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator", "path": "Medication.ingredient.strength.numerator", "min": 1, "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.ingredient.strength.numerator.value", "path": "Medication.ingredient.strength.numerator.value", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.unit", "path": "Medication.ingredient.strength.numerator.unit", "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.system", "path": "Medication.ingredient.strength.numerator.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.system.extension:dataAbsentReason", "path": "Medication.ingredient.strength.numerator.system.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.numerator.system.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.ingredient.strength.numerator.code", "path": "Medication.ingredient.strength.numerator.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.code.extension:dataAbsentReason", "path": "Medication.ingredient.strength.numerator.code.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.numerator.code.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.ingredient.strength.denominator", "path": "Medication.ingredient.strength.denominator", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.ingredient.strength.denominator.value", "path": "Medication.ingredient.strength.denominator.value", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.unit", "path": "Medication.ingredient.strength.denominator.unit", "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.system", "path": "Medication.ingredient.strength.denominator.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.system.extension:dataAbsentReason", "path": "Medication.ingredient.strength.denominator.system.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.denominator.system.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.ingredient.strength.denominator.code", "path": "Medication.ingredient.strength.denominator.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.code.extension:dataAbsentReason", "path": "Medication.ingredient.strength.denominator.code.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.denominator.code.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.batch", "path": "Medication.batch", "short": "Batch Information" }, { "id": "Medication.batch.lotNumber", "path": "Medication.batch.lotNumber", "short": "Batch Number" } ] } }
Profil: EPA Medication Ingredient
EPAMedicationPZNIngredient (Medication) | I | Medication | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..* | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..0 | Resource | |
extension | I | 0..* | Extension |
rxPrescriptionProcessIdentifier | I | 0..1 | Extension(RxPrescriptionProcessIdentifier) |
epaDispensationIdentifier | I | 0..1 | Extension(EPADispensationIdentifier) |
isVaccine | I | 0..1 | Extension(boolean) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueBoolean | boolean | ||
drugCategory | I | 0..1 | Extension(Coding) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
normSizeCode | I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 0..1 | Binding |
valueCode | code | ||
packaging | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
manufacturingInstructions | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
type | S I | 0..1 | Extension(Coding) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
EPAMedicationUniqueIdentifier | Σ | 0..1 | EPAMedicationUniqueIdentifierPattern |
RxOriginatorProcessIdentifier | Σ | 0..1 | RxOriginatorProcessIdentifierPattern |
code | S Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..* | Coding |
pzn | S Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
atc-de | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
ask | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
snomed | Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | S Σ | 0..1 | string |
status | S Σ ?! | 0..1 | codeBinding |
manufacturer | S Σ I | 0..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | S Σ | 1..1 | string |
form | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
edqm | S Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
snomed | Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
kbvDarreichungsform | S Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
amount | S Σ I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
numerator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
packagingSize | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
totalQuantity | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 0..1 | code |
denominator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 0..1 | code |
ingredient | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
darreichungsform | I | 0..1 | Extension(string) |
modifierExtension | Σ ?! I | 0..* | Extension |
item[x] | S | 1..1 | |
itemCodeableConcept | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
ask | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
atc-de | S Σ | 0..* | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
snomed | Σ | 0..* | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
pzn | Σ | 0..0 | CodingPattern |
text | S Σ | 0..1 | string |
itemReference | S | 0..0 | Reference(Medication) |
isActive | 0..1 | boolean | |
strength | S I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
amountText | I | 0..1 | Extension(string) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | |
valueString | string | ||
numerator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
denominator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..1 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
batch | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | dateTime |
Medication | |
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Medication.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Medication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Medication.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) 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. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...* |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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). |
Invariants |
|
Mappings |
|
Medication.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
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. |
Invariants |
|
Mappings |
|
Medication.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...0 |
Type | Resource |
Alias | inline resources, anonymous resources, contained 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. |
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:rxPrescriptionProcessIdentifier | |
Definition | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems. |
Cardinality | 0...1 |
Type | Extension(RxPrescriptionProcessIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:epaDispensationIdentifier | |
Definition | This extension is used to track the dispensation identifier for non-rx use-cases |
Cardinality | 0...1 |
Type | Extension(EPADispensationIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine | |
Definition | Indicator of whether this is a vaccine. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:isVaccine.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension |
Mappings |
|
Medication.extension:isVaccine.value[x] | |
Definition | Indicator of whether this is a vaccine.. false - no vaccine (default value) true - vaccine |
Cardinality | 1...1 |
Type | boolean |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory | |
Definition | Extension for indicating the medication category. |
Cardinality | 0...1 |
Type | Extension(Coding) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension |
Mappings |
|
Medication.extension:drugCategory.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPADrugCategoryVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].code | |
Definition | Drug Category |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode | |
Definition | Description of the therapy-appropriate package size (e.g., N1) |
Cardinality | 0...1 |
Type | Extension(code) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:normSizeCode.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://fhir.de/StructureDefinition/normgroesse |
Mappings |
|
Medication.extension:normSizeCode.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | code |
Binding | KBV_VS_SFHIR_KBV_NORMGROESSE (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:packaging | |
Definition | Information on the packaging of a formulation. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:packaging.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:packaging.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:packaging.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension |
Mappings |
|
Medication.extension:packaging.value[x] | |
Definition | Information on transport containers or packaging for a formulation. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:manufacturingInstructions.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension |
Mappings |
|
Medication.extension:manufacturingInstructions.value[x] | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:type | |
Definition | Extension for EPAMedication types |
Cardinality | 0...1 |
Type | Extension(Coding) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension: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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension: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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:type.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension |
Mappings |
|
Medication.extension:type.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAMedicationTypeProductVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.identifier | |
Definition | Business identifier for this medication. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.identifier:EPAMedicationUniqueIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | EPAMedicationUniqueIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" } |
Mappings |
|
Medication.identifier:RxOriginatorProcessIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | RxOriginatorProcessIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" } |
Mappings |
|
Medication.code | |
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept that defines the type of a medication. |
Must Support | True |
Summary | True |
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). |
Invariants |
|
Mappings |
|
Medication.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.code.coding:pzn.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ifa/pzn |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.code.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.code.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | EPAMedicationSNOMEDCTVS (extensible) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.status | |
Definition | A code to indicate if the medication is in active use. |
Cardinality | 0...1 |
Type | code |
Binding | A coded concept defining if the medication is in active use. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. |
Invariants |
|
Mappings |
|
Medication.manufacturer | |
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Comments | Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer. |
Invariants |
|
Mappings |
|
Medication.manufacturer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.manufacturer.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.manufacturer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Medication.manufacturer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Medication.manufacturer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Medication.manufacturer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Medication.form | |
Definition | Describes the form of the item. Powder; tablets; capsule. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept defining the form of a medication. |
Must Support | True |
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. |
Invariants |
|
Mappings |
|
Medication.form.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://standardterms.edqm.eu" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://standardterms.edqm.eu |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | EPAMedicineFormSNOMEDCTVS (preferred) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" } |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.amount | |
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Summary | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.amount.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator | |
Definition | The value of the numerator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.value[x] | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.value[x] | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.amount.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient | |
Definition | Identifies a particular constituent of interest in the product. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. |
Invariants |
|
Mappings |
|
Medication.ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.extension:darreichungsform | |
Definition | Dosage form of an ingredient in a formulation. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x] | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Binding | EPASubstanceSNOMEDCTVS (preferred) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...0 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemReference | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...0 |
Type | Reference(Medication) |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.isActive | |
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. |
Cardinality | 0...1 |
Type | boolean |
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength | |
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.extension:amountText.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension |
Mappings |
|
Medication.ingredient.strength.extension:amountText.value[x] | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator | |
Definition | The value of the numerator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.batch | |
Definition | Information that only applies to packages (not products). |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Medication.batch.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.batch.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.batch.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.batch.lotNumber | |
Definition | The assigned lot number of a batch of the specified product. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.batch.expirationDate | |
Definition | When this specific batch of product will expire. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-medication-pzn-ingredient" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" /> <version value="1.1.1" /> <name value="EPAMedicationPZNIngredient" /> <title value="EPA Medication Ingredient" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Defines the medication resource for a PZN ingredient of a compounding medication for the Medication Service in the ePA system. These profiles are intended to inherit from EPAMedication, but due to tooling issues, this inheritance cannot currently be implemented." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Medication" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Medication" /> <derivation value="constraint" /> <differential> <element id="Medication"> <path value="Medication" /> <constraint> <key value="epa-med-1" /> <severity value="error" /> <human value="Medication code, name, or ingredients must be specified" /> <expression value="code.exists() or ingredient.exists()" /> <source value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" /> </constraint> <constraint> <key value="epa-med-2" /> <severity value="error" /> <human value="Extemporaneous preparation medications and 'Kombipackungen' have to reference their components via .ingredient.itemReference" /> <expression value="extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '1208954007').exists() or form.coding.where(code = 'KPG').exists() implies ingredient.item.ofType(Reference).exists()" /> <source value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" /> </constraint> <constraint> <key value="epa-med-3" /> <severity value="error" /> <human value="Medicinal product medications (Fertigarzneimittel) are not allowed to reference other medications via .ingredient.itemReference" /> <expression value="extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '781405001').exists() and form.coding.where(code = 'KPG').exists().not() implies ingredient.item.ofType(Reference).exists().not()" /> <source value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" /> </constraint> </element> <element id="Medication.meta"> <path value="Medication.meta" /> <mustSupport value="true" /> </element> <element id="Medication.meta.versionId"> <path value="Medication.meta.versionId" /> <mustSupport value="true" /> </element> <element id="Medication.meta.lastUpdated"> <path value="Medication.meta.lastUpdated" /> <mustSupport value="true" /> </element> <element id="Medication.contained"> <path value="Medication.contained" /> <max value="0" /> </element> <element id="Medication.extension:rxPrescriptionProcessIdentifier"> <path value="Medication.extension" /> <sliceName value="rxPrescriptionProcessIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension" /> </type> </element> <element id="Medication.extension:epaDispensationIdentifier"> <path value="Medication.extension" /> <sliceName value="epaDispensationIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/dispensation-identifier-extension" /> </type> </element> <element id="Medication.extension:isVaccine"> <path value="Medication.extension" /> <sliceName value="isVaccine" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension" /> </type> </element> <element id="Medication.extension:isVaccine.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:drugCategory"> <path value="Medication.extension" /> <sliceName value="drugCategory" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension" /> </type> </element> <element id="Medication.extension:drugCategory.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:drugCategory.value[x].system"> <path value="Medication.extension.value[x].system" /> <mustSupport value="true" /> </element> <element id="Medication.extension:drugCategory.value[x].code"> <path value="Medication.extension.value[x].code" /> <mustSupport value="true" /> </element> <element id="Medication.extension:normSizeCode"> <path value="Medication.extension" /> <sliceName value="normSizeCode" /> <short value="Package size according to N-designation" /> <definition value="Description of the therapy-appropriate package size (e.g., N1)" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://fhir.de/StructureDefinition/normgroesse" /> </type> </element> <element id="Medication.extension:normSizeCode.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:packaging"> <path value="Medication.extension" /> <sliceName value="packaging" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension" /> </type> </element> <element id="Medication.extension:packaging.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:manufacturingInstructions"> <path value="Medication.extension" /> <sliceName value="manufacturingInstructions" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension" /> </type> </element> <element id="Medication.extension:manufacturingInstructions.value[x]"> <path value="Medication.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.extension:type"> <path value="Medication.extension" /> <sliceName value="type" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension" /> </type> <mustSupport value="true" /> </element> <element id="Medication.extension:type.value[x]"> <path value="Medication.extension.value[x]" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medication-type-product-vs" /> </binding> </element> <element id="Medication.identifier"> <path value="Medication.identifier" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Medication.identifier:EPAMedicationUniqueIdentifier"> <path value="Medication.identifier" /> <sliceName value="EPAMedicationUniqueIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-unique-identifier" /> </type> <patternIdentifier> <system value="https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" /> </patternIdentifier> </element> <element id="Medication.identifier:RxOriginatorProcessIdentifier"> <path value="Medication.identifier" /> <sliceName value="RxOriginatorProcessIdentifier" /> <min value="0" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-originator-process-identifier" /> </type> <patternIdentifier> <system value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" /> </patternIdentifier> </element> <element id="Medication.code"> <path value="Medication.code" /> <short value="Medication in coded form or as free text if necessary" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding"> <path value="Medication.code.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn"> <path value="Medication.code.coding" /> <sliceName value="pzn" /> <min value="1" /> <max value="1" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ifa/pzn" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.version"> <path value="Medication.code.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:pzn.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de"> <path value="Medication.code.coding" /> <sliceName value="atc-de" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/bfarm/atc" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:atc-de.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask"> <path value="Medication.code.coding" /> <sliceName value="ask" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ask" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:ask.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed"> <path value="Medication.code.coding" /> <sliceName value="snomed" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://snomed.info/sct" /> </patternCoding> <binding> <strength value="extensible" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medication-snomed-ct-vs" /> </binding> </element> <element id="Medication.code.coding:snomed.system"> <path value="Medication.code.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.version"> <path value="Medication.code.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.code"> <path value="Medication.code.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.display"> <path value="Medication.code.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.code.text"> <path value="Medication.code.text" /> <mustSupport value="true" /> </element> <element id="Medication.status"> <path value="Medication.status" /> <short value="Status of Medication Information" /> <mustSupport value="true" /> </element> <element id="Medication.manufacturer"> <path value="Medication.manufacturer" /> <short value="Manufacturer of the Medication" /> <comment value="Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer." /> <mustSupport value="true" /> </element> <element id="Medication.manufacturer.display"> <path value="Medication.manufacturer.display" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form"> <path value="Medication.form" /> <short value="Form of Dispensing" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding"> <path value="Medication.form.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.form.coding:edqm"> <path value="Medication.form.coding" /> <sliceName value="edqm" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://standardterms.edqm.eu" /> </patternCoding> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform" /> </binding> </element> <element id="Medication.form.coding:edqm.system"> <path value="Medication.form.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:edqm.code"> <path value="Medication.form.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:edqm.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed"> <path value="Medication.form.coding" /> <sliceName value="snomed" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://snomed.info/sct" /> </patternCoding> <binding> <strength value="preferred" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medicine-form-snomed-ct-vs" /> </binding> </element> <element id="Medication.form.coding:snomed.system"> <path value="Medication.form.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.version"> <path value="Medication.form.coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.code"> <path value="Medication.form.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:kbvDarreichungsform"> <path value="Medication.form.coding" /> <sliceName value="kbvDarreichungsform" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" /> </patternCoding> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM" /> </binding> </element> <element id="Medication.form.coding:kbvDarreichungsform.system"> <path value="Medication.form.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:kbvDarreichungsform.code"> <path value="Medication.form.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:kbvDarreichungsform.display"> <path value="Medication.form.coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.amount"> <path value="Medication.amount" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator"> <path value="Medication.amount.numerator" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.amount.numerator.extension:packagingSize"> <path value="Medication.amount.numerator.extension" /> <sliceName value="packagingSize" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension" /> </type> </element> <element id="Medication.amount.numerator.extension:packagingSize.value[x]"> <path value="Medication.amount.numerator.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.extension:totalQuantity"> <path value="Medication.amount.numerator.extension" /> <sliceName value="totalQuantity" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension" /> </type> </element> <element id="Medication.amount.numerator.extension:totalQuantity.value[x]"> <path value="Medication.amount.numerator.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.value"> <path value="Medication.amount.numerator.value" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.unit"> <path value="Medication.amount.numerator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.system"> <path value="Medication.amount.numerator.system" /> <mustSupport value="true" /> </element> <element id="Medication.amount.numerator.code"> <path value="Medication.amount.numerator.code" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator"> <path value="Medication.amount.denominator" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.amount.denominator.value"> <path value="Medication.amount.denominator.value" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator.unit"> <path value="Medication.amount.denominator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator.system"> <path value="Medication.amount.denominator.system" /> <mustSupport value="true" /> </element> <element id="Medication.amount.denominator.code"> <path value="Medication.amount.denominator.code" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient"> <path value="Medication.ingredient" /> <short value="Information on Components (Rezeptur)" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.extension:darreichungsform"> <path value="Medication.ingredient.extension" /> <sliceName value="darreichungsform" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension" /> </type> </element> <element id="Medication.ingredient.item[x]"> <path value="Medication.ingredient.item[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemCodeableConcept" /> <short value="Component in coded form or, if necessary, as free text" /> <min value="0" /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding"> <path value="Medication.ingredient.item[x].coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="ask" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ask" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system"> <path value="Medication.ingredient.item[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.code"> <path value="Medication.ingredient.item[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="atc-de" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://fhir.de/CodeSystem/bfarm/atc" /> </patternCoding> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system"> <path value="Medication.ingredient.item[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.code"> <path value="Medication.ingredient.item[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="snomed" /> <min value="0" /> <max value="*" /> <patternCoding> <system value="http://snomed.info/sct" /> </patternCoding> <binding> <strength value="preferred" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs" /> </binding> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system"> <path value="Medication.ingredient.item[x].coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.version"> <path value="Medication.ingredient.item[x].coding.version" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.code"> <path value="Medication.ingredient.item[x].coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display"> <path value="Medication.ingredient.item[x].coding.display" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="pzn" /> <min value="0" /> <max value="0" /> <patternCoding> <system value="http://fhir.de/CodeSystem/ifa/pzn" /> </patternCoding> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.text"> <path value="Medication.ingredient.item[x].text" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemReference"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemReference" /> <short value="EPA Medication Ingredients can't have child Medications" /> <min value="0" /> <max value="0" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Medication" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.isActive"> <path value="Medication.ingredient.isActive" /> <short value="Is it an active ingredient?" /> </element> <element id="Medication.ingredient.strength"> <path value="Medication.ingredient.strength" /> <short value="Strength" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.extension:amountText"> <path value="Medication.ingredient.strength.extension" /> <sliceName value="amountText" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension" /> </type> </element> <element id="Medication.ingredient.strength.extension:amountText.value[x]"> <path value="Medication.ingredient.strength.extension.value[x]" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator"> <path value="Medication.ingredient.strength.numerator" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.ingredient.strength.numerator.value"> <path value="Medication.ingredient.strength.numerator.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.unit"> <path value="Medication.ingredient.strength.numerator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.system"> <path value="Medication.ingredient.strength.numerator.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.system.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.numerator.system.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.numerator.system.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.ingredient.strength.numerator.code"> <path value="Medication.ingredient.strength.numerator.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.code.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.numerator.code.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.numerator.code.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.ingredient.strength.denominator"> <path value="Medication.ingredient.strength.denominator" /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/ucum-units" /> </binding> </element> <element id="Medication.ingredient.strength.denominator.value"> <path value="Medication.ingredient.strength.denominator.value" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.unit"> <path value="Medication.ingredient.strength.denominator.unit" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.system"> <path value="Medication.ingredient.strength.denominator.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.system.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.denominator.system.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.denominator.system.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.ingredient.strength.denominator.code"> <path value="Medication.ingredient.strength.denominator.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.code.extension:dataAbsentReason"> <path value="Medication.ingredient.strength.denominator.code.extension" /> <sliceName value="dataAbsentReason" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/data-absent-reason" /> </type> <mustSupport value="true" /> </element> <element id="Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x]"> <path value="Medication.ingredient.strength.denominator.code.extension.value[x]" /> <patternCode value="unknown" /> </element> <element id="Medication.batch"> <path value="Medication.batch" /> <short value="Batch Information" /> </element> <element id="Medication.batch.lotNumber"> <path value="Medication.batch.lotNumber" /> <short value="Batch Number" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-medication-pzn-ingredient", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient", "version": "1.1.1", "name": "EPAMedicationPZNIngredient", "title": "EPA Medication Ingredient", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Defines the medication resource for a PZN ingredient of a compounding medication for the Medication Service in the ePA system. These profiles are intended to inherit from EPAMedication, but due to tooling issues, this inheritance cannot currently be implemented.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Medication", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication", "derivation": "constraint", "differential": { "element": [ { "id": "Medication", "path": "Medication", "constraint": [ { "key": "epa-med-1", "severity": "error", "human": "Medication code, name, or ingredients must be specified", "expression": "code.exists() or ingredient.exists()", "source": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" }, { "key": "epa-med-2", "severity": "error", "human": "Extemporaneous preparation medications and 'Kombipackungen' have to reference their components via .ingredient.itemReference", "expression": "extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '1208954007').exists() or form.coding.where(code = 'KPG').exists() implies ingredient.item.ofType(Reference).exists()", "source": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" }, { "key": "epa-med-3", "severity": "error", "human": "Medicinal product medications (Fertigarzneimittel) are not allowed to reference other medications via .ingredient.itemReference", "expression": "extension('https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension').value.where(code = '781405001').exists() and form.coding.where(code = 'KPG').exists().not() implies ingredient.item.ofType(Reference).exists().not()", "source": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" } ] }, { "id": "Medication.meta", "path": "Medication.meta", "mustSupport": true }, { "id": "Medication.meta.versionId", "path": "Medication.meta.versionId", "mustSupport": true }, { "id": "Medication.meta.lastUpdated", "path": "Medication.meta.lastUpdated", "mustSupport": true }, { "id": "Medication.contained", "path": "Medication.contained", "max": "0" }, { "id": "Medication.extension:rxPrescriptionProcessIdentifier", "path": "Medication.extension", "sliceName": "rxPrescriptionProcessIdentifier", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension" ] } ] }, { "id": "Medication.extension:epaDispensationIdentifier", "path": "Medication.extension", "sliceName": "epaDispensationIdentifier", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/dispensation-identifier-extension" ] } ] }, { "id": "Medication.extension:isVaccine", "path": "Medication.extension", "sliceName": "isVaccine", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension" ] } ] }, { "id": "Medication.extension:isVaccine.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:drugCategory", "path": "Medication.extension", "sliceName": "drugCategory", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension" ] } ] }, { "id": "Medication.extension:drugCategory.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:drugCategory.value[x].system", "path": "Medication.extension.value[x].system", "mustSupport": true }, { "id": "Medication.extension:drugCategory.value[x].code", "path": "Medication.extension.value[x].code", "mustSupport": true }, { "id": "Medication.extension:normSizeCode", "path": "Medication.extension", "sliceName": "normSizeCode", "short": "Package size according to N-designation", "definition": "Description of the therapy-appropriate package size (e.g., N1)", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://fhir.de/StructureDefinition/normgroesse" ] } ] }, { "id": "Medication.extension:normSizeCode.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:packaging", "path": "Medication.extension", "sliceName": "packaging", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension" ] } ] }, { "id": "Medication.extension:packaging.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:manufacturingInstructions", "path": "Medication.extension", "sliceName": "manufacturingInstructions", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension" ] } ] }, { "id": "Medication.extension:manufacturingInstructions.value[x]", "path": "Medication.extension.value[x]", "mustSupport": true }, { "id": "Medication.extension:type", "path": "Medication.extension", "sliceName": "type", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension" ] } ], "mustSupport": true }, { "id": "Medication.extension:type.value[x]", "path": "Medication.extension.value[x]", "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medication-type-product-vs" } }, { "id": "Medication.identifier", "path": "Medication.identifier", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" } }, { "id": "Medication.identifier:EPAMedicationUniqueIdentifier", "path": "Medication.identifier", "sliceName": "EPAMedicationUniqueIdentifier", "min": 0, "max": "1", "type": [ { "code": "Identifier", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-unique-identifier" ] } ], "patternIdentifier": { "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" } }, { "id": "Medication.identifier:RxOriginatorProcessIdentifier", "path": "Medication.identifier", "sliceName": "RxOriginatorProcessIdentifier", "min": 0, "max": "1", "type": [ { "code": "Identifier", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-originator-process-identifier" ] } ], "patternIdentifier": { "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" } }, { "id": "Medication.code", "path": "Medication.code", "short": "Medication in coded form or as free text if necessary", "mustSupport": true }, { "id": "Medication.code.coding", "path": "Medication.code.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:pzn", "path": "Medication.code.coding", "sliceName": "pzn", "min": 1, "max": "1", "patternCoding": { "system": "http://fhir.de/CodeSystem/ifa/pzn" }, "mustSupport": true }, { "id": "Medication.code.coding:pzn.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:pzn.version", "path": "Medication.code.coding.version", "mustSupport": true }, { "id": "Medication.code.coding:pzn.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:pzn.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:atc-de", "path": "Medication.code.coding", "sliceName": "atc-de", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/bfarm/atc" }, "mustSupport": true }, { "id": "Medication.code.coding:atc-de.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:atc-de.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:atc-de.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:ask", "path": "Medication.code.coding", "sliceName": "ask", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/ask" }, "mustSupport": true }, { "id": "Medication.code.coding:ask.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:ask.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:ask.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.coding:snomed", "path": "Medication.code.coding", "sliceName": "snomed", "min": 0, "max": "*", "patternCoding": { "system": "http://snomed.info/sct" }, "binding": { "strength": "extensible", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medication-snomed-ct-vs" } }, { "id": "Medication.code.coding:snomed.system", "path": "Medication.code.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:snomed.version", "path": "Medication.code.coding.version", "mustSupport": true }, { "id": "Medication.code.coding:snomed.code", "path": "Medication.code.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.code.coding:snomed.display", "path": "Medication.code.coding.display", "mustSupport": true }, { "id": "Medication.code.text", "path": "Medication.code.text", "mustSupport": true }, { "id": "Medication.status", "path": "Medication.status", "short": "Status of Medication Information", "mustSupport": true }, { "id": "Medication.manufacturer", "path": "Medication.manufacturer", "short": "Manufacturer of the Medication", "comment": "Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer.", "mustSupport": true }, { "id": "Medication.manufacturer.display", "path": "Medication.manufacturer.display", "min": 1, "mustSupport": true }, { "id": "Medication.form", "path": "Medication.form", "short": "Form of Dispensing", "mustSupport": true }, { "id": "Medication.form.coding", "path": "Medication.form.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "mustSupport": true }, { "id": "Medication.form.coding:edqm", "path": "Medication.form.coding", "sliceName": "edqm", "min": 0, "max": "*", "patternCoding": { "system": "http://standardterms.edqm.eu" }, "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform" } }, { "id": "Medication.form.coding:edqm.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:edqm.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:edqm.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.form.coding:snomed", "path": "Medication.form.coding", "sliceName": "snomed", "min": 0, "max": "*", "patternCoding": { "system": "http://snomed.info/sct" }, "binding": { "strength": "preferred", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medicine-form-snomed-ct-vs" } }, { "id": "Medication.form.coding:snomed.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:snomed.version", "path": "Medication.form.coding.version", "mustSupport": true }, { "id": "Medication.form.coding:snomed.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:snomed.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.form.coding:kbvDarreichungsform", "path": "Medication.form.coding", "sliceName": "kbvDarreichungsform", "min": 0, "max": "*", "patternCoding": { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" }, "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_DARREICHUNGSFORM" } }, { "id": "Medication.form.coding:kbvDarreichungsform.system", "path": "Medication.form.coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:kbvDarreichungsform.code", "path": "Medication.form.coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.form.coding:kbvDarreichungsform.display", "path": "Medication.form.coding.display", "mustSupport": true }, { "id": "Medication.amount", "path": "Medication.amount", "mustSupport": true }, { "id": "Medication.amount.numerator", "path": "Medication.amount.numerator", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.amount.numerator.extension:packagingSize", "path": "Medication.amount.numerator.extension", "sliceName": "packagingSize", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension" ] } ] }, { "id": "Medication.amount.numerator.extension:packagingSize.value[x]", "path": "Medication.amount.numerator.extension.value[x]", "mustSupport": true }, { "id": "Medication.amount.numerator.extension:totalQuantity", "path": "Medication.amount.numerator.extension", "sliceName": "totalQuantity", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension" ] } ] }, { "id": "Medication.amount.numerator.extension:totalQuantity.value[x]", "path": "Medication.amount.numerator.extension.value[x]", "mustSupport": true }, { "id": "Medication.amount.numerator.value", "path": "Medication.amount.numerator.value", "mustSupport": true }, { "id": "Medication.amount.numerator.unit", "path": "Medication.amount.numerator.unit", "mustSupport": true }, { "id": "Medication.amount.numerator.system", "path": "Medication.amount.numerator.system", "mustSupport": true }, { "id": "Medication.amount.numerator.code", "path": "Medication.amount.numerator.code", "mustSupport": true }, { "id": "Medication.amount.denominator", "path": "Medication.amount.denominator", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.amount.denominator.value", "path": "Medication.amount.denominator.value", "mustSupport": true }, { "id": "Medication.amount.denominator.unit", "path": "Medication.amount.denominator.unit", "mustSupport": true }, { "id": "Medication.amount.denominator.system", "path": "Medication.amount.denominator.system", "mustSupport": true }, { "id": "Medication.amount.denominator.code", "path": "Medication.amount.denominator.code", "mustSupport": true }, { "id": "Medication.ingredient", "path": "Medication.ingredient", "short": "Information on Components (Rezeptur)", "mustSupport": true }, { "id": "Medication.ingredient.extension:darreichungsform", "path": "Medication.ingredient.extension", "sliceName": "darreichungsform", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension" ] } ] }, { "id": "Medication.ingredient.item[x]", "path": "Medication.ingredient.item[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept", "path": "Medication.ingredient.item[x]", "sliceName": "itemCodeableConcept", "short": "Component in coded form or, if necessary, as free text", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding", "path": "Medication.ingredient.item[x].coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask", "path": "Medication.ingredient.item[x].coding", "sliceName": "ask", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/ask" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system", "path": "Medication.ingredient.item[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.code", "path": "Medication.ingredient.item[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de", "path": "Medication.ingredient.item[x].coding", "sliceName": "atc-de", "min": 0, "max": "*", "patternCoding": { "system": "http://fhir.de/CodeSystem/bfarm/atc" }, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system", "path": "Medication.ingredient.item[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.code", "path": "Medication.ingredient.item[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed", "path": "Medication.ingredient.item[x].coding", "sliceName": "snomed", "min": 0, "max": "*", "patternCoding": { "system": "http://snomed.info/sct" }, "binding": { "strength": "preferred", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-substance-snomed-ct-vs" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system", "path": "Medication.ingredient.item[x].coding.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.version", "path": "Medication.ingredient.item[x].coding.version", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.code", "path": "Medication.ingredient.item[x].coding.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display", "path": "Medication.ingredient.item[x].coding.display", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn", "path": "Medication.ingredient.item[x].coding", "sliceName": "pzn", "min": 0, "max": "0", "patternCoding": { "system": "http://fhir.de/CodeSystem/ifa/pzn" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.text", "path": "Medication.ingredient.item[x].text", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemReference", "path": "Medication.ingredient.item[x]", "sliceName": "itemReference", "short": "EPA Medication Ingredients can't have child Medications", "min": 0, "max": "0", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Medication" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.isActive", "path": "Medication.ingredient.isActive", "short": "Is it an active ingredient?" }, { "id": "Medication.ingredient.strength", "path": "Medication.ingredient.strength", "short": "Strength", "mustSupport": true }, { "id": "Medication.ingredient.strength.extension:amountText", "path": "Medication.ingredient.strength.extension", "sliceName": "amountText", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension" ] } ] }, { "id": "Medication.ingredient.strength.extension:amountText.value[x]", "path": "Medication.ingredient.strength.extension.value[x]", "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator", "path": "Medication.ingredient.strength.numerator", "min": 1, "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.ingredient.strength.numerator.value", "path": "Medication.ingredient.strength.numerator.value", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.unit", "path": "Medication.ingredient.strength.numerator.unit", "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.system", "path": "Medication.ingredient.strength.numerator.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.system.extension:dataAbsentReason", "path": "Medication.ingredient.strength.numerator.system.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.numerator.system.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.ingredient.strength.numerator.code", "path": "Medication.ingredient.strength.numerator.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.code.extension:dataAbsentReason", "path": "Medication.ingredient.strength.numerator.code.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.numerator.code.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.ingredient.strength.denominator", "path": "Medication.ingredient.strength.denominator", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/ucum-units" } }, { "id": "Medication.ingredient.strength.denominator.value", "path": "Medication.ingredient.strength.denominator.value", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.unit", "path": "Medication.ingredient.strength.denominator.unit", "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.system", "path": "Medication.ingredient.strength.denominator.system", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.system.extension:dataAbsentReason", "path": "Medication.ingredient.strength.denominator.system.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.denominator.system.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.ingredient.strength.denominator.code", "path": "Medication.ingredient.strength.denominator.code", "min": 1, "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.code.extension:dataAbsentReason", "path": "Medication.ingredient.strength.denominator.code.extension", "sliceName": "dataAbsentReason", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x]", "path": "Medication.ingredient.strength.denominator.code.extension.value[x]", "patternCode": "unknown" }, { "id": "Medication.batch", "path": "Medication.batch", "short": "Batch Information" }, { "id": "Medication.batch.lotNumber", "path": "Medication.batch.lotNumber", "short": "Batch Number" } ] } }
Profile für die Datenverwaltung im Kontext der Medikationsplanung
Die Profile für die Datenverwaltung im Kontext der Medikationsplannung finden Verwendung bei dem Schreibenden und Lesenden Zugriff auf Inhalte im Rahmen der Medikationsplannung.
Profil: EPA Medication Planning
EPAMedicationPlanning (Medication) | I | EPAMedication | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..0 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..0 | CodingBinding |
tag | Σ | 0..0 | Coding |
implicitRules | Σ ?! | 0..0 | uri |
language | 0..0 | codeBinding | |
text | 0..0 | Narrative | |
contained | S | 0..0 | EPAMedicationPharmaceuticalProduct, EPAMedicationPZNIngredient |
extension | I | 0..1 | Extension |
rxPrescriptionProcessIdentifier | I | 0..0 | Extension(RxPrescriptionProcessIdentifier) |
epaDispensationIdentifier | I | 0..0 | Extension(EPADispensationIdentifier) |
isVaccine | I | 0..0 | Extension(boolean) |
drugCategory | I | 0..0 | Extension(Coding) |
normSizeCode | I | 0..0 | Extension(code) |
packaging | I | 0..0 | Extension(string) |
manufacturingInstructions | I | 0..0 | Extension(string) |
type | S I | 0..1 | Extension(Coding) |
modifierExtension | ?! I | 0..0 | Extension |
identifier | Σ | 0..0 | Identifier |
code | S Σ | 1..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..4 | Coding |
pzn | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
atc-de | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
ask | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
snomed | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | S Σ | 0..1 | string |
status | S Σ ?! | 0..1 | codeBinding |
manufacturer | S Σ I | 0..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..0 | string |
type | Σ | 0..0 | uriBinding |
identifier | Σ | 0..0 | Identifier |
display | S Σ | 1..1 | string |
form | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..3 | Coding |
edqm | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
snomed | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
kbvDarreichungsform | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..0 | string |
amount | S Σ I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
numerator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 1..1 | string |
system | S Σ I | 1..1 | uri |
code | S Σ | 1..1 | code |
denominator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 1..1 | string |
system | S Σ I | 1..1 | uri |
code | S Σ | 1..1 | code |
ingredient | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
item[x] | S | 1..1 | |
itemCodeableConcept | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..3 | Coding |
ask | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
atc-de | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
snomed | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
pzn | Σ | 0..0 | CodingPattern |
text | S Σ | 0..1 | string |
itemReference | S | 0..1 | Reference(Medication) |
isActive | 0..0 | boolean | |
strength | S I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
numerator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 1..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
denominator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 1..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
batch | 0..0 | BackboneElement |
Medication | |
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Medication.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Medication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Medication.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) 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. |
Cardinality | 0...0 |
Type | uri |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...0 |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...0 |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...0 |
Type | uri |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...0 |
Type | code |
Binding | A human language. |
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). |
Invariants |
|
Mappings |
|
Medication.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...0 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
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. |
Invariants |
|
Mappings |
|
Medication.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...0 |
Type | EPAMedicationPharmaceuticalProduct, EPAMedicationPZNIngredient |
Must Support | True |
Alias | inline resources, anonymous resources, contained 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. |
Mappings |
|
Medication.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. |
Cardinality | 0...1 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Closed, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:rxPrescriptionProcessIdentifier | |
Definition | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems. |
Cardinality | 0...0 |
Type | Extension(RxPrescriptionProcessIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:epaDispensationIdentifier | |
Definition | This extension is used to track the dispensation identifier for non-rx use-cases |
Cardinality | 0...0 |
Type | Extension(EPADispensationIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine | |
Definition | Indicator of whether this is a vaccine. |
Cardinality | 0...0 |
Type | Extension(boolean) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:isVaccine.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension |
Mappings |
|
Medication.extension:isVaccine.value[x] | |
Definition | Indicator of whether this is a vaccine.. false - no vaccine (default value) true - vaccine |
Cardinality | 1...1 |
Type | boolean |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory | |
Definition | Extension for indicating the medication category. |
Cardinality | 0...0 |
Type | Extension(Coding) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension |
Mappings |
|
Medication.extension:drugCategory.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPADrugCategoryVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].code | |
Definition | Drug Category |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode | |
Definition | Description of the therapy-appropriate package size (e.g., N1) |
Cardinality | 0...0 |
Type | Extension(code) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:normSizeCode.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://fhir.de/StructureDefinition/normgroesse |
Mappings |
|
Medication.extension:normSizeCode.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | code |
Binding | KBV_VS_SFHIR_KBV_NORMGROESSE (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:packaging | |
Definition | Information on the packaging of a formulation. |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:packaging.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:packaging.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:packaging.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension |
Mappings |
|
Medication.extension:packaging.value[x] | |
Definition | Information on transport containers or packaging for a formulation. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:manufacturingInstructions.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension |
Mappings |
|
Medication.extension:manufacturingInstructions.value[x] | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:type | |
Definition | Extension for EPAMedication types |
Cardinality | 0...1 |
Type | Extension(Coding) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.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). |
Cardinality | 0...0 |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.identifier | |
Definition | Business identifier for this medication. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.identifier:EPAMedicationUniqueIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...0 |
Type | EPAMedicationUniqueIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" } |
Mappings |
|
Medication.identifier:RxOriginatorProcessIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...0 |
Type | RxOriginatorProcessIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" } |
Mappings |
|
Medication.code | |
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A coded concept that defines the type of a medication. |
Must Support | True |
Summary | True |
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). |
Invariants |
|
Mappings |
|
Medication.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...4 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Closed, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.code.coding:pzn.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ifa/pzn |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.code.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.code.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | EPAMedicationSNOMEDCTVS (extensible) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.status | |
Definition | A code to indicate if the medication is in active use. |
Cardinality | 0...1 |
Type | code |
Binding | A coded concept defining if the medication is in active use. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. |
Invariants |
|
Mappings |
|
Medication.manufacturer | |
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Comments | Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer. |
Invariants |
|
Mappings |
|
Medication.manufacturer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.manufacturer.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.manufacturer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Medication.manufacturer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...0 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Medication.manufacturer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Medication.manufacturer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Medication.form | |
Definition | Describes the form of the item. Powder; tablets; capsule. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept defining the form of a medication. |
Must Support | True |
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. |
Invariants |
|
Mappings |
|
Medication.form.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...3 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Closed, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://standardterms.edqm.eu" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://standardterms.edqm.eu |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | EPAMedicineFormSNOMEDCTVS (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" } |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...0 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.amount | |
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Summary | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.amount.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator | |
Definition | The value of the numerator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.value[x] | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.value[x] | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 1...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.amount.denominator | |
Definition | The value of the denominator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 1...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient | |
Definition | Identifies a particular constituent of interest in the product. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. |
Invariants |
|
Mappings |
|
Medication.ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.extension:darreichungsform | |
Definition | Dosage form of an ingredient in a formulation. |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x] | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Slicing | Unordered, Closed, by $this(Type) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...3 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Closed, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | EPASubstanceSNOMEDCTVS (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...0 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemReference | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...1 |
Type | Reference(Medication) |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.isActive | |
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. |
Cardinality | 0...0 |
Type | boolean |
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength | |
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.extension:amountText.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension |
Mappings |
|
Medication.ingredient.strength.extension:amountText.value[x] | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator | |
Definition | The value of the numerator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 1...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator | |
Definition | The value of the denominator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 1...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.batch | |
Definition | Information that only applies to packages (not products). |
Cardinality | 0...0 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Medication.batch.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.batch.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.batch.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.batch.lotNumber | |
Definition | The assigned lot number of a batch of the specified product. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.batch.expirationDate | |
Definition | When this specific batch of product will expire. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-medication-planning" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-planning" /> <version value="1.1.1" /> <name value="EPAMedicationPlanning" /> <title value="EPA Medication Planning" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="mio42 GmbH" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Medication" /> <baseDefinition value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication" /> <derivation value="constraint" /> <differential> <element id="Medication.meta.source"> <path value="Medication.meta.source" /> <max value="0" /> </element> <element id="Medication.meta.security"> <path value="Medication.meta.security" /> <max value="0" /> </element> <element id="Medication.meta.tag"> <path value="Medication.meta.tag" /> <max value="0" /> </element> <element id="Medication.implicitRules"> <path value="Medication.implicitRules" /> <max value="0" /> </element> <element id="Medication.language"> <path value="Medication.language" /> <max value="0" /> </element> <element id="Medication.text"> <path value="Medication.text" /> <max value="0" /> </element> <element id="Medication.contained"> <path value="Medication.contained" /> <max value="0" /> </element> <element id="Medication.extension"> <path value="Medication.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="closed" /> </slicing> <max value="1" /> </element> <element id="Medication.extension:rxPrescriptionProcessIdentifier"> <path value="Medication.extension" /> <sliceName value="rxPrescriptionProcessIdentifier" /> <max value="0" /> </element> <element id="Medication.extension:epaDispensationIdentifier"> <path value="Medication.extension" /> <sliceName value="epaDispensationIdentifier" /> <max value="0" /> </element> <element id="Medication.extension:isVaccine"> <path value="Medication.extension" /> <sliceName value="isVaccine" /> <max value="0" /> </element> <element id="Medication.extension:drugCategory"> <path value="Medication.extension" /> <sliceName value="drugCategory" /> <max value="0" /> </element> <element id="Medication.extension:normSizeCode"> <path value="Medication.extension" /> <sliceName value="normSizeCode" /> <max value="0" /> </element> <element id="Medication.extension:packaging"> <path value="Medication.extension" /> <sliceName value="packaging" /> <max value="0" /> </element> <element id="Medication.extension:manufacturingInstructions"> <path value="Medication.extension" /> <sliceName value="manufacturingInstructions" /> <max value="0" /> </element> <element id="Medication.modifierExtension"> <path value="Medication.modifierExtension" /> <max value="0" /> </element> <element id="Medication.identifier"> <path value="Medication.identifier" /> <max value="0" /> </element> <element id="Medication.identifier:EPAMedicationUniqueIdentifier"> <path value="Medication.identifier" /> <sliceName value="EPAMedicationUniqueIdentifier" /> <max value="0" /> </element> <element id="Medication.identifier:RxOriginatorProcessIdentifier"> <path value="Medication.identifier" /> <sliceName value="RxOriginatorProcessIdentifier" /> <max value="0" /> </element> <element id="Medication.code"> <path value="Medication.code" /> <min value="1" /> </element> <element id="Medication.code.coding"> <path value="Medication.code.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="4" /> </element> <element id="Medication.code.coding:pzn"> <path value="Medication.code.coding" /> <sliceName value="pzn" /> </element> <element id="Medication.code.coding:pzn.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.code.coding:atc-de"> <path value="Medication.code.coding" /> <sliceName value="atc-de" /> <max value="1" /> </element> <element id="Medication.code.coding:atc-de.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.code.coding:ask"> <path value="Medication.code.coding" /> <sliceName value="ask" /> <max value="1" /> </element> <element id="Medication.code.coding:ask.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.code.coding:snomed"> <path value="Medication.code.coding" /> <sliceName value="snomed" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.manufacturer.reference"> <path value="Medication.manufacturer.reference" /> <max value="0" /> </element> <element id="Medication.manufacturer.type"> <path value="Medication.manufacturer.type" /> <max value="0" /> </element> <element id="Medication.manufacturer.identifier"> <path value="Medication.manufacturer.identifier" /> <max value="0" /> </element> <element id="Medication.form.coding"> <path value="Medication.form.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="3" /> </element> <element id="Medication.form.coding:edqm"> <path value="Medication.form.coding" /> <sliceName value="edqm" /> <max value="1" /> </element> <element id="Medication.form.coding:edqm.userSelected"> <path value="Medication.form.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.form.coding:snomed"> <path value="Medication.form.coding" /> <sliceName value="snomed" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.userSelected"> <path value="Medication.form.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.form.coding:kbvDarreichungsform"> <path value="Medication.form.coding" /> <sliceName value="kbvDarreichungsform" /> <max value="1" /> </element> <element id="Medication.form.coding:kbvDarreichungsform.userSelected"> <path value="Medication.form.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.form.text"> <path value="Medication.form.text" /> <max value="0" /> </element> <element id="Medication.amount.numerator"> <path value="Medication.amount.numerator" /> <min value="1" /> </element> <element id="Medication.amount.numerator.extension"> <path value="Medication.amount.numerator.extension" /> <max value="0" /> </element> <element id="Medication.amount.numerator.extension:packagingSize"> <path value="Medication.amount.numerator.extension" /> <sliceName value="packagingSize" /> <max value="0" /> </element> <element id="Medication.amount.numerator.extension:totalQuantity"> <path value="Medication.amount.numerator.extension" /> <sliceName value="totalQuantity" /> <max value="0" /> </element> <element id="Medication.amount.numerator.value"> <path value="Medication.amount.numerator.value" /> <min value="1" /> </element> <element id="Medication.amount.numerator.comparator"> <path value="Medication.amount.numerator.comparator" /> <max value="0" /> </element> <element id="Medication.amount.numerator.unit"> <path value="Medication.amount.numerator.unit" /> <min value="1" /> </element> <element id="Medication.amount.numerator.system"> <path value="Medication.amount.numerator.system" /> <min value="1" /> </element> <element id="Medication.amount.numerator.code"> <path value="Medication.amount.numerator.code" /> <min value="1" /> </element> <element id="Medication.amount.denominator"> <path value="Medication.amount.denominator" /> <min value="1" /> </element> <element id="Medication.amount.denominator.value"> <path value="Medication.amount.denominator.value" /> <min value="1" /> </element> <element id="Medication.amount.denominator.comparator"> <path value="Medication.amount.denominator.comparator" /> <max value="0" /> </element> <element id="Medication.amount.denominator.unit"> <path value="Medication.amount.denominator.unit" /> <min value="1" /> </element> <element id="Medication.amount.denominator.system"> <path value="Medication.amount.denominator.system" /> <min value="1" /> </element> <element id="Medication.amount.denominator.code"> <path value="Medication.amount.denominator.code" /> <min value="1" /> </element> <element id="Medication.ingredient.extension"> <path value="Medication.ingredient.extension" /> <max value="0" /> </element> <element id="Medication.ingredient.extension:darreichungsform"> <path value="Medication.ingredient.extension" /> <sliceName value="darreichungsform" /> <max value="0" /> </element> <element id="Medication.ingredient.item[x]"> <path value="Medication.ingredient.item[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="closed" /> </slicing> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemCodeableConcept" /> <type> <code value="CodeableConcept" /> </type> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding"> <path value="Medication.ingredient.item[x].coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="3" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="ask" /> <max value="1" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected"> <path value="Medication.ingredient.item[x].coding.userSelected" /> <max value="0" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="atc-de" /> <max value="1" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected"> <path value="Medication.ingredient.item[x].coding.userSelected" /> <max value="0" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="snomed" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.userSelected"> <path value="Medication.ingredient.item[x].coding.userSelected" /> <max value="0" /> </element> <element id="Medication.ingredient.isActive"> <path value="Medication.ingredient.isActive" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.extension"> <path value="Medication.ingredient.strength.extension" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.extension:amountText"> <path value="Medication.ingredient.strength.extension" /> <sliceName value="amountText" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.numerator.comparator"> <path value="Medication.ingredient.strength.numerator.comparator" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.numerator.unit"> <path value="Medication.ingredient.strength.numerator.unit" /> <min value="1" /> </element> <element id="Medication.ingredient.strength.denominator"> <path value="Medication.ingredient.strength.denominator" /> <min value="1" /> </element> <element id="Medication.ingredient.strength.denominator.comparator"> <path value="Medication.ingredient.strength.denominator.comparator" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.denominator.unit"> <path value="Medication.ingredient.strength.denominator.unit" /> <min value="1" /> </element> <element id="Medication.batch"> <path value="Medication.batch" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-medication-planning", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-planning", "version": "1.1.1", "name": "EPAMedicationPlanning", "title": "EPA Medication Planning", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "mio42 GmbH", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Medication", "baseDefinition": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication", "derivation": "constraint", "differential": { "element": [ { "id": "Medication.meta.source", "path": "Medication.meta.source", "max": "0" }, { "id": "Medication.meta.security", "path": "Medication.meta.security", "max": "0" }, { "id": "Medication.meta.tag", "path": "Medication.meta.tag", "max": "0" }, { "id": "Medication.implicitRules", "path": "Medication.implicitRules", "max": "0" }, { "id": "Medication.language", "path": "Medication.language", "max": "0" }, { "id": "Medication.text", "path": "Medication.text", "max": "0" }, { "id": "Medication.contained", "path": "Medication.contained", "max": "0" }, { "id": "Medication.extension", "path": "Medication.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "closed" }, "max": "1" }, { "id": "Medication.extension:rxPrescriptionProcessIdentifier", "path": "Medication.extension", "sliceName": "rxPrescriptionProcessIdentifier", "max": "0" }, { "id": "Medication.extension:epaDispensationIdentifier", "path": "Medication.extension", "sliceName": "epaDispensationIdentifier", "max": "0" }, { "id": "Medication.extension:isVaccine", "path": "Medication.extension", "sliceName": "isVaccine", "max": "0" }, { "id": "Medication.extension:drugCategory", "path": "Medication.extension", "sliceName": "drugCategory", "max": "0" }, { "id": "Medication.extension:normSizeCode", "path": "Medication.extension", "sliceName": "normSizeCode", "max": "0" }, { "id": "Medication.extension:packaging", "path": "Medication.extension", "sliceName": "packaging", "max": "0" }, { "id": "Medication.extension:manufacturingInstructions", "path": "Medication.extension", "sliceName": "manufacturingInstructions", "max": "0" }, { "id": "Medication.modifierExtension", "path": "Medication.modifierExtension", "max": "0" }, { "id": "Medication.identifier", "path": "Medication.identifier", "max": "0" }, { "id": "Medication.identifier:EPAMedicationUniqueIdentifier", "path": "Medication.identifier", "sliceName": "EPAMedicationUniqueIdentifier", "max": "0" }, { "id": "Medication.identifier:RxOriginatorProcessIdentifier", "path": "Medication.identifier", "sliceName": "RxOriginatorProcessIdentifier", "max": "0" }, { "id": "Medication.code", "path": "Medication.code", "min": 1 }, { "id": "Medication.code.coding", "path": "Medication.code.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "closed" }, "max": "4" }, { "id": "Medication.code.coding:pzn", "path": "Medication.code.coding", "sliceName": "pzn" }, { "id": "Medication.code.coding:pzn.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.code.coding:atc-de", "path": "Medication.code.coding", "sliceName": "atc-de", "max": "1" }, { "id": "Medication.code.coding:atc-de.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.code.coding:ask", "path": "Medication.code.coding", "sliceName": "ask", "max": "1" }, { "id": "Medication.code.coding:ask.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.code.coding:snomed", "path": "Medication.code.coding", "sliceName": "snomed", "max": "1", "mustSupport": true }, { "id": "Medication.code.coding:snomed.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.manufacturer.reference", "path": "Medication.manufacturer.reference", "max": "0" }, { "id": "Medication.manufacturer.type", "path": "Medication.manufacturer.type", "max": "0" }, { "id": "Medication.manufacturer.identifier", "path": "Medication.manufacturer.identifier", "max": "0" }, { "id": "Medication.form.coding", "path": "Medication.form.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "closed" }, "max": "3" }, { "id": "Medication.form.coding:edqm", "path": "Medication.form.coding", "sliceName": "edqm", "max": "1" }, { "id": "Medication.form.coding:edqm.userSelected", "path": "Medication.form.coding.userSelected", "max": "0" }, { "id": "Medication.form.coding:snomed", "path": "Medication.form.coding", "sliceName": "snomed", "max": "1", "mustSupport": true }, { "id": "Medication.form.coding:snomed.userSelected", "path": "Medication.form.coding.userSelected", "max": "0" }, { "id": "Medication.form.coding:kbvDarreichungsform", "path": "Medication.form.coding", "sliceName": "kbvDarreichungsform", "max": "1" }, { "id": "Medication.form.coding:kbvDarreichungsform.userSelected", "path": "Medication.form.coding.userSelected", "max": "0" }, { "id": "Medication.form.text", "path": "Medication.form.text", "max": "0" }, { "id": "Medication.amount.numerator", "path": "Medication.amount.numerator", "min": 1 }, { "id": "Medication.amount.numerator.extension", "path": "Medication.amount.numerator.extension", "max": "0" }, { "id": "Medication.amount.numerator.extension:packagingSize", "path": "Medication.amount.numerator.extension", "sliceName": "packagingSize", "max": "0" }, { "id": "Medication.amount.numerator.extension:totalQuantity", "path": "Medication.amount.numerator.extension", "sliceName": "totalQuantity", "max": "0" }, { "id": "Medication.amount.numerator.value", "path": "Medication.amount.numerator.value", "min": 1 }, { "id": "Medication.amount.numerator.comparator", "path": "Medication.amount.numerator.comparator", "max": "0" }, { "id": "Medication.amount.numerator.unit", "path": "Medication.amount.numerator.unit", "min": 1 }, { "id": "Medication.amount.numerator.system", "path": "Medication.amount.numerator.system", "min": 1 }, { "id": "Medication.amount.numerator.code", "path": "Medication.amount.numerator.code", "min": 1 }, { "id": "Medication.amount.denominator", "path": "Medication.amount.denominator", "min": 1 }, { "id": "Medication.amount.denominator.value", "path": "Medication.amount.denominator.value", "min": 1 }, { "id": "Medication.amount.denominator.comparator", "path": "Medication.amount.denominator.comparator", "max": "0" }, { "id": "Medication.amount.denominator.unit", "path": "Medication.amount.denominator.unit", "min": 1 }, { "id": "Medication.amount.denominator.system", "path": "Medication.amount.denominator.system", "min": 1 }, { "id": "Medication.amount.denominator.code", "path": "Medication.amount.denominator.code", "min": 1 }, { "id": "Medication.ingredient.extension", "path": "Medication.ingredient.extension", "max": "0" }, { "id": "Medication.ingredient.extension:darreichungsform", "path": "Medication.ingredient.extension", "sliceName": "darreichungsform", "max": "0" }, { "id": "Medication.ingredient.item[x]", "path": "Medication.ingredient.item[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "closed" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept", "path": "Medication.ingredient.item[x]", "sliceName": "itemCodeableConcept", "type": [ { "code": "CodeableConcept" } ] }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding", "path": "Medication.ingredient.item[x].coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "closed" }, "max": "3" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask", "path": "Medication.ingredient.item[x].coding", "sliceName": "ask", "max": "1" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected", "path": "Medication.ingredient.item[x].coding.userSelected", "max": "0" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de", "path": "Medication.ingredient.item[x].coding", "sliceName": "atc-de", "max": "1" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected", "path": "Medication.ingredient.item[x].coding.userSelected", "max": "0" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed", "path": "Medication.ingredient.item[x].coding", "sliceName": "snomed", "max": "1", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.userSelected", "path": "Medication.ingredient.item[x].coding.userSelected", "max": "0" }, { "id": "Medication.ingredient.isActive", "path": "Medication.ingredient.isActive", "max": "0" }, { "id": "Medication.ingredient.strength.extension", "path": "Medication.ingredient.strength.extension", "max": "0" }, { "id": "Medication.ingredient.strength.extension:amountText", "path": "Medication.ingredient.strength.extension", "sliceName": "amountText", "max": "0" }, { "id": "Medication.ingredient.strength.numerator.comparator", "path": "Medication.ingredient.strength.numerator.comparator", "max": "0" }, { "id": "Medication.ingredient.strength.numerator.unit", "path": "Medication.ingredient.strength.numerator.unit", "min": 1 }, { "id": "Medication.ingredient.strength.denominator", "path": "Medication.ingredient.strength.denominator", "min": 1 }, { "id": "Medication.ingredient.strength.denominator.comparator", "path": "Medication.ingredient.strength.denominator.comparator", "max": "0" }, { "id": "Medication.ingredient.strength.denominator.unit", "path": "Medication.ingredient.strength.denominator.unit", "min": 1 }, { "id": "Medication.batch", "path": "Medication.batch", "max": "0" } ] } }
Profil: EPA Medication Pharmaceutical Product Planning
EPAMedicationPharmaceuticalProductPlanning (Medication) | I | EPAMedicationPharmaceuticalProduct | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..0 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..0 | CodingBinding |
tag | Σ | 0..0 | Coding |
implicitRules | Σ ?! | 0..0 | uri |
language | 0..0 | codeBinding | |
text | 0..0 | Narrative | |
contained | 0..0 | Resource | |
extension | I | 0..1 | Extension |
rxPrescriptionProcessIdentifier | I | 0..0 | Extension(RxPrescriptionProcessIdentifier) |
epaDispensationIdentifier | I | 0..0 | Extension(EPADispensationIdentifier) |
isVaccine | I | 0..0 | Extension(boolean) |
drugCategory | I | 0..0 | Extension(Coding) |
normSizeCode | I | 0..0 | Extension(code) |
packaging | I | 0..0 | Extension(string) |
manufacturingInstructions | I | 0..0 | Extension(string) |
type | S I | 0..1 | Extension(Coding) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
modifierExtension | ?! I | 0..0 | Extension |
identifier | Σ | 0..0 | Identifier |
code | S Σ | 1..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..4 | Coding |
pzn | S Σ | 0..0 | CodingPattern |
atc-de | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
ask | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
snomed | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
product-key | S Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | S Σ | 0..1 | string |
status | S Σ ?! | 0..1 | codeBinding |
manufacturer | S Σ I | 0..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..0 | string |
type | Σ | 0..0 | uriBinding |
identifier | Σ | 0..0 | Identifier |
display | S Σ | 1..1 | string |
form | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..3 | Coding |
edqm | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
snomed | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
kbvDarreichungsform | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..0 | string |
amount | S Σ I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
numerator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 1..1 | string |
system | S Σ I | 1..1 | uri |
code | S Σ | 1..1 | code |
denominator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 1..1 | string |
system | S Σ I | 1..1 | uri |
code | S Σ | 1..1 | code |
ingredient | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
item[x] | S | 1..1 | |
itemCodeableConcept | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..3 | Coding |
ask | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
atc-de | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
snomed | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
pzn | Σ | 0..0 | CodingPattern |
text | S Σ | 0..1 | string |
itemReference | S | 0..0 | Reference(Medication) |
isActive | 0..0 | boolean | |
strength | S I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
numerator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 1..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
denominator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 1..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
batch | 0..0 | BackboneElement |
Medication | |
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Medication.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Medication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Medication.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) 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. |
Cardinality | 0...0 |
Type | uri |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...0 |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...0 |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...0 |
Type | uri |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...0 |
Type | code |
Binding | A human language. |
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). |
Invariants |
|
Mappings |
|
Medication.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...0 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
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. |
Invariants |
|
Mappings |
|
Medication.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...0 |
Type | Resource |
Alias | inline resources, anonymous resources, contained 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. |
Mappings |
|
Medication.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. |
Cardinality | 0...1 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Closed, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:rxPrescriptionProcessIdentifier | |
Definition | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems. |
Cardinality | 0...0 |
Type | Extension(RxPrescriptionProcessIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:epaDispensationIdentifier | |
Definition | This extension is used to track the dispensation identifier for non-rx use-cases |
Cardinality | 0...0 |
Type | Extension(EPADispensationIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine | |
Definition | Indicator of whether this is a vaccine. |
Cardinality | 0...0 |
Type | Extension(boolean) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:isVaccine.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension |
Mappings |
|
Medication.extension:isVaccine.value[x] | |
Definition | Indicator of whether this is a vaccine.. false - no vaccine (default value) true - vaccine |
Cardinality | 1...1 |
Type | boolean |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory | |
Definition | Extension for indicating the medication category. |
Cardinality | 0...0 |
Type | Extension(Coding) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension |
Mappings |
|
Medication.extension:drugCategory.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPADrugCategoryVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].code | |
Definition | Drug Category |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode | |
Definition | Description of the therapy-appropriate package size (e.g., N1) |
Cardinality | 0...0 |
Type | Extension(code) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:normSizeCode.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://fhir.de/StructureDefinition/normgroesse |
Mappings |
|
Medication.extension:normSizeCode.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | code |
Binding | KBV_VS_SFHIR_KBV_NORMGROESSE (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:packaging | |
Definition | Information on the packaging of a formulation. |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:packaging.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:packaging.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:packaging.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension |
Mappings |
|
Medication.extension:packaging.value[x] | |
Definition | Information on transport containers or packaging for a formulation. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:manufacturingInstructions.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension |
Mappings |
|
Medication.extension:manufacturingInstructions.value[x] | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:type | |
Definition | Extension for EPAMedication types |
Cardinality | 0...1 |
Type | Extension(Coding) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension: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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension: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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:type.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension |
Mappings |
|
Medication.extension:type.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAMedicationTypePharmaceuticalProductVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.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). |
Cardinality | 0...0 |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.identifier | |
Definition | Business identifier for this medication. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.identifier:EPAMedicationUniqueIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...0 |
Type | EPAMedicationUniqueIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" } |
Mappings |
|
Medication.identifier:RxOriginatorProcessIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...0 |
Type | RxOriginatorProcessIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" } |
Mappings |
|
Medication.code | |
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A coded concept that defines the type of a medication. |
Must Support | True |
Summary | True |
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). |
Invariants |
|
Mappings |
|
Medication.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...4 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Closed, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...0 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.code.coding:pzn.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ifa/pzn |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.code.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.code.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | EPAMedicationSNOMEDCTVS (extensible) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "https://terminologieserver.bfarm.de/fhir/CodeSystem/arzneimittel-referenzdaten-pharmazeutisches-produkt" } |
Mappings |
|
Medication.code.coding:product-key.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:product-key.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | https://terminologieserver.bfarm.de/fhir/CodeSystem/arzneimittel-referenzdaten-pharmazeutisches-produkt |
Mappings |
|
Medication.code.coding:product-key.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:product-key.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.status | |
Definition | A code to indicate if the medication is in active use. |
Cardinality | 0...1 |
Type | code |
Binding | A coded concept defining if the medication is in active use. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. |
Invariants |
|
Mappings |
|
Medication.manufacturer | |
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Comments | Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer. |
Invariants |
|
Mappings |
|
Medication.manufacturer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.manufacturer.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.manufacturer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Medication.manufacturer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...0 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Medication.manufacturer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Medication.manufacturer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Medication.form | |
Definition | Describes the form of the item. Powder; tablets; capsule. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept defining the form of a medication. |
Must Support | True |
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. |
Invariants |
|
Mappings |
|
Medication.form.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...3 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Closed, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://standardterms.edqm.eu" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://standardterms.edqm.eu |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | EPAMedicineFormSNOMEDCTVS (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" } |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...0 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.amount | |
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Summary | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.amount.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator | |
Definition | The value of the numerator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.value[x] | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.value[x] | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 1...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.amount.denominator | |
Definition | The value of the denominator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 1...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient | |
Definition | Identifies a particular constituent of interest in the product. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. |
Invariants |
|
Mappings |
|
Medication.ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.extension:darreichungsform | |
Definition | Dosage form of an ingredient in a formulation. |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x] | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Slicing | Unordered, Closed, by $this(Type) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...3 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Closed, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | EPASubstanceSNOMEDCTVS (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...0 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemReference | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...0 |
Type | Reference(Medication) |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.isActive | |
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. |
Cardinality | 0...0 |
Type | boolean |
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength | |
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.extension:amountText.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension |
Mappings |
|
Medication.ingredient.strength.extension:amountText.value[x] | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator | |
Definition | The value of the numerator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 1...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator | |
Definition | The value of the denominator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 1...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.batch | |
Definition | Information that only applies to packages (not products). |
Cardinality | 0...0 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Medication.batch.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.batch.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.batch.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.batch.lotNumber | |
Definition | The assigned lot number of a batch of the specified product. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.batch.expirationDate | |
Definition | When this specific batch of product will expire. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-medication-pharmaceutical-product-planning" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product-planning" /> <version value="1.1.1" /> <name value="EPAMedicationPharmaceuticalProductPlanning" /> <title value="EPA Medication Pharmaceutical Product Planning" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="mio42 GmbH" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Medication" /> <baseDefinition value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product" /> <derivation value="constraint" /> <differential> <element id="Medication.meta.source"> <path value="Medication.meta.source" /> <max value="0" /> </element> <element id="Medication.meta.security"> <path value="Medication.meta.security" /> <max value="0" /> </element> <element id="Medication.meta.tag"> <path value="Medication.meta.tag" /> <max value="0" /> </element> <element id="Medication.implicitRules"> <path value="Medication.implicitRules" /> <max value="0" /> </element> <element id="Medication.language"> <path value="Medication.language" /> <max value="0" /> </element> <element id="Medication.text"> <path value="Medication.text" /> <max value="0" /> </element> <element id="Medication.extension"> <path value="Medication.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="closed" /> </slicing> <max value="1" /> </element> <element id="Medication.extension:rxPrescriptionProcessIdentifier"> <path value="Medication.extension" /> <sliceName value="rxPrescriptionProcessIdentifier" /> <max value="0" /> </element> <element id="Medication.extension:epaDispensationIdentifier"> <path value="Medication.extension" /> <sliceName value="epaDispensationIdentifier" /> <max value="0" /> </element> <element id="Medication.extension:isVaccine"> <path value="Medication.extension" /> <sliceName value="isVaccine" /> <max value="0" /> </element> <element id="Medication.extension:drugCategory"> <path value="Medication.extension" /> <sliceName value="drugCategory" /> <max value="0" /> </element> <element id="Medication.extension:normSizeCode"> <path value="Medication.extension" /> <sliceName value="normSizeCode" /> <max value="0" /> </element> <element id="Medication.extension:packaging"> <path value="Medication.extension" /> <sliceName value="packaging" /> <max value="0" /> </element> <element id="Medication.extension:manufacturingInstructions"> <path value="Medication.extension" /> <sliceName value="manufacturingInstructions" /> <max value="0" /> </element> <element id="Medication.modifierExtension"> <path value="Medication.modifierExtension" /> <max value="0" /> </element> <element id="Medication.identifier"> <path value="Medication.identifier" /> <max value="0" /> </element> <element id="Medication.identifier:EPAMedicationUniqueIdentifier"> <path value="Medication.identifier" /> <sliceName value="EPAMedicationUniqueIdentifier" /> <max value="0" /> </element> <element id="Medication.identifier:RxOriginatorProcessIdentifier"> <path value="Medication.identifier" /> <sliceName value="RxOriginatorProcessIdentifier" /> <max value="0" /> </element> <element id="Medication.code"> <path value="Medication.code" /> <min value="1" /> </element> <element id="Medication.code.coding"> <path value="Medication.code.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="4" /> </element> <element id="Medication.code.coding:atc-de"> <path value="Medication.code.coding" /> <sliceName value="atc-de" /> <max value="1" /> </element> <element id="Medication.code.coding:atc-de.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.code.coding:ask"> <path value="Medication.code.coding" /> <sliceName value="ask" /> <max value="1" /> </element> <element id="Medication.code.coding:ask.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.code.coding:snomed"> <path value="Medication.code.coding" /> <sliceName value="snomed" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.code.coding:product-key"> <path value="Medication.code.coding" /> <sliceName value="product-key" /> </element> <element id="Medication.code.coding:product-key.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.manufacturer.reference"> <path value="Medication.manufacturer.reference" /> <max value="0" /> </element> <element id="Medication.manufacturer.type"> <path value="Medication.manufacturer.type" /> <max value="0" /> </element> <element id="Medication.manufacturer.identifier"> <path value="Medication.manufacturer.identifier" /> <max value="0" /> </element> <element id="Medication.form.coding"> <path value="Medication.form.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="3" /> </element> <element id="Medication.form.coding:edqm"> <path value="Medication.form.coding" /> <sliceName value="edqm" /> <max value="1" /> </element> <element id="Medication.form.coding:edqm.userSelected"> <path value="Medication.form.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.form.coding:snomed"> <path value="Medication.form.coding" /> <sliceName value="snomed" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.userSelected"> <path value="Medication.form.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.form.coding:kbvDarreichungsform"> <path value="Medication.form.coding" /> <sliceName value="kbvDarreichungsform" /> <max value="1" /> </element> <element id="Medication.form.coding:kbvDarreichungsform.userSelected"> <path value="Medication.form.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.form.text"> <path value="Medication.form.text" /> <max value="0" /> </element> <element id="Medication.amount.numerator"> <path value="Medication.amount.numerator" /> <min value="1" /> </element> <element id="Medication.amount.numerator.extension"> <path value="Medication.amount.numerator.extension" /> <max value="0" /> </element> <element id="Medication.amount.numerator.extension:packagingSize"> <path value="Medication.amount.numerator.extension" /> <sliceName value="packagingSize" /> <max value="0" /> </element> <element id="Medication.amount.numerator.extension:totalQuantity"> <path value="Medication.amount.numerator.extension" /> <sliceName value="totalQuantity" /> <max value="0" /> </element> <element id="Medication.amount.numerator.value"> <path value="Medication.amount.numerator.value" /> <min value="1" /> </element> <element id="Medication.amount.numerator.comparator"> <path value="Medication.amount.numerator.comparator" /> <max value="0" /> </element> <element id="Medication.amount.numerator.unit"> <path value="Medication.amount.numerator.unit" /> <min value="1" /> </element> <element id="Medication.amount.numerator.system"> <path value="Medication.amount.numerator.system" /> <min value="1" /> </element> <element id="Medication.amount.numerator.code"> <path value="Medication.amount.numerator.code" /> <min value="1" /> </element> <element id="Medication.amount.denominator"> <path value="Medication.amount.denominator" /> <min value="1" /> </element> <element id="Medication.amount.denominator.value"> <path value="Medication.amount.denominator.value" /> <min value="1" /> </element> <element id="Medication.amount.denominator.comparator"> <path value="Medication.amount.denominator.comparator" /> <max value="0" /> </element> <element id="Medication.amount.denominator.unit"> <path value="Medication.amount.denominator.unit" /> <min value="1" /> </element> <element id="Medication.amount.denominator.system"> <path value="Medication.amount.denominator.system" /> <min value="1" /> </element> <element id="Medication.amount.denominator.code"> <path value="Medication.amount.denominator.code" /> <min value="1" /> </element> <element id="Medication.ingredient.extension"> <path value="Medication.ingredient.extension" /> <max value="0" /> </element> <element id="Medication.ingredient.extension:darreichungsform"> <path value="Medication.ingredient.extension" /> <sliceName value="darreichungsform" /> <max value="0" /> </element> <element id="Medication.ingredient.item[x]"> <path value="Medication.ingredient.item[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="closed" /> </slicing> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemCodeableConcept" /> <type> <code value="CodeableConcept" /> </type> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding"> <path value="Medication.ingredient.item[x].coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="3" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="ask" /> <max value="1" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected"> <path value="Medication.ingredient.item[x].coding.userSelected" /> <max value="0" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="atc-de" /> <max value="1" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected"> <path value="Medication.ingredient.item[x].coding.userSelected" /> <max value="0" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="snomed" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.userSelected"> <path value="Medication.ingredient.item[x].coding.userSelected" /> <max value="0" /> </element> <element id="Medication.ingredient.isActive"> <path value="Medication.ingredient.isActive" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.extension"> <path value="Medication.ingredient.strength.extension" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.extension:amountText"> <path value="Medication.ingredient.strength.extension" /> <sliceName value="amountText" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.numerator.comparator"> <path value="Medication.ingredient.strength.numerator.comparator" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.numerator.unit"> <path value="Medication.ingredient.strength.numerator.unit" /> <min value="1" /> </element> <element id="Medication.ingredient.strength.denominator"> <path value="Medication.ingredient.strength.denominator" /> <min value="1" /> </element> <element id="Medication.ingredient.strength.denominator.comparator"> <path value="Medication.ingredient.strength.denominator.comparator" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.denominator.unit"> <path value="Medication.ingredient.strength.denominator.unit" /> <min value="1" /> </element> <element id="Medication.batch"> <path value="Medication.batch" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-medication-pharmaceutical-product-planning", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product-planning", "version": "1.1.1", "name": "EPAMedicationPharmaceuticalProductPlanning", "title": "EPA Medication Pharmaceutical Product Planning", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "mio42 GmbH", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Medication", "baseDefinition": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pharmaceutical-product", "derivation": "constraint", "differential": { "element": [ { "id": "Medication.meta.source", "path": "Medication.meta.source", "max": "0" }, { "id": "Medication.meta.security", "path": "Medication.meta.security", "max": "0" }, { "id": "Medication.meta.tag", "path": "Medication.meta.tag", "max": "0" }, { "id": "Medication.implicitRules", "path": "Medication.implicitRules", "max": "0" }, { "id": "Medication.language", "path": "Medication.language", "max": "0" }, { "id": "Medication.text", "path": "Medication.text", "max": "0" }, { "id": "Medication.extension", "path": "Medication.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "closed" }, "max": "1" }, { "id": "Medication.extension:rxPrescriptionProcessIdentifier", "path": "Medication.extension", "sliceName": "rxPrescriptionProcessIdentifier", "max": "0" }, { "id": "Medication.extension:epaDispensationIdentifier", "path": "Medication.extension", "sliceName": "epaDispensationIdentifier", "max": "0" }, { "id": "Medication.extension:isVaccine", "path": "Medication.extension", "sliceName": "isVaccine", "max": "0" }, { "id": "Medication.extension:drugCategory", "path": "Medication.extension", "sliceName": "drugCategory", "max": "0" }, { "id": "Medication.extension:normSizeCode", "path": "Medication.extension", "sliceName": "normSizeCode", "max": "0" }, { "id": "Medication.extension:packaging", "path": "Medication.extension", "sliceName": "packaging", "max": "0" }, { "id": "Medication.extension:manufacturingInstructions", "path": "Medication.extension", "sliceName": "manufacturingInstructions", "max": "0" }, { "id": "Medication.modifierExtension", "path": "Medication.modifierExtension", "max": "0" }, { "id": "Medication.identifier", "path": "Medication.identifier", "max": "0" }, { "id": "Medication.identifier:EPAMedicationUniqueIdentifier", "path": "Medication.identifier", "sliceName": "EPAMedicationUniqueIdentifier", "max": "0" }, { "id": "Medication.identifier:RxOriginatorProcessIdentifier", "path": "Medication.identifier", "sliceName": "RxOriginatorProcessIdentifier", "max": "0" }, { "id": "Medication.code", "path": "Medication.code", "min": 1 }, { "id": "Medication.code.coding", "path": "Medication.code.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "closed" }, "max": "4" }, { "id": "Medication.code.coding:atc-de", "path": "Medication.code.coding", "sliceName": "atc-de", "max": "1" }, { "id": "Medication.code.coding:atc-de.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.code.coding:ask", "path": "Medication.code.coding", "sliceName": "ask", "max": "1" }, { "id": "Medication.code.coding:ask.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.code.coding:snomed", "path": "Medication.code.coding", "sliceName": "snomed", "max": "1", "mustSupport": true }, { "id": "Medication.code.coding:snomed.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.code.coding:product-key", "path": "Medication.code.coding", "sliceName": "product-key" }, { "id": "Medication.code.coding:product-key.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.manufacturer.reference", "path": "Medication.manufacturer.reference", "max": "0" }, { "id": "Medication.manufacturer.type", "path": "Medication.manufacturer.type", "max": "0" }, { "id": "Medication.manufacturer.identifier", "path": "Medication.manufacturer.identifier", "max": "0" }, { "id": "Medication.form.coding", "path": "Medication.form.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "closed" }, "max": "3" }, { "id": "Medication.form.coding:edqm", "path": "Medication.form.coding", "sliceName": "edqm", "max": "1" }, { "id": "Medication.form.coding:edqm.userSelected", "path": "Medication.form.coding.userSelected", "max": "0" }, { "id": "Medication.form.coding:snomed", "path": "Medication.form.coding", "sliceName": "snomed", "max": "1", "mustSupport": true }, { "id": "Medication.form.coding:snomed.userSelected", "path": "Medication.form.coding.userSelected", "max": "0" }, { "id": "Medication.form.coding:kbvDarreichungsform", "path": "Medication.form.coding", "sliceName": "kbvDarreichungsform", "max": "1" }, { "id": "Medication.form.coding:kbvDarreichungsform.userSelected", "path": "Medication.form.coding.userSelected", "max": "0" }, { "id": "Medication.form.text", "path": "Medication.form.text", "max": "0" }, { "id": "Medication.amount.numerator", "path": "Medication.amount.numerator", "min": 1 }, { "id": "Medication.amount.numerator.extension", "path": "Medication.amount.numerator.extension", "max": "0" }, { "id": "Medication.amount.numerator.extension:packagingSize", "path": "Medication.amount.numerator.extension", "sliceName": "packagingSize", "max": "0" }, { "id": "Medication.amount.numerator.extension:totalQuantity", "path": "Medication.amount.numerator.extension", "sliceName": "totalQuantity", "max": "0" }, { "id": "Medication.amount.numerator.value", "path": "Medication.amount.numerator.value", "min": 1 }, { "id": "Medication.amount.numerator.comparator", "path": "Medication.amount.numerator.comparator", "max": "0" }, { "id": "Medication.amount.numerator.unit", "path": "Medication.amount.numerator.unit", "min": 1 }, { "id": "Medication.amount.numerator.system", "path": "Medication.amount.numerator.system", "min": 1 }, { "id": "Medication.amount.numerator.code", "path": "Medication.amount.numerator.code", "min": 1 }, { "id": "Medication.amount.denominator", "path": "Medication.amount.denominator", "min": 1 }, { "id": "Medication.amount.denominator.value", "path": "Medication.amount.denominator.value", "min": 1 }, { "id": "Medication.amount.denominator.comparator", "path": "Medication.amount.denominator.comparator", "max": "0" }, { "id": "Medication.amount.denominator.unit", "path": "Medication.amount.denominator.unit", "min": 1 }, { "id": "Medication.amount.denominator.system", "path": "Medication.amount.denominator.system", "min": 1 }, { "id": "Medication.amount.denominator.code", "path": "Medication.amount.denominator.code", "min": 1 }, { "id": "Medication.ingredient.extension", "path": "Medication.ingredient.extension", "max": "0" }, { "id": "Medication.ingredient.extension:darreichungsform", "path": "Medication.ingredient.extension", "sliceName": "darreichungsform", "max": "0" }, { "id": "Medication.ingredient.item[x]", "path": "Medication.ingredient.item[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "closed" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept", "path": "Medication.ingredient.item[x]", "sliceName": "itemCodeableConcept", "type": [ { "code": "CodeableConcept" } ] }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding", "path": "Medication.ingredient.item[x].coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "closed" }, "max": "3" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask", "path": "Medication.ingredient.item[x].coding", "sliceName": "ask", "max": "1" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected", "path": "Medication.ingredient.item[x].coding.userSelected", "max": "0" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de", "path": "Medication.ingredient.item[x].coding", "sliceName": "atc-de", "max": "1" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected", "path": "Medication.ingredient.item[x].coding.userSelected", "max": "0" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed", "path": "Medication.ingredient.item[x].coding", "sliceName": "snomed", "max": "1", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.userSelected", "path": "Medication.ingredient.item[x].coding.userSelected", "max": "0" }, { "id": "Medication.ingredient.isActive", "path": "Medication.ingredient.isActive", "max": "0" }, { "id": "Medication.ingredient.strength.extension", "path": "Medication.ingredient.strength.extension", "max": "0" }, { "id": "Medication.ingredient.strength.extension:amountText", "path": "Medication.ingredient.strength.extension", "sliceName": "amountText", "max": "0" }, { "id": "Medication.ingredient.strength.numerator.comparator", "path": "Medication.ingredient.strength.numerator.comparator", "max": "0" }, { "id": "Medication.ingredient.strength.numerator.unit", "path": "Medication.ingredient.strength.numerator.unit", "min": 1 }, { "id": "Medication.ingredient.strength.denominator", "path": "Medication.ingredient.strength.denominator", "min": 1 }, { "id": "Medication.ingredient.strength.denominator.comparator", "path": "Medication.ingredient.strength.denominator.comparator", "max": "0" }, { "id": "Medication.ingredient.strength.denominator.unit", "path": "Medication.ingredient.strength.denominator.unit", "min": 1 }, { "id": "Medication.batch", "path": "Medication.batch", "max": "0" } ] } }
Profil: EPA Medication Ingredient Planning
EPAMedicationPZNIngredientPlanning (Medication) | I | EPAMedicationPZNIngredient | |
id | Σ | 0..1 | string |
meta | S Σ | 0..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | S Σ | 0..1 | id |
lastUpdated | S Σ | 0..1 | instant |
source | Σ | 0..0 | uri |
profile | Σ | 0..* | canonical(StructureDefinition) |
security | Σ | 0..0 | CodingBinding |
tag | Σ | 0..* | Coding |
implicitRules | Σ ?! | 0..0 | uri |
language | 0..0 | codeBinding | |
text | 0..0 | Narrative | |
contained | 0..0 | Resource | |
extension | I | 0..1 | Extension |
rxPrescriptionProcessIdentifier | I | 0..0 | Extension(RxPrescriptionProcessIdentifier) |
epaDispensationIdentifier | I | 0..0 | Extension(EPADispensationIdentifier) |
isVaccine | I | 0..0 | Extension(boolean) |
drugCategory | I | 0..0 | Extension(Coding) |
normSizeCode | I | 0..0 | Extension(code) |
packaging | I | 0..0 | Extension(string) |
manufacturingInstructions | I | 0..0 | Extension(string) |
type | S I | 0..1 | Extension(Coding) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | S | 1..1 | Binding |
valueCoding | Coding | ||
modifierExtension | ?! I | 0..0 | Extension |
identifier | Σ | 0..0 | Identifier |
code | S Σ | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 1..4 | Coding |
pzn | S Σ | 1..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
atc-de | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
ask | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
snomed | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | S Σ | 0..1 | string |
status | S Σ ?! | 0..1 | codeBinding |
manufacturer | S Σ I | 0..1 | Reference(Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..0 | string |
type | Σ | 0..0 | uriBinding |
identifier | Σ | 0..0 | Identifier |
display | S Σ | 1..1 | string |
form | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..3 | Coding |
edqm | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
snomed | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
kbvDarreichungsform | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..0 | string |
amount | S Σ I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..* | Extension |
numerator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 0..1 | code |
denominator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 0..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 0..1 | uri |
code | S Σ | 0..1 | code |
ingredient | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
item[x] | S | 1..1 | |
itemCodeableConcept | S | 0..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..3 | Coding |
ask | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
atc-de | S Σ | 0..1 | CodingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
snomed | S Σ | 0..1 | CodingBindingPattern |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uriPattern |
version | S Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
pzn | Σ | 0..0 | CodingPattern |
text | S Σ | 0..1 | string |
itemReference | S | 0..0 | Reference(Medication) |
isActive | 0..0 | boolean | |
strength | S I | 0..1 | Ratio |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
numerator | S Σ I | 1..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
denominator | S Σ I | 0..1 | QuantityBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
value | S Σ | 1..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | S Σ | 0..1 | string |
system | S Σ I | 1..1 | uri |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
code | S Σ | 1..1 | code |
id | 0..1 | string | |
extension | I | 0..* | Extension |
dataAbsentReason | S I | 0..1 | Extension(code) |
id | 0..1 | string | |
extension | I | 0..0 | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | BindingPattern | |
valueCode | code | ||
value | 0..1 | System.String | |
batch | 0..0 | BackboneElement |
Medication | |
Definition | This resource is primarily used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication as well as for making statements about medication use. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Medication.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Medication.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Medication.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...1 |
Type | id |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) 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. |
Cardinality | 0...0 |
Type | uri |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 0...* |
Type | canonical(StructureDefinition) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...0 |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.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. |
Cardinality | 0...* |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...0 |
Type | uri |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...0 |
Type | code |
Binding | A human language. |
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). |
Invariants |
|
Mappings |
|
Medication.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...0 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
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. |
Invariants |
|
Mappings |
|
Medication.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...0 |
Type | Resource |
Alias | inline resources, anonymous resources, contained 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. |
Mappings |
|
Medication.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. |
Cardinality | 0...1 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Closed, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:rxPrescriptionProcessIdentifier | |
Definition | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems. |
Cardinality | 0...0 |
Type | Extension(RxPrescriptionProcessIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:epaDispensationIdentifier | |
Definition | This extension is used to track the dispensation identifier for non-rx use-cases |
Cardinality | 0...0 |
Type | Extension(EPADispensationIdentifier) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine | |
Definition | Indicator of whether this is a vaccine. |
Cardinality | 0...0 |
Type | Extension(boolean) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:isVaccine.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:isVaccine.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension |
Mappings |
|
Medication.extension:isVaccine.value[x] | |
Definition | Indicator of whether this is a vaccine.. false - no vaccine (default value) true - vaccine |
Cardinality | 1...1 |
Type | boolean |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory | |
Definition | Extension for indicating the medication category. |
Cardinality | 0...0 |
Type | Extension(Coding) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension |
Mappings |
|
Medication.extension:drugCategory.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPADrugCategoryVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:drugCategory.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].code | |
Definition | Drug Category |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.extension:drugCategory.value[x].userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode | |
Definition | Description of the therapy-appropriate package size (e.g., N1) |
Cardinality | 0...0 |
Type | Extension(code) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:normSizeCode.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:normSizeCode.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://fhir.de/StructureDefinition/normgroesse |
Mappings |
|
Medication.extension:normSizeCode.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | code |
Binding | KBV_VS_SFHIR_KBV_NORMGROESSE (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:packaging | |
Definition | Information on the packaging of a formulation. |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:packaging.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:packaging.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:packaging.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension |
Mappings |
|
Medication.extension:packaging.value[x] | |
Definition | Information on transport containers or packaging for a formulation. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension:manufacturingInstructions.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:manufacturingInstructions.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension |
Mappings |
|
Medication.extension:manufacturingInstructions.value[x] | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.extension:type | |
Definition | Extension for EPAMedication types |
Cardinality | 0...1 |
Type | Extension(Coding) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.extension: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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.extension: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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.extension:type.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension |
Mappings |
|
Medication.extension:type.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAMedicationTypeProductVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.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). |
Cardinality | 0...0 |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
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. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.identifier | |
Definition | Business identifier for this medication. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.identifier:EPAMedicationUniqueIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...0 |
Type | EPAMedicationUniqueIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" } |
Mappings |
|
Medication.identifier:RxOriginatorProcessIdentifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...0 |
Type | RxOriginatorProcessIdentifier |
Summary | True |
Comments | The serial number could be included as an identifier. |
Invariants |
|
Pattern | { "system": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" } |
Mappings |
|
Medication.code | |
Definition | A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept that defines the type of a medication. |
Must Support | True |
Summary | True |
Comments | Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one). |
Invariants |
|
Mappings |
|
Medication.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...4 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Closed, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.code.coding:pzn.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ifa/pzn |
Mappings |
|
Medication.code.coding:pzn.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:pzn.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.code.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.code.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.code.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.code.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | EPAMedicationSNOMEDCTVS (extensible) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.code.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.code.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.status | |
Definition | A code to indicate if the medication is in active use. |
Cardinality | 0...1 |
Type | code |
Binding | A coded concept defining if the medication is in active use. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This status is intended to identify if the medication in a local system is in active use within a drug database or inventory. For example, a pharmacy system may create a new drug file record for a compounded product "ABC Hospital Special Cream" with an active status. At some point in the future, it may be determined that the drug record was created with an error and the status is changed to "entered in error". This status is not intended to specify if a medication is part of a particular formulary. It is possible that the drug record may be referenced by multiple formularies or catalogues and each of those entries would have a separate status. |
Invariants |
|
Mappings |
|
Medication.manufacturer | |
Definition | Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Comments | Here, the actual manufacturer of the medication can be named, primarily in the case of active ingredient mixtures (compounding prescriptions), such as the hospital pharmacy. It is important to note that the licensing organization, as mentioned in the PZN (Pharmaceutical Central Number) data, is not considered the manufacturer. |
Invariants |
|
Mappings |
|
Medication.manufacturer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.manufacturer.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.manufacturer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Medication.manufacturer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...0 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Medication.manufacturer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Medication.manufacturer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Medication.form | |
Definition | Describes the form of the item. Powder; tablets; capsule. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept defining the form of a medication. |
Must Support | True |
Comments | When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form. |
Invariants |
|
Mappings |
|
Medication.form.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...3 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Closed, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | http://hl7.org/fhir/uv/ips/ValueSet/medicine-doseform (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://standardterms.edqm.eu" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://standardterms.edqm.eu |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:edqm.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | EPAMedicineFormSNOMEDCTVS (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.form.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | KBV_VS_SFHIR_KBV_DARREICHUNGSFORM (required) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM" } |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | https://fhir.kbv.de/CodeSystem/KBV_CS_SFHIR_KBV_DARREICHUNGSFORM |
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.form.coding:kbvDarreichungsform.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.form.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...0 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.amount | |
Definition | Specific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.). |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Summary | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.amount.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator | |
Definition | The value of the numerator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:packagingSize.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension |
Mappings |
|
Medication.amount.numerator.extension:packagingSize.value[x] | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension |
Mappings |
|
Medication.amount.numerator.extension:totalQuantity.value[x] | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.amount.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.amount.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.amount.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.amount.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.amount.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.amount.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.amount.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient | |
Definition | Identifies a particular constituent of interest in the product. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Comments | The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients. |
Invariants |
|
Mappings |
|
Medication.ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.extension:darreichungsform | |
Definition | Dosage form of an ingredient in a formulation. |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x] | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 1...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Slicing | Unordered, Closed, by $this(Type) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...1 |
Type | CodeableConcept |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...3 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Slicing | Unordered, Closed, by $this(Pattern) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ask" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/ask |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/bfarm/atc" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://fhir.de/CodeSystem/bfarm/atc |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Binding | EPASubstanceSNOMEDCTVS (preferred) |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://snomed.info/sct" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Pattern | http://snomed.info/sct |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.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). |
Cardinality | 0...0 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.coding:pzn | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...0 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
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. |
Invariants |
|
Pattern | { "system": "http://fhir.de/CodeSystem/ifa/pzn" } |
Mappings |
|
Medication.ingredient.item[x]:itemCodeableConcept.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Medication.ingredient.item[x]:itemReference | |
Definition | The actual ingredient - either a substance (simple ingredient) or another medication of a medication. |
Cardinality | 0...0 |
Type | Reference(Medication) |
Must Support | True |
Requirements | The ingredient may reference a substance (for example, amoxicillin) or another medication (for example in the case of a compounded product, Glaxal Base). |
Invariants |
|
Mappings |
|
Medication.ingredient.isActive | |
Definition | Indication of whether this ingredient affects the therapeutic action of the drug. |
Cardinality | 0...0 |
Type | boolean |
Requirements | True indicates that the ingredient affects the therapeutic action of the drug (i.e. active). False indicates that the ingredient does not affect the therapeutic action of the drug (i.e. inactive). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength | |
Definition | Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet. |
Cardinality | 0...1 |
Type | Ratio |
Must Support | True |
Comments | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 0...0 |
Type | Extension(string) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.extension:amountText.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.extension:amountText.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-amount-extension |
Mappings |
|
Medication.ingredient.strength.extension:amountText.value[x] | |
Definition | Free-text amount of the ingredient for classical Latin notations such as "ad 100.0" or "quantum satis," including the unit. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator | |
Definition | The value of the numerator. |
Cardinality | 1...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.numerator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.numerator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.numerator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator | |
Definition | The value of the denominator. |
Cardinality | 0...1 |
Type | Quantity |
Binding | UCUMCodes (preferred) |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 1...1 |
Type | decimal |
Must Support | True |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
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). |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.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. |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
Modifier | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.system.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.system.value | |
Definition | Primitive value for uri |
Cardinality | 0...1 |
Type | System.String |
Medication.ingredient.strength.denominator.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 1...1 |
Type | code |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason | |
Definition | Provides a reason why the expected value or elements in the element that is extended are missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Must Support | True |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://hl7.org/fhir/StructureDefinition/data-absent-reason |
Mappings |
|
Medication.ingredient.strength.denominator.code.extension:dataAbsentReason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Binding | Used to specify why the normally expected content of the data element is missing. |
Invariants |
|
Pattern | unknown |
Mappings |
|
Medication.ingredient.strength.denominator.code.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Medication.batch | |
Definition | Information that only applies to packages (not products). |
Cardinality | 0...0 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Medication.batch.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Medication.batch.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Medication.batch.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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
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. |
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. |
Invariants |
|
Mappings |
|
Medication.batch.lotNumber | |
Definition | The assigned lot number of a batch of the specified product. |
Cardinality | 0...1 |
Type | string |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Medication.batch.expirationDate | |
Definition | When this specific batch of product will expire. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-medication-pzn-ingredient-planning" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient-planning" /> <version value="1.1.1" /> <name value="EPAMedicationPZNIngredientPlanning" /> <title value="EPA Medication Ingredient Planning" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="mio42 GmbH" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Medication" /> <baseDefinition value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient" /> <derivation value="constraint" /> <differential> <element id="Medication.meta.source"> <path value="Medication.meta.source" /> <max value="0" /> </element> <element id="Medication.meta.security"> <path value="Medication.meta.security" /> <max value="0" /> </element> <element id="Medication.implicitRules"> <path value="Medication.implicitRules" /> <max value="0" /> </element> <element id="Medication.language"> <path value="Medication.language" /> <max value="0" /> </element> <element id="Medication.text"> <path value="Medication.text" /> <max value="0" /> </element> <element id="Medication.extension"> <path value="Medication.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="closed" /> </slicing> <max value="1" /> </element> <element id="Medication.extension:rxPrescriptionProcessIdentifier"> <path value="Medication.extension" /> <sliceName value="rxPrescriptionProcessIdentifier" /> <max value="0" /> </element> <element id="Medication.extension:epaDispensationIdentifier"> <path value="Medication.extension" /> <sliceName value="epaDispensationIdentifier" /> <max value="0" /> </element> <element id="Medication.extension:isVaccine"> <path value="Medication.extension" /> <sliceName value="isVaccine" /> <max value="0" /> </element> <element id="Medication.extension:drugCategory"> <path value="Medication.extension" /> <sliceName value="drugCategory" /> <max value="0" /> </element> <element id="Medication.extension:normSizeCode"> <path value="Medication.extension" /> <sliceName value="normSizeCode" /> <max value="0" /> </element> <element id="Medication.extension:packaging"> <path value="Medication.extension" /> <sliceName value="packaging" /> <max value="0" /> </element> <element id="Medication.extension:manufacturingInstructions"> <path value="Medication.extension" /> <sliceName value="manufacturingInstructions" /> <max value="0" /> </element> <element id="Medication.modifierExtension"> <path value="Medication.modifierExtension" /> <max value="0" /> </element> <element id="Medication.identifier"> <path value="Medication.identifier" /> <max value="0" /> </element> <element id="Medication.identifier:EPAMedicationUniqueIdentifier"> <path value="Medication.identifier" /> <sliceName value="EPAMedicationUniqueIdentifier" /> <max value="0" /> </element> <element id="Medication.identifier:RxOriginatorProcessIdentifier"> <path value="Medication.identifier" /> <sliceName value="RxOriginatorProcessIdentifier" /> <max value="0" /> </element> <element id="Medication.code.coding"> <path value="Medication.code.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="4" /> </element> <element id="Medication.code.coding:pzn"> <path value="Medication.code.coding" /> <sliceName value="pzn" /> </element> <element id="Medication.code.coding:pzn.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.code.coding:atc-de"> <path value="Medication.code.coding" /> <sliceName value="atc-de" /> <max value="1" /> </element> <element id="Medication.code.coding:atc-de.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.code.coding:ask"> <path value="Medication.code.coding" /> <sliceName value="ask" /> <max value="1" /> </element> <element id="Medication.code.coding:ask.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.code.coding:snomed"> <path value="Medication.code.coding" /> <sliceName value="snomed" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Medication.code.coding:snomed.userSelected"> <path value="Medication.code.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.manufacturer.reference"> <path value="Medication.manufacturer.reference" /> <max value="0" /> </element> <element id="Medication.manufacturer.type"> <path value="Medication.manufacturer.type" /> <max value="0" /> </element> <element id="Medication.manufacturer.identifier"> <path value="Medication.manufacturer.identifier" /> <max value="0" /> </element> <element id="Medication.form.coding"> <path value="Medication.form.coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="3" /> </element> <element id="Medication.form.coding:edqm"> <path value="Medication.form.coding" /> <sliceName value="edqm" /> <max value="1" /> </element> <element id="Medication.form.coding:edqm.userSelected"> <path value="Medication.form.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.form.coding:snomed"> <path value="Medication.form.coding" /> <sliceName value="snomed" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Medication.form.coding:snomed.userSelected"> <path value="Medication.form.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.form.coding:kbvDarreichungsform"> <path value="Medication.form.coding" /> <sliceName value="kbvDarreichungsform" /> <max value="1" /> </element> <element id="Medication.form.coding:kbvDarreichungsform.userSelected"> <path value="Medication.form.coding.userSelected" /> <max value="0" /> </element> <element id="Medication.form.text"> <path value="Medication.form.text" /> <max value="0" /> </element> <element id="Medication.amount.numerator.extension"> <path value="Medication.amount.numerator.extension" /> <max value="0" /> </element> <element id="Medication.amount.numerator.extension:packagingSize"> <path value="Medication.amount.numerator.extension" /> <sliceName value="packagingSize" /> <max value="0" /> </element> <element id="Medication.amount.numerator.extension:totalQuantity"> <path value="Medication.amount.numerator.extension" /> <sliceName value="totalQuantity" /> <max value="0" /> </element> <element id="Medication.amount.numerator.comparator"> <path value="Medication.amount.numerator.comparator" /> <max value="0" /> </element> <element id="Medication.amount.denominator.comparator"> <path value="Medication.amount.denominator.comparator" /> <max value="0" /> </element> <element id="Medication.ingredient.extension"> <path value="Medication.ingredient.extension" /> <max value="0" /> </element> <element id="Medication.ingredient.extension:darreichungsform"> <path value="Medication.ingredient.extension" /> <sliceName value="darreichungsform" /> <max value="0" /> </element> <element id="Medication.ingredient.item[x]"> <path value="Medication.ingredient.item[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="closed" /> </slicing> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept"> <path value="Medication.ingredient.item[x]" /> <sliceName value="itemCodeableConcept" /> <type> <code value="CodeableConcept" /> </type> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding"> <path value="Medication.ingredient.item[x].coding" /> <slicing> <discriminator> <type value="pattern" /> <path value="$this" /> </discriminator> <rules value="closed" /> </slicing> <max value="3" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="ask" /> <max value="1" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected"> <path value="Medication.ingredient.item[x].coding.userSelected" /> <max value="0" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="atc-de" /> <max value="1" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected"> <path value="Medication.ingredient.item[x].coding.userSelected" /> <max value="0" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed"> <path value="Medication.ingredient.item[x].coding" /> <sliceName value="snomed" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.userSelected"> <path value="Medication.ingredient.item[x].coding.userSelected" /> <max value="0" /> </element> <element id="Medication.ingredient.isActive"> <path value="Medication.ingredient.isActive" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.extension"> <path value="Medication.ingredient.strength.extension" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.extension:amountText"> <path value="Medication.ingredient.strength.extension" /> <sliceName value="amountText" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.numerator.comparator"> <path value="Medication.ingredient.strength.numerator.comparator" /> <max value="0" /> </element> <element id="Medication.ingredient.strength.denominator.comparator"> <path value="Medication.ingredient.strength.denominator.comparator" /> <max value="0" /> </element> <element id="Medication.batch"> <path value="Medication.batch" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-medication-pzn-ingredient-planning", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient-planning", "version": "1.1.1", "name": "EPAMedicationPZNIngredientPlanning", "title": "EPA Medication Ingredient Planning", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "mio42 GmbH", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Medication", "baseDefinition": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-pzn-ingredient", "derivation": "constraint", "differential": { "element": [ { "id": "Medication.meta.source", "path": "Medication.meta.source", "max": "0" }, { "id": "Medication.meta.security", "path": "Medication.meta.security", "max": "0" }, { "id": "Medication.implicitRules", "path": "Medication.implicitRules", "max": "0" }, { "id": "Medication.language", "path": "Medication.language", "max": "0" }, { "id": "Medication.text", "path": "Medication.text", "max": "0" }, { "id": "Medication.extension", "path": "Medication.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "closed" }, "max": "1" }, { "id": "Medication.extension:rxPrescriptionProcessIdentifier", "path": "Medication.extension", "sliceName": "rxPrescriptionProcessIdentifier", "max": "0" }, { "id": "Medication.extension:epaDispensationIdentifier", "path": "Medication.extension", "sliceName": "epaDispensationIdentifier", "max": "0" }, { "id": "Medication.extension:isVaccine", "path": "Medication.extension", "sliceName": "isVaccine", "max": "0" }, { "id": "Medication.extension:drugCategory", "path": "Medication.extension", "sliceName": "drugCategory", "max": "0" }, { "id": "Medication.extension:normSizeCode", "path": "Medication.extension", "sliceName": "normSizeCode", "max": "0" }, { "id": "Medication.extension:packaging", "path": "Medication.extension", "sliceName": "packaging", "max": "0" }, { "id": "Medication.extension:manufacturingInstructions", "path": "Medication.extension", "sliceName": "manufacturingInstructions", "max": "0" }, { "id": "Medication.modifierExtension", "path": "Medication.modifierExtension", "max": "0" }, { "id": "Medication.identifier", "path": "Medication.identifier", "max": "0" }, { "id": "Medication.identifier:EPAMedicationUniqueIdentifier", "path": "Medication.identifier", "sliceName": "EPAMedicationUniqueIdentifier", "max": "0" }, { "id": "Medication.identifier:RxOriginatorProcessIdentifier", "path": "Medication.identifier", "sliceName": "RxOriginatorProcessIdentifier", "max": "0" }, { "id": "Medication.code.coding", "path": "Medication.code.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "closed" }, "max": "4" }, { "id": "Medication.code.coding:pzn", "path": "Medication.code.coding", "sliceName": "pzn" }, { "id": "Medication.code.coding:pzn.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.code.coding:atc-de", "path": "Medication.code.coding", "sliceName": "atc-de", "max": "1" }, { "id": "Medication.code.coding:atc-de.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.code.coding:ask", "path": "Medication.code.coding", "sliceName": "ask", "max": "1" }, { "id": "Medication.code.coding:ask.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.code.coding:snomed", "path": "Medication.code.coding", "sliceName": "snomed", "max": "1", "mustSupport": true }, { "id": "Medication.code.coding:snomed.userSelected", "path": "Medication.code.coding.userSelected", "max": "0" }, { "id": "Medication.manufacturer.reference", "path": "Medication.manufacturer.reference", "max": "0" }, { "id": "Medication.manufacturer.type", "path": "Medication.manufacturer.type", "max": "0" }, { "id": "Medication.manufacturer.identifier", "path": "Medication.manufacturer.identifier", "max": "0" }, { "id": "Medication.form.coding", "path": "Medication.form.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "closed" }, "max": "3" }, { "id": "Medication.form.coding:edqm", "path": "Medication.form.coding", "sliceName": "edqm", "max": "1" }, { "id": "Medication.form.coding:edqm.userSelected", "path": "Medication.form.coding.userSelected", "max": "0" }, { "id": "Medication.form.coding:snomed", "path": "Medication.form.coding", "sliceName": "snomed", "max": "1", "mustSupport": true }, { "id": "Medication.form.coding:snomed.userSelected", "path": "Medication.form.coding.userSelected", "max": "0" }, { "id": "Medication.form.coding:kbvDarreichungsform", "path": "Medication.form.coding", "sliceName": "kbvDarreichungsform", "max": "1" }, { "id": "Medication.form.coding:kbvDarreichungsform.userSelected", "path": "Medication.form.coding.userSelected", "max": "0" }, { "id": "Medication.form.text", "path": "Medication.form.text", "max": "0" }, { "id": "Medication.amount.numerator.extension", "path": "Medication.amount.numerator.extension", "max": "0" }, { "id": "Medication.amount.numerator.extension:packagingSize", "path": "Medication.amount.numerator.extension", "sliceName": "packagingSize", "max": "0" }, { "id": "Medication.amount.numerator.extension:totalQuantity", "path": "Medication.amount.numerator.extension", "sliceName": "totalQuantity", "max": "0" }, { "id": "Medication.amount.numerator.comparator", "path": "Medication.amount.numerator.comparator", "max": "0" }, { "id": "Medication.amount.denominator.comparator", "path": "Medication.amount.denominator.comparator", "max": "0" }, { "id": "Medication.ingredient.extension", "path": "Medication.ingredient.extension", "max": "0" }, { "id": "Medication.ingredient.extension:darreichungsform", "path": "Medication.ingredient.extension", "sliceName": "darreichungsform", "max": "0" }, { "id": "Medication.ingredient.item[x]", "path": "Medication.ingredient.item[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "closed" } }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept", "path": "Medication.ingredient.item[x]", "sliceName": "itemCodeableConcept", "type": [ { "code": "CodeableConcept" } ] }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding", "path": "Medication.ingredient.item[x].coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "closed" }, "max": "3" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask", "path": "Medication.ingredient.item[x].coding", "sliceName": "ask", "max": "1" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:ask.userSelected", "path": "Medication.ingredient.item[x].coding.userSelected", "max": "0" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de", "path": "Medication.ingredient.item[x].coding", "sliceName": "atc-de", "max": "1" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:atc-de.userSelected", "path": "Medication.ingredient.item[x].coding.userSelected", "max": "0" }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed", "path": "Medication.ingredient.item[x].coding", "sliceName": "snomed", "max": "1", "mustSupport": true }, { "id": "Medication.ingredient.item[x]:itemCodeableConcept.coding:snomed.userSelected", "path": "Medication.ingredient.item[x].coding.userSelected", "max": "0" }, { "id": "Medication.ingredient.isActive", "path": "Medication.ingredient.isActive", "max": "0" }, { "id": "Medication.ingredient.strength.extension", "path": "Medication.ingredient.strength.extension", "max": "0" }, { "id": "Medication.ingredient.strength.extension:amountText", "path": "Medication.ingredient.strength.extension", "sliceName": "amountText", "max": "0" }, { "id": "Medication.ingredient.strength.numerator.comparator", "path": "Medication.ingredient.strength.numerator.comparator", "max": "0" }, { "id": "Medication.ingredient.strength.denominator.comparator", "path": "Medication.ingredient.strength.denominator.comparator", "max": "0" }, { "id": "Medication.batch", "path": "Medication.batch", "max": "0" } ] } }
Identifier
Profil: EPA Medication Unique Identifier
EPAMedicationUniqueIdentifier (Identifier) | Identifier | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uriPattern |
value | S Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
Identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Identifier.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
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. |
Invariants |
|
Mappings |
|
Identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
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. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Pattern | https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier |
Mappings |
|
Identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-medication-unique-identifier" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-unique-identifier" /> <version value="1.1.1" /> <name value="EPAMedicationUniqueIdentifier" /> <title value="EPA Medication Unique Identifier" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="This unique identifier is generated within the Medication Service. It is either a hash derived from a specific set of data elements of the Medication resource or a direct repetition of a single data element. This identifier ensures the distinct identification of Medication resources across the ePA system." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <type value="Identifier" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Identifier" /> <derivation value="constraint" /> <differential> <element id="Identifier.system"> <path value="Identifier.system" /> <min value="1" /> <patternUri value="https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier" /> <mustSupport value="true" /> </element> <element id="Identifier.value"> <path value="Identifier.value" /> <min value="1" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-medication-unique-identifier", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-unique-identifier", "version": "1.1.1", "name": "EPAMedicationUniqueIdentifier", "title": "EPA Medication Unique Identifier", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "This unique identifier is generated within the Medication Service. It is either a hash derived from a specific set of data elements of the Medication resource or a direct repetition of a single data element. This identifier ensures the distinct identification of Medication resources across the ePA system.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "type": "Identifier", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Identifier", "derivation": "constraint", "differential": { "element": [ { "id": "Identifier.system", "path": "Identifier.system", "min": 1, "patternUri": "https://gematik.de/fhir/epa-medication/sid/epa-medication-unique-identifier", "mustSupport": true }, { "id": "Identifier.value", "path": "Identifier.value", "min": 1, "mustSupport": true } ] } }
Profil: RxOriginatorProcessIdentifier
RxOriginatorProcessIdentifier (Identifier) | Identifier | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | S Σ | 1..1 | uriPattern |
value | S Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(Organization) |
Identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Identifier.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
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. |
Invariants |
|
Mappings |
|
Identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
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. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Pattern | https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier |
Mappings |
|
Identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
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. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="rx-originator-process-identifier" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-originator-process-identifier" /> <version value="1.1.1" /> <name value="RxOriginatorProcessIdentifier" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="The RxOriginatorProcessIdentifier, generated within the Medication Service, links the prescriptionID from the E-Rezept-Fachdienst with the original input FHIR resource ID, facilitating accurate tracking and utilization of medication data in operational processes within digital healthcare systems." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <type value="Identifier" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Identifier" /> <derivation value="constraint" /> <differential> <element id="Identifier.system"> <path value="Identifier.system" /> <min value="1" /> <patternUri value="https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier" /> <mustSupport value="true" /> </element> <element id="Identifier.value"> <path value="Identifier.value" /> <min value="1" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "rx-originator-process-identifier", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-originator-process-identifier", "version": "1.1.1", "name": "RxOriginatorProcessIdentifier", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "The RxOriginatorProcessIdentifier, generated within the Medication Service, links the prescriptionID from the E-Rezept-Fachdienst with the original input FHIR resource ID, facilitating accurate tracking and utilization of medication data in operational processes within digital healthcare systems.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "type": "Identifier", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Identifier", "derivation": "constraint", "differential": { "element": [ { "id": "Identifier.system", "path": "Identifier.system", "min": 1, "patternUri": "https://gematik.de/fhir/epa-medication/sid/rx-originator-process-identifier", "mustSupport": true }, { "id": "Identifier.value", "path": "Identifier.value", "min": 1, "mustSupport": true } ] } }
Extensions
Profil: RxPrescriptionProcessIdentifierExtension
Extension | |
Definition | This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension |
Mappings |
|
Extension.value[x] | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | RxPrescriptionProcessIdentifier |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="rx-prescription-process-identifier-extension" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension" /> <version value="1.1.1" /> <name value="RxPrescriptionProcessIdentifierExtension" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Element" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <definition value="This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <type> <code value="Identifier" /> <profile value="https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier" /> </type> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "rx-prescription-process-identifier-extension", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension", "version": "1.1.1", "name": "RxPrescriptionProcessIdentifierExtension", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Element" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "definition": "This extension is used to track medication prescription transactions between the E-Rezept-Fachdienst and the ePA. The RxPrescriptionProcessIdentifier is generated by the ePA Medication Service and consists of the PrescriptionId and the authoredOn date of the operation parameters request. It ensures consistent referencing and management of medication-related resources across different systems." }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier-extension" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "type": [ { "code": "Identifier", "profile": [ "https://gematik.de/fhir/epa-medication/StructureDefinition/rx-prescription-process-identifier" ] } ] } ] } }
Profil: MedicationIsVaccineExtension
Extension | |
Definition | Indicator of whether this is a vaccine. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension |
Mappings |
|
Extension.value[x] | |
Definition | Indicator of whether this is a vaccine.. false - no vaccine (default value) true - vaccine |
Cardinality | 1...1 |
Type | boolean |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="medication-id-vaccine-extension" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension" /> <version value="1.1.1" /> <name value="MedicationIsVaccineExtension" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Indicator of whether this is a vaccine." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Element" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <definition value="Indicator of whether this is a vaccine." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Vaccine Indicator" /> <definition value="Indicator of whether this is a vaccine..\n\n\nfalse - no vaccine (default value)\n\ntrue - vaccine" /> <min value="1" /> <type> <code value="boolean" /> </type> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "medication-id-vaccine-extension", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension", "version": "1.1.1", "name": "MedicationIsVaccineExtension", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Indicator of whether this is a vaccine.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Element" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "definition": "Indicator of whether this is a vaccine." }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-id-vaccine-extension" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Vaccine Indicator", "definition": "Indicator of whether this is a vaccine..\n\n\nfalse - no vaccine (default value)\n\ntrue - vaccine", "min": 1, "type": [ { "code": "boolean" } ] } ] } }
Profil: DrugCategoryExtension
Extension | |
Definition | Extension for indicating the medication category. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension |
Mappings |
|
Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPADrugCategoryVS (required) |
Invariants |
|
Mappings |
|
Extension.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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.value[x].system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
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. |
Invariants |
|
Mappings |
|
Extension.value[x].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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Extension.value[x].code | |
Definition | Drug Category |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Extension.value[x].display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Extension.value[x].userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
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. |
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. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="drug-category-extension" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension" /> <version value="1.1.1" /> <name value="DrugCategoryExtension" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Extension for indicating the medication category." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Element" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <definition value="Extension for indicating the medication category." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <min value="1" /> <type> <code value="Coding" /> </type> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-drug-category-vs" /> </binding> </element> <element id="Extension.value[x].code"> <path value="Extension.value[x].code" /> <short value="Category" /> <definition value="Drug Category" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "drug-category-extension", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension", "version": "1.1.1", "name": "DrugCategoryExtension", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Extension for indicating the medication category.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Element" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "definition": "Extension for indicating the medication category." }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://gematik.de/fhir/epa-medication/StructureDefinition/drug-category-extension" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "Coding" } ], "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-drug-category-vs" } }, { "id": "Extension.value[x].code", "path": "Extension.value[x].code", "short": "Category", "definition": "Drug Category" } ] } }
Profil: package/StructureDefinition-normgroesse.json
Extension | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | http://fhir.de/StructureDefinition/normgroesse |
Mappings |
|
Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | code |
Binding | KBV_VS_SFHIR_KBV_NORMGROESSE (required) |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="normgroesse" /> <url value="http://fhir.de/StructureDefinition/normgroesse" /> <version value="1.5.0" /> <name value="ExtensionNormgroesseDeBasis" /> <status value="active" /> <experimental value="false" /> <date value="2023-11-30" /> <publisher value="HL7 Deutschland e.V. (Technisches Komitee FHIR)" /> <contact> <telecom> <system value="url" /> <value value="http://hl7.de/technische-komitees/fhir/" /> </telecom> </contact> <description value="Die Packungsgrößenkennzeichnung für Medikamente ist eine in Deutschland bestehende Normierung der in der Apotheke abzugebenden Menge (Stückzahl bei Tabletten, Kapseln, Zäpfchen und anderen einzeldosierten Formen, Milliliter oder Gramm bei halbfesten und flüssigen Mitteln) eines Fertigarzneimittels im Rahmen der vertragsärztlichen Versorgung.\nRechtsgrundlage der Normierung war bis 2010 die Packungsgrößenverordnung (PackungsV). Sie ordnete folgende drei Packungsgrößen zu – das N steht für Normgröße:\n\nN1 – kleine Packung\nN2 – mittlere Packung\nN3 – große Packung\n(siehe https://de.wikipedia.org/wiki/Packungsgr%C3%B6%C3%9Fenkennzeichnung)" /> <copyright value="HL7 Deutschland e.V." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Medication" /> </context> <context> <type value="element" /> <expression value="MedicationRequest.dispenseRequest.quantity" /> </context> <context> <type value="element" /> <expression value="MedicationDispense.quantity" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="http://fhir.de/StructureDefinition/normgroesse" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <type> <code value="code" /> </type> <binding> <strength value="required" /> <valueSet value="https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE" /> </binding> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "normgroesse", "url": "http://fhir.de/StructureDefinition/normgroesse", "version": "1.5.0", "name": "ExtensionNormgroesseDeBasis", "status": "active", "experimental": false, "date": "2023-11-30", "publisher": "HL7 Deutschland e.V. (Technisches Komitee FHIR)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.de/technische-komitees/fhir/" } ] } ], "description": "Die Packungsgrößenkennzeichnung für Medikamente ist eine in Deutschland bestehende Normierung der in der Apotheke abzugebenden Menge (Stückzahl bei Tabletten, Kapseln, Zäpfchen und anderen einzeldosierten Formen, Milliliter oder Gramm bei halbfesten und flüssigen Mitteln) eines Fertigarzneimittels im Rahmen der vertragsärztlichen Versorgung.\nRechtsgrundlage der Normierung war bis 2010 die Packungsgrößenverordnung (PackungsV). Sie ordnete folgende drei Packungsgrößen zu – das N steht für Normgröße:\n\nN1 – kleine Packung\nN2 – mittlere Packung\nN3 – große Packung\n(siehe https://de.wikipedia.org/wiki/Packungsgr%C3%B6%C3%9Fenkennzeichnung)", "copyright": "HL7 Deutschland e.V.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Medication" }, { "type": "element", "expression": "MedicationRequest.dispenseRequest.quantity" }, { "type": "element", "expression": "MedicationDispense.quantity" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "http://fhir.de/StructureDefinition/normgroesse" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "type": [ { "code": "code" } ], "binding": { "strength": "required", "valueSet": "https://fhir.kbv.de/ValueSet/KBV_VS_SFHIR_KBV_NORMGROESSE" } } ] } }
Profil: MedicationFormulationPackagingExtension
Extension | |
Definition | Information on the packaging of a formulation. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension |
Mappings |
|
Extension.value[x] | |
Definition | Information on transport containers or packaging for a formulation. |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="medication-formulation-packaging-extension" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension" /> <version value="1.1.1" /> <name value="MedicationFormulationPackagingExtension" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Information on the packaging of a formulation." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Element" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <definition value="Information on the packaging of a formulation." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Packaging of a formulation." /> <definition value="Information on transport containers or packaging for a formulation." /> <min value="1" /> <type> <code value="string" /> </type> <maxLength value="90" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "medication-formulation-packaging-extension", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension", "version": "1.1.1", "name": "MedicationFormulationPackagingExtension", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Information on the packaging of a formulation.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Element" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "definition": "Information on the packaging of a formulation." }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-formulation-packaging-extension" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Packaging of a formulation.", "definition": "Information on transport containers or packaging for a formulation.", "min": 1, "type": [ { "code": "string" } ], "maxLength": 90 } ] } }
Profil: MedicationManufacturingInstructionsExtension
Extension | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension |
Mappings |
|
Extension.value[x] | |
Definition | Manufacturing instructions regarding the preparation of a formulation (Subscriptio). |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="medication-manufacturing-instructions-extension" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension" /> <version value="1.1.1" /> <name value="MedicationManufacturingInstructionsExtension" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Manufacturing instructions regarding the preparation of a formulation (Subscriptio)." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Element" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <definition value="Manufacturing instructions regarding the preparation of a formulation (Subscriptio)." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Manufacturing instructions for a formulation." /> <definition value="Manufacturing instructions regarding the preparation of a formulation (Subscriptio)." /> <min value="1" /> <type> <code value="string" /> </type> <maxLength value="500" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "medication-manufacturing-instructions-extension", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension", "version": "1.1.1", "name": "MedicationManufacturingInstructionsExtension", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Manufacturing instructions regarding the preparation of a formulation (Subscriptio).", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Element" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "definition": "Manufacturing instructions regarding the preparation of a formulation (Subscriptio)." }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-manufacturing-instructions-extension" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Manufacturing instructions for a formulation.", "definition": "Manufacturing instructions regarding the preparation of a formulation (Subscriptio).", "min": 1, "type": [ { "code": "string" } ], "maxLength": 500 } ] } }
Profil: Medication Type
Extension | |
Definition | Extension for EPAMedication types |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension |
Mappings |
|
Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | EPAMedicationTypeVS (required) |
Must Support | True |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-medication-type-extension" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension" /> <version value="1.1.1" /> <name value="EPAMedicationTypeExtension" /> <title value="Medication Type" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Extension for EPAMedication types" /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Medication" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="Medication Type" /> <definition value="Extension for EPAMedication types" /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <min value="1" /> <type> <code value="Coding" /> </type> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-medication-type-vs" /> </binding> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-medication-type-extension", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension", "version": "1.1.1", "name": "EPAMedicationTypeExtension", "title": "Medication Type", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Extension for EPAMedication types", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "expression": "Medication", "type": "element" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "Medication Type", "definition": "Extension for EPAMedication types" }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://gematik.de/fhir/epa-medication/StructureDefinition/epa-medication-type-extension" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "min": 1, "type": [ { "code": "Coding" } ], "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-medication-type-vs" } } ] } }
Profil: MedicationPackagingSizeExtension
Extension | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension |
Mappings |
|
Extension.value[x] | |
Definition | Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück). |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="medication-packaging-size-extension" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension" /> <version value="1.1.1" /> <name value="MedicationPackagingSizeExtension" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück)." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Element" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <definition value="Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück)." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Package size according to divided quantity" /> <definition value="Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with "unit" (e.g., 100 Stück)." /> <min value="1" /> <type> <code value="string" /> </type> <maxLength value="7" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "medication-packaging-size-extension", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension", "version": "1.1.1", "name": "MedicationPackagingSizeExtension", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with \"unit\" (e.g., 100 Stück).", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Element" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "definition": "Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with \"unit\" (e.g., 100 Stück)." }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-packaging-size-extension" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Package size according to divided quantity", "definition": "Specification of the package size according to divided quantity (e.g., 100, 2x25), only appears in conjunction with \"unit\" (e.g., 100 Stück).", "min": 1, "type": [ { "code": "string" } ], "maxLength": 7 } ] } }
Profil: MedicationTotalQuantityFormulationExtension
Extension | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension |
Mappings |
|
Extension.value[x] | |
Definition | Total quantity of the formulation (without the unit). |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="medication-total-quantity-formulation-extension" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension" /> <version value="1.1.1" /> <name value="MedicationTotalQuantityFormulationExtension" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Total quantity of the formulation (without the unit)." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Element" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <definition value="Total quantity of the formulation (without the unit)." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Total quantity of the formulation." /> <definition value="Total quantity of the formulation (without the unit)." /> <min value="1" /> <type> <code value="string" /> </type> <maxLength value="7" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "medication-total-quantity-formulation-extension", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension", "version": "1.1.1", "name": "MedicationTotalQuantityFormulationExtension", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Total quantity of the formulation (without the unit).", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Element" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "definition": "Total quantity of the formulation (without the unit)." }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-total-quantity-formulation-extension" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Total quantity of the formulation.", "definition": "Total quantity of the formulation (without the unit).", "min": 1, "type": [ { "code": "string" } ], "maxLength": 7 } ] } }
Profil: MedicationIngredientDarreichungsformExtension
Extension | |
Definition | Dosage form of an ingredient in a formulation. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.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. |
Cardinality | 0...0 |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
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. |
Fixed Value | https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension |
Mappings |
|
Extension.value[x] | |
Definition | The dosage form as free text can be used if the ingredient in the formulation is not a finished medicinal product. |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="medication-ingredient-darreichungsform-extension" /> <url value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension" /> <version value="1.1.1" /> <name value="MedicationIngredientDarreichungsformExtension" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Dosage form of an ingredient in a formulation." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Element" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <definition value="Dosage form of an ingredient in a formulation." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <max value="0" /> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <short value="Dosage form of an ingredient in a formulation." /> <definition value="The dosage form as free text can be used if the ingredient in the formulation is not a finished medicinal product." /> <min value="1" /> <type> <code value="string" /> </type> <maxLength value="30" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "medication-ingredient-darreichungsform-extension", "url": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension", "version": "1.1.1", "name": "MedicationIngredientDarreichungsformExtension", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Dosage form of an ingredient in a formulation.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Element" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "definition": "Dosage form of an ingredient in a formulation." }, { "id": "Extension.extension", "path": "Extension.extension", "max": "0" }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://gematik.de/fhir/epa-medication/StructureDefinition/medication-ingredient-darreichungsform-extension" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "short": "Dosage form of an ingredient in a formulation.", "definition": "The dosage form as free text can be used if the ingredient in the formulation is not a finished medicinal product.", "min": 1, "type": [ { "code": "string" } ], "maxLength": 30 } ] } }
Überblick über die Abbildung des KBV Medication-Profils nach ePA
Ein tabellarischer Überblick über die Unterschiede in den Profilen der KBV zum E-Rezept gegenüber dem ePA Medication-Profil kann hier eingesehen werden.
Informationsmodell als LogicalModel
Die Profile basieren auf folgenden Informationsmodellen:
Arzneimittel (arzneimittel) | http://hl7.org/fhir/StructureDefinition/Base | ||
typ | 0..1 | CodingBinding | |
arzneimittelRezepturCodeBezeichnung | 1..1 | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
pzn | 0..1 | Coding | |
atcCodeDeutsch | 0..1 | Coding | |
askCode | 0..1 | Coding | |
snomedCtCode | 0..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
status | 0..1 | CodingBinding | |
freitextDerDenHerstellerIdentifiziert | 0..1 | string | |
darreichungsformCodeBezeichnung | 0..1 | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
snomedCtCode | 0..1 | CodingBinding | |
edqm | 0..1 | CodingBinding | |
kbvDarreichungsform | 0..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
packungsgroesseGesamtmenge | 0..1 | BackboneElement | |
anzahlMenge | 1..1 | BackboneElement | |
wert | 1..1 | SimpleQuantity | |
einheit | 1..1 | Coding | |
anzahlMengeDerBezugsgroesse | 1..1 | BackboneElement | |
wert | 1..1 | SimpleQuantity | |
einheit | 1..1 | Coding | |
bestandteile | 0..* | BackboneElement | |
bestandteilAuswahl | 1..1 | BackboneElement | |
codeBezeichnung | 0..1 | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
askCode | 0..1 | Coding | |
atcCodeDeutsch | 0..1 | Coding | |
snomedCtCode | 0..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
arzneimittelReferenz | 0..1 | BackboneElement | |
arzneimittelKombipackung | 0..1 | Reference() | |
arzneimittelBestandteil | 0..1 | Reference() | |
mengeStaerke | 0..1 | BackboneElement | |
anzahlMengeDesEnthaltenenBestandteils | 1..1 | BackboneElement | |
wert | 1..1 | SimpleQuantity | |
einheit | 1..1 | Coding | |
anzahlMengeDerBezugsgroesse | 1..1 | BackboneElement | |
wert | 1..1 | Count | |
einheit | 1..1 | Coding |
ArzneimittelBestandteil (arzneimittelBestandteil) | http://hl7.org/fhir/StructureDefinition/Base | ||
typ | 0..1 | CodingBinding | |
arzneimittelRezepturCodeBezeichnung | 1..1 | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
pzn | 0..1 | Coding | |
atcCodeDeutsch | 0..1 | Coding | |
askCode | 0..1 | Coding | |
snomedCtCode | 0..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
status | 0..1 | CodingBinding | |
freitextDerDenHerstellerIdentifiziert | 0..1 | string | |
darreichungsformCodeBezeichnung | 0..1 | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
snomedCtCode | 0..1 | CodingBinding | |
edqm | 0..1 | CodingBinding | |
kbvDarreichungsform | 0..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
packungsgroesseGesamtmenge | 0..1 | BackboneElement | |
anzahlMenge | 1..1 | BackboneElement | |
wert | 1..1 | SimpleQuantity | |
einheit | 1..1 | Coding | |
anzahlMengeDerBezugsgroesse | 1..1 | BackboneElement | |
wert | 1..1 | SimpleQuantity | |
einheit | 1..1 | Coding | |
bestandteile | 0..* | BackboneElement | |
bestandteilAuswahl | 1..1 | BackboneElement | |
codeBezeichnung | 0..1 | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
askCode | 0..1 | Coding | |
atcCodeDeutsch | 0..1 | Coding | |
snomedCtCode | 0..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
mengeStaerke | 0..1 | BackboneElement | |
anzahlMengeDesEnthaltenenBestandteils | 1..1 | BackboneElement | |
wert | 1..1 | SimpleQuantity | |
einheit | 1..1 | Coding | |
anzahlMengeDerBezugsgroesse | 1..1 | BackboneElement | |
wert | 1..1 | Count | |
einheit | 1..1 | Coding |
ArzneimittelKombipackung (arzneimittelKombipackung) | http://hl7.org/fhir/StructureDefinition/Base | ||
typ | 0..1 | CodingBinding | |
arzneimittelRezepturCodeBezeichnung | 1..1 | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
atcCodeDeutsch | 0..1 | Coding | |
askCode | 0..1 | Coding | |
snomedCtCode | 0..1 | CodingBinding | |
produktId | 1..1 | Coding | |
bezeichnung | 0..1 | string | |
status | 0..1 | CodingBinding | |
freitextDerDenHerstellerIdentifiziert | 0..1 | string | |
darreichungsformCodeBezeichnung | 0..1 | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
snomedCtCode | 0..1 | CodingBinding | |
edqm | 0..1 | CodingBinding | |
kbvDarreichungsform | 0..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
packungsgroesseGesamtmenge | 0..1 | BackboneElement | |
anzahlMenge | 1..1 | BackboneElement | |
wert | 1..1 | SimpleQuantity | |
einheit | 1..1 | Coding | |
anzahlMengeDerBezugsgroesse | 1..1 | BackboneElement | |
wert | 1..1 | SimpleQuantity | |
einheit | 1..1 | Coding | |
bestandteile | 0..* | BackboneElement | |
bestandteilAuswahl | 1..1 | BackboneElement | |
codeBezeichnung | 0..1 | BackboneElement | |
codeAuswahl | 0..* | BackboneElement | |
askCode | 0..1 | Coding | |
atcCodeDeutsch | 0..1 | Coding | |
snomedCtCode | 0..1 | CodingBinding | |
bezeichnung | 0..1 | string | |
mengeStaerke | 0..1 | BackboneElement | |
anzahlMengeDesEnthaltenenBestandteils | 1..1 | BackboneElement | |
wert | 1..1 | SimpleQuantity | |
einheit | 1..1 | Coding | |
anzahlMengeDerBezugsgroesse | 1..1 | BackboneElement | |
wert | 1..1 | Count | |
einheit | 1..1 | Coding |