{
"description": null,
"_filename": "StructureDefinition-BSeR-Referral-Response-Message-Header.json",
"package_name": "hl7.fhir.us.bser",
"date": "2019-03-27T07:29:43+11:00",
"derivation": "constraint",
"publisher": null,
"fhirVersion": "3.0.1",
"name": "BSeR Referral Response Message Header",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "MessageHeader",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.2.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "MessageHeader",
"min": 0,
"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.",
"short": "A resource that describes a message that is exchanged between systems",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "MSH / MSA / ERR",
"identity": "v2"
}, {
"map": "Message",
"identity": "rim"
}, {
"map": "infrastructure.exchange",
"identity": "w5"
} ],
"max": "*",
"id": "MessageHeader",
"base": {
"max": "*",
"min": 0,
"path": "MessageHeader"
}
}, {
"path": "MessageHeader.id",
"min": 0,
"definition": "MAY contain zero or one [0..1] id (CONF:4383-701).",
"short": "id",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "MessageHeader.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "MessageHeader.meta",
"min": 0,
"definition": "MAY contain zero or one [0..1] meta (CONF:4383-700).",
"short": "meta",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "MessageHeader.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "MessageHeader.meta.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.meta.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "MessageHeader.meta.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MessageHeader.meta.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MessageHeader.meta.versionId",
"min": 0,
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"short": "Version specific identifier",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "MessageHeader.meta.versionId",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.versionId"
},
"isSummary": true
}, {
"path": "MessageHeader.meta.lastUpdated",
"min": 0,
"definition": "When the resource last changed - e.g. when the version changed.",
"short": "When the resource version last changed",
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "MessageHeader.meta.lastUpdated",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"base": {
"max": "1",
"min": 0,
"path": "Meta.lastUpdated"
},
"isSummary": true
}, {
"path": "MessageHeader.meta.profile",
"min": 1,
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/bser/StructureDefinition/nullBSeR-Referral-Response-Message-Header\" (CONF:4383-702).",
"short": "profile",
"type": [ {
"code": "uri"
} ],
"patternString": "http://hl7.org/fhir/us/bser/StructureDefinition/nullBSeR-Referral-Response-Message-Header",
"max": "1",
"id": "MessageHeader.meta.profile",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.profile"
},
"isSummary": true
}, {
"path": "MessageHeader.meta.security",
"min": 0,
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"short": "Security Labels applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "MessageHeader.meta.security",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.security"
},
"isSummary": true
}, {
"path": "MessageHeader.meta.tag",
"min": 0,
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"short": "Tags applied to this resource",
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
} ],
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags"
}
},
"max": "*",
"id": "MessageHeader.meta.tag",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"base": {
"max": "*",
"min": 0,
"path": "Meta.tag"
},
"isSummary": true
}, {
"path": "MessageHeader.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "MessageHeader.implicitRules",
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "MessageHeader.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"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
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "MessageHeader.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "MessageHeader.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "MessageHeader.text",
"condition": [ "dom-1" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "MessageHeader.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "MessageHeader.contained",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "MessageHeader.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MessageHeader.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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "MessageHeader.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MessageHeader.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "MessageHeader.event",
"requirements": "Drives the behavior associated with this message.",
"min": 1,
"definition": "SHALL contain exactly one [1..1] event, which SHALL be selected from ValueSet message-events http://hl7.org/fhir/ValueSet/message-events DYNAMIC (CONF:4383-707).",
"short": "event",
"mapping": [ {
"map": "MSH-9.2",
"identity": "v2"
}, {
"map": "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code",
"identity": "rim"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-events"
}
},
"max": "1",
"id": "MessageHeader.event",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.event"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "MessageHeader.destination",
"requirements": "Indicates where message is to be sent for routing purposes. Allows verification of \"am I the intended recipient\".",
"min": 0,
"definition": "The destination application which the message is intended for.",
"short": "Message destination application(s)",
"mapping": [ {
"map": "./communicationFunction[typeCode=\"RCV\"]",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "MessageDestination"
} ],
"max": "*",
"id": "MessageHeader.destination",
"comment": "There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.",
"base": {
"max": "*",
"min": 0,
"path": "MessageHeader.destination"
},
"isSummary": true
}, {
"path": "MessageHeader.destination.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.destination.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "MessageHeader.destination.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MessageHeader.destination.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MessageHeader.destination.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "MessageHeader.destination.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "MessageHeader.destination.name",
"requirements": "May be used for routing of response and/or to support audit.",
"min": 0,
"definition": "Human-readable name for the target system.",
"short": "Name of system",
"mapping": [ {
"map": "MSH-5",
"identity": "v2"
}, {
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]/name[type='ST' and isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.destination.name",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.destination.name"
},
"isSummary": true
}, {
"path": "MessageHeader.destination.target",
"requirements": "Supports multi-hop routing.",
"min": 0,
"definition": "Identifies the target end system in situations where the initial message transmission is to an intermediary system.",
"short": "Particular delivery destination within the destination",
"mapping": [ {
"map": "unique(./entity[determinerCode=\"INST\" and (classCode=(\"DEV\", \"PSN\", \"ORG\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
} ],
"max": "1",
"id": "MessageHeader.destination.target",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.destination.target"
},
"isSummary": true
}, {
"path": "MessageHeader.destination.endpoint",
"requirements": "Identifies where to route the message.",
"min": 1,
"definition": "Indicates where the message should be routed to.",
"short": "Actual destination address or id",
"mapping": [ {
"map": "MSH-25 (or MSH-6)",
"identity": "v2"
}, {
"map": "./telecom",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "MessageHeader.destination.endpoint",
"comment": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.destination.endpoint"
},
"isSummary": true
}, {
"path": "MessageHeader.receiver",
"requirements": "Allows routing beyond just the application level.",
"min": 0,
"definition": "MAY contain zero or one [0..1] receiver (CONF:4383-703).",
"short": "receiver",
"mapping": [ {
"map": "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'",
"identity": "v2"
}, {
"map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "MessageHeader.receiver",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.receiver"
},
"isSummary": true
}, {
"path": "MessageHeader.receiver.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.receiver.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "MessageHeader.receiver.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MessageHeader.receiver.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MessageHeader.receiver.reference",
"min": 1,
"definition": "The receiver, if present, SHALL contain exactly one [1..1] reference=\"BSeR Referral Initiator\" (CONF:4383-708).",
"short": "reference",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"patternString": "BSeR Referral Initiator",
"max": "1",
"id": "MessageHeader.receiver.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MessageHeader.receiver.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "MessageHeader.receiver.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MessageHeader.receiver.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MessageHeader.receiver.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "MessageHeader.sender",
"requirements": "Allows routing beyond just the application level.",
"min": 0,
"definition": "MAY contain zero or one [0..1] sender (CONF:4383-704).",
"short": "sender",
"mapping": [ {
"map": "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'",
"identity": "v2"
}, {
"map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "MessageHeader.sender",
"comment": "Use case is for where a (trusted) sending system is responsible for multiple organizations, and therefore cannot differentiate based on source endpoint / authentication alone.",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.sender"
},
"isSummary": true
}, {
"path": "MessageHeader.sender.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.sender.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "MessageHeader.sender.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MessageHeader.sender.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MessageHeader.sender.reference",
"min": 1,
"definition": "The sender, if present, SHALL contain exactly one [1..1] reference=\"BSeR Referral Recipient\" (CONF:4383-709).",
"short": "reference",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"patternString": "BSeR Referral Recipient",
"max": "1",
"id": "MessageHeader.sender.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MessageHeader.sender.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "MessageHeader.sender.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MessageHeader.sender.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MessageHeader.sender.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "MessageHeader.timestamp",
"requirements": "Allows limited detection of out-of-order and delayed transmission. Also supports audit.",
"min": 1,
"definition": "SHALL contain exactly one [1..1] timestamp (CONF:4383-710).",
"short": "timestamp",
"mapping": [ {
"map": "MSH-7",
"identity": "v2"
}, {
"map": "./creationTime[isNormalDatatype()]",
"identity": "rim"
}, {
"map": "when.init",
"identity": "w5"
} ],
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "MessageHeader.timestamp",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.timestamp"
},
"isSummary": true
}, {
"path": "MessageHeader.enterer",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 0,
"definition": "The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.",
"short": "The source of the data entry",
"mapping": [ {
"map": "EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10",
"identity": "v2"
}, {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"ENT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])",
"identity": "rim"
}, {
"map": "who.author",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"max": "1",
"id": "MessageHeader.enterer",
"comment": "Usually only for the request, but can be used in a response.",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.enterer"
},
"isSummary": true
}, {
"path": "MessageHeader.author",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 0,
"definition": "The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.",
"short": "The source of the decision",
"mapping": [ {
"map": "ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12",
"identity": "v2"
}, {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])",
"identity": "rim"
}, {
"map": "who.author",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"max": "1",
"id": "MessageHeader.author",
"comment": "Usually only for the request, but can be used in a response.",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.author"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "MessageHeader.source",
"requirements": "Allows replies, supports audit.",
"min": 1,
"definition": "SHALL contain exactly one [1..1] source (CONF:4383-705).",
"short": "source",
"mapping": [ {
"map": "unique(./communicationFunction[typeCode=\"SND\"])",
"identity": "rim"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "MessageSource"
} ],
"max": "1",
"id": "MessageHeader.source",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.source"
},
"isSummary": true
}, {
"path": "MessageHeader.source.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.source.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "MessageHeader.source.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MessageHeader.source.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MessageHeader.source.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "MessageHeader.source.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "MessageHeader.source.name",
"requirements": "May be used to support audit.",
"min": 0,
"definition": "This source MAY contain zero or one [0..1] name (CONF:4383-711).",
"short": "name",
"mapping": [ {
"map": "MSH-3",
"identity": "v2"
}, {
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.source.name",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.source.name"
},
"isSummary": true
}, {
"path": "MessageHeader.source.software",
"requirements": "Supports audit and possibly interface engine behavior.",
"min": 0,
"definition": "May include configuration or other information useful in debugging.",
"short": "Name of software running the system",
"mapping": [ {
"map": "SFT-3 ( +SFT-1)",
"identity": "v2"
}, {
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/softwareName[isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.source.software",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.source.software"
},
"isSummary": true
}, {
"path": "MessageHeader.source.version",
"requirements": "Supports audit and possibly interface engine behavior.",
"min": 0,
"definition": "Can convey versions of multiple systems in situations where a message passes through multiple hands.",
"short": "Version of software running",
"mapping": [ {
"map": "SFT-2",
"identity": "v2"
}, {
"map": "(Not supported)",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.source.version",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.source.version"
},
"isSummary": true
}, {
"path": "MessageHeader.source.contact",
"requirements": "Allows escalation of technical issues.",
"min": 0,
"definition": "An e-mail, phone, website or other contact point to use to resolve issues with message communications.",
"short": "Human contact for problems",
"mapping": [ {
"map": "(MSH-22?)",
"identity": "v2"
}, {
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/scopesRole[normalRole() and classCode=\"CON\" and layer[classCode=\"PSN\"]/telecom[isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "1",
"id": "MessageHeader.source.contact",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.source.contact"
},
"isSummary": true
}, {
"path": "MessageHeader.source.endpoint",
"requirements": "Identifies where to send responses, may influence security permissions.",
"min": 1,
"definition": "This source SHALL contain exactly one [1..1] endpoint (CONF:4383-712).",
"short": "endpoint",
"mapping": [ {
"map": "MSH-24",
"identity": "v2"
}, {
"map": "./telecom[isNormalDatatype()]",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "MessageHeader.source.endpoint",
"comment": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.source.endpoint"
},
"isSummary": true
}, {
"path": "MessageHeader.responsible",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 0,
"definition": "The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.",
"short": "Final responsibility for event",
"mapping": [ {
"map": "ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11",
"identity": "v2"
}, {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=\"PSN\" and determinerCode=\"INST\"] or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/scoper[isNormalEntity() and classCode=\"ORG\" and determinerCode=\"INST\"])",
"identity": "rim"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "MessageHeader.responsible",
"comment": "Usually only for the request, but can be used in a response.",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.responsible"
},
"isSummary": true
}, {
"path": "MessageHeader.reason",
"requirements": "Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.",
"min": 1,
"definition": "SHALL contain exactly one [1..1] reason, which SHALL be selected from ValueSet message-reason-encounter http://hl7.org/fhir/ValueSet/message-reason-encounter DYNAMIC (CONF:4383-713).",
"short": "reason",
"mapping": [ {
"map": "EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication",
"identity": "v2"
}, {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-reason-encounter"
}
},
"max": "1",
"id": "MessageHeader.reason",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.reason"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "MessageHeader.response",
"min": 0,
"definition": "MAY contain zero or one [0..1] response (CONF:4383-706).",
"short": "response",
"mapping": [ {
"map": "MSA",
"identity": "v2"
}, {
"map": "./conveyedAcknowledgement",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "MessageHeader.response",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.response"
},
"isSummary": true
}, {
"path": "MessageHeader.response.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.response.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "MessageHeader.response.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MessageHeader.response.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MessageHeader.response.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "MessageHeader.response.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "MessageHeader.response.identifier",
"requirements": "Allows receiver to know what message is being responded to.",
"min": 1,
"definition": "The response, if present, SHALL contain exactly one [1..1] identifier (CONF:4383-714).",
"short": "identifier",
"mapping": [ {
"map": "MSA-2",
"identity": "v2"
}, {
"map": "./acknowledges.id[isNormalDatatype()]",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "MessageHeader.response.identifier",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.response.identifier"
},
"isSummary": true
}, {
"path": "MessageHeader.response.code",
"requirements": "Allows the sender of the acknowledge message to know if the request was successful or if action is needed.",
"min": 1,
"definition": "The response, if present, SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet response-code http://hl7.org/fhir/ValueSet/response-code DYNAMIC (CONF:4383-715).",
"short": "code",
"mapping": [ {
"map": "MSA-1",
"identity": "v2"
}, {
"map": "./typeCode[isNormalDatatype()]",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/response-code"
}
},
"max": "1",
"id": "MessageHeader.response.code",
"comment": "This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.response.code"
},
"isSummary": true
}, {
"path": "MessageHeader.response.details",
"requirements": "Allows the sender of the message to determine what the specific issues are.",
"min": 0,
"definition": "The response, if present, MAY contain zero or one [0..1] details (CONF:4383-716).",
"short": "details",
"mapping": [ {
"map": "ERR",
"identity": "v2"
}, {
"map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/OperationOutcome"
} ],
"max": "1",
"id": "MessageHeader.response.details",
"comment": "This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.response.details"
},
"isSummary": true
}, {
"path": "MessageHeader.focus",
"requirements": "Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.",
"min": 0,
"definition": "MAY contain zero or more [0..*] focus (CONF:4383-717).",
"short": "focus",
"mapping": [ {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"SUBJ\" and isNormalParticipation]/role or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/outboundRelationship[typeCode=\"SBJ\" and isNormalActRelatoinship]/target)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "*",
"id": "MessageHeader.focus",
"comment": "The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.",
"base": {
"max": "*",
"min": 0,
"path": "MessageHeader.focus"
},
"isSummary": true
}, {
"path": "MessageHeader.focus.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.focus.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "MessageHeader.focus.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "MessageHeader.focus.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "MessageHeader.focus.reference",
"min": 0,
"definition": "The focus, if present, MAY contain zero or one [0..1] reference (CONF:4383-718).",
"short": "reference",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.focus.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "MessageHeader.focus.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "MessageHeader.focus.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "MessageHeader.focus.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "MessageHeader.focus.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
} ]
},
"status": "draft",
"id": "2aacd5c2-65df-478a-b028-24235a419286",
"kind": "resource",
"url": "http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-Referral-Response-Message-Header",
"context": [ "MessageHeader" ],
"version": "0.2.0",
"differential": {
"element": [ {
"id": "MessageHeader",
"path": "MessageHeader"
}, {
"id": "MessageHeader.id",
"max": "1",
"min": 0,
"path": "MessageHeader.id",
"short": "id",
"definition": "MAY contain zero or one [0..1] id (CONF:4383-701)."
}, {
"id": "MessageHeader.meta",
"max": "1",
"min": 0,
"path": "MessageHeader.meta",
"short": "meta",
"definition": "MAY contain zero or one [0..1] meta (CONF:4383-700)."
}, {
"id": "MessageHeader.meta.profile",
"max": "1",
"min": 1,
"path": "MessageHeader.meta.profile",
"short": "profile",
"definition": "The meta, if present, SHALL contain exactly one [1..1] profile=\"http://hl7.org/fhir/us/bser/StructureDefinition/nullBSeR-Referral-Response-Message-Header\" (CONF:4383-702).",
"patternString": "http://hl7.org/fhir/us/bser/StructureDefinition/nullBSeR-Referral-Response-Message-Header"
}, {
"id": "MessageHeader.event",
"max": "1",
"min": 1,
"path": "MessageHeader.event",
"type": [ {
"code": "Coding"
} ],
"short": "event",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-events"
}
},
"definition": "SHALL contain exactly one [1..1] event, which SHALL be selected from ValueSet message-events http://hl7.org/fhir/ValueSet/message-events DYNAMIC (CONF:4383-707)."
}, {
"id": "MessageHeader.receiver",
"max": "1",
"min": 0,
"path": "MessageHeader.receiver",
"short": "receiver",
"definition": "MAY contain zero or one [0..1] receiver (CONF:4383-703)."
}, {
"id": "MessageHeader.receiver.reference",
"max": "1",
"min": 1,
"path": "MessageHeader.receiver.reference",
"short": "reference",
"definition": "The receiver, if present, SHALL contain exactly one [1..1] reference=\"BSeR Referral Initiator\" (CONF:4383-708).",
"patternString": "BSeR Referral Initiator"
}, {
"id": "MessageHeader.sender",
"max": "1",
"min": 0,
"path": "MessageHeader.sender",
"short": "sender",
"definition": "MAY contain zero or one [0..1] sender (CONF:4383-704)."
}, {
"id": "MessageHeader.sender.reference",
"max": "1",
"min": 1,
"path": "MessageHeader.sender.reference",
"short": "reference",
"definition": "The sender, if present, SHALL contain exactly one [1..1] reference=\"BSeR Referral Recipient\" (CONF:4383-709).",
"patternString": "BSeR Referral Recipient"
}, {
"id": "MessageHeader.timestamp",
"max": "1",
"min": 1,
"path": "MessageHeader.timestamp",
"short": "timestamp",
"definition": "SHALL contain exactly one [1..1] timestamp (CONF:4383-710)."
}, {
"id": "MessageHeader.source",
"max": "1",
"min": 1,
"path": "MessageHeader.source",
"short": "source",
"definition": "SHALL contain exactly one [1..1] source (CONF:4383-705)."
}, {
"id": "MessageHeader.source.name",
"max": "1",
"min": 0,
"path": "MessageHeader.source.name",
"short": "name",
"definition": "This source MAY contain zero or one [0..1] name (CONF:4383-711)."
}, {
"id": "MessageHeader.source.endpoint",
"max": "1",
"min": 1,
"path": "MessageHeader.source.endpoint",
"short": "endpoint",
"definition": "This source SHALL contain exactly one [1..1] endpoint (CONF:4383-712)."
}, {
"id": "MessageHeader.reason",
"max": "1",
"min": 1,
"path": "MessageHeader.reason",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "reason",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/message-reason-encounter"
}
},
"definition": "SHALL contain exactly one [1..1] reason, which SHALL be selected from ValueSet message-reason-encounter http://hl7.org/fhir/ValueSet/message-reason-encounter DYNAMIC (CONF:4383-713)."
}, {
"id": "MessageHeader.response",
"max": "1",
"min": 0,
"path": "MessageHeader.response",
"short": "response",
"definition": "MAY contain zero or one [0..1] response (CONF:4383-706)."
}, {
"id": "MessageHeader.response.identifier",
"max": "1",
"min": 1,
"path": "MessageHeader.response.identifier",
"short": "identifier",
"definition": "The response, if present, SHALL contain exactly one [1..1] identifier (CONF:4383-714)."
}, {
"id": "MessageHeader.response.code",
"max": "1",
"min": 1,
"path": "MessageHeader.response.code",
"type": [ {
"code": "code"
} ],
"short": "code",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/response-code"
}
},
"definition": "The response, if present, SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet response-code http://hl7.org/fhir/ValueSet/response-code DYNAMIC (CONF:4383-715)."
}, {
"id": "MessageHeader.response.details",
"max": "1",
"min": 0,
"path": "MessageHeader.response.details",
"short": "details",
"definition": "The response, if present, MAY contain zero or one [0..1] details (CONF:4383-716)."
}, {
"id": "MessageHeader.focus",
"max": "*",
"min": 0,
"path": "MessageHeader.focus",
"short": "focus",
"definition": "MAY contain zero or more [0..*] focus (CONF:4383-717)."
}, {
"id": "MessageHeader.focus.reference",
"max": "1",
"min": 0,
"path": "MessageHeader.focus.reference",
"short": "reference",
"definition": "The focus, if present, MAY contain zero or one [0..1] reference (CONF:4383-718)."
} ]
},
"contact": [ {
"name": "Salimah Shakir",
"telecom": [ {
"use": "work",
"value": "8184306686",
"system": "phone"
}, {
"use": "work",
"value": "salimah@shakirconsulting.com",
"system": "email"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader"
}