Implementation Guide CH VACD
2.1.0 - STU 3 Ballot Switzerland flag

Implementation Guide CH VACD, published by HL7 Switzerland. This is not an authorized publication; it is the continuous build for version 2.1.0). 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 Request MessageHeader

Official URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-request-messageheader Version: 2.1.0
Active as of 2022-07-07 Computable Name: CHVACDRecommendationRequestMessageHeader

Copyright/Legal: CC-BY-SA-4.0

Definition of the MessageHeader for the immunization recommendation request.

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 S0..*MessageHeaderCH VACD Immunization Recommendation Request 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: immunrecorequest
.... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Request
... destination 1..1BackboneElementMessage destination application(s)
.... name 1..1stringName of system
.... receiver 1..1Reference(CH Core Organization)Intended "real-world" recipient for the data
... sender 1..1Reference(CH Core PractitionerRole | CH Core Organization)Real world sender of the message
.... name 1..1stringName of system
.... software 1..1stringName of software running the system
.... version 1..1stringVersion of software running
... responsible 1..1Reference(CH Core PractitionerRole | CH Core Organization)Final responsibility for event
... 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)
... focus 0..*Reference(CH Core Patient | 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader S0..*MessageHeaderCH VACD Immunization Recommendation Request MessageHeader
... id Σ0..1stringLogical 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..1CodingCode 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..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: immunrecorequest
..... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Request
..... 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 Σ1..1Reference(CH Core Organization)Intended "real-world" recipient for the data
... sender Σ1..1Reference(CH Core PractitionerRole | 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 Σ1..1stringName of system
.... software Σ1..1stringName of software running the system
.... version Σ1..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ1..1Reference(CH Core PractitionerRole | 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 Σ0..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 Core Patient | 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..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader S0..*MessageHeaderCH VACD Immunization Recommendation Request 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: immunrecorequest
.... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Request
... destination 1..1BackboneElementMessage destination application(s)
.... name 1..1stringName of system
.... receiver 1..1Reference(CH Core Organization)Intended "real-world" recipient for the data
... sender 1..1Reference(CH Core PractitionerRole | CH Core Organization)Real world sender of the message
.... name 1..1stringName of system
.... software 1..1stringName of software running the system
.... version 1..1stringVersion of software running
... responsible 1..1Reference(CH Core PractitionerRole | CH Core Organization)Final responsibility for event
... 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)
... focus 0..*Reference(CH Core Patient | 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader S0..*MessageHeaderCH VACD Immunization Recommendation Request MessageHeader
... id Σ0..1stringLogical 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..1CodingCode 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..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: immunrecorequest
..... display1..1stringRepresentation defined by the system
Fixed Value: Immunization Recommendation Request
..... 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 Σ1..1Reference(CH Core Organization)Intended "real-world" recipient for the data
... sender Σ1..1Reference(CH Core PractitionerRole | 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 Σ1..1stringName of system
.... software Σ1..1stringName of software running the system
.... version Σ1..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ1..1Reference(CH Core PractitionerRole | 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 Σ0..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 Core Patient | 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..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

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

Constraints

IdGradePathDetailsRequirements
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-1errorMessageHeader.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.event[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.event[x]:eventCodingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destinationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.destination.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.destination.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.destination.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.destination.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.destination.receiverAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.senderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.entererAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.source.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.source.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.source.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.source.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.softwareAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.contactAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.source.endpointAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.responsibleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.reasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.response.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.response.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.response.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorMessageHeader.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorMessageHeader.response.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.response.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.response.detailsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.focusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorMessageHeader.definitionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())