| Official URL: https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-request-header | Version: 1.2.0 | |||
| Active as of 2025-07-31 | Computable Name: ERPServiceRequestRequestHeader | |||
Header mit Informationen über Absender und Empfänger
Der ATF MessageHeader wurde dahingehend weiterspezifiziert, als dass nur für diesen Anwendungsfall gültige eventCodes und Ressourcen zu verwenden sind.
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:   |
|---|---|---|---|---|
  MessageHeader |
0..* | MessageHeaderAppTransportFramework | A resource that describes a message that is exchanged between systems | |
  id |
SΣ | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
  Slices for event[x] |
Σ | 1..1 | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this Binding: Anwendungskennzeichen (VS) (required): One of the message events defined as part of this version of FHIR. | |
   eventCoding |
Coding | |||
| eventUri |
uri | |||
  event[x]:eventCoding |
Σ | 0..1 | Coding | The event code that indicates in which application and which transmission path the communication is currently taking place Binding: Identifikator des Anwendungsfalls (required) |
| destination |
SΣ | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Adresse des Empfängers der Nachricht |
  receiver |
SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 |
 identifier |
SΣ | 0..1 | IdentifierTelematikId(1.5.2) | Identifier des Empfängers der Nachricht |
 display |
SΣ | 0..1 | string | Anzeigename des Empfängers der Nachricht |
| sender |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
| reference |
SΣC | 0..1 | string | Ressource des Absenders der Nachricht |
| identifier |
SΣ | 0..1 | IdentifierTelematikId(1.5.2) | Business Identifer des Absenders der Nachricht |
| display |
SΣ | 1..1 | string | Anzeigename des Absenders der Nachricht |
| source |
SΣ | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
SΣ | 1..1 | string | Name des Softwareherstellers |
| software |
SΣ | 1..1 | string | Name der Software |
| version |
SΣ | 1..1 | string | Version der Software |
| contact |
SΣ | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| endpoint |
SΣ | 1..1 | url | Adresse des Absenders der Nachricht |
| responsible |
SΣ | 1..1 | Reference(ERP Service Request Organisation) | The organization that is responsible for the request. |
| focus |
SΣ | 1..* | Reference(ERP Service Request Rezeptanforderung | ERP Service Request Abgabeanforderung | ERP Service Request Nachrichten-Container) | Specification of the ServiceRequest that contains the essential information for a given use case. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs | |
| MessageHeader.event[x]:eventCoding | required | ServiceIdentifierVShttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vsFrom this IG | |
| MessageHeader.source.contact.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | |
| MessageHeader.source.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From 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 MessageHeaderAppTransportFramework
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
MessageHeaderAppTransportFramework | |||
| Slices for event[x] |
1..1 | Coding, uri | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
| event[x]:eventCoding |
0..1 | Coding | The event code that indicates in which application and which transmission path the communication is currently taking place Binding: Identifikator des Anwendungsfalls (required) | |
 destination |
||||
| receiver |
||||
| identifier |
0..1 | IdentifierTelematikId(1.5.2) | Identifier des Empfängers der Nachricht | |
| sender |
||||
| identifier |
0..1 | IdentifierTelematikId(1.5.2) | Business Identifer des Absenders der Nachricht | |
| responsible |
S | 1..1 | Reference(ERP Service Request Organisation) | The organization that is responsible for the request. |
| focus |
1..* | Reference(ERP Service Request Rezeptanforderung | ERP Service Request Abgabeanforderung | ERP Service Request Nachrichten-Container) | Specification of the ServiceRequest that contains the essential information for a given use case. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MessageHeader.event[x]:eventCoding | required | ServiceIdentifierVShttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vsFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeaderAppTransportFramework | A resource that describes a message that is exchanged between systems | |||||
| id |
SΣ | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for event[x] |
Σ | 1..1 | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this Binding: Anwendungskennzeichen (VS) (required): One of the message events defined as part of this version of FHIR. | |||||
| eventCoding |
Coding | |||||||
| eventUri |
uri | |||||||
| event[x]:eventCoding |
Σ | 0..1 | Coding | The event code that indicates in which application and which transmission path the communication is currently taking place Binding: Identifikator des Anwendungsfalls (required) | ||||
| destination |
SΣ | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 0..1 | string | Name of system | ||||
| target |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint |
SΣ | 1..1 | url | Adresse des Empfängers der Nachricht | ||||
| receiver |
SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 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). | ||||
| identifier |
SΣ | 0..1 | IdentifierTelematikId(1.5.2) | Identifier des Empfängers der Nachricht | ||||
| display |
SΣ | 0..1 | string | Anzeigename des Empfängers der Nachricht | ||||
| sender |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 0..1 | string | Ressource des Absenders der Nachricht | ||||
| type |
Σ | 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). | ||||
| identifier |
SΣ | 0..1 | IdentifierTelematikId(1.5.2) | Business Identifer des Absenders der Nachricht | ||||
| display |
SΣ | 1..1 | string | Anzeigename des Absenders der Nachricht | ||||
| enterer |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source |
SΣ | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
SΣ | 1..1 | string | Name des Softwareherstellers | ||||
| software |
SΣ | 1..1 | string | Name der Software | ||||
| version |
SΣ | 1..1 | string | Version der Software | ||||
| contact |
SΣ | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value |
Σ | 0..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| endpoint |
SΣ | 1..1 | url | Adresse des Absenders der Nachricht | ||||
| responsible |
SΣ | 1..1 | Reference(ERP Service Request Organisation) | The organization that is responsible for the request. | ||||
| reason |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
| response |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 1..1 | id | Id of original message | ||||
| code |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus |
SΣ | 1..* | Reference(ERP Service Request Rezeptanforderung | ERP Service Request Abgabeanforderung | ERP Service Request Nachrichten-Container) | Specification of the ServiceRequest that contains the essential information for a given use case. | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs | ||||
| MessageHeader.event[x]:eventCoding | required | ServiceIdentifierVShttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vsFrom this IG | ||||
| MessageHeader.destination.receiver.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| MessageHeader.sender.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| MessageHeader.source.contact.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| MessageHeader.source.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounterFrom the FHIR Standard | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1From 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 MessageHeaderAppTransportFramework
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeaderAppTransportFramework | A resource that describes a message that is exchanged between systems | |
| id |
SΣ | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for event[x] |
Σ | 1..1 | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this Binding: Anwendungskennzeichen (VS) (required): One of the message events defined as part of this version of FHIR. | |
| eventCoding |
Coding | |||
| eventUri |
uri | |||
| event[x]:eventCoding |
Σ | 0..1 | Coding | The event code that indicates in which application and which transmission path the communication is currently taking place Binding: Identifikator des Anwendungsfalls (required) |
| destination |
SΣ | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Adresse des Empfängers der Nachricht |
| receiver |
SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 |
| identifier |
SΣ | 0..1 | IdentifierTelematikId(1.5.2) | Identifier des Empfängers der Nachricht |
| display |
SΣ | 0..1 | string | Anzeigename des Empfängers der Nachricht |
| sender |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
| reference |
SΣC | 0..1 | string | Ressource des Absenders der Nachricht |
| identifier |
SΣ | 0..1 | IdentifierTelematikId(1.5.2) | Business Identifer des Absenders der Nachricht |
| display |
SΣ | 1..1 | string | Anzeigename des Absenders der Nachricht |
| source |
SΣ | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name |
SΣ | 1..1 | string | Name des Softwareherstellers |
| software |
SΣ | 1..1 | string | Name der Software |
| version |
SΣ | 1..1 | string | Version der Software |
| contact |
SΣ | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller |
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| endpoint |
SΣ | 1..1 | url | Adresse des Absenders der Nachricht |
| responsible |
SΣ | 1..1 | Reference(ERP Service Request Organisation) | The organization that is responsible for the request. |
| focus |
SΣ | 1..* | Reference(ERP Service Request Rezeptanforderung | ERP Service Request Abgabeanforderung | ERP Service Request Nachrichten-Container) | Specification of the ServiceRequest that contains the essential information for a given use case. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs | |
| MessageHeader.event[x]:eventCoding | required | ServiceIdentifierVShttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vsFrom this IG | |
| MessageHeader.source.contact.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | |
| MessageHeader.source.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From 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 MessageHeaderAppTransportFramework
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
MessageHeaderAppTransportFramework | |||
| Slices for event[x] |
1..1 | Coding, uri | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
| event[x]:eventCoding |
0..1 | Coding | The event code that indicates in which application and which transmission path the communication is currently taking place Binding: Identifikator des Anwendungsfalls (required) | |
| destination |
||||
| receiver |
||||
| identifier |
0..1 | IdentifierTelematikId(1.5.2) | Identifier des Empfängers der Nachricht | |
| sender |
||||
| identifier |
0..1 | IdentifierTelematikId(1.5.2) | Business Identifer des Absenders der Nachricht | |
| responsible |
S | 1..1 | Reference(ERP Service Request Organisation) | The organization that is responsible for the request. |
| focus |
1..* | Reference(ERP Service Request Rezeptanforderung | ERP Service Request Abgabeanforderung | ERP Service Request Nachrichten-Container) | Specification of the ServiceRequest that contains the essential information for a given use case. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MessageHeader.event[x]:eventCoding | required | ServiceIdentifierVShttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vsFrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MessageHeaderAppTransportFramework | A resource that describes a message that is exchanged between systems | |||||
| id |
SΣ | 1..1 | id | Eindeutige ID der Nachricht, anzugeben als UUID | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for event[x] |
Σ | 1..1 | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this Binding: Anwendungskennzeichen (VS) (required): One of the message events defined as part of this version of FHIR. | |||||
| eventCoding |
Coding | |||||||
| eventUri |
uri | |||||||
| event[x]:eventCoding |
Σ | 0..1 | Coding | The event code that indicates in which application and which transmission path the communication is currently taking place Binding: Identifikator des Anwendungsfalls (required) | ||||
| destination |
SΣ | 1..* | BackboneElement | Angaben zum Empfänger der Nachricht | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 0..1 | string | Name of system | ||||
| target |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint |
SΣ | 1..1 | url | Adresse des Empfängers der Nachricht | ||||
| receiver |
SΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data Constraints: app-transport-message-header-1 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 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). | ||||
| identifier |
SΣ | 0..1 | IdentifierTelematikId(1.5.2) | Identifier des Empfängers der Nachricht | ||||
| display |
SΣ | 0..1 | string | Anzeigename des Empfängers der Nachricht | ||||
| sender |
SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
SΣC | 0..1 | string | Ressource des Absenders der Nachricht | ||||
| type |
Σ | 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). | ||||
| identifier |
SΣ | 0..1 | IdentifierTelematikId(1.5.2) | Business Identifer des Absenders der Nachricht | ||||
| display |
SΣ | 1..1 | string | Anzeigename des Absenders der Nachricht | ||||
| enterer |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source |
SΣ | 1..1 | BackboneElement | Angabe der Informationen des Absendenden Systems | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
SΣ | 1..1 | string | Name des Softwareherstellers | ||||
| software |
SΣ | 1..1 | string | Name der Software | ||||
| version |
SΣ | 1..1 | string | Version der Software | ||||
| contact |
SΣ | 1..1 | ContactPoint | E-Mail Kontaktmöglichkeit zum Hersteller | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
| value |
Σ | 0..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| endpoint |
SΣ | 1..1 | url | Adresse des Absenders der Nachricht | ||||
| responsible |
SΣ | 1..1 | Reference(ERP Service Request Organisation) | The organization that is responsible for the request. | ||||
| reason |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
| response |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier |
Σ | 1..1 | id | Id of original message | ||||
| code |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus |
SΣ | 1..* | Reference(ERP Service Request Rezeptanforderung | ERP Service Request Abgabeanforderung | ERP Service Request Nachrichten-Container) | Specification of the ServiceRequest that contains the essential information for a given use case. | ||||
| definition |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| MessageHeader.event[x] | required | ServiceIdentifierVShttps://gematik.de/fhir/atf/ValueSet/service-identifier-vs | ||||
| MessageHeader.event[x]:eventCoding | required | ServiceIdentifierVShttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vsFrom this IG | ||||
| MessageHeader.destination.receiver.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| MessageHeader.sender.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| MessageHeader.source.contact.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1From the FHIR Standard | ||||
| MessageHeader.source.contact.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1From the FHIR Standard | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounterFrom the FHIR Standard | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1From 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 MessageHeaderAppTransportFramework
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron