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