{
"description": "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.",
"_filename": "MessageHeader.json",
"package_name": "hl7.fhir.r4.id.core",
"date": "2022-01-10T01:58:17.2910025+00:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2022-01-10T02:13:10.079+00:00"
},
"publisher": "Health Level Seven International (Infrastructure And Messaging)",
"fhirVersion": "4.0.1",
"purpose": "Many implementations are not prepared to use REST and need a messaging based infrastructure.",
"name": "MessageHeader",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "MessageHeader",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Foundation.Other"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 4
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "not-classified"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "inm"
} ],
"status": "draft",
"id": "5232c1bd-0821-4018-80fd-9b8f96d984cd",
"kind": "resource",
"url": "https://fhir.kemkes.go.id/r4/StructureDefinition/MessageHeader",
"version": "4.0.1",
"differential": {
"element": [ {
"id": "MessageHeader",
"path": "MessageHeader",
"short": "A resource that describes a message that is exchanged between systems",
"mapping": [ {
"map": "MSH / MSA / ERR",
"identity": "v2"
}, {
"map": "Message",
"identity": "rim"
} ],
"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."
}, {
"path": "MessageHeader.event[x]",
"requirements": "Drives the behavior associated with this message.",
"min": 1,
"definition": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://terminology.hl7.org/CodeSystem/message-events\". Alternatively uri to the EventDefinition.",
"short": "Code for the event this message represents or link to event definition",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "MSH-9.2",
"identity": "v2"
}, {
"map": "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code",
"identity": "rim"
} ],
"type": [ {
"code": "Coding"
}, {
"code": "uri"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/message-events",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MessageEvent"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "One of the message events defined as part of this version of FHIR."
},
"max": "1",
"id": "MessageHeader.event[x]",
"comment": "The time of the event will be found in the focus resource. The time of the message will be found in [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp).",
"isSummary": true
}, {
"path": "MessageHeader.destination",
"requirements": "Indicates where message is to be sent for routing purposes. Allows verification of \"am I the intended recipient\".",
"definition": "The destination application which the message is intended for.",
"short": "Message destination application(s)",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "./communicationFunction[typeCode=\"RCV\"]",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "MessageDestination"
} ],
"id": "MessageHeader.destination",
"comment": "There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.",
"isSummary": true
}, {
"path": "MessageHeader.destination.name",
"requirements": "May be used for routing of response and/or to support audit.",
"definition": "Human-readable name for the target system.",
"short": "Name of system",
"mapping": [ {
"map": "MSH-5",
"identity": "v2"
}, {
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.destination.name",
"isSummary": true
}, {
"path": "MessageHeader.destination.target",
"requirements": "Supports multi-hop routing.",
"definition": "Identifies the target end system in situations where the initial message transmission is to an intermediary system.",
"short": "Particular delivery destination within the destination",
"mapping": [ {
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device" ]
} ],
"max": "1",
"id": "MessageHeader.destination.target",
"isSummary": true
}, {
"path": "MessageHeader.destination.endpoint",
"requirements": "Identifies where to route the message.",
"min": 1,
"definition": "Indicates where the message should be routed to.",
"short": "Actual destination address or id",
"mapping": [ {
"map": "MSH-25 (or MSH-6)",
"identity": "v2"
}, {
"map": "./telecom",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"max": "1",
"id": "MessageHeader.destination.endpoint",
"comment": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"isSummary": true
}, {
"path": "MessageHeader.destination.receiver",
"requirements": "Allows routing beyond just the application level.",
"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.",
"short": "Intended \"real-world\" recipient for the data",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'",
"identity": "v2"
}, {
"map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "MessageHeader.destination.receiver",
"isSummary": true
}, {
"path": "MessageHeader.sender",
"requirements": "Allows routing beyond just the application level.",
"definition": "Identifies the sending system to allow the use of a trust relationship.",
"short": "Real world sender of the message",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'",
"identity": "v2"
}, {
"map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "MessageHeader.sender",
"comment": "Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.",
"isSummary": true
}, {
"path": "MessageHeader.enterer",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"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.",
"short": "The source of the data entry",
"mapping": [ {
"map": "FiveWs.author",
"identity": "w5"
}, {
"map": "EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10",
"identity": "v2"
}, {
"map": "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\"])",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"max": "1",
"id": "MessageHeader.enterer",
"comment": "Usually only for the request but can be used in a response.",
"isSummary": true
}, {
"path": "MessageHeader.author",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"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.",
"short": "The source of the decision",
"mapping": [ {
"map": "FiveWs.author",
"identity": "w5"
}, {
"map": "ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12",
"identity": "v2"
}, {
"map": "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\"])",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"max": "1",
"id": "MessageHeader.author",
"comment": "Usually only for the request but can be used in a response.",
"isSummary": true
}, {
"path": "MessageHeader.source",
"requirements": "Allows replies, supports audit.",
"min": 1,
"definition": "The source application from which this message originated.",
"short": "Message source application",
"mapping": [ {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "unique(./communicationFunction[typeCode=\"SND\"])",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "MessageSource"
} ],
"max": "1",
"id": "MessageHeader.source",
"isSummary": true
}, {
"path": "MessageHeader.source.name",
"requirements": "May be used to support audit.",
"definition": "Human-readable name for the source system.",
"short": "Name of system",
"mapping": [ {
"map": "MSH-3",
"identity": "v2"
}, {
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.source.name",
"isSummary": true
}, {
"path": "MessageHeader.source.software",
"requirements": "Supports audit and possibly interface engine behavior.",
"definition": "May include configuration or other information useful in debugging.",
"short": "Name of software running the system",
"mapping": [ {
"map": "SFT-3 ( +SFT-1)",
"identity": "v2"
}, {
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.source.software",
"isSummary": true
}, {
"path": "MessageHeader.source.version",
"requirements": "Supports audit and possibly interface engine behavior.",
"definition": "Can convey versions of multiple systems in situations where a message passes through multiple hands.",
"short": "Version of software running",
"mapping": [ {
"map": "SFT-2",
"identity": "v2"
}, {
"map": "(Not supported)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.source.version",
"isSummary": true
}, {
"path": "MessageHeader.source.contact",
"requirements": "Allows escalation of technical issues.",
"definition": "An e-mail, phone, website or other contact point to use to resolve issues with message communications.",
"short": "Human contact for problems",
"mapping": [ {
"map": "(MSH-22?)",
"identity": "v2"
}, {
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "1",
"id": "MessageHeader.source.contact",
"isSummary": true
}, {
"path": "MessageHeader.source.endpoint",
"requirements": "Identifies where to send responses, may influence security permissions.",
"min": 1,
"definition": "Identifies the routing target to send acknowledgements to.",
"short": "Actual message source address or id",
"mapping": [ {
"map": "MSH-24",
"identity": "v2"
}, {
"map": "./telecom[isNormalDatatype()]",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"max": "1",
"id": "MessageHeader.source.endpoint",
"comment": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"isSummary": true
}, {
"path": "MessageHeader.responsible",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"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.",
"short": "Final responsibility for event",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": "ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11",
"identity": "v2"
}, {
"map": "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\"])",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "MessageHeader.responsible",
"comment": "Usually only for the request but can be used in a response.",
"isSummary": true
}, {
"path": "MessageHeader.reason",
"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.",
"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.",
"short": "Cause of event",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "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",
"identity": "v2"
}, {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/message-reason-encounter",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventReason"
} ],
"description": "Reason for event occurrence."
},
"max": "1",
"id": "MessageHeader.reason",
"isSummary": true
}, {
"id": "MessageHeader.response",
"max": "1",
"path": "MessageHeader.response",
"type": [ {
"code": "BackboneElement"
} ],
"short": "If this is a reply to prior message",
"mapping": [ {
"map": "MSA",
"identity": "v2"
}, {
"map": "./conveyedAcknowledgement",
"identity": "rim"
} ],
"isSummary": true,
"definition": "Information about the message that this message is a response to. Only present if this message is a response."
}, {
"path": "MessageHeader.response.identifier",
"requirements": "Allows receiver to know what message is being responded to.",
"min": 1,
"definition": "The MessageHeader.id of the message to which this message is a response.",
"short": "Id of original message",
"mapping": [ {
"map": "MSA-2",
"identity": "v2"
}, {
"map": "./acknowledges.id[isNormalDatatype()]",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "MessageHeader.response.identifier",
"isSummary": true
}, {
"path": "MessageHeader.response.code",
"requirements": "Allows the sender of the acknowledge message to know if the request was successful or if action is needed.",
"min": 1,
"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.",
"short": "ok | transient-error | fatal-error",
"mapping": [ {
"map": "MSA-1",
"identity": "v2"
}, {
"map": "./typeCode[isNormalDatatype()]",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/response-code|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResponseType"
} ],
"description": "The kind of response to a message."
},
"max": "1",
"id": "MessageHeader.response.code",
"comment": "This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.",
"isSummary": true
}, {
"path": "MessageHeader.response.details",
"requirements": "Allows the sender of the message to determine what the specific issues are.",
"definition": "Full details of any issues found in the message.",
"short": "Specific list of hints/warnings/errors",
"mapping": [ {
"map": "ERR",
"identity": "v2"
}, {
"map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/OperationOutcome" ]
} ],
"max": "1",
"id": "MessageHeader.response.details",
"comment": "This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.",
"isSummary": true
}, {
"path": "MessageHeader.focus",
"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.",
"definition": "The actual data of the message - a reference to the root/focus class of the event.",
"short": "The actual content of the message",
"mapping": [ {
"map": "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)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"id": "MessageHeader.focus",
"comment": "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.",
"isSummary": true
}, {
"path": "MessageHeader.definition",
"requirements": "Allows sender to define the expected contents of the message.",
"definition": "Permanent link to the MessageDefinition for this message.",
"short": "Link to the definition for this message",
"mapping": [ {
"map": "Not directly supported.",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/MessageDefinition" ]
} ],
"max": "1",
"id": "MessageHeader.definition",
"isSummary": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/special/committees/inm/index.cfm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}