Implementation Guide CH VACD
2.0.0 - STU 2
Implementation Guide CH VACD
2.0.0 - STU 2
This page is part of the CH VACD (R4) (v2.0.0: STU 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Defining URL: | http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-response-messageheader |
| Version: | 2.0.0 |
| Name: | CHVACDRecommendationResponseMessageHeader |
| Title: | CH VACD Immunization Recommendation Response MessageHeader Profile |
| Status: | Active as of 2022-02-11 02:45:16+0100 |
| Definition: | Definition of the MessageHeader for the immunization recommendation response. |
| Publisher: | HL7 Switzerland |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-response-messageheader
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | 0..* | MessageHeader | CH VACD Immunization Recommendation Response MessageHeader | |
  eventCoding | 0..1 | Coding | Code for the event this message represents or link to event definition 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 | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Response | |
 destination | 1..1 | BackboneElement | Message destination application(s) | |
| name | 1..1 | string | Name of system | |
 sender | 0..1 | Reference(CH Core Organization Profile) | Real world sender of the message | |
| responsible | 1..1 | Reference(CH Core Organization Profile) | Final responsibility for event | |
| reason | 1..1 | CodeableConcept | Cause of event 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Recommendation regarding vaccination (procedure) | |
| response | 1..1 | BackboneElement | If this is a reply to prior message | |
| focus | 0..* | Reference(CH VACD Immunization Recommendations Profile | CH VACD Recommendation Immunization Recommendations Profile) | The actual content of the message | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | CH VACD Immunization Recommendation Response MessageHeader | |
 id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| 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 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. |
  event[x]:eventCoding | Σ | 0..1 | Coding | Code 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 |
 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 | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Response | |
 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 Profile) | 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 Profile) | Final responsibility for event |
| reason | Σ | 1..1 | CodeableConcept | Cause of event 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 | 1..1 | string | Representation defined by the system Fixed Value: Recommendation regarding vaccination (procedure) | |
| 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 Profile | CH VACD Recommendation Immunization Recommendations Profile) | The actual content of the message |
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | CH VACD Immunization Recommendation Response MessageHeader | |
| Documentation for this format | ||||
This structure is derived from MessageHeader
Summary
Mandatory: 5 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | CH VACD Immunization Recommendation Response MessageHeader | |
| eventCoding | 0..1 | Coding | Code for the event this message represents or link to event definition 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Response | |
| destination | 1..1 | BackboneElement | Message destination application(s) | |
| name | 1..1 | string | Name of system | |
| sender | 0..1 | Reference(CH Core Organization Profile) | Real world sender of the message | |
| responsible | 1..1 | Reference(CH Core Organization Profile) | Final responsibility for event | |
| reason | 1..1 | CodeableConcept | Cause of event 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Recommendation regarding vaccination (procedure) | |
| response | 1..1 | BackboneElement | If this is a reply to prior message | |
| focus | 0..* | Reference(CH VACD Immunization Recommendations Profile | CH VACD Recommendation Immunization Recommendations Profile) | The actual content of the message | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | CH VACD Immunization Recommendation Response MessageHeader | |
| id | Σ | 0..1 | string | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
| 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 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. |
| event[x]:eventCoding | Σ | 0..1 | Coding | Code 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 |
| 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 | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Response | |
| 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 Profile) | 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 Profile) | Final responsibility for event |
| reason | Σ | 1..1 | CodeableConcept | Cause of event 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 | 1..1 | string | Representation defined by the system Fixed Value: Recommendation regarding vaccination (procedure) | |
| 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 Profile | CH VACD Recommendation Immunization Recommendations Profile) | The actual content of the message |
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| MessageHeader.language | preferred | CommonLanguages Max Binding: AllLanguages |
| MessageHeader.event[x] | example | MessageEvent |
| MessageHeader.event[x]:eventCoding | example | Pattern: immunrecoresponse("Immunization Recommendation Response") |
| MessageHeader.reason | example | Pattern: SNOMED CT code 830152006("Recommendation regarding vaccination (procedure)") |
| MessageHeader.response.code | required | ResponseType |
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MessageHeader | 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 : 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-4 | error | MessageHeader | If 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-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | MessageHeader.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MessageHeader.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MessageHeader.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MessageHeader.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MessageHeader.event[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.event[x]:eventCoding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.destination | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.destination.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MessageHeader.destination.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MessageHeader.destination.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MessageHeader.destination.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MessageHeader.destination.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.destination.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.destination.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.destination.receiver | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.enterer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.source.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MessageHeader.source.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MessageHeader.source.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MessageHeader.source.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MessageHeader.source.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.source.software | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.source.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.source.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.source.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.responsible | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.reason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MessageHeader.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MessageHeader.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | MessageHeader.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | MessageHeader.response.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.response.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.response.details | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.focus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | MessageHeader.definition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |