{
"description": "Definition of the MessageHeader for the immunization recommendation response.",
"_filename": "StructureDefinition-ch-vacd-recommendation-response-messageheader.json",
"package_name": "ch.fhir.ig.ch-vacd",
"date": "2024-05-17T07:08:01+00:00",
"derivation": "constraint",
"publisher": "HL7 Switzerland",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "CHE",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "CHVACDRecommendationResponseMessageHeader",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
} ],
"abstract": false,
"copyright": "CC0-1.0",
"type": "MessageHeader",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "CH VACD Immunization Recommendation Response MessageHeader",
"package_version": "5.0.0-ballot",
"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": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"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",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"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.",
"isModifier": false,
"short": "CH VACD Immunization Recommendation Response MessageHeader",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "MSH / MSA / ERR",
"identity": "v2"
}, {
"map": "Message",
"identity": "rim"
} ],
"max": "*",
"id": "MessageHeader",
"base": {
"max": "*",
"min": 0,
"path": "MessageHeader"
},
"isSummary": false
}, {
"path": "MessageHeader.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.meta",
"min": 0,
"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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "MessageHeader.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"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. 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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language."
},
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.text",
"min": 0,
"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.",
"isModifier": false,
"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",
"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 information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"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.",
"isModifier": false,
"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "MessageHeader.extension",
"min": 0,
"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.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "MessageHeader.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.event[x]",
"requirements": "Drives the behavior associated with this message.",
"min": 1,
"definition": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://terminology.hl7.org/CodeSystem/message-events\". Alternatively uri to the EventDefinition.",
"isModifier": false,
"short": "Code for the event this message represents or link to event definition",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "MSH-9.2",
"identity": "v2"
}, {
"map": "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "Coding"
}, {
"code": "uri"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/message-events",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MessageEvent"
} ],
"description": "One of the message events defined as part of this version of FHIR."
},
"max": "1",
"id": "MessageHeader.event[x]",
"comment": "The time of the event will be found in the focus resource. The time of the message will be found in [Bundle.timestamp](bundle-definitions.html#Bundle.timestamp).",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.event[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.event[x]",
"requirements": "Drives the behavior associated with this message.",
"min": 0,
"definition": "Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value \"http://terminology.hl7.org/CodeSystem/message-events\". Alternatively uri to the EventDefinition.",
"isModifier": false,
"short": "Immunization Recommendation Response",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "MSH-9.2",
"identity": "v2"
}, {
"map": "./payload[classCode=\"CACT\" and moodCode=\"EVN\" and isNormalAct()]/code[isNormalDatatype()]/code",
"identity": "rim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "eventCoding",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/message-events",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MessageEvent"
} ],
"description": "One of the message events defined as part of this version of FHIR."
},
"max": "1",
"id": "MessageHeader.event[x]:eventCoding",
"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).",
"patternCoding": {
"code": "immunrecoresponse",
"system": "http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs"
},
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.event[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (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": 1,
"definition": "The destination application which the message is intended for.",
"isModifier": false,
"short": "Message destination application(s)",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "./communicationFunction[typeCode=\"RCV\"]",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.destination.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"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. 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.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "MessageHeader.destination.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.destination.name",
"requirements": "May be used for routing of response and/or to support audit.",
"min": 1,
"definition": "Human-readable name for the target system.",
"isModifier": false,
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.destination.endpoint",
"requirements": "Identifies where to route the message.",
"min": 1,
"definition": "Indicates where the message should be routed to.",
"isModifier": false,
"short": "Actual destination address or id",
"mapping": [ {
"map": "MSH-25 (or MSH-6)",
"identity": "v2"
}, {
"map": "./telecom",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"max": "1",
"id": "MessageHeader.destination.endpoint",
"comment": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.destination.endpoint"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.destination.receiver",
"requirements": "Allows routing beyond just the application level.",
"min": 0,
"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.",
"isModifier": false,
"short": "Intended \"real-world\" recipient for the data",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'",
"identity": "v2"
}, {
"map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"max": "1",
"id": "MessageHeader.destination.receiver",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.destination.receiver"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.sender",
"requirements": "Allows routing beyond just the application level.",
"min": 0,
"definition": "Identifies the sending system to allow the use of a trust relationship.",
"isModifier": false,
"short": "Real world sender of the message",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "PRT-5:PRT-4='WAYR' / PRT-8:PRT-4='WAYR'",
"identity": "v2"
}, {
"map": "Not directly supported. Could be shared using attentionLine.value with an appropriate keyWordText",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "The source of the data entry",
"mapping": [ {
"map": "FiveWs.author",
"identity": "w5"
}, {
"map": "EVN-5 / ORC-10 / PRT-5:PRT-4='EP' / ROL where ROL.3 is EP or ORC.10",
"identity": "v2"
}, {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"ENT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"max": "1",
"id": "MessageHeader.enterer",
"comment": "Usually only for the request but can be used in a response.",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.enterer"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "The source of the decision",
"mapping": [ {
"map": "FiveWs.author",
"identity": "w5"
}, {
"map": "ORC-19 / PRT-5:PRT-4='AUT' / ROL where ROL.3 is IP or ORC.12",
"identity": "v2"
}, {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"AUT\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=(\"DEV\", \"PSN\") and determinerCode=\"INST\"])",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"max": "1",
"id": "MessageHeader.author",
"comment": "Usually only for the request but can be used in a response.",
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.source",
"requirements": "Allows replies, supports audit.",
"min": 1,
"definition": "The source application from which this message originated.",
"isModifier": false,
"short": "Message source application",
"mapping": [ {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "unique(./communicationFunction[typeCode=\"SND\"])",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.source.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"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. 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.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "MessageHeader.source.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.source.name",
"requirements": "May be used to support audit.",
"min": 0,
"definition": "Human-readable name for the source system.",
"isModifier": false,
"short": "Name of system",
"mapping": [ {
"map": "MSH-3",
"identity": "v2"
}, {
"map": "unique(./entity[determinerCode=\"INST\" and classCode=\"DEV\"]/name[type='ST' and isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "MessageHeader.source.name",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.source.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.source.software",
"requirements": "Supports audit and possibly interface engine behavior.",
"min": 0,
"definition": "May include configuration or other information useful in debugging.",
"isModifier": false,
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.source.endpoint",
"requirements": "Identifies where to send responses, may influence security permissions.",
"min": 1,
"definition": "Identifies the routing target to send acknowledgements to.",
"isModifier": false,
"short": "Actual message source address or id",
"mapping": [ {
"map": "MSH-24",
"identity": "v2"
}, {
"map": "./telecom[isNormalDatatype()]",
"identity": "rim"
} ],
"type": [ {
"code": "url"
} ],
"max": "1",
"id": "MessageHeader.source.endpoint",
"comment": "The id may be a non-resolvable URI for systems that do not use standard network-based addresses.",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.source.endpoint"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.responsible",
"requirements": "Need to know for audit/traceback requirements and possibly for authorization.",
"min": 1,
"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.",
"isModifier": false,
"short": "Final responsibility for event",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": "ORC-12 / PRT-5:PRT-4='OP' / PRT-8:PRT-4='OP' / ROL where ROL.3 is RO or ORC.11",
"identity": "v2"
}, {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/player[isNormalEntity() and classCode=\"PSN\" and determinerCode=\"INST\"] or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[isHighest(priorityCode) and typeCode=\"RESP\" and isNormalParticipation]/role[classCode=\"ASSIGNED\" and isNormalRole()]/scoper[isNormalEntity() and classCode=\"ORG\" and determinerCode=\"INST\"])",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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": "Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.",
"isModifier": false,
"short": "Recommendation regarding vaccination (procedure)",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "EVN.4 / ORC.16 / OBR-31-reason for study / BPO-13-BP indication for use / RXO-20-indication / RXE-27-give indication / RXD-21-indication / RXG-22-indication / RXA-19-indication",
"identity": "v2"
}, {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/reasonCode[isNormalDatatype()])",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/message-reason-encounter",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EventReason"
} ],
"description": "Reason for event occurrence."
},
"max": "1",
"id": "MessageHeader.reason",
"patternCodeableConcept": {
"coding": [ {
"code": "830152006",
"system": "http://snomed.info/sct"
} ]
},
"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": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.response",
"min": 1,
"definition": "Information about the message that this message is a response to. Only present if this message is a response.",
"isModifier": false,
"short": "If this is a reply to prior message",
"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.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "MessageHeader.response.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"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. 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.",
"isModifier": false,
"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"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "MessageHeader.response.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#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 in which it is contained and/or the understanding of the containing element's descendants. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"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"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.response.identifier",
"requirements": "Allows receiver to know what message is being responded to.",
"min": 1,
"definition": "The MessageHeader.id of the message to which this message is a response.",
"isModifier": false,
"short": "Id of original message",
"mapping": [ {
"map": "MSA-2",
"identity": "v2"
}, {
"map": "./acknowledges.id[isNormalDatatype()]",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "MessageHeader.response.identifier",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.response.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.response.code",
"requirements": "Allows the sender of the acknowledge message to know if the request was successful or if action is needed.",
"min": 1,
"definition": "Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.",
"isModifier": false,
"short": "ok | transient-error | fatal-error",
"mapping": [ {
"map": "MSA-1",
"identity": "v2"
}, {
"map": "./typeCode[isNormalDatatype()]",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/response-code|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResponseType"
} ],
"description": "The kind of response to a message."
},
"max": "1",
"id": "MessageHeader.response.code",
"comment": "This is a generic response to the request message. Specific data for the response will be found in MessageHeader.focus.",
"base": {
"max": "1",
"min": 1,
"path": "MessageHeader.response.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.response.details",
"requirements": "Allows the sender of the message to determine what the specific issues are.",
"min": 0,
"definition": "Full details of any issues found in the message.",
"isModifier": false,
"short": "Specific list of hints/warnings/errors",
"mapping": [ {
"map": "ERR",
"identity": "v2"
}, {
"map": "AcknowledgementDetail or Observation[classCode=\"ALRT\" and moodCode=\"EVN\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/OperationOutcome" ]
} ],
"max": "1",
"id": "MessageHeader.response.details",
"comment": "This SHALL be contained in the bundle. If any of the issues are errors, the response code SHALL be an error.",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.response.details"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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": "The actual data of the message - a reference to the root/focus class of the event.",
"isModifier": false,
"short": "The actual content of the message",
"mapping": [ {
"map": "unique(./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/participation[typeCode=\"SUBJ\" and isNormalParticipation]/role or ./controlAct[classCode=\"CACT\" and classCode=\"EVN\" and isNormalAct()]/outboundRelationship[typeCode=\"SBJ\" and isNormalActRelatoinship]/target)",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-immunization-recommendation" ]
} ],
"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
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "MessageHeader.definition",
"requirements": "Allows sender to define the expected contents of the message.",
"min": 0,
"definition": "Permanent link to the MessageDefinition for this message.",
"isModifier": false,
"short": "Link to the definition for this message",
"mapping": [ {
"map": "Not directly supported.",
"identity": "rim"
} ],
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/MessageDefinition" ]
} ],
"max": "1",
"id": "MessageHeader.definition",
"base": {
"max": "1",
"min": 0,
"path": "MessageHeader.definition"
},
"isSummary": true
} ]
},
"status": "active",
"id": "2346e3bb-3525-4a14-a44e-b97117d9845b",
"kind": "resource",
"url": "http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-response-messageheader",
"version": "5.0.0-ballot",
"differential": {
"element": [ {
"id": "MessageHeader",
"path": "MessageHeader",
"short": "CH VACD Immunization Recommendation Response MessageHeader"
}, {
"id": "MessageHeader.event[x]",
"path": "MessageHeader.event[x]",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "MessageHeader.event[x]:eventCoding",
"max": "1",
"min": 0,
"path": "MessageHeader.event[x]",
"type": [ {
"code": "Coding"
} ],
"short": "Immunization Recommendation Response",
"sliceName": "eventCoding",
"patternCoding": {
"code": "immunrecoresponse",
"system": "http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs"
}
}, {
"id": "MessageHeader.destination",
"max": "1",
"min": 1,
"path": "MessageHeader.destination"
}, {
"id": "MessageHeader.destination.name",
"min": 1,
"path": "MessageHeader.destination.name"
}, {
"id": "MessageHeader.sender",
"path": "MessageHeader.sender",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-organization" ]
} ]
}, {
"id": "MessageHeader.responsible",
"min": 1,
"path": "MessageHeader.responsible",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-organization" ]
} ]
}, {
"id": "MessageHeader.reason",
"min": 1,
"path": "MessageHeader.reason",
"short": "Recommendation regarding vaccination (procedure)",
"patternCodeableConcept": {
"coding": [ {
"code": "830152006",
"system": "http://snomed.info/sct"
} ]
}
}, {
"id": "MessageHeader.response",
"min": 1,
"path": "MessageHeader.response"
}, {
"id": "MessageHeader.focus",
"path": "MessageHeader.focus",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-immunization-recommendation" ]
} ]
} ]
},
"contact": [ {
"name": "HL7 Switzerland",
"telecom": [ {
"value": "https://www.hl7.ch/",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader"
}