Official URL: https://gematik.de/fhir/atf/StructureDefinition/atf-message-header | Version: 1.4.0 | |||
Active as of 2025-07-29 | Computable Name: MessageHeaderAppTransportFramework |
MessageHeader des MessageBundles
In jeder Übertragung gibt es genau einen MessageHeader. Dieser hält vier wesentliche Informationen
Diese Informationen können in dem vorliegenden Profil angegeben werden.
Hinweis: MessageHeader.destination.receiver ist bewusst offen spezifiziert worden. Je genauer der Empfänger in der Nachricht angegeben werden kann, desto besser. Daher sollte z.B. unter MessageHeader.destination.receiver.identifier
nach Möglichkeit die Telematik-ID des Empfängers angegeben werden. Dies ermöglicht eine genauere Zustellung im empfangenden System.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
![]() ![]() ![]() |
SΣ | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | Code for the event this message represents or link to event definition Binding: Anwendungskennzeichen (VS) (required) | |
![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | Adresse des Empfängers der Nachricht |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Identifier des Empfängers der Nachricht |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Anzeigename des Empfängers der Nachricht |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Ressource des Absenders der Nachricht |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Business Identifer des Absenders der Nachricht |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Anzeigename des Absenders der Nachricht |
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name des Softwareherstellers |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name der Software |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Version der Software |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | Adresse des Absenders der Nachricht |
![]() ![]() ![]() |
SΣ | 1..* | Reference(Resource) | The actual content of the message |
![]() |
Path | Conformance | ValueSet / Code | URI |
MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs From this IG | |
MessageHeader.source.contact.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | |
MessageHeader.source.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-transport-message-header-1 | error | MessageHeader.destination.receiver | Als Empfänger muss eine Referenz, Displaywert oder Identifier angegeben werden : reference.exists() or display.exists() or identifier.exists() | |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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 | error | MessageHeader | 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 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
MessageHeader | |||
![]() ![]() ![]() |
S | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID |
![]() ![]() ![]() |
1..1 | Coding, uri | Code for the event this message represents or link to event definition Binding: Anwendungskennzeichen (VS) (required) | |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht |
![]() ![]() ![]() ![]() |
S | 1..1 | url | Adresse des Empfängers der Nachricht |
![]() ![]() ![]() ![]() |
SC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Identifier des Empfängers der Nachricht |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Anzeigename des Empfängers der Nachricht |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Ressource des Absenders der Nachricht |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Business Identifer des Absenders der Nachricht |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Anzeigename des Absenders der Nachricht |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name des Softwareherstellers |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name der Software |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Version der Software |
![]() ![]() ![]() ![]() |
S | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
![]() ![]() ![]() ![]() |
S | 1..1 | url | Adresse des Absenders der Nachricht |
![]() ![]() ![]() |
S | 1..* | Reference(Resource) | The actual content of the message |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs From this IG |
Id | Grade | Path(s) | Details | Requirements |
app-transport-message-header-1 | error | MessageHeader.destination.receiver | Als Empfänger muss eine Referenz, Displaywert oder Identifier angegeben werden : reference.exists() or display.exists() or identifier.exists() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
![]() ![]() ![]() |
SΣ | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | Code for the event this message represents or link to event definition Binding: Anwendungskennzeichen (VS) (required) | |||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | Adresse des Empfängers der Nachricht | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Identifier des Empfängers der Nachricht | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Anzeigename des Empfängers der Nachricht | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Ressource des Absenders der Nachricht | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Business Identifer des Absenders der Nachricht | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Anzeigename des Absenders der Nachricht | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name des Softwareherstellers | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name der Software | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Version der Software | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | Adresse des Absenders der Nachricht | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | id | Id of original message | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() |
SΣ | 1..* | Reference(Resource) | The actual content of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs From this IG | ||||
MessageHeader.destination.receiver.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
MessageHeader.sender.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
MessageHeader.source.contact.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | ||||
MessageHeader.source.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | ||||
MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounter From the FHIR Standard | ||||
MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-transport-message-header-1 | error | MessageHeader.destination.receiver | Als Empfänger muss eine Referenz, Displaywert oder Identifier angegeben werden : reference.exists() or display.exists() or identifier.exists() | |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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 | error | MessageHeader | 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 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MessageHeader
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
![]() ![]() ![]() |
SΣ | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..1 | Code for the event this message represents or link to event definition Binding: Anwendungskennzeichen (VS) (required) | |
![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | Adresse des Empfängers der Nachricht |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Identifier des Empfängers der Nachricht |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Anzeigename des Empfängers der Nachricht |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Ressource des Absenders der Nachricht |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Business Identifer des Absenders der Nachricht |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Anzeigename des Absenders der Nachricht |
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name des Softwareherstellers |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name der Software |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Version der Software |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | Adresse des Absenders der Nachricht |
![]() ![]() ![]() |
SΣ | 1..* | Reference(Resource) | The actual content of the message |
![]() |
Path | Conformance | ValueSet / Code | URI |
MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs From this IG | |
MessageHeader.source.contact.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | |
MessageHeader.source.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-transport-message-header-1 | error | MessageHeader.destination.receiver | Als Empfänger muss eine Referenz, Displaywert oder Identifier angegeben werden : reference.exists() or display.exists() or identifier.exists() | |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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 | error | MessageHeader | 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 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
MessageHeader | |||
![]() ![]() ![]() |
S | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID |
![]() ![]() ![]() |
1..1 | Coding, uri | Code for the event this message represents or link to event definition Binding: Anwendungskennzeichen (VS) (required) | |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht |
![]() ![]() ![]() ![]() |
S | 1..1 | url | Adresse des Empfängers der Nachricht |
![]() ![]() ![]() ![]() |
SC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Identifier des Empfängers der Nachricht |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Anzeigename des Empfängers der Nachricht |
![]() ![]() ![]() |
S | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Ressource des Absenders der Nachricht |
![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | Business Identifer des Absenders der Nachricht |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Anzeigename des Absenders der Nachricht |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name des Softwareherstellers |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name der Software |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Version der Software |
![]() ![]() ![]() ![]() |
S | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | phone | fax | email | pager | url | sms | other Fixed Value: email | |
![]() ![]() ![]() ![]() |
S | 1..1 | url | Adresse des Absenders der Nachricht |
![]() ![]() ![]() |
S | 1..* | Reference(Resource) | The actual content of the message |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs From this IG |
Id | Grade | Path(s) | Details | Requirements |
app-transport-message-header-1 | error | MessageHeader.destination.receiver | Als Empfänger muss eine Referenz, Displaywert oder Identifier angegeben werden : reference.exists() or display.exists() or identifier.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
![]() ![]() ![]() |
SΣ | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..1 | Code for the event this message represents or link to event definition Binding: Anwendungskennzeichen (VS) (required) | |||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() |
SΣ | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | Adresse des Empfängers der Nachricht | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Identifier des Empfängers der Nachricht | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Anzeigename des Empfängers der Nachricht | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Ressource des Absenders der Nachricht | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Identifier | Business Identifer des Absenders der Nachricht | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Anzeigename des Absenders der Nachricht | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name des Softwareherstellers | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name der Software | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Version der Software | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | url | Adresse des Absenders der Nachricht | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | id | Id of original message | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() |
SΣ | 1..* | Reference(Resource) | The actual content of the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs From this IG | ||||
MessageHeader.destination.receiver.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
MessageHeader.sender.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
MessageHeader.source.contact.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 From the FHIR Standard | ||||
MessageHeader.source.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 From the FHIR Standard | ||||
MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounter From the FHIR Standard | ||||
MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-transport-message-header-1 | error | MessageHeader.destination.receiver | Als Empfänger muss eine Referenz, Displaywert oder Identifier angegeben werden : reference.exists() or display.exists() or identifier.exists() | |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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 | error | MessageHeader | 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 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MessageHeader
Other representations of profile: CSV, Excel, Schematron