GIIS Implementation Guide
0.1.8 - ci-build International flag

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

Resource Profile: VaccinationEvent

Official URL: https://paho.org/fhir/giis/StructureDefinition/VaccinationEvent Version: 0.1.8
Draft as of 2024-11-05 Computable Name: VaccinationEvent

A regular vaccination event, this one is for those ones that happens outside a vaccination calendar, so it can be related to an adult or a child.

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... Slices for extension 1..4 Extension Extension
Slice: Unordered, Open by value:url
.... vaccinationCampaign S 0..1 Reference(VaccinationCampaign) Extension made for handling Immunization Campaigns.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-campaign
.... AEFI S 0..1 boolean Extension made for handling AEFI.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-aefi
.... healthstatus S 1..1 CodeableConcept Extension made for handling patient's health status prior to this vaccination event
URL: https://paho.org/fhir/giis/StructureDefinition/giis-healthstatus
Binding: Health Status (example)
.... lotIdNumber S 0..1 integer Exttension made for handling the LotId number for the GIIS db
URL: https://paho.org/fhir/giis/StructureDefinition/giis-lotidnumber
... status S 1..1 code Code MUST be #completed OR #not-done
... statusReason S 0..1 CodeableConcept Reason not done
Binding: Non vaccination reason (example)
.... coding S 0..1 Coding Code defined by a terminology system
..... code S 1..1 code Symbol in syntax defined by the system
.... text S 0..1 string Plain text representation of the concept
.... coding S 0..1 Coding Code defined by a terminology system
.... text S 0..1 string Vaccine name as text
... patient 1..1 Reference(GIISPatient) Who was immunized
... Slices for occurrence[x] 1..1 dateTime Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 1..1 dateTime Vaccine administration date YYYY-MM-DD.
... location S 1..1 Reference(HealthFacilityLocation) Where immunization occurred
... lotNumber S 1..1 string If the vaccine is not from stock, the lot number is free text
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: Vaccination body site (example)
.... coding S 0..1 Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
Required Pattern: https://paho.org/fhir/giis/CodeSystem/VaccinationSiteCS
..... code S 0..1 code Symbol in syntax defined by the system
.... text S 0..1 string Plain text representation of the concept
... performer 1..1 BackboneElement Who performed event
.... actor 1..1 Reference(Practitioner) Individual or organization who was performing
... note S 0..1 Annotation Additional immunization notes
... reasonCode S 1..1 CodeableConcept Why immunization occurred
Binding: Vaccination reason (example)
.... coding S 0..1 Coding Code defined by a terminology system
..... code S 1..1 code Symbol in syntax defined by the system
.... text S 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusReasonexampleNonVaccinationReasonVS (a valid code from Non vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/NonVaccinationReasonVS
from this IG
Immunization.vaccineCodeexampleOtherVaccineVS (a valid code from Other Vaccine codes)
https://paho.org/fhir/giis/ValueSet/OtherVaccineVS
from this IG
Immunization.siteexampleVaccinationSiteVS (a valid code from Vaccination site codes)
https://paho.org/fhir/giis/ValueSet/VaccinationSiteVS
from this IG
Immunization.reasonCodeexampleVaccinationReasonVS (a valid code from Vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/VaccinationReasonVS
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..4 Extension Extension
Slice: Unordered, Open by value:url
.... vaccinationCampaign S 0..1 Reference(VaccinationCampaign) Extension made for handling Immunization Campaigns.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-campaign
.... AEFI S 0..1 boolean Extension made for handling AEFI.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-aefi
.... healthstatus S 1..1 CodeableConcept Extension made for handling patient's health status prior to this vaccination event
URL: https://paho.org/fhir/giis/StructureDefinition/giis-healthstatus
Binding: Health Status (example)
.... lotIdNumber S 0..1 integer Exttension made for handling the LotId number for the GIIS db
URL: https://paho.org/fhir/giis/StructureDefinition/giis-lotidnumber
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... statusReason S 0..1 CodeableConcept Reason not done
Binding: Non vaccination reason (example)
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: Other Vaccine codes (example)
.... coding SΣ 0..1 Coding Code defined by a terminology system
.... text SΣ 0..1 string Vaccine name as text
... patient Σ 1..1 Reference(GIISPatient) Who was immunized
... Slices for occurrence[x] Σ 1..1 dateTime Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime Vaccine administration date YYYY-MM-DD.
... location S 1..1 Reference(HealthFacilityLocation) Where immunization occurred
... lotNumber S 1..1 string If the vaccine is not from stock, the lot number is free text
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: Vaccination body site (example)
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://paho.org/fhir/giis/CodeSystem/VaccinationSiteCS
..... code SΣ 0..1 code Symbol in syntax defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... performer Σ 1..1 BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
... note SΣ 0..1 Annotation Additional immunization notes
... reasonCode S 1..1 CodeableConcept Why immunization occurred
Binding: Vaccination reason (example)
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonexampleNonVaccinationReasonVS (a valid code from Non vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/NonVaccinationReasonVS
from this IG
Immunization.vaccineCodeexampleOtherVaccineVS (a valid code from Other Vaccine codes)
https://paho.org/fhir/giis/ValueSet/OtherVaccineVS
from this IG
Immunization.siteexampleVaccinationSiteVS (a valid code from Vaccination site codes)
https://paho.org/fhir/giis/ValueSet/VaccinationSiteVS
from this IG
Immunization.reasonCodeexampleVaccinationReasonVS (a valid code from Vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/VaccinationReasonVS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..4 Extension Extension
Slice: Unordered, Open by value:url
.... vaccinationCampaign S 0..1 Reference(VaccinationCampaign) Extension made for handling Immunization Campaigns.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-campaign
.... AEFI S 0..1 boolean Extension made for handling AEFI.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-aefi
.... healthstatus S 1..1 CodeableConcept Extension made for handling patient's health status prior to this vaccination event
URL: https://paho.org/fhir/giis/StructureDefinition/giis-healthstatus
Binding: Health Status (example)
.... lotIdNumber S 0..1 integer Exttension made for handling the LotId number for the GIIS db
URL: https://paho.org/fhir/giis/StructureDefinition/giis-lotidnumber
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 1..1 code Code MUST be #completed OR #not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S 0..1 CodeableConcept Reason not done
Binding: Non vaccination reason (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Σ 1..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
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: Other 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
.... text SΣ 0..1 string Vaccine name as text
... patient Σ 1..1 Reference(GIISPatient) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 dateTime Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime Vaccine administration date YYYY-MM-DD.
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location S 1..1 Reference(HealthFacilityLocation) Where immunization occurred
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 1..1 string If the vaccine is not from stock, the lot number is free text
... expirationDate 0..1 date Vaccine expiration date
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: Vaccination body site (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 SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://paho.org/fhir/giis/CodeSystem/VaccinationSiteCS
..... 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
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

... doseQuantity 0..1 SimpleQuantity Amount of vaccine administered
... performer Σ 1..1 BackboneElement Who performed event
.... 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
.... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
... note SΣ 0..1 Annotation Additional immunization notes
... reasonCode S 1..1 CodeableConcept Why immunization occurred
Binding: Vaccination reason (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Σ 1..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
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C 0..* BackboneElement Educational material presented to patient
imm-1: One of documentType or reference 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
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..* BackboneElement Details of a reaction that follows 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
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... 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
.... series 0..1 string Name of vaccine series
.... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.


.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonexampleNonVaccinationReasonVS (a valid code from Non vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/NonVaccinationReasonVS
from this IG
Immunization.vaccineCodeexampleOtherVaccineVS (a valid code from Other Vaccine codes)
https://paho.org/fhir/giis/ValueSet/OtherVaccineVS
from this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siteexampleVaccinationSiteVS (a valid code from Vaccination site codes)
https://paho.org/fhir/giis/ValueSet/VaccinationSiteVS
from this IG
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodeexampleVaccinationReasonVS (a valid code from Vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/VaccinationReasonVS
from this IG
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

Summary

Mandatory: 8 elements(3 nested mandatory elements)
Must-Support: 25 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.occurrence[x]

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... Slices for extension 1..4 Extension Extension
Slice: Unordered, Open by value:url
.... vaccinationCampaign S 0..1 Reference(VaccinationCampaign) Extension made for handling Immunization Campaigns.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-campaign
.... AEFI S 0..1 boolean Extension made for handling AEFI.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-aefi
.... healthstatus S 1..1 CodeableConcept Extension made for handling patient's health status prior to this vaccination event
URL: https://paho.org/fhir/giis/StructureDefinition/giis-healthstatus
Binding: Health Status (example)
.... lotIdNumber S 0..1 integer Exttension made for handling the LotId number for the GIIS db
URL: https://paho.org/fhir/giis/StructureDefinition/giis-lotidnumber
... status S 1..1 code Code MUST be #completed OR #not-done
... statusReason S 0..1 CodeableConcept Reason not done
Binding: Non vaccination reason (example)
.... coding S 0..1 Coding Code defined by a terminology system
..... code S 1..1 code Symbol in syntax defined by the system
.... text S 0..1 string Plain text representation of the concept
.... coding S 0..1 Coding Code defined by a terminology system
.... text S 0..1 string Vaccine name as text
... patient 1..1 Reference(GIISPatient) Who was immunized
... Slices for occurrence[x] 1..1 dateTime Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 1..1 dateTime Vaccine administration date YYYY-MM-DD.
... location S 1..1 Reference(HealthFacilityLocation) Where immunization occurred
... lotNumber S 1..1 string If the vaccine is not from stock, the lot number is free text
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: Vaccination body site (example)
.... coding S 0..1 Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
Required Pattern: https://paho.org/fhir/giis/CodeSystem/VaccinationSiteCS
..... code S 0..1 code Symbol in syntax defined by the system
.... text S 0..1 string Plain text representation of the concept
... performer 1..1 BackboneElement Who performed event
.... actor 1..1 Reference(Practitioner) Individual or organization who was performing
... note S 0..1 Annotation Additional immunization notes
... reasonCode S 1..1 CodeableConcept Why immunization occurred
Binding: Vaccination reason (example)
.... coding S 0..1 Coding Code defined by a terminology system
..... code S 1..1 code Symbol in syntax defined by the system
.... text S 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusReasonexampleNonVaccinationReasonVS (a valid code from Non vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/NonVaccinationReasonVS
from this IG
Immunization.vaccineCodeexampleOtherVaccineVS (a valid code from Other Vaccine codes)
https://paho.org/fhir/giis/ValueSet/OtherVaccineVS
from this IG
Immunization.siteexampleVaccinationSiteVS (a valid code from Vaccination site codes)
https://paho.org/fhir/giis/ValueSet/VaccinationSiteVS
from this IG
Immunization.reasonCodeexampleVaccinationReasonVS (a valid code from Vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/VaccinationReasonVS
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..4 Extension Extension
Slice: Unordered, Open by value:url
.... vaccinationCampaign S 0..1 Reference(VaccinationCampaign) Extension made for handling Immunization Campaigns.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-campaign
.... AEFI S 0..1 boolean Extension made for handling AEFI.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-aefi
.... healthstatus S 1..1 CodeableConcept Extension made for handling patient's health status prior to this vaccination event
URL: https://paho.org/fhir/giis/StructureDefinition/giis-healthstatus
Binding: Health Status (example)
.... lotIdNumber S 0..1 integer Exttension made for handling the LotId number for the GIIS db
URL: https://paho.org/fhir/giis/StructureDefinition/giis-lotidnumber
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... statusReason S 0..1 CodeableConcept Reason not done
Binding: Non vaccination reason (example)
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: Other Vaccine codes (example)
.... coding SΣ 0..1 Coding Code defined by a terminology system
.... text SΣ 0..1 string Vaccine name as text
... patient Σ 1..1 Reference(GIISPatient) Who was immunized
... Slices for occurrence[x] Σ 1..1 dateTime Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime Vaccine administration date YYYY-MM-DD.
... location S 1..1 Reference(HealthFacilityLocation) Where immunization occurred
... lotNumber S 1..1 string If the vaccine is not from stock, the lot number is free text
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: Vaccination body site (example)
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://paho.org/fhir/giis/CodeSystem/VaccinationSiteCS
..... code SΣ 0..1 code Symbol in syntax defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... performer Σ 1..1 BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
... note SΣ 0..1 Annotation Additional immunization notes
... reasonCode S 1..1 CodeableConcept Why immunization occurred
Binding: Vaccination reason (example)
.... coding SΣ 0..1 Coding Code defined by a terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonexampleNonVaccinationReasonVS (a valid code from Non vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/NonVaccinationReasonVS
from this IG
Immunization.vaccineCodeexampleOtherVaccineVS (a valid code from Other Vaccine codes)
https://paho.org/fhir/giis/ValueSet/OtherVaccineVS
from this IG
Immunization.siteexampleVaccinationSiteVS (a valid code from Vaccination site codes)
https://paho.org/fhir/giis/ValueSet/VaccinationSiteVS
from this IG
Immunization.reasonCodeexampleVaccinationReasonVS (a valid code from Vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/VaccinationReasonVS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Immunization event information
... 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.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..4 Extension Extension
Slice: Unordered, Open by value:url
.... vaccinationCampaign S 0..1 Reference(VaccinationCampaign) Extension made for handling Immunization Campaigns.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-campaign
.... AEFI S 0..1 boolean Extension made for handling AEFI.
URL: https://paho.org/fhir/giis/StructureDefinition/giis-aefi
.... healthstatus S 1..1 CodeableConcept Extension made for handling patient's health status prior to this vaccination event
URL: https://paho.org/fhir/giis/StructureDefinition/giis-healthstatus
Binding: Health Status (example)
.... lotIdNumber S 0..1 integer Exttension made for handling the LotId number for the GIIS db
URL: https://paho.org/fhir/giis/StructureDefinition/giis-lotidnumber
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 1..1 code Code MUST be #completed OR #not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S 0..1 CodeableConcept Reason not done
Binding: Non vaccination reason (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Σ 1..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
... vaccineCode SΣ 1..1 CodeableConcept Vaccine product administered
Binding: Other 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
.... text SΣ 0..1 string Vaccine name as text
... patient Σ 1..1 Reference(GIISPatient) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 dateTime Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣ 1..1 dateTime Vaccine administration date YYYY-MM-DD.
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location S 1..1 Reference(HealthFacilityLocation) Where immunization occurred
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 1..1 string If the vaccine is not from stock, the lot number is free text
... expirationDate 0..1 date Vaccine expiration date
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: Vaccination body site (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 SΣ 1..1 uri Identity of the terminology system
Required Pattern: https://paho.org/fhir/giis/CodeSystem/VaccinationSiteCS
..... 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
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

... doseQuantity 0..1 SimpleQuantity Amount of vaccine administered
... performer Σ 1..1 BackboneElement Who performed event
.... 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
.... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ 1..1 Reference(Practitioner) Individual or organization who was performing
... note SΣ 0..1 Annotation Additional immunization notes
... reasonCode S 1..1 CodeableConcept Why immunization occurred
Binding: Vaccination reason (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Σ 1..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
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C 0..* BackboneElement Educational material presented to patient
imm-1: One of documentType or reference 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
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..* BackboneElement Details of a reaction that follows 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
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied 0..* BackboneElement Protocol followed by the provider
.... 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
.... series 0..1 string Name of vaccine series
.... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.


.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonexampleNonVaccinationReasonVS (a valid code from Non vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/NonVaccinationReasonVS
from this IG
Immunization.vaccineCodeexampleOtherVaccineVS (a valid code from Other Vaccine codes)
https://paho.org/fhir/giis/ValueSet/OtherVaccineVS
from this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siteexampleVaccinationSiteVS (a valid code from Vaccination site codes)
https://paho.org/fhir/giis/ValueSet/VaccinationSiteVS
from this IG
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
from the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodeexampleVaccinationReasonVS (a valid code from Vaccination reason codes)
https://paho.org/fhir/giis/ValueSet/VaccinationReasonVS
from this IG
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

Summary

Mandatory: 8 elements(3 nested mandatory elements)
Must-Support: 25 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.occurrence[x]

 

Other representations of profile: CSV, Excel, Schematron