GIIS Implementation Guide
0.1.8 - ci-build
GIIS Implementation Guide
0.1.8 - ci-build
GIIS Implementation Guide, published by CENS. This guide is not an authorized publication; it is the continuous build for version 0.1.8 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cens-chile/giis_fhir_IG/ and changes regularly. See the Directory of published versions
| Official URL: https://paho.org/fhir/giis/StructureDefinition/VaccinationAppointment | Version: 0.1.8 | |||
| Draft as of 2024-11-05 | Computable Name: VaccinationAppointment | |||
The appointment handler for a vaccination event related to the vaccination calendar
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
  patient |
1..1 | Reference(GIISPatient) | Who this profile is for | |
 date |
S | 1..1 | dateTime | Date recommendation(s) created |
 recommendation |
S | 1..* | BackboneElement | Vaccine administration recommendations |
  vaccineCode |
S | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccine codes (example) |
 coding |
S | 0..1 | Coding | Code defined by a terminology system |
 code |
S | 0..1 | code | Symbol in syntax defined by the system |
| text |
S | 0..1 | string | Plain text representation of the concept |
| forecastStatus |
S | 1..1 | CodeableConcept | Vaccine recommendation status |
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| text |
S | 0..1 | string | Plain text representation of the concept |
| dateCriterion |
S | 1..1 | BackboneElement | Dates governing proposed immunization |
| code |
S | 1..1 | CodeableConcept | Type of date |
| value |
S | 1..1 | dateTime | Date as YYYY-MM-DD |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineVS (a valid code from Vaccine codes)https://paho.org/fhir/giis/ValueSet/VaccineVSfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
 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(GIISPatient) | Who this profile is for |
| date |
SΣ | 1..1 | dateTime | Date recommendation(s) created |
 recommendation |
SΣ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 |
| vaccineCode |
SΣ | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccine codes (example) |
| coding |
SΣ | 0..1 | Coding | Code defined by a terminology system |
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| forecastStatus |
?!SΣ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| dateCriterion |
S | 1..1 | BackboneElement | Dates governing proposed immunization |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
S | 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 |
S | 1..1 | dateTime | Date as YYYY-MM-DD |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineVS (a valid code from Vaccine codes)https://paho.org/fhir/giis/ValueSet/VaccineVSfrom this IG | |
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusfrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterionfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImmunizationRecommendation | 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() | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||
| 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 | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
| patient |
Σ | 1..1 | Reference(GIISPatient) | Who this profile is for | ||||
| date |
SΣ | 1..1 | dateTime | Date recommendation(s) created | ||||
| authority |
0..1 | Reference(Organization) | Who is responsible for protocol | |||||
| recommendation |
SΣ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 |
SΣ | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccine codes (example) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| 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 |
?!SΣ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| forecastReason |
Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||
| dateCriterion |
S | 1..1 | 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 |
S | 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 |
S | 1..1 | dateTime | Date as YYYY-MM-DD | ||||
| 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(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
| supportingPatientInformation |
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 | VaccineVS (a valid code from Vaccine codes)https://paho.org/fhir/giis/ValueSet/VaccineVSfrom this IG | ||||
| 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 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImmunizationRecommendation | 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() | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() |
This structure is derived from ImmunizationRecommendation
Differential View
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
| patient |
1..1 | Reference(GIISPatient) | Who this profile is for | |
| date |
S | 1..1 | dateTime | Date recommendation(s) created |
| recommendation |
S | 1..* | BackboneElement | Vaccine administration recommendations |
| vaccineCode |
S | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccine codes (example) |
| coding |
S | 0..1 | Coding | Code defined by a terminology system |
| code |
S | 0..1 | code | Symbol in syntax defined by the system |
| text |
S | 0..1 | string | Plain text representation of the concept |
| forecastStatus |
S | 1..1 | CodeableConcept | Vaccine recommendation status |
| coding |
S | 0..* | Coding | Code defined by a terminology system |
| text |
S | 0..1 | string | Plain text representation of the concept |
| dateCriterion |
S | 1..1 | BackboneElement | Dates governing proposed immunization |
| code |
S | 1..1 | CodeableConcept | Type of date |
| value |
S | 1..1 | dateTime | Date as YYYY-MM-DD |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineVS (a valid code from Vaccine codes)https://paho.org/fhir/giis/ValueSet/VaccineVSfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
| 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(GIISPatient) | Who this profile is for |
| date |
SΣ | 1..1 | dateTime | Date recommendation(s) created |
| recommendation |
SΣ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 |
| vaccineCode |
SΣ | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccine codes (example) |
| coding |
SΣ | 0..1 | Coding | Code defined by a terminology system |
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| forecastStatus |
?!SΣ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system |
| text |
SΣ | 0..1 | string | Plain text representation of the concept |
| dateCriterion |
S | 1..1 | BackboneElement | Dates governing proposed immunization |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
S | 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 |
S | 1..1 | dateTime | Date as YYYY-MM-DD |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineVS (a valid code from Vaccine codes)https://paho.org/fhir/giis/ValueSet/VaccineVSfrom this IG | |
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusfrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterionfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImmunizationRecommendation | 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() | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||
| 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 | ||||
| identifier |
Σ | 0..* | Identifier | Business identifier | ||||
| patient |
Σ | 1..1 | Reference(GIISPatient) | Who this profile is for | ||||
| date |
SΣ | 1..1 | dateTime | Date recommendation(s) created | ||||
| authority |
0..1 | Reference(Organization) | Who is responsible for protocol | |||||
| recommendation |
SΣ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 |
SΣ | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: Vaccine codes (example) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 0..1 | Coding | Code defined by a terminology system | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
SΣ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| 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 |
?!SΣ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 0..1 | string | Plain text representation of the concept | ||||
| forecastReason |
Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||
| dateCriterion |
S | 1..1 | 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 |
S | 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 |
S | 1..1 | dateTime | Date as YYYY-MM-DD | ||||
| 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(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
| supportingPatientInformation |
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 | VaccineVS (a valid code from Vaccine codes)https://paho.org/fhir/giis/ValueSet/VaccineVSfrom this IG | ||||
| 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 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImmunizationRecommendation | 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() | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() |
This structure is derived from ImmunizationRecommendation
Other representations of profile: CSV, Excel, Schematron