The formal definitions for the elements in the message resource. Also available as an XML file.
| Message |
| Definition | A transmission requesting action on a bundle of one or more resources or a response to such a request |
| Control | 1..1 |
| Requirements | Many implementations are not prepared to use REST, and need a message based infrastructure |
| RIM Mapping | Message |
| v2 Mapping | MSH |
| Message.id |
| Definition | The identifier of this message |
| Control | 1..1 |
| Type | id |
| Must Understand | true |
| Comments | This must be unique within the scope of this stream of messages |
| RIM Mapping | Message.id |
| Message.instant |
| Definition | Instant the message was sent |
| Control | 1..1 |
| Type | instant |
| Must Understand | true |
| Requirements | Allows limited detection of out-of-order and delayed transmission. Also supports audit. |
| RIM Mapping | ./creationTime[isNormalDatatype()] |
| v2 Mapping | MSH.7 |
| Message.event |
| Definition | Code that identifies the event this message represents, and connects it with the event definition in the FHIR specification |
| Control | 1..1 |
| Type | code from MessageEvent |
| Must Understand | true |
| Requirements | Drives the behavior associated with this message |
| RIM Mapping | ./payload[classCode="CACT" and moodCode="EVN" and isNormalAct()]/code[isNormalDatatype()]/code |
| v2 Mapping | MSH.9.2 |
| To Do | Consider changing to Coding to support profile-defined events |
| Message.response |
| Definition | Information about the message that this message is a response to. Only present if this message is a response. |
| Control | 0..1 |
| Must Understand | true |
| RIM Mapping | ./conveyedAcknowledgement |
| v2 Mapping | MSA |
| Message.response.id |
| Definition | The id of the message that this a response to |
| Control | 1..1 |
| Type | id |
| Must Understand | true |
| Requirements | Allows receiver to know what message is being responded to |
| RIM Mapping | ./acknowledges.id[isNormalDatatype()] |
| v2 Mapping | MSA.2 |
| Message.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 |
| Control | 1..1 |
| Type | code from ResponseCode |
| Must Understand | 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 Message.data |
| RIM Mapping | ./typeCode[isNormalDatatype()] |
| v2 Mapping | MSA.1 | |
| Message.response.details |
| Definition | Full details of any issues found in the message |
| Control | 0..1 |
| Type | Resource(IssueReport) |
| Requirements | Allows the sender of the message to determine what the specific issues are |
| Comments | This must be contained in the bundle. If any of the issues are errors, the response code must be an error |
| RIM Mapping | AcknowledgementDetail or Observation[classCode="ALRT" and moodCode="EVN"] |
| v2 Mapping | ERR |
| Message.source |
| Definition | The source application from which this message originated |
| Control | 1..1 |
| Requirements | Allows replies, supports audit. |
| RIM Mapping | unique(./communicationFunction[typeCode="SND"]) |
| v2 Mapping | NA |
| Message.source.name |
| Definition | Human readable name for the target system |
| Control | 0..1 |
| Type | string |
| Requirements | May be used to support audit |
| RIM Mapping | unique(./entity[determinerCode="INST" and classCode="DEV"]/name[type='ST' and isNormalDatatype()]) |
| v2 Mapping | (Not supported) |
| Message.source.software |
| Definition | May include configuration or other information useful in debugging. |
| Control | 1..1 |
| Type | string |
| Requirements | Supports audit and possibly interface engine behavior |
| RIM Mapping | unique(./entity[determinerCode="INST" and classCode="DEV"]/softwareName[isNormalDatatype()]) |
| v2 Mapping | SFT.3 |
| Message.source.version |
| Definition | Can convey versions of multiple systems in situations where a message passes through multiple hands. |
| Control | 0..1 |
| Type | string |
| Requirements | Supports audit and possibly interface engine behavior |
| RIM Mapping | (Not supported) |
| v2 Mapping | SFT.4 |
| Message.source.contact |
| Definition | An e-mail, phone, website or other contact point to use to resolve issues with message communications. |
| Control | 0..1 |
| Type | Contact |
| Requirements | Allows escalation of technical issues. |
| RIM Mapping | unique(./entity[determinerCode="INST" and classCode="DEV"]/scopesRole[normalRole() and classCode="CON" and layer[classCode="PSN"]/telecom[isNormalDatatype()]) |
| v2 Mapping | (Not supported) |
| Message.source.endpoint |
| Definition | Identifies the routing target to send acknowledgements to. |
| Control | 1..1 |
| Type | uri |
| 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 |
| RIM Mapping | ./telecom[isNormalDatatype()] |
| v2 Mapping | (Not supported) |
| Message.destination |
| Definition | The destination application which the message is intended for |
| Control | 1..1 |
| Requirements | Indicates where message is to be sent to for routing purposes. Allows verification of "am I the intended recipient" |
| RIM Mapping | ./communicationFunction[typeCode="RCV"] |
| v2 Mapping | NA |
| Message.destination.name |
| Definition | Human readable name for the source system |
| Control | 0..1 |
| Type | string |
| Requirements | May be used for routing of response and/or to support audit |
| RIM Mapping | unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"]/name[type='ST' and isNormalDatatype()]) |
| v2 Mapping | (Not supported) |
| Message.destination.target |
| Definition | Identifies the target end system in situations where the initial message transmission is to an intermediary system. |
| Control | 0..1 |
| Type | Resource(Device) |
| Requirements | Supports multi-hop routing |
| RIM Mapping | unique(./entity[determinerCode="INST" and (classCode=("DEV", "PSN", "ORG"] |
| v2 Mapping | varies |
| Message.destination.endpoint |
| Definition | Indicates where the message should be routed to. |
| Control | 1..1 |
| Type | uri |
| 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 |
| RIM Mapping | ./telecom |
| v2 Mapping | (Not supported) |
| Message.enterer |
| Definition | The person or device that performed the data entry leading to this Message. Where there is more than one candidate, pick the most proximal to the Message. Can provide other enterers in extensions |
| Control | 0..1 |
| Type | Resource(Agent) |
| 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 |
| RIM Mapping | 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"]) |
| v2 Mapping | ROL where ROL.3 is EP or ORC.10 |
| Message.author |
| Definition | The logical author of the message - the person or device that decided the described event should happen. Where there is more than one candidate, pick the most proximal to the Message. Can provide other authors in extensions |
| Control | 0..1 |
| Type | Resource(Agent) |
| 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 |
| RIM Mapping | 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"]) |
| v2 Mapping | ROL where ROL.3 is IP or ORC.12 |
| Message.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. |
| Control | 0..1 |
| Type | Resource(Person|Organization) |
| Requirements | Allows routing beyond just to the application level |
| Message.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 |
| Control | 0..1 |
| Type | Resource(Agent|Organization) |
| 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 |
| RIM Mapping | 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"]) |
| v2 Mapping | ROL where ROL.3 is RO or ORC.11 |
| Message.effective |
| Definition | The effective time - the real world time of the event that the message represents. Usually this is just a starting time, but some message events also have an end time (do x for period y) |
| Control | 0..1 |
| Type | Period |
| Requirements | Need to know for understanding the content of the message, may govern receiver's behavior. |
| Comments | Usually only for the request, but can be used in a response |
| RIM Mapping | unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/effectiveTime[isNormalDatatype() and type="IVL_TS"]) |
| v2 Mapping | EVN.3 or EVN.6 or ORC.15 |
| To Do | Grahame thinks this is not 80/20. Also, that it really should be domain modeled, not tucked away here |
| Message.reason |
| Definition | The cause of the event - a reason for the event that is a focus of this message occurred |
| Control | 0..1 |
| Type | CodeableConcept from EventReason |
| 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. |
| RIM Mapping | unique(./controlAct[classCode="CACT" and classCode="EVN" and isNormalAct()]/reasonCode[isNormalDatatype()]) |
| v2 Mapping | EVN.4 or ORC.16 |
| Message.data |
| Definition | The actual data of the message - a reference to the root/focus class of the event. |
| Control | 0..* |
| Type | Resource(Any) |
| Must Understand | 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 tree of referenced resources conveyed in the atom feed is determined by navigating the tree and consulting the "bundled" property of the profile, not by listing all resources here. Multiple repetitions are provided for merges and other situations with multiple focal targets |
| RIM Mapping | 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) |
| v2 Mapping | varies |
| Message.extension |
| Definition | See Extensions |
| Control | 0..* |
| Type | Extension |
| RIM Mapping | varies |
| v2 Mapping | varies |
| Message.text |
| Definition | |
| Control | 1..1 |
| Type | Narrative |
| RIM Mapping | (Not supported) |
| v2 Mapping | (Not supported) |
This is an old version of FHIR retained for archive purposes. Do not use for anything else