ERP ServiceRequest Request Header

Übersicht über das Profil

NameDescriptionCanonical_URLStatusVersionBasiert auf
ERPServiceRequestRequestHeader

Header containing information about the sender and addressee

https://gematik.de/fhir/erp-servicerequest/StructureDefinition/erp-service-request-request-headerdraft1.2https://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:

idS Σ1..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
CopyToCareFacilityS ?! I0..1Extension(ContactDetail)
modifierExtension?! I0..*Extension
eventUriuri
eventCodingΣ0..1CodingBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameΣ0..1string
targetΣ I0..1Reference(Device)
endpointS Σ1..1url
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierS Σ0..1IdentifierTelematikId
displayS Σ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeΣ0..1uriBinding
identifierS Σ0..1IdentifierTelematikId
displayS Σ1..1string
entererΣ I0..1Reference(Practitioner | PractitionerRole)
authorΣ I0..1Reference(Practitioner | PractitionerRole)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
nameS Σ1..1string
softwareS Σ1..1string
versionS Σ1..1string
id0..1string
extensionI0..*Extension
systemΣ I0..1codeBindingFixed Value
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
endpointS Σ1..1url
responsibleS Σ I1..1Reference(ERPServiceRequestOrganization)
reasonΣ0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifierΣ1..1id
codeΣ1..1codeBinding
detailsΣ I0..1Reference(OperationOutcome)
focusS Σ I1..*Reference(ERPServiceRequestPrescriptionRequest | ERPServiceRequestDispenseRequest | ERPServiceRequestMessageContainer)
definitionΣ0..1canonical(MessageDefinition)
MessageHeader
DefinitionThe 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.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • v2: MSH / MSA / ERR
  • rim: Message
MessageHeader.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
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
DefinitionThe 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.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.implicitRules
DefinitionA 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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MessageHeader.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
MessageHeader.text
DefinitionA 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.
Cardinality0...1
TypeNarrative
Aliasnarrative, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
MessageHeader.contained
DefinitionThese 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.
Cardinality0...*
TypeResource
Aliasinline 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
  • rim: Entity. Role, or Act
  • rim: N/A
MessageHeader.extension
DefinitionMay 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.
Cardinality0...1
TypeExtension
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.extension:CopyToCareFacility
DefinitionOptional Extension Element - found in all resources.
Cardinality0...1
TypeExtension(ContactDetail)
Must SupportTrue
ModifierTrue
Aliasextensions, user content
Comments

If this is set to true, the receiver of the message must be informed that is is a copy and not a request. The receiving system should not allow any further processing of the message.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.event[x]
DefinitionCode 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.
Cardinality1...1
TypeCoding
Binding

One of the message events defined as part of this version of FHIR.

ServiceIdentifierVS (required)
SummaryTrue
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.

SlicingUnordered, Open, by $this(Type)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.what[x]
  • v2: MSH-9.2
  • rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
MessageHeader.event[x]:eventCoding
DefinitionCode 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.
Cardinality0...1
TypeCoding
Binding

One of the message events defined as part of this version of FHIR.

ServiceIdentifierVS (required)
SummaryTrue
Requirements

Drives the behavior associated with this message.

Comments

For more information see ATF ImplementationGuide

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.what[x]
  • v2: MSH-9.2
  • rim: ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code
MessageHeader.destination
DefinitionThe destination application which the message is intended for.
Cardinality1...*
TypeBackboneElement
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.subject[x]
  • rim: ./communicationFunction[typeCode="RCV"]
  • w5: FiveWs.subject
MessageHeader.destination.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.destination.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.destination.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.destination.name
DefinitionHuman-readable name for the target system.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSH-5
  • rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()])
MessageHeader.destination.target
DefinitionIdentifies the target end system in situations where the initial message transmission is to an intermediary system.
Cardinality0...1
TypeReference(Device)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]
MessageHeader.destination.endpoint
DefinitionIndicates where the message should be routed to.
Cardinality1...1
Typeurl
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSH-25 (or MSH-6)
  • rim: ./telecom
MessageHeader.destination.receiver
DefinitionAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole | Organization)
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
  • app-transport-message-header-1: Als Empfänger muss eine Referenz, Displaywert oder Identifier angegeben werden
    reference.exists() or display.exists() or identifier.exists()
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.subject[x]
  • v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
  • rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
  • w5: FiveWs.subject
MessageHeader.destination.receiver.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.destination.receiver.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.destination.receiver.reference
DefinitionA 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.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.destination.receiver.type
DefinitionThe 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).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.destination.receiver.identifier
DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality0...1
TypeIdentifierTelematikId
Must SupportTrue
SummaryTrue
Comments

Bspw. kann hier die Telematik-ID des Empfängers angegeben werden

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
MessageHeader.destination.receiver.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.sender
DefinitionIdentifies the sending system to allow the use of a trust relationship.
Cardinality1...1
TypeReference(Practitioner | PractitionerRole | Organization)
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.subject[x]
  • v2: PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'
  • rim: Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText
  • w5: FiveWs.subject
MessageHeader.sender.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.sender.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.sender.reference
DefinitionA 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.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Comments

Hier kann eine FHIR-Ressource referenziert werden, die den Absender der Nachricht repräsentiert. Bspw. ein Practitioner oder eine Organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.sender.type
DefinitionThe 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).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.sender.identifier
DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality0...1
TypeIdentifierTelematikId
Must SupportTrue
SummaryTrue
Comments

Bspw. kann hier die Telematik-ID des Absenders angegeben werden

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
MessageHeader.sender.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Comments

Es muss mindestens ein Anzeigename angegeben werden, um den Absender der Nachricht anzeigen zu können

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.enterer
DefinitionThe 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.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • v2: EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="ENT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])
MessageHeader.author
DefinitionThe 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.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.author
  • v2: ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode=("DEV", "PSN") and determinerCode="INST"])
MessageHeader.source
DefinitionThe source application from which this message originated.
Cardinality1...1
TypeBackboneElement
Must SupportTrue
SummaryTrue
Requirements

Allows replies, supports audit.

Comments

Diese Infomation ist verpflichtend

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.actor
  • rim: unique(./communicationFunction[typeCode="SND"])
MessageHeader.source.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.source.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.source.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.source.name
DefinitionHuman-readable name for the source system.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

May be used to support audit.

Comments

Diese Infomation ist verpflichtend, um das sendende System identifizieren zu können

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSH-3
  • rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()])
MessageHeader.source.software
DefinitionMay include configuration or other information useful in debugging.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Supports audit and possibly interface engine behavior.

Comments

Diese Infomation ist verpflichtend, um das sendende System identifizieren zu können

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SFT-3 ( +SFT-1)
  • rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()])
MessageHeader.source.version
DefinitionCan convey versions of multiple systems in situations where a message passes through multiple hands.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Supports audit and possibly interface engine behavior.

Comments

Diese Infomation ist verpflichtend, um das sendende System identifizieren zu können

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SFT-2
  • rim: (Not supported)
MessageHeader.source.contact
DefinitionAn e-mail, phone, website or other contact point to use to resolve issues with message communications.
Cardinality1...1
TypeContactPoint
Must SupportTrue
SummaryTrue
Requirements

Allows escalation of technical issues.

Comments

Es ist mindestens eine E-Mail anzugeben, um Kontakt mit dem Hersteller herstellen zu können

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cpt-2: A system is required if a value is provided.
    value.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: XTN
  • rim: TEL
  • servd: ContactPoint
  • v2: (MSH-22?)
  • rim: unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()])
MessageHeader.source.contact.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.source.contact.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.source.contact.system
DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact.
Cardinality0...1
Typecode
Binding

Telecommunications form for contact point.

ContactPointSystem (required)
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

email

Mappings
  • rim: n/a
  • v2: XTN.3
  • rim: ./scheme
  • servd: ./ContactPointType
MessageHeader.source.contact.value
DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.1 (or XTN.12)
  • rim: ./url
  • servd: ./Value
MessageHeader.source.contact.use
DefinitionIdentifies the purpose for the contact point.
Cardinality0...1
Typecode
Binding

Use of contact point.

ContactPointUse (required)
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XTN.2 - but often indicated by field
  • rim: unique(./use)
  • servd: ./ContactPointPurpose
MessageHeader.source.contact.rank
DefinitionSpecifies 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.
Cardinality0...1
TypepositiveInt
SummaryTrue
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: n/a
MessageHeader.source.contact.period
DefinitionTime period when the contact point was/is in use.
Cardinality0...1
TypePeriod
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2: N/A
  • rim: ./usablePeriod[type="IVL<TS>"]
  • servd: ./StartDate and ./EndDate
MessageHeader.source.endpoint
DefinitionIdentifies the routing target to send acknowledgements to.
Cardinality1...1
Typeurl
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSH-24
  • rim: ./telecom[isNormalDatatype()]
MessageHeader.responsible
DefinitionThe 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.
Cardinality1...1
TypeReference(ERPServiceRequestOrganization)
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • v2: ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/player[isNormalEntity() and classCode="PSN" and determinerCode="INST"] or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode="RESP" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()]/scoper[isNormalEntity() and classCode="ORG" and determinerCode="INST"])
MessageHeader.reason
DefinitionCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
Cardinality0...1
TypeCodeableConcept
Binding

Reason for event occurrence.

ExampleMessageReasonCodes (example)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.why[x]
  • v2: EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reasonCode[isNormalDatatype()])
MessageHeader.response
DefinitionInformation about the message that this message is a response to. Only present if this message is a response.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSA
  • rim: ./conveyedAcknowledgement
MessageHeader.response.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
MessageHeader.response.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.response.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
MessageHeader.response.identifier
DefinitionThe MessageHeader.id of the message to which this message is a response.
Cardinality1...1
Typeid
SummaryTrue
Requirements

Allows receiver to know what message is being responded to.

Comments

RFC 4122

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSA-2
  • rim: ./acknowledges.id[isNormalDatatype()]
MessageHeader.response.code
DefinitionCode that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
Cardinality1...1
Typecode
Binding

The kind of response to a message.

ResponseType (required)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: MSA-1
  • rim: ./typeCode[isNormalDatatype()]
MessageHeader.response.details
DefinitionFull details of any issues found in the message.
Cardinality0...1
TypeReference(OperationOutcome)
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2: ERR
  • rim: AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"]
MessageHeader.focus
DefinitionThe actual data of the message - a reference to the root/focus class of the event.
Cardinality1...*
TypeReference(ERPServiceRequestPrescriptionRequest | ERPServiceRequestDispenseRequest | ERPServiceRequestMessageContainer)
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/participation[typeCode="SUBJ" and isNormalParticipation]/role or ./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/outboundRelationship[typeCode="SBJ" and isNormalActRelatoinship]/target)
MessageHeader.definition
DefinitionPermanent link to the MessageDefinition for this message.
Cardinality0...1
Typecanonical(MessageDefinition)
SummaryTrue
Requirements

Allows sender to define the expected contents of the message.

Comments

see Canonical References

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: Not directly supported.
<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.extension">
            <path value="MessageHeader.extension" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="MessageHeader.extension:CopyToCareFacility">
            <path value="MessageHeader.extension" />
            <sliceName value="CopyToCareFacility" />
            <short value="The contact details of the care facility that receives a copy of the request." />
            <comment value="If this is set to true, the receiver of the message must be informed that is is a copy and not a request. The receiving system should not allow any further processing of the message." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://gematik.de/fhir/erp-servicerequest/StructureDefinition/copy-to-care-facility-ex" />
            </type>
            <mustSupport value="true" />
            <isModifier value="true" />
        </element>
        <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.extension",
                "path": "MessageHeader.extension",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "MessageHeader.extension:CopyToCareFacility",
                "path": "MessageHeader.extension",
                "sliceName": "CopyToCareFacility",
                "short": "The contact details of the care facility that receives a copy of the request.",
                "comment": "If this is set to true, the receiver of the message must be informed that is is a copy and not a request. The receiving system should not allow any further processing of the message.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://gematik.de/fhir/erp-servicerequest/StructureDefinition/copy-to-care-facility-ex"
                        ]
                    }
                ],
                "mustSupport": true,
                "isModifier": true
            },
            {
                "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:

PathConformanceValueSet
MessageHeader.event[x]:eventCodingrequiredhttps://gematik.de/fhir/erp-servicerequest/ValueSet/service-identifier-vs

Constraints

Folgende Constraints sind für diese Ressource spezifiziert: