1.0.0 - ci-build

chvacd, published by eHealth Suisse. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/ehealthsuisse/ch-vacd/ and changes regularly. See the Directory of published versions

Resource Profile: CH VACD Recommendation Immunization Recommendations Profile

Defining URL:http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-immunization-recommendations
Version:1.0.0
Name:CHVACDRecommendationImmunizationRecommendations
Title:CH VACD Recommendation Immunization Recommendations Profile
Status:Draft as of 11/28/21, 9:23 PM
Definition:

Definition of the immunization recommendation part for immunization recommendation request and response documents.

Publisher:eHealth Suisse
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-recommendation-immunization-recommendations

Formal Views of Profile Content

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

This structure is derived from CHVACDImmunizationRecommendations

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*CHVACDImmunizationRecommendationsCH VACD Recommendation Immunization Recommendation
... 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..1ResourceImmunizationRecommendation inline resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ch-vacd-ext-cross-reference 0..1(Complex)Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-cross-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierImmunization Recommendation item ID
... patient Σ1..1Reference(CH Core Patient Profile)Patient
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(CH Core Organization Profile)Who is responsible for protocol
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... 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
.... vaccineCode Σ0..*CodeableConceptImmunization Recommendation Vaccine Code
Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered.


.... targetDisease Σ1..1CodeableConceptDisease to be immunized against
Binding: Target disease and illnesses undergone for immunization (required): The code for disease.

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason Σ1..*CodeableConceptVaccine administration status reason
Binding: Recommendation-Categories for Immunizations (required): The code for disease.


.... dateCriterion 1..*BackboneElementDates governing proposed immunization
..... 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
..... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).

..... value 1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(Immunization | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format

This structure is derived from CHVACDImmunizationRecommendations

Summary

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*CHVACDImmunizationRecommendationsCH VACD Recommendation Immunization Recommendation
... 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..1ResourceImmunizationRecommendation inline resource
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ch-vacd-ext-cross-reference 0..1(Complex)Reference to related resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-cross-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ1..*IdentifierImmunization Recommendation item ID
... patient Σ1..1Reference(CH Core Patient Profile)Patient
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(CH Core Organization Profile)Who is responsible for protocol
... recommendation ΣI1..*BackboneElementVaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... 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
.... vaccineCode Σ0..*CodeableConceptImmunization Recommendation Vaccine Code
Binding: Swiss Vaccination Plan Immunizations (extensible): The code for vaccine product administered.


.... targetDisease Σ1..1CodeableConceptDisease to be immunized against
Binding: Target disease and illnesses undergone for immunization (required): The code for disease.

.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... forecastReason Σ1..*CodeableConceptVaccine administration status reason
Binding: Recommendation-Categories for Immunizations (required): The code for disease.


.... dateCriterion 1..*BackboneElementDates governing proposed immunization
..... 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
..... code 1..1CodeableConceptType of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).

..... value 1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization 0..*Reference(Immunization | ImmunizationEvaluation)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
ImmunizationRecommendation.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImmunizationRecommendation.recommendation.vaccineCodeextensibleSwissVaccinationPlanImmunizations
ImmunizationRecommendation.recommendation.targetDiseaserequiredTargetDiseasesAndIllnessesUndergoneForImmunization
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
ImmunizationRecommendation.recommendation.forecastReasonrequiredEmpfehlungskategorien
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes

Constraints

IdPathDetailsRequirements
dom-2ImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ImmunizationRecommendationIf 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-4ImmunizationRecommendationIf 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-5ImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ImmunizationRecommendationA resource should have narrative for robust management
: text.`div`.exists()
ele-1ImmunizationRecommendation.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.extension:relatesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.extension:relatesToMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
imr-1ImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
ele-1ImmunizationRecommendation.recommendation.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.vaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.forecastStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.forecastReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterion.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.dateCriterion.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterion.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ImmunizationRecommendation.recommendation.dateCriterion.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ImmunizationRecommendation.recommendation.dateCriterion.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.dateCriterion.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.doseNumber[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.seriesDoses[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.supportingImmunizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImmunizationRecommendation.recommendation.supportingPatientInformationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())