HL7 FHIR Costa Rica - Core
0.0.1-ballot - ci-build Costa Rica flag

HL7 FHIR Costa Rica - Core, published by Iniciativa HL7 Costa Rica. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cr/core/ and changes regularly. See the Directory of published versions

Resource Profile: Inmunización

Official URL: https://hl7.or.cr/fhir/core/StructureDefinition/cr-core-immunization Version: 0.0.1-ballot
Standards status: Draft Maturity Level: 0 Computable Name: CRCoreImmunization

Copyright/Legal: Usado con el permiso de HL7 International, todos los derechos resevados en los Licencias de HL7 Internacional.

Perfil Immunization para registrar eventos de inmunización, incluyendo metadatos específicos relacionados con la administración de vacunas.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization(5.0.0) Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!SΣ 1..1 code Estado de la inmunización.
Binding: ImmunizationStatusCodes (required): ValueSet de estados de Immunization definidos en FHIR.
... statusReason S 0..1 CodeableConcept Razón del estado de la inmunización.
Binding: ImmunizationStatusReasonCodes (extensible): ValueSet de razones de estado de Immunization definidas en FHIR.
... vaccineCode SΣ 1..1 CodeableConcept Código de la vacuna administrada.
Binding: VaccineAdministeredValueSet (example)
... manufacturer S 0..1 CodeableReference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiration date
... patient SΣ 1..1 Reference(Paciente(0.0.1-ballot)) Paciente que recibió la inmunización.
... encounter S 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
... primarySource SΣ 0..1 boolean Indicates context the data was captured in
... informationSource S 0..1 CodeableReference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Indicates the source of a reported record
Binding: ImmunizationOriginCodes (example)
... location S 0..1 Reference(Ubicación(0.0.1-ballot)) Where immunization occurred
... performer SΣ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function SΣ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
.... actor SΣ 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Individual or organization who was performing
... note SΣ 0..* Annotation Additional immunization notes
... isSubpotent ?!Σ 0..1 boolean Dose potency
... reaction S 0..* BackboneElement Details of a reaction that follows immunization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📍5.0.0 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍5.0.0 FHIR Std.
Immunization.informationSource Base example Immunization Origin Codes 📍5.0.0 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error Immunization.implicitRules, Immunization.modifierExtension, Immunization.identifier, Immunization.status, Immunization.statusReason, Immunization.vaccineCode, Immunization.manufacturer, Immunization.lotNumber, Immunization.expirationDate, Immunization.patient, Immunization.encounter, Immunization.occurrence[x], Immunization.occurrence[x]:occurrenceDateTime, Immunization.primarySource, Immunization.informationSource, Immunization.location, Immunization.performer, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.note, Immunization.isSubpotent, Immunization.reaction, Immunization.reaction.modifierExtension All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Immunization.modifierExtension, Immunization.performer.modifierExtension, Immunization.reaction.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization(5.0.0) Immunization event information
... identifier S 0..* Identifier Identificadores de la inmunización.
... status S 1..1 code Estado de la inmunización.
Binding: ImmunizationStatusCodes (required): ValueSet de estados de Immunization definidos en FHIR.
... statusReason S 0..1 CodeableConcept Razón del estado de la inmunización.
Binding: ImmunizationStatusReasonCodes (extensible): ValueSet de razones de estado de Immunization definidas en FHIR.
... manufacturer S 0..1 CodeableReference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiration date
... patient S 1..1 Reference(Paciente(0.0.1-ballot)) Paciente que recibió la inmunización.
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... 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
... primarySource S 0..1 boolean Indicates context the data was captured in
... informationSource S 0..1 CodeableReference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Indicates the source of a reported record
... location S 0..1 Reference(Ubicación(0.0.1-ballot)) Where immunization occurred
... performer S 0..* BackboneElement Who performed event
.... function S 0..1 CodeableConcept What type of performance was done
.... actor S 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Individual or organization who was performing
... note S 0..* Annotation Additional immunization notes
... reaction S 0..* BackboneElement Details of a reaction that follows immunization

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📍5.0.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization(5.0.0) 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier S 0..* Identifier Identificadores de la inmunización.
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Authority that the immunization event is based on
... status ?!SΣ 1..1 code Estado de la inmunización.
Binding: ImmunizationStatusCodes (required): ValueSet de estados de Immunization definidos en FHIR.
... statusReason S 0..1 CodeableConcept Razón del estado de la inmunización.
Binding: ImmunizationStatusReasonCodes (extensible): ValueSet de razones de estado de Immunization definidas en FHIR.
... vaccineCode SΣ 1..1 CodeableConcept Código de la vacuna administrada.
Binding: VaccineAdministeredValueSet (example)
... administeredProduct 0..1 CodeableReference(Medication) Product that was administered
... manufacturer S 0..1 CodeableReference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiration date
... patient SΣ 1..1 Reference(Paciente(0.0.1-ballot)) Paciente que recibió la inmunización.
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... supportingInformation 0..* Reference(Resource) Additional information in support of the immunization
... 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
... primarySource SΣ 0..1 boolean Indicates context the data was captured in
... informationSource S 0..1 CodeableReference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Indicates the source of a reported record
Binding: ImmunizationOriginCodes (example)
... location S 0..1 Reference(Ubicación(0.0.1-ballot)) Where immunization occurred
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity 0..1 SimpleQuantity(5.0.0) Amount of vaccine administered
... performer SΣ 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function SΣ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
.... actor SΣ 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Individual or organization who was performing
... note SΣ 0..* Annotation Additional immunization notes
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport) Why immunization occurred
Binding: ImmunizationReasonCodes (example)
... 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.
... programEligibility 0..* BackboneElement Patient eligibility for a specific vaccination program
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... program 1..1 CodeableConcept The program that eligibility is declared for
Binding: CodesForVaccineFundingPrograms (example)
.... programStatus 1..1 CodeableConcept The patient's eligibility status for the program
Binding: ImmunizationProgramEligibility (example)
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example)
... reaction S 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... date 0..1 dateTime When reaction started
.... manifestation 0..1 CodeableReference(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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 targeted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber 1..1 string Dose number within series
.... seriesDoses 0..1 string Recommended number of doses for immunity

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base required All Languages 📍5.0.0 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📍5.0.0 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍5.0.0 FHIR Std.
Immunization.informationSource Base example Immunization Origin Codes 📍5.0.0 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍5.0.0 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍5.0.0 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍5.0.0 FHIR Std.
Immunization.reason Base example Immunization Reason Codes 📍5.0.0 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍5.0.0 FHIR Std.
Immunization.programEligibility.​program Base example Vaccine Funding Programs 📍5.0.0 FHIR Std.
Immunization.programEligibility.​programStatus Base example Immunization Program Eligibility 📍5.0.0 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍5.0.0 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error Immunization.meta, Immunization.implicitRules, Immunization.language, Immunization.text, Immunization.extension, Immunization.modifierExtension, Immunization.identifier, Immunization.basedOn, Immunization.status, Immunization.statusReason, Immunization.vaccineCode, Immunization.administeredProduct, Immunization.manufacturer, Immunization.lotNumber, Immunization.expirationDate, Immunization.patient, Immunization.encounter, Immunization.supportingInformation, Immunization.occurrence[x], Immunization.occurrence[x]:occurrenceDateTime, Immunization.primarySource, Immunization.informationSource, Immunization.location, Immunization.site, Immunization.route, Immunization.doseQuantity, Immunization.performer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.note, Immunization.reason, Immunization.isSubpotent, Immunization.subpotentReason, Immunization.programEligibility, Immunization.programEligibility.extension, Immunization.programEligibility.modifierExtension, Immunization.programEligibility.program, Immunization.programEligibility.programStatus, Immunization.fundingSource, Immunization.reaction, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.date, Immunization.reaction.manifestation, Immunization.reaction.reported, Immunization.protocolApplied, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.authority, Immunization.protocolApplied.targetDisease, Immunization.protocolApplied.doseNumber, Immunization.protocolApplied.seriesDoses All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Immunization.extension, Immunization.modifierExtension, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.programEligibility.extension, Immunization.programEligibility.modifierExtension, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization(5.0.0) Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!SΣ 1..1 code Estado de la inmunización.
Binding: ImmunizationStatusCodes (required): ValueSet de estados de Immunization definidos en FHIR.
... statusReason S 0..1 CodeableConcept Razón del estado de la inmunización.
Binding: ImmunizationStatusReasonCodes (extensible): ValueSet de razones de estado de Immunization definidas en FHIR.
... vaccineCode SΣ 1..1 CodeableConcept Código de la vacuna administrada.
Binding: VaccineAdministeredValueSet (example)
... manufacturer S 0..1 CodeableReference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiration date
... patient SΣ 1..1 Reference(Paciente(0.0.1-ballot)) Paciente que recibió la inmunización.
... encounter S 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
... primarySource SΣ 0..1 boolean Indicates context the data was captured in
... informationSource S 0..1 CodeableReference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Indicates the source of a reported record
Binding: ImmunizationOriginCodes (example)
... location S 0..1 Reference(Ubicación(0.0.1-ballot)) Where immunization occurred
... performer SΣ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function SΣ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
.... actor SΣ 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Individual or organization who was performing
... note SΣ 0..* Annotation Additional immunization notes
... isSubpotent ?!Σ 0..1 boolean Dose potency
... reaction S 0..* BackboneElement Details of a reaction that follows immunization
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📍5.0.0 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍5.0.0 FHIR Std.
Immunization.informationSource Base example Immunization Origin Codes 📍5.0.0 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error Immunization.implicitRules, Immunization.modifierExtension, Immunization.identifier, Immunization.status, Immunization.statusReason, Immunization.vaccineCode, Immunization.manufacturer, Immunization.lotNumber, Immunization.expirationDate, Immunization.patient, Immunization.encounter, Immunization.occurrence[x], Immunization.occurrence[x]:occurrenceDateTime, Immunization.primarySource, Immunization.informationSource, Immunization.location, Immunization.performer, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.note, Immunization.isSubpotent, Immunization.reaction, Immunization.reaction.modifierExtension All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Immunization.modifierExtension, Immunization.performer.modifierExtension, Immunization.reaction.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization(5.0.0) Immunization event information
... identifier S 0..* Identifier Identificadores de la inmunización.
... status S 1..1 code Estado de la inmunización.
Binding: ImmunizationStatusCodes (required): ValueSet de estados de Immunization definidos en FHIR.
... statusReason S 0..1 CodeableConcept Razón del estado de la inmunización.
Binding: ImmunizationStatusReasonCodes (extensible): ValueSet de razones de estado de Immunization definidas en FHIR.
... manufacturer S 0..1 CodeableReference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiration date
... patient S 1..1 Reference(Paciente(0.0.1-ballot)) Paciente que recibió la inmunización.
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... 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
... primarySource S 0..1 boolean Indicates context the data was captured in
... informationSource S 0..1 CodeableReference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Indicates the source of a reported record
... location S 0..1 Reference(Ubicación(0.0.1-ballot)) Where immunization occurred
... performer S 0..* BackboneElement Who performed event
.... function S 0..1 CodeableConcept What type of performance was done
.... actor S 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Individual or organization who was performing
... note S 0..* Annotation Additional immunization notes
... reaction S 0..* BackboneElement Details of a reaction that follows immunization

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📍5.0.0 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization(5.0.0) 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier S 0..* Identifier Identificadores de la inmunización.
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Authority that the immunization event is based on
... status ?!SΣ 1..1 code Estado de la inmunización.
Binding: ImmunizationStatusCodes (required): ValueSet de estados de Immunization definidos en FHIR.
... statusReason S 0..1 CodeableConcept Razón del estado de la inmunización.
Binding: ImmunizationStatusReasonCodes (extensible): ValueSet de razones de estado de Immunization definidas en FHIR.
... vaccineCode SΣ 1..1 CodeableConcept Código de la vacuna administrada.
Binding: VaccineAdministeredValueSet (example)
... administeredProduct 0..1 CodeableReference(Medication) Product that was administered
... manufacturer S 0..1 CodeableReference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Vaccine lot number
... expirationDate S 0..1 date Vaccine expiration date
... patient SΣ 1..1 Reference(Paciente(0.0.1-ballot)) Paciente que recibió la inmunización.
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... supportingInformation 0..* Reference(Resource) Additional information in support of the immunization
... 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
... primarySource SΣ 0..1 boolean Indicates context the data was captured in
... informationSource S 0..1 CodeableReference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Indicates the source of a reported record
Binding: ImmunizationOriginCodes (example)
... location S 0..1 Reference(Ubicación(0.0.1-ballot)) Where immunization occurred
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity 0..1 SimpleQuantity(5.0.0) Amount of vaccine administered
... performer SΣ 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... function SΣ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
.... actor SΣ 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Individual or organization who was performing
... note SΣ 0..* Annotation Additional immunization notes
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport) Why immunization occurred
Binding: ImmunizationReasonCodes (example)
... 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.
... programEligibility 0..* BackboneElement Patient eligibility for a specific vaccination program
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... program 1..1 CodeableConcept The program that eligibility is declared for
Binding: CodesForVaccineFundingPrograms (example)
.... programStatus 1..1 CodeableConcept The patient's eligibility status for the program
Binding: ImmunizationProgramEligibility (example)
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example)
... reaction S 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... date 0..1 dateTime When reaction started
.... manifestation 0..1 CodeableReference(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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 targeted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber 1..1 string Dose number within series
.... seriesDoses 0..1 string Recommended number of doses for immunity

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base required All Languages 📍5.0.0 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📍5.0.0 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍5.0.0 FHIR Std.
Immunization.informationSource Base example Immunization Origin Codes 📍5.0.0 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍5.0.0 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍5.0.0 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍5.0.0 FHIR Std.
Immunization.reason Base example Immunization Reason Codes 📍5.0.0 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍5.0.0 FHIR Std.
Immunization.programEligibility.​program Base example Vaccine Funding Programs 📍5.0.0 FHIR Std.
Immunization.programEligibility.​programStatus Base example Immunization Program Eligibility 📍5.0.0 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍5.0.0 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization 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 Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error Immunization.meta, Immunization.implicitRules, Immunization.language, Immunization.text, Immunization.extension, Immunization.modifierExtension, Immunization.identifier, Immunization.basedOn, Immunization.status, Immunization.statusReason, Immunization.vaccineCode, Immunization.administeredProduct, Immunization.manufacturer, Immunization.lotNumber, Immunization.expirationDate, Immunization.patient, Immunization.encounter, Immunization.supportingInformation, Immunization.occurrence[x], Immunization.occurrence[x]:occurrenceDateTime, Immunization.primarySource, Immunization.informationSource, Immunization.location, Immunization.site, Immunization.route, Immunization.doseQuantity, Immunization.performer, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.performer.function, Immunization.performer.actor, Immunization.note, Immunization.reason, Immunization.isSubpotent, Immunization.subpotentReason, Immunization.programEligibility, Immunization.programEligibility.extension, Immunization.programEligibility.modifierExtension, Immunization.programEligibility.program, Immunization.programEligibility.programStatus, Immunization.fundingSource, Immunization.reaction, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.reaction.date, Immunization.reaction.manifestation, Immunization.reaction.reported, Immunization.protocolApplied, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension, Immunization.protocolApplied.series, Immunization.protocolApplied.authority, Immunization.protocolApplied.targetDisease, Immunization.protocolApplied.doseNumber, Immunization.protocolApplied.seriesDoses All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Immunization.extension, Immunization.modifierExtension, Immunization.performer.extension, Immunization.performer.modifierExtension, Immunization.programEligibility.extension, Immunization.programEligibility.modifierExtension, Immunization.reaction.extension, Immunization.reaction.modifierExtension, Immunization.protocolApplied.extension, Immunization.protocolApplied.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Immunization

 

Other representations of profile: CSV, Excel, Schematron