# Paratyphus/Typhus, nicht differenziert-Immunisierungsinformationen (ImmunizationInformationSXXD)

https://demis.rki.de/fhir/StructureDefinition/ImmunizationInformationSXXD

Das ImmunizationInformationSXXD-Profil ist eine weitergehende Spezialisierung des ImmunizationInformation-Profils.

Das Profil nimmt zusätzliche Paratyphus/Typhus, nicht differenziert-spezifische Einschränkungen an der zugrundeliegenden Immunization-Ressource vor. Dazu gehört insbesondere die normative Bindung des SNOMED-Slice in vaccineCode an ein Paratyphus/Typhus, nicht differenziert-spezifisches ValueSet für entsprechende Impfstoffe.

Die kodierte Angabe eines Wertes für vaccineCode (Impfstoff) ist entsprechend der Vorgaben der StructureDefinition verpflichtend. Dies wurde bei der Ausgestaltung der referenzierten ValueSets berücksichtigt, so dass auch Fälle abbildbar sind, in denen der konkret verabreichte Impfstoff nicht in der Vorselektion des RKI enthalten ist (-> Other (qualifier value)), nicht erhoben wurde, welcher Impfstoff zum Einsatz kam (-> NASK Null-Flavor) oder aber der verwendete Impfstoff nicht ermittelbar ist (-> ASKU Null-Flavor).

Hinweis: Eine ImmunizationInformationSXXD-Instanz kann grundsätzlich nur für die Darstellung einer erhaltenen/durchgeführten Impfung genutzt werden. Hat die betroffene Person mehrere Impfungen erhalten, müssen auch mehrere Ressourcen dieses Typs angelegt und über den ausgefüllten krankheitsspezifischen Fragebogen referenziert werden.

Profilansicht

ImmunizationInformationSXXD (Immunization) | C |  | ImmunizationInformation | There are no (further) constraints on this element Element id
    Immunization
Short description Immunization event information Definition Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. Data type ImmunizationInformation Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management `text.`div`.exists()` Mappings rim: Entity. Role, or Act workflow: Event v2: VXU_V04 rim: SubstanceAdministration
id | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.id
Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. 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. Data type string
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element id
    Immunization.meta
Short description Metadata about the resource 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element id
    Immunization.implicitRules
Short description A set of rules under which this content was created 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. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language |  | 0..1 | code Binding | There are no (further) constraints on this element Element id
    Immunization.language
Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. CommonLanguages (preferred) Binding extensions
maxValueSet | AllLanguages
Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text |  | 0..1 | Narrative | There are no (further) constraints on this element Element id
    Immunization.text
Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained |  | 0..* | Resource | There are no (further) constraints on this element Element id
    Immunization.contained
Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources 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. 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. Data type Resource Mappings rim: N/A
extension | C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.extension
Short description Additional content defined by implementations Alternate names extensions, user content 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.modifierExtension
Short description Extensions that cannot be ignored Alternate names extensions, user content 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). 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
identifier |  | 0..* | Identifier | There are no (further) constraints on this element Element id
    Immunization.identifier
Short description Business identifier Definition A unique identifier assigned to this immunization record. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.identifier w5: FiveWs.identifier rim: .id cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
status | S Σ ?! | 1..1 | code BindingFixed Value | There are no (further) constraints on this element Element id
    Immunization.status
Short description completed | entered-in-error | not-done Definition Indicates the current status of the immunization event. Comments Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Data type code Binding A set of codes indicating the current status of an Immunization. ImmunizationStatusCodes (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value
    completed
Mappings workflow: Event.status w5: FiveWs.status rim: statusCode
statusReason |  | 0..0 | CodeableConcept | There are no (further) constraints on this element Element id
    Immunization.statusReason
Short description Reason not done Definition Indicates the reason the immunization event was not performed. Comments This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here. Data type CodeableConcept Binding The reason why a vaccine was not administered. ImmunizationStatusReasonCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.statusReason rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
vaccineCode | S Σ | 1..1 | CodeableConcept | Element id
    Immunization.vaccineCode
Short description Verabreichter Impfstoff in Bezug auf Paratyphus/Typhus, nicht differenziert Definition Verabreichter Impfstoff in Bezug auf Paratyphus/Typhus, nicht differenziert Data type CodeableConcept Binding The code for vaccine product administered. VaccineAdministeredValueSet (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.code w5: FiveWs.what[x] v2: RXA-5 rim: .code cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
id |  | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.id
Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension | C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.extension
Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
coding | S Σ | 1..* | Coding | Element id
    Immunization.vaccineCode.coding
Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. 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. Data type Coding Slicing Unordered, Closed, by system(Value) Slicing based on system Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.1-8, C*E.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
snomed_CT | S Σ | 0..1 | Coding Binding | Element id
    Immunization.vaccineCode.coding:snomed_CT
Short description SNOMED CT Definition Dieses Element beschreibt den Impfstoff als SNOMED CT® Product Code. 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. Data type Coding Binding VaccineSXXD (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.1-8, C*E.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id |  | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:snomed_CT.id
Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension | C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:snomed_CT.extension
Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system | S Σ | 1..1 | uri Fixed Value | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:snomed_CT.system
Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value
    http://snomed.info/sct
Mappings v2: C*E.3 rim: ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:snomed_CT.version
Short description Version of the system - if relevant 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.7 rim: ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:snomed_CT.code
Short description Symbol in syntax defined by the system 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). Requirements Need to refer to a particular code in the system. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.1 rim: ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:snomed_CT.display
Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.2 - but note this is not well followed rim: CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:snomed_CT.userSelected
Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
pharmazentralnummer_pzn | S Σ | 0..1 | Coding | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:pharmazentralnummer_pzn
Short description Pharmazentralnummer (PZN) Definition Dieses Element beschreibt den Impfstoff als 8-stellige Pharmazentralnummer (PZN). Die PZN definiert ein Fertigarzneimittel eindeutig. 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. Data type Coding Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.1-8, C*E.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id |  | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:pharmazentralnummer_pzn.id
Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension | C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:pharmazentralnummer_pzn.extension
Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system | S Σ | 1..1 | uri Fixed Value | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:pharmazentralnummer_pzn.system
Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value
    http://fhir.de/CodeSystem/ifa/pzn
Mappings v2: C*E.3 rim: ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:pharmazentralnummer_pzn.version
Short description Version of the system - if relevant 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.7 rim: ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:pharmazentralnummer_pzn.code
Short description Symbol in syntax defined by the system 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). Requirements Need to refer to a particular code in the system. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.1 rim: ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:pharmazentralnummer_pzn.display
Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.2 - but note this is not well followed rim: CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:pharmazentralnummer_pzn.userSelected
Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
nullflavor | S Σ | 0..* | Coding Binding | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:nullflavor
Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. 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. Data type Coding Binding NullFlavor (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.1-8, C*E.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id |  | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:nullflavor.id
Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension | C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:nullflavor.extension
Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system | S Σ | 1..1 | uri Fixed Value | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:nullflavor.system
Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value
    http://terminology.hl7.org/CodeSystem/v3-NullFlavor
Mappings v2: C*E.3 rim: ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:nullflavor.version
Short description Version of the system - if relevant 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.7 rim: ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:nullflavor.code
Short description Symbol in syntax defined by the system 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). Requirements Need to refer to a particular code in the system. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.1 rim: ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:nullflavor.display
Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.2 - but note this is not well followed rim: CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.coding:nullflavor.userSelected
Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text | Σ | 0..0 | string | There are no (further) constraints on this element Element id
    Immunization.vaccineCode.text
Short description Plain text representation of the concept 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.9. But note many systems use C*E.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
patient | S Σ | 1..1 | Reference(NotifiedPerson) | There are no (further) constraints on this element Element id
    Immunization.patient
Short description Verweis auf die in der Meldung benannte betroffene Person. Definition Verweis auf die in der Meldung benannte betroffene Person. Hierbei handelt es sich grundsätzlich um den Verweis auf die in der Erregernachweismeldung als „subject“ referenzierte Patient Ressource. Data type Reference(NotifiedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.subject w5: FiveWs.subject[x] v2: PID-3 rim: .partipication[ttypeCode=].role w5: FiveWs.subject
encounter |  | 0..0 | Reference(Encounter) | There are no (further) constraints on this element Element id
    Immunization.encounter
Short description Encounter immunization was part of Definition The visit or admission or other contact between patient and health care provider the immunization was performed as part of. Data type Reference(Encounter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.context w5: FiveWs.context v2: PV1-19 rim: component->EncounterEvent
occurrence[x] | S Σ | 1..1 |  | There are no (further) constraints on this element Element id
    Immunization.occurrence[x]
Short description Datum der Impfung Definition Datum der Impfung Comments When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose. Slicing Unordered, Closed, by $this(Type) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.occurrence[x] w5: FiveWs.done[x] v2: RXA-3 rim: .effectiveTime cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
occurrenceDateTime | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element id
    Immunization.occurrence[x]:occurrenceDateTime
Short description Vaccine administration date Definition Date vaccine administered or was to be administered. Comments When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.occurrence[x] w5: FiveWs.done[x] v2: RXA-3 rim: .effectiveTime cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
occurrenceString | Σ | 0..1 | string Binding | There are no (further) constraints on this element Element id
    Immunization.occurrence[x]:occurrenceString
Short description Vaccine administration date Definition Date vaccine administered or was to be administered. Comments When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose. Data type string Binding NullFlavor (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.occurrence[x] w5: FiveWs.done[x] v2: RXA-3 rim: .effectiveTime cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
recorded |  | 0..0 | dateTime | There are no (further) constraints on this element Element id
    Immunization.recorded
Short description When the immunization was first captured in the subject's record Definition The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.recorded rim: .participation[typeCode=AUT].time
primarySource | Σ | 0..0 | boolean | There are no (further) constraints on this element Element id
    Immunization.primarySource
Short description Indicates context the data was recorded in Definition An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded. Comments Reflects the “reliability” of the content. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.source v2: RXA-9 rim: immunization.uncertaintycode (if primary source=false, uncertainty=U)
reportOrigin |  | 0..0 | CodeableConcept | There are no (further) constraints on this element Element id
    Immunization.reportOrigin
Short description Indicates the source of a secondarily reported record Definition The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. Comments Should not be populated if primarySource = True, not required even if primarySource = False. Data type CodeableConcept Binding The source of the data for a record which is not from a primary source. ImmunizationOriginCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.source v2: RXA-9 rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)
location |  | 0..0 | Reference(Location) | There are no (further) constraints on this element Element id
    Immunization.location
Short description Where immunization occurred Definition The service delivery location where the vaccine administration occurred. Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.location w5: FiveWs.where[x] v2: RXA-27 (or RXA-11, deprecated as of v2.7) rim: .participation[typeCode=LOC].COCT_MT240000UV
manufacturer |  | 0..0 | Reference(Organization) | There are no (further) constraints on this element Element id
    Immunization.manufacturer
Short description Vaccine manufacturer Definition Name of vaccine manufacturer. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-17 rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG] cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
lotNumber |  | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.lotNumber
Short description Chargenbezeichnung Definition Chargenbezeichnung Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-15 rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
expirationDate |  | 0..0 | date | There are no (further) constraints on this element Element id
    Immunization.expirationDate
Short description Vaccine expiration date Definition Date vaccine batch expires. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-16 rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
site |  | 0..0 | CodeableConcept | There are no (further) constraints on this element Element id
    Immunization.site
Short description Body site vaccine was administered Definition Body site where vaccine was administered. Data type CodeableConcept Binding The site at which the vaccine was administered. CodesForImmunizationSiteOfAdministration (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXR-2 rim: observation.targetSiteCode cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
route |  | 0..0 | CodeableConcept | There are no (further) constraints on this element Element id
    Immunization.route
Short description How vaccine entered body Definition The path by which the vaccine product is taken into the body. Data type CodeableConcept Binding The route by which the vaccine was administered. ImmunizationRouteCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXR-1 rim: .routeCode cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
doseQuantity |  | 0..0 | SimpleQuantity | There are no (further) constraints on this element Element id
    Immunization.doseQuantity
Short description Amount of vaccine administered Definition The quantity of vaccine product that was administered. Data type SimpleQuantity Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-6 / RXA-7 rim: .doseQuantity
performer | Σ | 0..1 | BackboneElement | There are no (further) constraints on this element Element id
    Immunization.performer
Short description Verantwortliche Person für die Durchführung der Schutzimpfung Definition Verantwortliche Person für die Durchführung der Schutzimpfung Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer v2: ORC-12 / RXA-10 rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
id |  | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.performer.id
Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension | C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.performer.extension
Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.performer.modifierExtension
Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers 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). 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. Data type Extension Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: N/A
function | Σ | 0..1 | CodeableConcept Binding | There are no (further) constraints on this element Element id
    Immunization.performer.function
Short description What type of performance was done Definition Describes the type of performance (e.g. ordering provider, administering provider, etc.). Data type CodeableConcept Binding The role a practitioner or organization plays in the immunization event. ImmunizationFunctionCodes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.function rim: .participation.functionCode
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | There are no (further) constraints on this element Element id
    Immunization.performer.actor
Short description Individual or organization who was performing Definition The practitioner or organization who performed the action. Comments When the individual practitioner who performed the action is known, it is best to send. Data type Reference(Practitioner | PractitionerRole | Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.actor w5: FiveWs.actor rim: .player
note | S Σ | 0..* | Annotation | There are no (further) constraints on this element Element id
    Immunization.note
Short description Hinweis zur Impfung Definition Hinweis zur Impfung Data type Annotation Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.note v2: OBX-5 : OBX-3 = 48767-8 rim: note
reasonCode | S | 0..1 | CodeableConcept | There are no (further) constraints on this element Element id
    Immunization.reasonCode
Short description Impfindikation Definition Impfindikation Data type CodeableConcept Binding The reason why a vaccine was administered. ImmunizationReasonCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.reasonCode rim: [actionNegationInd=false].reasonCode
id |  | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.reasonCode.id
Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension | C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.reasonCode.extension
Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
coding | S Σ | 1..1 | Coding Binding | There are no (further) constraints on this element Element id
    Immunization.reasonCode.coding
Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. 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. Data type Coding Binding Impfindikation VaccinationIndication (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.1-8, C*E.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id |  | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.reasonCode.coding.id
Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension | C | 0..* | Extension | There are no (further) constraints on this element Element id
    Immunization.reasonCode.coding.extension
Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element id
    Immunization.reasonCode.coding.system
Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.3 rim: ./codeSystem orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.reasonCode.coding.version
Short description Version of the system - if relevant 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.7 rim: ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code | S Σ | 1..1 | code | There are no (further) constraints on this element Element id
    Immunization.reasonCode.coding.code
Short description Symbol in syntax defined by the system 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). Requirements Need to refer to a particular code in the system. Data type code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.1 rim: ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.reasonCode.coding.display
Short description Representation defined by the system Definition A representation of the meaning of the code in the system, following the rules of the system. Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.2 - but note this is not well followed rim: CV.displayName orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element id
    Immunization.reasonCode.coding.userSelected
Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: Sometimes implied by being first rim: CD.codingRationale orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
text | Σ | 0..1 | string | There are no (further) constraints on this element Element id
    Immunization.reasonCode.text
Short description Plain text representation of the concept 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. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: C*E.9. But note many systems use C*E.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
reasonReference |  | 0..0 | Reference(Condition | Observation | DiagnosticReport) | There are no (further) constraints on this element Element id
    Immunization.reasonReference
Short description Why immunization occurred Definition Condition, Observation or DiagnosticReport that supports why the immunization was administered. Data type Reference(Condition | Observation | DiagnosticReport) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.reasonReference rim: N/A
isSubpotent | Σ ?! | 0..0 | boolean | There are no (further) constraints on this element Element id
    Immunization.isSubpotent
Short description Dose potency Definition Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. Comments Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event. Meaning when missing By default, a dose should be considered to be potent. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-20 = PA (partial administration) rim: N/A
subpotentReason |  | 0..0 | CodeableConcept | There are no (further) constraints on this element Element id
    Immunization.subpotentReason
Short description Reason for being subpotent Definition Reason why a dose is considered to be subpotent. Data type CodeableConcept Binding The reason why a dose is considered to be subpotent. ImmunizationSubpotentReason (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
education | C | 0..0 | BackboneElement | There are no (further) constraints on this element Element id
    Immunization.education
Short description Educational material presented to patient Definition Educational material presented to the patient (or guardian) at the time of vaccine administration. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` imm-1: One of documentType or reference SHALL be present `documentType.exists() or reference.exists()` Mappings rim: N/A
programEligibility |  | 0..0 | CodeableConcept | There are no (further) constraints on this element Element id
    Immunization.programEligibility
Short description Patient eligibility for a vaccination program Definition Indicates a patient's eligibility for a funding program. Data type CodeableConcept Binding The patient's eligibility for a vaccation program. ImmunizationProgramEligibility (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: OBX-5 : OBX-3 = 64994-7 rim: N/A
fundingSource |  | 0..0 | CodeableConcept | There are no (further) constraints on this element Element id
    Immunization.fundingSource
Short description Funding source for the vaccine Definition Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered). Data type CodeableConcept Binding The source of funding used to purchase the vaccine administered. ImmunizationFundingSource (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
reaction |  | 0..0 | BackboneElement | There are no (further) constraints on this element Element id
    Immunization.reaction
Short description Details of a reaction that follows immunization Definition Categorical data indicating that an adverse event is associated in time to an immunization. Comments A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: OBX-3 rim: Observation[classCode=obs].code
protocolApplied |  | 0..0 | BackboneElement | There are no (further) constraints on this element Element id
    Immunization.protocolApplied
Short description Protocol followed by the provider Definition The protocol (set of recommendations) being followed by the provider who administered the dose. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A

Beispiel

<Immunization xmlns="http://hl7.org/fhir">
<id value="01b4ee88-33bd-3e8a-8683-a84cf4920eaa" />
<meta>
<profile value="https://demis.rki.de/fhir/StructureDefinition/ImmunizationInformationSXXD" />
</meta>
<status value="completed" />
<vaccineCode>
<coding>
<system value="http://snomed.info/sct" />
<code value="971000221109" />
<display value="Typhus-Impfstoff, oral,lebend abgeschwächt (Typhoral L)" />
</coding>
</vaccineCode>
<patient>
<reference value="Patient/198b8948-67bc-3ced-8b37-d3ab6e335f97" />
</patient>
<occurrenceDateTime value="2022-12-01" />
<note>
<text value="-" />
</note>
</Immunization>