Details
| 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 | 0...1 |
| Type | id |
| 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 may not always be associated with version changes to the resource. |
| Cardinality | 0...1 |
| Type | Meta |
| Summary | True |
| 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. |
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| MessageHeader.language | |
| Definition | The base language in which the resource is written. |
| Cardinality | 0...1 |
| Type | code |
| Binding | A human language. Common Languages (extensible) |
| 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). |
| MessageHeader.text | |
| Definition | A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later. |
| 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. |
| Mappings |
|
| MessageHeader.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
| 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. |
| 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. Usually modifier elements provide negation or qualification. In order 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. |
| Cardinality | 0...* |
| Type | Extension |
| Modifier | True |
| 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. |
| Mappings |
|
| MessageHeader.event | |
| 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://hl7.org/fhir/message-events". |
| Cardinality | 1...1 |
| Type | Coding |
| Binding | One of the message events defined as part of FHIR. messageHeaderEvents (required) |
| Summary | True |
| Requirements | Drives the behavior associated with this message. |
| Mappings |
|
| MessageHeader.event.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.event.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| 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) |
| Mappings |
|
| MessageHeader.event.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Cardinality | 0...1 |
| Type | uri |
| Summary | True |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
| Mappings |
|
| MessageHeader.event.version | |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Cardinality | 0...1 |
| Type | string |
| Summary | True |
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
| Mappings |
|
| MessageHeader.event.code | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Cardinality | 0...1 |
| Type | code |
| Summary | True |
| Requirements | Need to refer to a particular code in the system. |
| Mappings |
|
| MessageHeader.event.display | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Cardinality | 0...1 |
| Type | string |
| Summary | True |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Mappings |
|
| MessageHeader.event.userSelected | |
| Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
| Cardinality | 0...1 |
| Type | boolean |
| Summary | True |
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
| Mappings |
|
| MessageHeader.destination | |
| Definition | The destination application which the message is intended for. |
| Cardinality | 0...* |
| Type | BackboneElement |
| 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. In order 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. |
| 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. |
| 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
| Cardinality | 0...* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| 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. |
| 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. |
| 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. |
| Mappings |
|
| MessageHeader.destination.endpoint | |
| Definition | Indicates where the message should be routed to. |
| Cardinality | 1...1 |
| Type | uri |
| Summary | True |
| Requirements | Identifies where to route the message. |
| Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses. |
| Mappings |
|
| MessageHeader.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 | Organization) |
| Summary | True |
| Requirements | Allows routing beyond just the application level. |
| Mappings |
|
| MessageHeader.sender | |
| Definition | Identifies the sending system to allow the use of a trust relationship. |
| Cardinality | 0...1 |
| Type | Reference(Practitioner | Organization) |
| 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. |
| Mappings |
|
| MessageHeader.timestamp | |
| Definition | The time that the message was sent. |
| Cardinality | 1...1 |
| Type | instant |
| Summary | True |
| Requirements | Allows limited detection of out-of-order and delayed transmission. Also supports audit. |
| 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) |
| 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. |
| 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) |
| 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. |
| Mappings |
|
| MessageHeader.source | |
| Definition | The source application from which this message originated. |
| Cardinality | 1...1 |
| Type | BackboneElement |
| Summary | True |
| Requirements | Allows replies, supports audit. |
| 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. In order 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. |
| 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. |
| 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
| Cardinality | 0...* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| 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. |
| Mappings |
|
| MessageHeader.source.name | |
| Definition | Human-readable name for the source system. |
| Cardinality | 0...1 |
| Type | string |
| Summary | True |
| Requirements | May be used to support audit. |
| Mappings |
|
| MessageHeader.source.software | |
| Definition | May include configuration or other information useful in debugging. |
| Cardinality | 0...1 |
| Type | string |
| Summary | True |
| Requirements | Supports audit and possibly interface engine behavior. |
| Mappings |
|
| MessageHeader.source.version | |
| Definition | Can convey versions of multiple systems in situations where a message passes through multiple hands. |
| Cardinality | 0...1 |
| Type | string |
| Summary | True |
| Requirements | Supports audit and possibly interface engine behavior. |
| Mappings |
|
| MessageHeader.source.contact | |
| Definition | An e-mail, phone, website or other contact point to use to resolve issues with message communications. |
| Cardinality | 0...1 |
| Type | ContactPoint |
| Summary | True |
| Requirements | Allows escalation of technical issues. |
| Mappings |
|
| MessageHeader.source.endpoint | |
| Definition | Actual endpoint: "https://uudev-internal.rochedc.accentureanalytics.com/fhirmsg/rdc/v1.0.0/$process-message" |
| Cardinality | 1...1 |
| Type | uri |
| Summary | True |
| Requirements | Identifies where to send responses, may influence security permissions. |
| Comments | The id may be a non-resolvable URI for systems that do not use standard network-based addresses. |
| 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 | 0...1 |
| Type | Reference(Practitioner | Organization) |
| 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. |
| 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 Example Message Reason Codes (example) |
| 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. |
| 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. In order 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. |
| 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. |
| 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. |
| Cardinality | 0...* |
| Type | Extension |
| Modifier | True |
| Summary | True |
| Alias | extensions, user content, modifiers |
| 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. |
| 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. |
| 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 ResponseType (required) |
| 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. |
| 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. |
| Mappings |
|
| MessageHeader.focus | |
| Definition | The actual data of the message - a reference to the root/focus class of the event. |
| Cardinality | 0...* |
| Type | Reference(Resource) |
| 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 | The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets. |
| Mappings |
|