IL Core Implementation Guide
0.18.0 - draft Israel flag

This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: ILCore ImmunizationRecommendation Profile

Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-immunization-recommendation Version: 0.18.0
Standards status: Trial-use Maturity Level: 1 Computable Name: ILCoreImmunizationRecommendation

Israel Core proposed constraints and extensions on the ImmunizationRecommendation Resource

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation ILCore ImmunizationRecommendation Profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient Σ 1..1 Reference(ILCore Patient Profile) Who this profile is for
... authority 0..1 Reference(ILCore Organization Profile) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... supportingImmunization 0..* Reference(ILCore Immunization Profile | ImmunizationEvaluation) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation ILCore ImmunizationRecommendation Profile
... 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
... 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
... identifier Σ 0..* Identifier Business identifier
... patient Σ 1..1 Reference(ILCore Patient Profile) Who this profile is for
... date Σ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(ILCore Organization Profile) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... 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
.... vaccineCode Σ 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

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


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

.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... 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
..... code 1..1 CodeableConcept Type 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..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] Σ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
.... supportingImmunization 0..* Reference(ILCore Immunization Profile | ImmunizationEvaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.targetDiseaseexampleImmunizationRecommendationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease
from the FHIR Standard
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

Differential View

This structure is derived from ImmunizationRecommendation

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation ILCore ImmunizationRecommendation Profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient Σ 1..1 Reference(ILCore Patient Profile) Who this profile is for
... authority 0..1 Reference(ILCore Organization Profile) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.

.... supportingImmunization 0..* Reference(ILCore Immunization Profile | ImmunizationEvaluation) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation ILCore ImmunizationRecommendation Profile
... 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
... 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
... identifier Σ 0..* Identifier Business identifier
... patient Σ 1..1 Reference(ILCore Patient Profile) Who this profile is for
... date Σ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(ILCore Organization Profile) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... 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
.... vaccineCode Σ 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.

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


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

.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... 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
..... code 1..1 CodeableConcept Type 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..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] Σ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
.... supportingImmunization 0..* Reference(ILCore Immunization Profile | ImmunizationEvaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.targetDiseaseexampleImmunizationRecommendationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease
from the FHIR Standard
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatusexampleImmunizationRecommendationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexampleImmunizationRecommendationDateCriterionCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron