IL Core Implementation Guide
0.18.0 - draft
Publication Build: This will be filled in by the publication tooling
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | ImmunizationRecommendation | ILCore ImmunizationRecommendation Profile | |
![]() ![]() |
1..1 | Reference(ILCore Patient Profile) | Who this profile is for | |
![]() ![]() |
0..1 | Reference(ILCore Organization Profile) | Who is responsible for protocol | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Reference(ILCore Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | ImmunizationRecommendation | ILCore ImmunizationRecommendation Profile | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 1..1 | Reference(ILCore Patient Profile) | Who this profile is for |
![]() ![]() |
Σ | 1..1 | dateTime | Date recommendation(s) created |
![]() ![]() |
0..1 | Reference(ILCore Organization Profile) | Who is responsible for protocol | |
![]() ![]() |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
![]() ![]() ![]() |
0..* | Reference(ILCore Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ImmunizationRecommendation | ILCore ImmunizationRecommendation Profile | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier | ||||
![]() ![]() |
Σ | 1..1 | Reference(ILCore Patient Profile) | Who this profile is for | ||||
![]() ![]() |
Σ | 1..1 | dateTime | Date recommendation(s) created | ||||
![]() ![]() |
0..1 | Reference(ILCore Organization Profile) | Who is responsible for protocol | |||||
![]() ![]() |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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.). | |||||
![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||
![]() ![]() ![]() |
0..1 | string | Protocol details | |||||
![]() ![]() ![]() |
0..1 | string | Name of vaccination series | |||||
![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series | |||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..* | Reference(ILCore Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Patient observations supporting recommendation | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ImmunizationRecommendation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.targetDisease | example | ImmunizationRecommendationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-target-diseasefrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusfrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.forecastReason | example | ImmunizationRecommendationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-reasonfrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterionfrom the FHIR Standard |
This structure is derived from ImmunizationRecommendation
Summary
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | ImmunizationRecommendation | ILCore ImmunizationRecommendation Profile | |
![]() ![]() |
1..1 | Reference(ILCore Patient Profile) | Who this profile is for | |
![]() ![]() |
0..1 | Reference(ILCore Organization Profile) | Who is responsible for protocol | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..* | Reference(ILCore Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation | |
Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() |
0..* | ImmunizationRecommendation | ILCore ImmunizationRecommendation Profile | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 1..1 | Reference(ILCore Patient Profile) | Who this profile is for |
![]() ![]() |
Σ | 1..1 | dateTime | Date recommendation(s) created |
![]() ![]() |
0..1 | Reference(ILCore Organization Profile) | Who is responsible for protocol | |
![]() ![]() |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
![]() ![]() ![]() |
0..* | Reference(ILCore Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation | |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusfrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ImmunizationRecommendation | ILCore ImmunizationRecommendation Profile | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Business identifier | ||||
![]() ![]() |
Σ | 1..1 | Reference(ILCore Patient Profile) | Who this profile is for | ||||
![]() ![]() |
Σ | 1..1 | dateTime | Date recommendation(s) created | ||||
![]() ![]() |
0..1 | Reference(ILCore Organization Profile) | Who is responsible for protocol | |||||
![]() ![]() |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations imr-1: One of vaccineCode or targetDisease SHALL be present | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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.). | |||||
![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||
![]() ![]() ![]() |
0..1 | string | Protocol details | |||||
![]() ![]() ![]() |
0..1 | string | Name of vaccination series | |||||
![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series | |||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..* | Reference(ILCore Immunization Profile | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Patient observations supporting recommendation | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ImmunizationRecommendation.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.targetDisease | example | ImmunizationRecommendationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-target-diseasefrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codefrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusfrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.forecastReason | example | ImmunizationRecommendationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-reasonfrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterionfrom the FHIR Standard |
This structure is derived from ImmunizationRecommendation
Summary
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron