R4 Ballot #1 (Mixed Normative/Trial use)
FoundationThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| Infrastructure And Messaging Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Practitioner |
StructureDefinition for messageheader
{
"resourceType": "StructureDefinition",
"id": "MessageHeader",
"meta": {
"lastUpdated": "2018-04-03T12:05:46.262+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
"valueString": "Trial Use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "inm"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
"name": "MessageHeader",
"status": "draft",
"date": "2018-04-03T12:05:46+10: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": "3.3.0",
"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"
}
],
"kind": "resource",
"abstract": false,
"type": "MessageHeader",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"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.",
"min": 0,
"max": "*",
"base": {
"path": "MessageHeader",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "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",
"expression": "contained.all(('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "MSH / MSA / ERR"
},
{
"identity": "rim",
"map": "Message"
}
]
},
{
"id": "MessageHeader.id",
"path": "MessageHeader.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "MessageHeader.meta",
"path": "MessageHeader.meta",
"short": "Metadata about the resource",
"definition": "The 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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "MessageHeader.implicitRules",
"path": "MessageHeader.implicitRules",
"short": "A set of rules under which this content was created",
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "MessageHeader.language",
"path": "MessageHeader.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "MessageHeader.text",
"path": "MessageHeader.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A 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.",
"comment": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "MessageHeader.contained",
"path": "MessageHeader.contained",
"short": "Contained, inline Resources",
"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.",
"comment": "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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MessageHeader.extension",
"path": "MessageHeader.extension",
"short": "Additional Content defined by implementations",
"definition": "May 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MessageHeader.modifierExtension",
"path": "MessageHeader.modifierExtension",
"short": "Extensions that cannot be ignored",
"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. 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "Not known why this is labelled a modifier",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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://hl7.org/fhir/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",
"base": {
"path": "MessageHeader.event[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Coding"
},
{
"code": "uri"
}
],
"isModifier": false,
"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.",
"valueSetCanonical": "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\".",
"min": 0,
"max": "*",
"base": {
"path": "MessageHeader.destination",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "rim",
"map": "./communicationFunction[typeCode=\"RCV\"]"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "MessageHeader.destination.id",
"path": "MessageHeader.destination.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MessageHeader.destination.extension",
"path": "MessageHeader.destination.extension",
"short": "Additional content defined by implementations",
"definition": "May 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MessageHeader.destination.modifierExtension",
"path": "MessageHeader.destination.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 in which it is contained. 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.",
"comment": "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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.destination.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.destination.target",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Device"
]
}
],
"isModifier": false,
"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",
"base": {
"path": "MessageHeader.destination.endpoint",
"min": 1,
"max": "1"
},
"type": [
{
"code": "url"
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.destination.receiver",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.sender",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.enterer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.author",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"isModifier": false,
"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",
"base": {
"path": "MessageHeader.source",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"identity": "rim",
"map": "unique(./communicationFunction[typeCode=\"SND\"])"
}
]
},
{
"id": "MessageHeader.source.id",
"path": "MessageHeader.source.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MessageHeader.source.extension",
"path": "MessageHeader.source.extension",
"short": "Additional content defined by implementations",
"definition": "May 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MessageHeader.source.modifierExtension",
"path": "MessageHeader.source.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 in which it is contained. 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.",
"comment": "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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.source.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.source.software",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.source.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.source.contact",
"min": 0,
"max": "1"
},
"type": [
{
"code": "ContactPoint"
}
],
"isModifier": false,
"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",
"base": {
"path": "MessageHeader.source.endpoint",
"min": 1,
"max": "1"
},
"type": [
{
"code": "url"
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.responsible",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.reason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventReason"
}
],
"strength": "example",
"description": "Reason for event occurrence",
"valueSetCanonical": "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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.response",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "MSA"
},
{
"identity": "rim",
"map": "./conveyedAcknowledgement"
}
]
},
{
"id": "MessageHeader.response.id",
"path": "MessageHeader.response.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MessageHeader.response.extension",
"path": "MessageHeader.response.extension",
"short": "Additional content defined by implementations",
"definition": "May 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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MessageHeader.response.modifierExtension",
"path": "MessageHeader.response.modifierExtension",
"short": "Extensions that cannot be ignored",
"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 in which it is contained. 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.",
"comment": "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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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",
"base": {
"path": "MessageHeader.response.identifier",
"min": 1,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isModifier": false,
"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",
"base": {
"path": "MessageHeader.response.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResponseType"
}
],
"strength": "required",
"description": "The kind of response to a message",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/response-code"
},
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.response.details",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/OperationOutcome"
]
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "*",
"base": {
"path": "MessageHeader.focus",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Resource"
]
}
],
"isModifier": false,
"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.",
"min": 0,
"max": "1",
"base": {
"path": "MessageHeader.definition",
"min": 0,
"max": "1"
},
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/MessageDefinition"
]
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Not directly supported."
}
]
}
]
},
"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.",
"min": 0,
"max": "*",
"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://hl7.org/fhir/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.",
"valueSetCanonical": "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\".",
"min": 0,
"max": "*",
"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.",
"min": 0,
"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.",
"min": 0,
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"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.",
"min": 0,
"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.",
"min": 0,
"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.",
"min": 0,
"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.",
"min": 0,
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner",
"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.",
"min": 0,
"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",
"valueSetCanonical": "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.",
"min": 0,
"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",
"valueSetCanonical": "http://hl7.org/fhir/ValueSet/response-code"
},
"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.",
"min": 0,
"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.",
"min": 0,
"max": "*",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "canonical",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/MessageDefinition"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "Not directly supported."
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:16+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change