Implementation Guide CH VACD
6.0.0-ballot-ci-build - ci-build Switzerland flag

Implementation Guide CH VACD, published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ballot-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-vacd/ and changes regularly. See the Directory of published versions

Resource Profile: CH VACD Immunization Recommendation Response MessageHeader

Official URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-response-messageheader Version: 6.0.0-ballot-ci-build
Active as of 2024-12-18 Computable Name: CHVACDRecommendationResponseMessageHeader

Copyright/Legal: CC0-1.0

Definition of the MessageHeader for the immunization recommendation response.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader CH VACD Immunization Recommendation Response MessageHeader
... Slices for event[x] 1..1 Coding, uri Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
.... event[x]:eventCoding 0..1 Coding Immunization Recommendation Response
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunrecoresponse
... destination 1..1 BackboneElement Message destination application(s)
.... name 1..1 string Name of system
... sender 0..1 Reference(CH Core Organization) Real world sender of the message
... reason 1..1 CodeableConcept Recommendation regarding vaccination (procedure)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 830152006
... response 1..1 BackboneElement If this is a reply to prior message
... focus 0..* Reference(CH VACD Immunization Recommendations) The actual content of the message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader CH VACD Immunization Recommendation Response MessageHeader
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for event[x] Σ 1..1 Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


ele-1: All FHIR elements must have a @value or children
.... eventCoding Coding
.... eventUri uri
.... event[x]:eventCoding Σ 0..1 Coding Immunization Recommendation Response
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunrecoresponse
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... name Σ 1..1 string Name of system
ele-1: All FHIR elements must have a @value or children
.... endpoint Σ 1..1 url Actual destination address or id
ele-1: All FHIR elements must have a @value or children
... sender Σ 0..1 Reference(CH Core Organization) Real world sender of the message
ele-1: All FHIR elements must have a @value or children
... source Σ 1..1 BackboneElement Message source application
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... endpoint Σ 1..1 url Actual message source address or id
ele-1: All FHIR elements must have a @value or children
... responsible Σ 1..1 Reference(CH Core Organization) Final responsibility for event
ele-1: All FHIR elements must have a @value or children
... reason Σ 1..1 CodeableConcept Recommendation regarding vaccination (procedure)
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 830152006
... response Σ 1..1 BackboneElement If this is a reply to prior message
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier Σ 1..1 id Id of original message
ele-1: All FHIR elements must have a @value or children
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.


ele-1: All FHIR elements must have a @value or children
... focus Σ 0..* Reference(CH VACD Immunization Recommendations) The actual content of the message
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingexamplePattern: immunrecoresponse
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.reasonexamplePattern: SNOMED-CT Code 830152006
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader CH VACD Immunization Recommendation Response MessageHeader
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 1..1 Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... eventCoding Coding
.... eventUri uri
.... event[x]:eventCoding Σ 0..1 Coding Immunization Recommendation Response
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunrecoresponse
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... destination Σ 1..1 BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 1..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(CH Core Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 1..1 Reference(CH Core Organization) Final responsibility for event
... reason Σ 1..1 CodeableConcept Recommendation regarding vaccination (procedure)
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 830152006
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... response Σ 1..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 1..1 id Id of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* Reference(CH VACD Immunization Recommendations) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingexamplePattern: immunrecoresponse
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.reasonexamplePattern: SNOMED-CT Code 830152006
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.event[x]

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader CH VACD Immunization Recommendation Response MessageHeader
... Slices for event[x] 1..1 Coding, uri Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
.... event[x]:eventCoding 0..1 Coding Immunization Recommendation Response
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunrecoresponse
... destination 1..1 BackboneElement Message destination application(s)
.... name 1..1 string Name of system
... sender 0..1 Reference(CH Core Organization) Real world sender of the message
... reason 1..1 CodeableConcept Recommendation regarding vaccination (procedure)
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 830152006
... response 1..1 BackboneElement If this is a reply to prior message
... focus 0..* Reference(CH VACD Immunization Recommendations) The actual content of the message

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader CH VACD Immunization Recommendation Response MessageHeader
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for event[x] Σ 1..1 Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


ele-1: All FHIR elements must have a @value or children
.... eventCoding Coding
.... eventUri uri
.... event[x]:eventCoding Σ 0..1 Coding Immunization Recommendation Response
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunrecoresponse
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... name Σ 1..1 string Name of system
ele-1: All FHIR elements must have a @value or children
.... endpoint Σ 1..1 url Actual destination address or id
ele-1: All FHIR elements must have a @value or children
... sender Σ 0..1 Reference(CH Core Organization) Real world sender of the message
ele-1: All FHIR elements must have a @value or children
... source Σ 1..1 BackboneElement Message source application
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... endpoint Σ 1..1 url Actual message source address or id
ele-1: All FHIR elements must have a @value or children
... responsible Σ 1..1 Reference(CH Core Organization) Final responsibility for event
ele-1: All FHIR elements must have a @value or children
... reason Σ 1..1 CodeableConcept Recommendation regarding vaccination (procedure)
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 830152006
... response Σ 1..1 BackboneElement If this is a reply to prior message
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier Σ 1..1 id Id of original message
ele-1: All FHIR elements must have a @value or children
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.


ele-1: All FHIR elements must have a @value or children
... focus Σ 0..* Reference(CH VACD Immunization Recommendations) The actual content of the message
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingexamplePattern: immunrecoresponse
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.reasonexamplePattern: SNOMED-CT Code 830152006
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..* MessageHeader CH VACD Immunization Recommendation Response MessageHeader
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] Σ 1..1 Code for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... eventCoding Coding
.... eventUri uri
.... event[x]:eventCoding Σ 0..1 Coding Immunization Recommendation Response
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: immunrecoresponse
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... destination Σ 1..1 BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 1..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(CH Core Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 1..1 Reference(CH Core Organization) Final responsibility for event
... reason Σ 1..1 CodeableConcept Recommendation regarding vaccination (procedure)
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.


Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 830152006
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... response Σ 1..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier Σ 1..1 id Id of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* Reference(CH VACD Immunization Recommendations) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]exampleMessageEvent
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.event[x]:eventCodingexamplePattern: immunrecoresponse
http://hl7.org/fhir/ValueSet/message-events
from the FHIR Standard
MessageHeader.reasonexamplePattern: SNOMED-CT Code 830152006
http://hl7.org/fhir/ValueSet/message-reason-encounter
from the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: 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()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MessageHeader.event[x]

 

Other representations of profile: CSV, Excel, Schematron