Implementation Guide CH VACD
3.0.0 - STU3 Switzerland flag

This page is part of the CH VACD (R4) (v3.0.0: STU 3) based on FHIR R4. . For a full list of available versions, 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: 3.0.0
Active as of 2022-12-21 Computable Name: CHVACDRecommendationResponseMessageHeader

Copyright/Legal: CC-BY-SA-4.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..*MessageHeaderCH VACD Immunization Recommendation Response MessageHeader
... eventCoding 0..1CodingCode for the event this message represents or link to event definition
Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: immunrecoresponse
.... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Response
... destination 1..1BackboneElementMessage destination application(s)
.... name 1..1stringName of system
... sender 0..1Reference(CH Core Organization)Real world sender of the message
... reason 1..1CodeableConceptCause of event
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 830152006
..... display1..1stringRepresentation defined by the system
Fixed Value: Recommendation regarding vaccination (procedure)
... response 1..1BackboneElementIf 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..*MessageHeaderCH VACD Immunization Recommendation Response MessageHeader
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1Code 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.

.... eventCodingCoding
.... eventUriuri
.... event[x]:eventCoding Σ0..1CodingCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: immunrecoresponse
..... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Response
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringName of system
.... endpoint Σ1..1urlActual destination address or id
... sender Σ0..1Reference(CH Core Organization)Real world sender of the message
... source Σ1..1BackboneElementMessage source application
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ1..1Reference(CH Core Organization)Final responsibility for event
... reason Σ1..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 830152006
..... display1..1stringRepresentation defined by the system
Fixed Value: Recommendation regarding vaccination (procedure)
... response Σ1..1BackboneElementIf this is a reply to prior message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

... focus Σ0..*Reference(CH VACD Immunization Recommendations)The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingexamplePattern: immunrecoresponse("Immunization Recommendation Response")
MessageHeader.reasonexamplePattern: SNOMED CT code 830152006("Recommendation regarding vaccination (procedure)")
MessageHeader.response.coderequiredResponseType

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..*MessageHeaderCH VACD Immunization Recommendation Response MessageHeader
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1Code 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.

.... eventCodingCoding
.... eventUriuri
.... event[x]:eventCoding Σ0..1CodingCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: immunrecoresponse
..... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Response
..... userSelected0..1booleanIf this coding was chosen directly by the user
... destination Σ1..1BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender Σ0..1Reference(CH Core Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source Σ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ1..1Reference(CH Core Organization)Final responsibility for event
... reason Σ1..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 830152006
..... display1..1stringRepresentation defined by the system
Fixed Value: Recommendation regarding vaccination (procedure)
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... response Σ1..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingexamplePattern: immunrecoresponse("Immunization Recommendation Response")
MessageHeader.reasonexamplePattern: SNOMED CT code 830152006("Recommendation regarding vaccination (procedure)")
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
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()

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderCH VACD Immunization Recommendation Response MessageHeader
... eventCoding 0..1CodingCode for the event this message represents or link to event definition
Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: immunrecoresponse
.... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Response
... destination 1..1BackboneElementMessage destination application(s)
.... name 1..1stringName of system
... sender 0..1Reference(CH Core Organization)Real world sender of the message
... reason 1..1CodeableConceptCause of event
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 830152006
..... display1..1stringRepresentation defined by the system
Fixed Value: Recommendation regarding vaccination (procedure)
... response 1..1BackboneElementIf 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..*MessageHeaderCH VACD Immunization Recommendation Response MessageHeader
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1Code 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.

.... eventCodingCoding
.... eventUriuri
.... event[x]:eventCoding Σ0..1CodingCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: immunrecoresponse
..... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Response
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringName of system
.... endpoint Σ1..1urlActual destination address or id
... sender Σ0..1Reference(CH Core Organization)Real world sender of the message
... source Σ1..1BackboneElementMessage source application
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ1..1Reference(CH Core Organization)Final responsibility for event
... reason Σ1..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.


Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 830152006
..... display1..1stringRepresentation defined by the system
Fixed Value: Recommendation regarding vaccination (procedure)
... response Σ1..1BackboneElementIf this is a reply to prior message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

... focus Σ0..*Reference(CH VACD Immunization Recommendations)The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingexamplePattern: immunrecoresponse("Immunization Recommendation Response")
MessageHeader.reasonexamplePattern: SNOMED CT code 830152006("Recommendation regarding vaccination (procedure)")
MessageHeader.response.coderequiredResponseType

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..*MessageHeaderCH VACD Immunization Recommendation Response MessageHeader
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1Code 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.

.... eventCodingCoding
.... eventUriuri
.... event[x]:eventCoding Σ0..1CodingCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.ch/ig/ch-vacd/CodeSystem/ch-vacd-clinical-decision-support-event-cs
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: immunrecoresponse
..... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Response
..... userSelected0..1booleanIf this coding was chosen directly by the user
... destination Σ1..1BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender Σ0..1Reference(CH Core Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source Σ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ1..1Reference(CH Core Organization)Final responsibility for event
... reason Σ1..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.


Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 830152006
..... display1..1stringRepresentation defined by the system
Fixed Value: Recommendation regarding vaccination (procedure)
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... response Σ1..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingexamplePattern: immunrecoresponse("Immunization Recommendation Response")
MessageHeader.reasonexamplePattern: SNOMED CT code 830152006("Recommendation regarding vaccination (procedure)")
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
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()

 

Other representations of profile: CSV, Excel, Schematron