ERP ServiceRequest Request Header
Übersicht über das Profil
Name | Description | Canonical_URL | Status | Version | Basiert auf |
---|---|---|---|---|---|
ERPServiceRequestRequestHeader | Header containing information about the sender and addressee | https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-request-header | draft | 1.2 | https://gematik.de/fhir/atf/StructureDefinition/message-header-app-transport |
Über das Profil
Motivation
Der ATF MessageHeader wurde dahingehend weiterspezifiziert, als dass nur für diesen Anwendungsfall gültige eventCodes und Ressourcen zu verwenden sind.
Inhalt des Profils
Folgende Ansichten existieren auf das Profil:
ERPServiceRequestRequestHeader (MessageHeader) | I | MessageHeaderAppTransportFramework | |
id | S Σ | 1..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
event[x] | Σ | 1..1 | Binding |
(All Slices) | |||
eventUri | uri | ||
eventCoding | Σ | 0..1 | CodingBinding |
destination | S Σ | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | Σ | 0..1 | string |
target | Σ I | 0..1 | Reference(Device) |
endpoint | S Σ | 1..1 | url |
receiver | S Σ I | 0..1 | Reference(Practitioner | PractitionerRole | Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | IdentifierTelematikId |
display | S Σ | 0..1 | string |
sender | S Σ I | 1..1 | Reference(Practitioner | PractitionerRole | Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 0..1 | IdentifierTelematikId |
display | S Σ | 1..1 | string |
enterer | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) |
author | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) |
source | S Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | S Σ | 1..1 | string |
software | S Σ | 1..1 | string |
version | S Σ | 1..1 | string |
contact | S Σ I | 1..1 | ContactPoint |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ I | 0..1 | codeBindingFixed Value |
value | Σ | 0..1 | string |
use | Σ ?! | 0..1 | codeBinding |
rank | Σ | 0..1 | positiveInt |
period | Σ I | 0..1 | Period |
endpoint | S Σ | 1..1 | url |
responsible | S Σ I | 1..1 | Reference(ERPServiceRequestOrganization) |
reason | Σ | 0..1 | CodeableConcept |
response | Σ | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
identifier | Σ | 1..1 | id |
code | Σ | 1..1 | codeBinding |
details | Σ I | 0..1 | Reference(OperationOutcome) |
focus | S Σ I | 1..* | Reference(ERPServiceRequestPrescriptionRequest | ERPServiceRequestDispenseRequest | ERPServiceRequestMessageContainer) |
definition | Σ | 0..1 | canonical(MessageDefinition) |
MessageHeader | |
Definition | The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
MessageHeader.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
MessageHeader.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
MessageHeader.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
MessageHeader.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
MessageHeader.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
MessageHeader.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
MessageHeader.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MessageHeader.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MessageHeader.event[x] | |
Definition | Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. |
Cardinality | 1...1 |
Type | Coding |
Binding | One of the message events defined as part of this version of FHIR. |
Summary | True |
Requirements | Drives the behavior associated with this message. |
Comments | The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp. |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
MessageHeader.event[x]:eventCoding | |
Definition | Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition. |
Cardinality | 0...1 |
Type | Coding |
Binding | One of the message events defined as part of this version of FHIR. |
Summary | True |
Requirements | Drives the behavior associated with this message. |
Comments | For more information see ATF ImplementationGuide |
Invariants |
|
Mappings |
|
MessageHeader.destination | |
Definition | The destination application which the message is intended for. |
Cardinality | 1...* |
Type | BackboneElement |
Must Support | True |
Summary | True |
Requirements | Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient". |
Comments | There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system. |
Invariants |
|
Mappings |
|
MessageHeader.destination.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MessageHeader.destination.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MessageHeader.destination.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
MessageHeader.destination.name | |
Definition | Human-readable name for the target system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | May be used for routing of response and/or to support audit. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
MessageHeader.destination.target | |
Definition | Identifies the target end system in situations where the initial message transmission is to an intermediary system. |
Cardinality | 0...1 |
Type | Reference(Device) |
Summary | True |
Requirements | Supports multi-hop routing. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
MessageHeader.destination.endpoint | |
Definition | Indicates where the message should be routed to. |
Cardinality | 1...1 |
Type | url |
Must Support | True |
Summary | True |
Requirements | Identifies where to route the message. |
Comments | Bspw. KIM- oder TIM-Adresse des Empfängers. Die FHIR Ressource sieht hier eine URL vor. Bspw. kann hier eine KIM-Adresse genutzt werden. Diese beginnt mit 'mailto:', da der Datentyp url ist. |
Invariants |
|
Mappings |
|
MessageHeader.destination.receiver | |
Definition | Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Must Support | True |
Summary | True |
Requirements | Allows routing beyond just the application level. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
MessageHeader.destination.receiver.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MessageHeader.destination.receiver.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MessageHeader.destination.receiver.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
MessageHeader.destination.receiver.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
MessageHeader.destination.receiver.identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | IdentifierTelematikId |
Must Support | True |
Summary | True |
Comments | Bspw. kann hier die Telematik-ID des Empfängers angegeben werden |
Invariants |
|
Mappings |
|
MessageHeader.destination.receiver.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
MessageHeader.sender | |
Definition | Identifies the sending system to allow the use of a trust relationship. |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Must Support | True |
Summary | True |
Requirements | Allows routing beyond just the application level. |
Comments | Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone. |
Invariants |
|
Mappings |
|
MessageHeader.sender.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MessageHeader.sender.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MessageHeader.sender.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Hier kann eine FHIR-Ressource referenziert werden, die den Absender der Nachricht repräsentiert. Bspw. ein Practitioner oder eine Organization. |
Invariants |
|
Mappings |
|
MessageHeader.sender.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
MessageHeader.sender.identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | IdentifierTelematikId |
Must Support | True |
Summary | True |
Comments | Bspw. kann hier die Telematik-ID des Absenders angegeben werden |
Invariants |
|
Mappings |
|
MessageHeader.sender.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Es muss mindestens ein Anzeigename angegeben werden, um den Absender der Nachricht anzeigen zu können |
Invariants |
|
Mappings |
|
MessageHeader.enterer | |
Definition | The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole) |
Summary | True |
Requirements | Need to know for audit/traceback requirements and possibly for authorization. |
Comments | Usually only for the request but can be used in a response. |
Invariants |
|
Mappings |
|
MessageHeader.author | |
Definition | The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole) |
Summary | True |
Requirements | Need to know for audit/traceback requirements and possibly for authorization. |
Comments | Usually only for the request but can be used in a response. |
Invariants |
|
Mappings |
|
MessageHeader.source | |
Definition | The source application from which this message originated. |
Cardinality | 1...1 |
Type | BackboneElement |
Must Support | True |
Summary | True |
Requirements | Allows replies, supports audit. |
Comments | Diese Infomation ist verpflichtend |
Invariants |
|
Mappings |
|
MessageHeader.source.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MessageHeader.source.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MessageHeader.source.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
MessageHeader.source.name | |
Definition | Human-readable name for the source system. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | May be used to support audit. |
Comments | Diese Infomation ist verpflichtend, um das sendende System identifizieren zu können |
Invariants |
|
Mappings |
|
MessageHeader.source.software | |
Definition | May include configuration or other information useful in debugging. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Supports audit and possibly interface engine behavior. |
Comments | Diese Infomation ist verpflichtend, um das sendende System identifizieren zu können |
Invariants |
|
Mappings |
|
MessageHeader.source.version | |
Definition | Can convey versions of multiple systems in situations where a message passes through multiple hands. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Supports audit and possibly interface engine behavior. |
Comments | Diese Infomation ist verpflichtend, um das sendende System identifizieren zu können |
Invariants |
|
Mappings |
|
MessageHeader.source.contact | |
Definition | An e-mail, phone, website or other contact point to use to resolve issues with message communications. |
Cardinality | 1...1 |
Type | ContactPoint |
Must Support | True |
Summary | True |
Requirements | Allows escalation of technical issues. |
Comments | Es ist mindestens eine E-Mail anzugeben, um Kontakt mit dem Hersteller herstellen zu können |
Invariants |
|
Mappings |
|
MessageHeader.source.contact.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MessageHeader.source.contact.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MessageHeader.source.contact.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Cardinality | 0...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Fixed Value | |
Mappings |
|
MessageHeader.source.contact.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Invariants |
|
Mappings |
|
MessageHeader.source.contact.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 0...1 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
MessageHeader.source.contact.rank | |
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
MessageHeader.source.contact.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
MessageHeader.source.endpoint | |
Definition | Identifies the routing target to send acknowledgements to. |
Cardinality | 1...1 |
Type | url |
Must Support | True |
Summary | True |
Requirements | Identifies where to send responses, may influence security permissions. |
Comments | Bspw. KIM- oder TIM-Adresse des Absenders. Die FHIR Ressource sieht hier eine URL vor. Bspw. kann hier eine KIM-Adresse genutzt werden. Diese beginnt mit 'mailto:', da der Datentyp url ist. |
Invariants |
|
Mappings |
|
MessageHeader.responsible | |
Definition | The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party. |
Cardinality | 1...1 |
Type | Reference(ERPServiceRequestOrganization) |
Must Support | True |
Summary | True |
Requirements | Need to know for audit/traceback requirements and possibly for authorization. |
Comments | This organization will be stated in the message header as the sender of the message. |
Invariants |
|
Mappings |
|
MessageHeader.reason | |
Definition | Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Reason for event occurrence. |
Summary | True |
Requirements | Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
MessageHeader.response | |
Definition | Information about the message that this message is a response to. Only present if this message is a response. |
Cardinality | 0...1 |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
MessageHeader.response.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
MessageHeader.response.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
MessageHeader.response.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
MessageHeader.response.identifier | |
Definition | The MessageHeader.id of the message to which this message is a response. |
Cardinality | 1...1 |
Type | id |
Summary | True |
Requirements | Allows receiver to know what message is being responded to. |
Comments | RFC 4122 |
Invariants |
|
Mappings |
|
MessageHeader.response.code | |
Definition | Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not. |
Cardinality | 1...1 |
Type | code |
Binding | The kind of response to a message. |
Summary | True |
Requirements | Allows the sender of the acknowledge message to know if the request was successful or if action is needed. |
Comments | This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus. |
Invariants |
|
Mappings |
|
MessageHeader.response.details | |
Definition | Full details of any issues found in the message. |
Cardinality | 0...1 |
Type | Reference(OperationOutcome) |
Summary | True |
Requirements | Allows the sender of the message to determine what the specific issues are. |
Comments | This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error. |
Invariants |
|
Mappings |
|
MessageHeader.focus | |
Definition | The actual data of the message - a reference to the root/focus class of the event. |
Cardinality | 1...* |
Type | Reference(ERPServiceRequestPrescriptionRequest | ERPServiceRequestDispenseRequest | ERPServiceRequestMessageContainer) |
Must Support | True |
Summary | True |
Requirements | Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources. |
Comments | One Message can contain multiple ServiceRequests which each are identified with an ID. |
Invariants |
|
Mappings |
|
MessageHeader.definition | |
Definition | Permanent link to the MessageDefinition for this message. |
Cardinality | 0...1 |
Type | canonical(MessageDefinition) |
Summary | True |
Requirements | Allows sender to define the expected contents of the message. |
Comments | |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="erp-service-request-request-header" /> <url value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-request-header" /> <version value="1.2" /> <name value="ERPServiceRequestRequestHeader" /> <title value="ERP Service Request Request Header" /> <status value="draft" /> <experimental value="false" /> <date value="2025-01-01" /> <publisher value="gematik GmbH" /> <description value="Header containing information about the sender and addressee" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="MessageHeader" /> <baseDefinition value="https://gematik.de/fhir/atf/StructureDefinition/message-header-app-transport" /> <derivation value="constraint" /> <differential> <element id="MessageHeader.event[x]"> <path value="MessageHeader.event[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> </element> <element id="MessageHeader.event[x]:eventCoding"> <path value="MessageHeader.event[x]" /> <sliceName value="eventCoding" /> <short value="The event code that indicates in which application and which transmission path the communication is currently taking place" /> <comment value="For more information see [ATF ImplementationGuide](https://simplifier.net/app-transport-framework/~guides)" /> <min value="0" /> <max value="1" /> <type> <code value="Coding" /> </type> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vs" /> </binding> </element> <element id="MessageHeader.destination.receiver.identifier"> <path value="MessageHeader.destination.receiver.identifier" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" /> </type> </element> <element id="MessageHeader.sender.identifier"> <path value="MessageHeader.sender.identifier" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" /> </type> </element> <element id="MessageHeader.responsible"> <path value="MessageHeader.responsible" /> <short value="The organization that is responsible for the request." /> <comment value="This organization will be stated in the message header as the sender of the message." /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-organization" /> </type> <mustSupport value="true" /> </element> <element id="MessageHeader.focus"> <path value="MessageHeader.focus" /> <short value="Specification of the ServiceRequest that contains the essential information for a given use case." /> <comment value="One Message can contain multiple ServiceRequests which each are identified with an ID." /> <type> <code value="Reference" /> <targetProfile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-prescription-request" /> <targetProfile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request" /> <targetProfile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-message-container" /> </type> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "erp-service-request-request-header", "url": "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-request-header", "version": "1.2", "name": "ERPServiceRequestRequestHeader", "title": "ERP Service Request Request Header", "status": "draft", "experimental": false, "date": "2025-01-01", "publisher": "gematik GmbH", "description": "Header containing information about the sender and addressee", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "MessageHeader", "baseDefinition": "https://gematik.de/fhir/atf/StructureDefinition/message-header-app-transport", "derivation": "constraint", "differential": { "element": [ { "id": "MessageHeader.event[x]", "path": "MessageHeader.event[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" } }, { "id": "MessageHeader.event[x]:eventCoding", "path": "MessageHeader.event[x]", "sliceName": "eventCoding", "short": "The event code that indicates in which application and which transmission path the communication is currently taking place", "comment": "For more information see [ATF ImplementationGuide](https://simplifier.net/app-transport-framework/~guides)", "min": 0, "max": "1", "type": [ { "code": "Coding" } ], "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vs" } }, { "id": "MessageHeader.destination.receiver.identifier", "path": "MessageHeader.destination.receiver.identifier", "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-telematik-id" ] } ] }, { "id": "MessageHeader.sender.identifier", "path": "MessageHeader.sender.identifier", "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-telematik-id" ] } ] }, { "id": "MessageHeader.responsible", "path": "MessageHeader.responsible", "short": "The organization that is responsible for the request.", "comment": "This organization will be stated in the message header as the sender of the message.", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-organization" ] } ], "mustSupport": true }, { "id": "MessageHeader.focus", "path": "MessageHeader.focus", "short": "Specification of the ServiceRequest that contains the essential information for a given use case.", "comment": "One Message can contain multiple ServiceRequests which each are identified with an ID.", "type": [ { "code": "Reference", "targetProfile": [ "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-prescription-request", "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-dispense-request", "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-message-container" ] } ] } ] } }
Terminologie Bindings
Folgende Bindings sind für diese Ressource spezifiziert:
Path | Conformance | ValueSet |
---|---|---|
MessageHeader.event[x]:eventCoding | required | https://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vs |
Constraints
Folgende Constraints sind für diese Ressource spezifiziert: