Implementation Guide CH VACD
4.0.1 - trial-use
Implementation Guide CH VACD
4.0.1 - trial-use
This page is part of the CH VACD (R4) (v4.0.1: STU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-request-messageheader | Version: 4.0.1 | |||
| Active as of 2023-12-28 | Computable Name: CHVACDRecommendationRequestMessageHeader | |||
Copyright/Legal: CC0-1.0 |
||||
Definition of the MessageHeader for the immunization recommendation request.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | S | 0..* | MessageHeader | CH VACD Immunization Recommendation Request 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 | 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: immunrecorequest | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Request | |
 destination | 1..1 | BackboneElement | Message destination application(s) | |
 name | 1..1 | string | Name of system | |
  receiver | 1..1 | Reference(CH Core Organization) | Intended "real-world" recipient for the data | |
| sender | 1..1 | Reference(CH Core PractitionerRole | CH Core Organization) | Real world sender of the message | |
| source | ||||
| name | 1..1 | string | Name of system | |
| software | 1..1 | string | Name of software running the system | |
| version | 1..1 | string | Version of software running | |
| responsible | 1..1 | Reference(CH Core PractitionerRole | CH Core Organization) | Final responsibility for event | |
| 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 | |
| focus | 0..* | Reference(CH Core Patient EPR | CH Core PractitionerRole | CH Core Practitioner | CH Core Organization | CH VACD AllergyIntolerance | CH VACD Immunization | CH VACD Laboratory And Serology | CH VACD Medical Problems | CH VACD Past Illness | CH VACD Basic Immunization | Consent) | The actual content of the message | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | S | 0..* | MessageHeader | CH VACD Immunization Recommendation Request MessageHeader |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 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 | 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 |
| 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: immunrecorequest | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Request | |
| destination | Σ | 1..1 | BackboneElement | Message destination application(s) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | Σ | 1..1 | string | Name of system |
| endpoint | Σ | 1..1 | url | Actual destination address or id |
| receiver | Σ | 1..1 | Reference(CH Core Organization) | Intended "real-world" recipient for the data |
| sender | Σ | 1..1 | Reference(CH Core PractitionerRole | CH Core Organization) | Real world sender of the message |
| source | Σ | 1..1 | BackboneElement | Message source application |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | Σ | 1..1 | string | Name of system |
| software | Σ | 1..1 | string | Name of software running the system |
| version | Σ | 1..1 | string | Version of software running |
| endpoint | Σ | 1..1 | url | Actual message source address or id |
| responsible | Σ | 1..1 | Reference(CH Core PractitionerRole | 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 |
| 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 | |
| focus | Σ | 0..* | Reference(CH Core Patient EPR | CH Core PractitionerRole | CH Core Practitioner | CH Core Organization | CH VACD AllergyIntolerance | CH VACD Immunization | CH VACD Laboratory And Serology | CH VACD Medical Problems | CH VACD Past Illness | CH VACD Basic Immunization | Consent) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| MessageHeader.event[x] | example | MessageEvent |
| MessageHeader.event[x]:eventCoding | example | Pattern: immunrecorequest("Immunization Recommendation Request") |
| MessageHeader.reason | example | Pattern: SNOMED CT code 830152006 |
| Id | Grade | Path(s) | 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader | S | 0..* | MessageHeader | CH VACD Immunization Recommendation Request 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | 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 | 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: immunrecorequest | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Request | |||||
| 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 | Σ | 1..1 | Reference(CH Core Organization) | Intended "real-world" recipient for the data | ||||
| sender | Σ | 1..1 | Reference(CH Core PractitionerRole | 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 | Σ | 1..1 | string | Name of system | ||||
| software | Σ | 1..1 | string | Name of software running the system | ||||
| version | Σ | 1..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 PractitionerRole | 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 | Σ | 0..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 Core Patient EPR | CH Core PractitionerRole | CH Core Practitioner | CH Core Organization | CH VACD AllergyIntolerance | CH VACD Immunization | CH VACD Laboratory And Serology | CH VACD Medical Problems | CH VACD Past Illness | CH VACD Basic Immunization | Consent) | The actual content of the message | ||||
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | example | MessageEvent | ||||
| MessageHeader.event[x]:eventCoding | example | Pattern: immunrecorequest("Immunization Recommendation Request") | ||||
| MessageHeader.reason | example | Pattern: SNOMED CT code 830152006 | ||||
| MessageHeader.response.code | required | ResponseType |
| Id | Grade | Path(s) | 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MessageHeader
Summary
Mandatory: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | S | 0..* | MessageHeader | CH VACD Immunization Recommendation Request 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 | 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: immunrecorequest | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Request | |
| destination | 1..1 | BackboneElement | Message destination application(s) | |
| name | 1..1 | string | Name of system | |
| receiver | 1..1 | Reference(CH Core Organization) | Intended "real-world" recipient for the data | |
| sender | 1..1 | Reference(CH Core PractitionerRole | CH Core Organization) | Real world sender of the message | |
| source | ||||
| name | 1..1 | string | Name of system | |
| software | 1..1 | string | Name of software running the system | |
| version | 1..1 | string | Version of software running | |
| responsible | 1..1 | Reference(CH Core PractitionerRole | CH Core Organization) | Final responsibility for event | |
| 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 | |
| focus | 0..* | Reference(CH Core Patient EPR | CH Core PractitionerRole | CH Core Practitioner | CH Core Organization | CH VACD AllergyIntolerance | CH VACD Immunization | CH VACD Laboratory And Serology | CH VACD Medical Problems | CH VACD Past Illness | CH VACD Basic Immunization | Consent) | The actual content of the message | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | S | 0..* | MessageHeader | CH VACD Immunization Recommendation Request MessageHeader |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| 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 | 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 |
| 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: immunrecorequest | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Request | |
| destination | Σ | 1..1 | BackboneElement | Message destination application(s) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | Σ | 1..1 | string | Name of system |
| endpoint | Σ | 1..1 | url | Actual destination address or id |
| receiver | Σ | 1..1 | Reference(CH Core Organization) | Intended "real-world" recipient for the data |
| sender | Σ | 1..1 | Reference(CH Core PractitionerRole | CH Core Organization) | Real world sender of the message |
| source | Σ | 1..1 | BackboneElement | Message source application |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | Σ | 1..1 | string | Name of system |
| software | Σ | 1..1 | string | Name of software running the system |
| version | Σ | 1..1 | string | Version of software running |
| endpoint | Σ | 1..1 | url | Actual message source address or id |
| responsible | Σ | 1..1 | Reference(CH Core PractitionerRole | 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 |
| 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 | |
| focus | Σ | 0..* | Reference(CH Core Patient EPR | CH Core PractitionerRole | CH Core Practitioner | CH Core Organization | CH VACD AllergyIntolerance | CH VACD Immunization | CH VACD Laboratory And Serology | CH VACD Medical Problems | CH VACD Past Illness | CH VACD Basic Immunization | Consent) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| MessageHeader.event[x] | example | MessageEvent |
| MessageHeader.event[x]:eventCoding | example | Pattern: immunrecorequest("Immunization Recommendation Request") |
| MessageHeader.reason | example | Pattern: SNOMED CT code 830152006 |
| Id | Grade | Path(s) | 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader | S | 0..* | MessageHeader | CH VACD Immunization Recommendation Request 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | 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 | 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: immunrecorequest | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Immunization Recommendation Request | |||||
| 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 | Σ | 1..1 | Reference(CH Core Organization) | Intended "real-world" recipient for the data | ||||
| sender | Σ | 1..1 | Reference(CH Core PractitionerRole | 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 | Σ | 1..1 | string | Name of system | ||||
| software | Σ | 1..1 | string | Name of software running the system | ||||
| version | Σ | 1..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 PractitionerRole | 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 | Σ | 0..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 Core Patient EPR | CH Core PractitionerRole | CH Core Practitioner | CH Core Organization | CH VACD AllergyIntolerance | CH VACD Immunization | CH VACD Laboratory And Serology | CH VACD Medical Problems | CH VACD Past Illness | CH VACD Basic Immunization | Consent) | The actual content of the message | ||||
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | example | MessageEvent | ||||
| MessageHeader.event[x]:eventCoding | example | Pattern: immunrecorequest("Immunization Recommendation Request") | ||||
| MessageHeader.reason | example | Pattern: SNOMED CT code 830152006 | ||||
| MessageHeader.response.code | required | ResponseType |
| Id | Grade | Path(s) | 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from MessageHeader
Summary
Mandatory: 9 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron