Resumen Clínico del Paciente de Chile
0.5.0-ci-build - STU3 Chile flag

Resumen Clínico del Paciente de Chile, published by HL7 Chile. This guide is not an authorized publication; it is the continuous build for version 0.5.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7Chile/IPS-CL/ and changes regularly. See the Directory of published versions

Resource Profile: Inmunización ICVP

Official URL: https://hl7chile.cl/fhir/ig/clips/StructureDefinition/Inmunizacion-cl-ips-icvp Version: 0.5.0-ci-build
Standards status: Draft Maturity Level: 1 Computable Name: InmunizacionClICVPIps

Este perfil representa las restricciones aplicadas al recurso Inmunización por la Guía de Implementación FHIR del Resumen Internacional del Paciente (IPS) orientado a la certificación internacional para fiebre amarilla y polio

Usages:

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..* ImmunizationCL Immunization event information
This profile also complies with the profile DVC - WHO ICVP Immunization for IPS
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ClaseVacuna S 0..1 Coding Clase de Vacuna
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ClaseVacuna
Binding: Códigos de clases de Vacuna (preferred)
.... extension:Campana S 0..1 string Nombre Campaña de Vacunación
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Campana
.... extension:Dosis S 0..1 string Dosis Administrada
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Dosis
.... extension:ProxFecha S 0..1 date Proxima fecha de vacunación
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ProxFecha
.... extension:productID SC 1..1 Coding Identificador del producto de la vacuna según los códigos prequal de la OMS
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID profiled by https://hl7chile.cl/fhir/ig/clips/StructureDefinition/ProductID
Binding: WHO ICVP Vaccine Product Ids (required)
Constraints: has-an-icvp-vaccine-product-id-code
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason S 0..1 CodeableConcept Razón de no realizarse la inmunización
Binding: Razones no Inmunización (example)
.... text SΣ 0..1 string Descripción de la razón por la cual no se produjo la inmunización
... vaccineCode SΣC 1..1 CodeableConcept Código de la Vacuna que fue administrada o será administrada
Binding: Vaccine Types for use in the ICVP (required)
Constraints: has-an-icvp-vaccine-type
.... text SΣ 0..1 string Nombre normalizado a nivel nacional de la vacuna
... patient SΣ 1..1 Reference(Paciente) Paciente inmunizado
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for occurrence[x] SΣ 1..1 Momento de administración de la vacuna
Slice: Unordered, Closed by type:$this
.... occurrence[x]:All Slices Content/Rules for all slices
..... occurrence[x]All Types Content/Rules for all Types
...... Slices for extension Content/Rules for all slices
....... extension:data-absent-reason S 0..1 code occurrence[x] razón de la ausencia
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Fecha y hora de la administración
.... occurrence[x]:occurrenceString SΣ 0..1 string Momento de la administración
... recorded S 0..1 dateTime Cuando realizó el registro de la inmunización
... reportOrigin S 0..1 CodeableConcept Fuente de registro
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location S 0..1 Reference(CL Localización) Dónde se produjo la inmunización
... lotNumber S 0..1 string Número de lote de la vacuna
... expirationDate S 0..1 date Fecha de caducidad de la vacuna
... performer SΣ 0..* BackboneElement Quién realizó la inmunización
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(CL Prestador | CL Organización) Prestador personal u organizacional que realizó la acción
... isSubpotent ?!Σ 0..1 boolean Dose potency
... programEligibility S 0..* CodeableConcept Corresponde al Id del criterio de elegibilidad de la vacuna administrada
Binding: ImmunizationProgramEligibility (example)
.... coding Σ 0..* Coding Code defined by a terminology system
..... code SΣ 0..1 code Código identificador del criterio
..... display SΣ 0..1 string Descripción del programa asociado al identificador del criterio
... reaction S 0..* BackboneElement Detalles de una reacción que proviene de la inmunización
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... protocolApplied S 0..* BackboneElement Protocolo seguido por el proveedor
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base example Razones no Inmunización 📦1.9.4 Guía de Implementación ''cl core'' FHIR R4, v1.9
Immunization.vaccineCode Base required Vaccine Types for use in the ICVP 📦0.3.0 SMART ICVP v0.3
Immunization.reportOrigin Base example Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📦4.0.1 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().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 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 **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()
has-an-icvp-vaccine-product-id-code error Immunization.extension:productID Check if there is a business identifier of a vaccine product in the ICVP product catalogue, The ICVP product catalogue consists of vaccines listed in the list of Prequalified Vaccines and the Emergency Use Listing. - https://extranet.who.int/prequal/vaccines/prequalified-vaccines - https://www.who.int/teams/regulation-prequalification/eul In FHIR R6, this could also be a reference to an InventoryItem .valueCoding.code.memberOf('http://smart.who.int/icvp/ValueSet/ICVPProductIds')
has-an-icvp-vaccine-type error Immunization.vaccineCode Ensure vaccine type is from the prequal vaccine database for ICVP vaccines memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')

This structure is derived from ImmunizationCL

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization ImmunizationCL This profile also complies with the profile DVC - WHO ICVP Immunization for IPS
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:productID SC 1..1 Coding Identificador del producto de la vacuna según los códigos prequal de la OMS
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID profiled by https://hl7chile.cl/fhir/ig/clips/StructureDefinition/ProductID
Binding: WHO ICVP Vaccine Product Ids (required)
Constraints: has-an-icvp-vaccine-product-id-code
... vaccineCode C 1..1 CodeableConcept Código de la Vacuna que fue administrada o será administrada
Binding: Vaccine Types for use in the ICVP (required)
Constraints: has-an-icvp-vaccine-type
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... occurrence[x] 1..1 dateTime, string Momento de administración de la vacuna
.... Slices for extension Content/Rules for all slices
..... extension:data-absent-reason S 0..1 code occurrence[x] razón de la ausencia
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base required Vaccine Types for use in the ICVP 📦0.3.0 SMART ICVP v0.3

Constraints

Id Grade Path(s) Description Expression
has-an-icvp-vaccine-product-id-code error Immunization.extension:productID Check if there is a business identifier of a vaccine product in the ICVP product catalogue, The ICVP product catalogue consists of vaccines listed in the list of Prequalified Vaccines and the Emergency Use Listing. - https://extranet.who.int/prequal/vaccines/prequalified-vaccines - https://www.who.int/teams/regulation-prequalification/eul In FHIR R6, this could also be a reference to an InventoryItem .valueCoding.code.memberOf('http://smart.who.int/icvp/ValueSet/ICVPProductIds')
has-an-icvp-vaccine-type error Immunization.vaccineCode Ensure vaccine type is from the prequal vaccine database for ICVP vaccines memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* ImmunizationCL Immunization event information
This profile also complies with the profile DVC - WHO ICVP Immunization for IPS
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ClaseVacuna S 0..1 Coding Clase de Vacuna
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ClaseVacuna
Binding: Códigos de clases de Vacuna (preferred)
.... extension:Campana S 0..1 string Nombre Campaña de Vacunación
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Campana
.... extension:Dosis S 0..1 string Dosis Administrada
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Dosis
.... extension:ProxFecha S 0..1 date Proxima fecha de vacunación
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ProxFecha
.... extension:productID SC 1..1 Coding Identificador del producto de la vacuna según los códigos prequal de la OMS
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID profiled by https://hl7chile.cl/fhir/ig/clips/StructureDefinition/ProductID
Binding: WHO ICVP Vaccine Product Ids (required)
Constraints: has-an-icvp-vaccine-product-id-code
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier Identificador(es) por los que se conoce este registro de Inmunización. En el caso del sistema público correspondería al ID del Registro de Inmunización
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason S 0..1 CodeableConcept Razón de no realizarse la inmunización
Binding: Razones no Inmunización (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 Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Descripción de la razón por la cual no se produjo la inmunización
... vaccineCode SΣC 1..1 CodeableConcept Código de la Vacuna que fue administrada o será administrada
Binding: Vaccine Types for use in the ICVP (required)
Constraints: has-an-icvp-vaccine-type
.... 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 Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Nombre normalizado a nivel nacional de la vacuna
... patient SΣ 1..1 Reference(Paciente) Paciente inmunizado
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] SΣ 1..1 Momento de administración de la vacuna
Slice: Unordered, Closed by type:$this
.... occurrence[x]:All Slices Content/Rules for all slices
..... occurrence[x]All Types Content/Rules for all Types
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:data-absent-reason S 0..1 code occurrence[x] razón de la ausencia
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Fecha y hora de la administración
.... occurrence[x]:occurrenceString SΣ 0..1 string Momento de la administración
... recorded S 0..1 dateTime Cuando realizó el registro de la inmunización
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin S 0..1 CodeableConcept Fuente de registro
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location S 0..1 Reference(CL Localización) Dónde se produjo la inmunización
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Número de lote de la vacuna
... expirationDate S 0..1 date Fecha de caducidad de la vacuna
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... 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 SΣ 0..* BackboneElement Quién realizó la inmunización
.... 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 SΣ 1..1 Reference(CL Prestador | CL Organización) Prestador personal u organizacional que realizó la acción
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... 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
Constraints: imm-1
.... 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 S 0..* CodeableConcept Corresponde al Id del criterio de elegibilidad de la vacuna administrada
Binding: ImmunizationProgramEligibility (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 Σ 0..* 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 Código identificador del criterio
..... display SΣ 0..1 string Descripción del programa asociado al identificador del criterio
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
... reaction S 0..* BackboneElement Detalles de una reacción que proviene de la inmunización
.... 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 Cuándo comenzó la reacción
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indica si se reportó reacción adversa a la vacuna
... protocolApplied S 0..* BackboneElement Protocolo seguido por el proveedor
.... 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

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base example Razones no Inmunización 📦1.9.4 Guía de Implementación ''cl core'' FHIR R4, v1.9
Immunization.vaccineCode Base required Vaccine Types for use in the ICVP 📦0.3.0 SMART ICVP v0.3
Immunization.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Immunization.reportOrigin Base example Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📦4.0.1 FHIR Std.
Immunization.route Base example Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📦4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📦4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📦4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📦4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📦4.0.1 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().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 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 **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()
has-an-icvp-vaccine-product-id-code error Immunization.extension:productID Check if there is a business identifier of a vaccine product in the ICVP product catalogue, The ICVP product catalogue consists of vaccines listed in the list of Prequalified Vaccines and the Emergency Use Listing. - https://extranet.who.int/prequal/vaccines/prequalified-vaccines - https://www.who.int/teams/regulation-prequalification/eul In FHIR R6, this could also be a reference to an InventoryItem .valueCoding.code.memberOf('http://smart.who.int/icvp/ValueSet/ICVPProductIds')
has-an-icvp-vaccine-type error Immunization.vaccineCode Ensure vaccine type is from the prequal vaccine database for ICVP vaccines memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()

This structure is derived from ImmunizationCL

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* ImmunizationCL Immunization event information
This profile also complies with the profile DVC - WHO ICVP Immunization for IPS
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ClaseVacuna S 0..1 Coding Clase de Vacuna
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ClaseVacuna
Binding: Códigos de clases de Vacuna (preferred)
.... extension:Campana S 0..1 string Nombre Campaña de Vacunación
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Campana
.... extension:Dosis S 0..1 string Dosis Administrada
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Dosis
.... extension:ProxFecha S 0..1 date Proxima fecha de vacunación
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ProxFecha
.... extension:productID SC 1..1 Coding Identificador del producto de la vacuna según los códigos prequal de la OMS
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID profiled by https://hl7chile.cl/fhir/ig/clips/StructureDefinition/ProductID
Binding: WHO ICVP Vaccine Product Ids (required)
Constraints: has-an-icvp-vaccine-product-id-code
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason S 0..1 CodeableConcept Razón de no realizarse la inmunización
Binding: Razones no Inmunización (example)
.... text SΣ 0..1 string Descripción de la razón por la cual no se produjo la inmunización
... vaccineCode SΣC 1..1 CodeableConcept Código de la Vacuna que fue administrada o será administrada
Binding: Vaccine Types for use in the ICVP (required)
Constraints: has-an-icvp-vaccine-type
.... text SΣ 0..1 string Nombre normalizado a nivel nacional de la vacuna
... patient SΣ 1..1 Reference(Paciente) Paciente inmunizado
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for occurrence[x] SΣ 1..1 Momento de administración de la vacuna
Slice: Unordered, Closed by type:$this
.... occurrence[x]:All Slices Content/Rules for all slices
..... occurrence[x]All Types Content/Rules for all Types
...... Slices for extension Content/Rules for all slices
....... extension:data-absent-reason S 0..1 code occurrence[x] razón de la ausencia
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Fecha y hora de la administración
.... occurrence[x]:occurrenceString SΣ 0..1 string Momento de la administración
... recorded S 0..1 dateTime Cuando realizó el registro de la inmunización
... reportOrigin S 0..1 CodeableConcept Fuente de registro
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location S 0..1 Reference(CL Localización) Dónde se produjo la inmunización
... lotNumber S 0..1 string Número de lote de la vacuna
... expirationDate S 0..1 date Fecha de caducidad de la vacuna
... performer SΣ 0..* BackboneElement Quién realizó la inmunización
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(CL Prestador | CL Organización) Prestador personal u organizacional que realizó la acción
... isSubpotent ?!Σ 0..1 boolean Dose potency
... programEligibility S 0..* CodeableConcept Corresponde al Id del criterio de elegibilidad de la vacuna administrada
Binding: ImmunizationProgramEligibility (example)
.... coding Σ 0..* Coding Code defined by a terminology system
..... code SΣ 0..1 code Código identificador del criterio
..... display SΣ 0..1 string Descripción del programa asociado al identificador del criterio
... reaction S 0..* BackboneElement Detalles de una reacción que proviene de la inmunización
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... protocolApplied S 0..* BackboneElement Protocolo seguido por el proveedor
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base example Razones no Inmunización 📦1.9.4 Guía de Implementación ''cl core'' FHIR R4, v1.9
Immunization.vaccineCode Base required Vaccine Types for use in the ICVP 📦0.3.0 SMART ICVP v0.3
Immunization.reportOrigin Base example Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📦4.0.1 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().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 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 **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()
has-an-icvp-vaccine-product-id-code error Immunization.extension:productID Check if there is a business identifier of a vaccine product in the ICVP product catalogue, The ICVP product catalogue consists of vaccines listed in the list of Prequalified Vaccines and the Emergency Use Listing. - https://extranet.who.int/prequal/vaccines/prequalified-vaccines - https://www.who.int/teams/regulation-prequalification/eul In FHIR R6, this could also be a reference to an InventoryItem .valueCoding.code.memberOf('http://smart.who.int/icvp/ValueSet/ICVPProductIds')
has-an-icvp-vaccine-type error Immunization.vaccineCode Ensure vaccine type is from the prequal vaccine database for ICVP vaccines memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')

Differential View

This structure is derived from ImmunizationCL

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization ImmunizationCL This profile also complies with the profile DVC - WHO ICVP Immunization for IPS
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:productID SC 1..1 Coding Identificador del producto de la vacuna según los códigos prequal de la OMS
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID profiled by https://hl7chile.cl/fhir/ig/clips/StructureDefinition/ProductID
Binding: WHO ICVP Vaccine Product Ids (required)
Constraints: has-an-icvp-vaccine-product-id-code
... vaccineCode C 1..1 CodeableConcept Código de la Vacuna que fue administrada o será administrada
Binding: Vaccine Types for use in the ICVP (required)
Constraints: has-an-icvp-vaccine-type
.... reference S 1..1 string Literal reference, Relative, internal or absolute URL
... occurrence[x] 1..1 dateTime, string Momento de administración de la vacuna
.... Slices for extension Content/Rules for all slices
..... extension:data-absent-reason S 0..1 code occurrence[x] razón de la ausencia
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base required Vaccine Types for use in the ICVP 📦0.3.0 SMART ICVP v0.3

Constraints

Id Grade Path(s) Description Expression
has-an-icvp-vaccine-product-id-code error Immunization.extension:productID Check if there is a business identifier of a vaccine product in the ICVP product catalogue, The ICVP product catalogue consists of vaccines listed in the list of Prequalified Vaccines and the Emergency Use Listing. - https://extranet.who.int/prequal/vaccines/prequalified-vaccines - https://www.who.int/teams/regulation-prequalification/eul In FHIR R6, this could also be a reference to an InventoryItem .valueCoding.code.memberOf('http://smart.who.int/icvp/ValueSet/ICVPProductIds')
has-an-icvp-vaccine-type error Immunization.vaccineCode Ensure vaccine type is from the prequal vaccine database for ICVP vaccines memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* ImmunizationCL Immunization event information
This profile also complies with the profile DVC - WHO ICVP Immunization for IPS
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ClaseVacuna S 0..1 Coding Clase de Vacuna
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ClaseVacuna
Binding: Códigos de clases de Vacuna (preferred)
.... extension:Campana S 0..1 string Nombre Campaña de Vacunación
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Campana
.... extension:Dosis S 0..1 string Dosis Administrada
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Dosis
.... extension:ProxFecha S 0..1 date Proxima fecha de vacunación
URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ProxFecha
.... extension:productID SC 1..1 Coding Identificador del producto de la vacuna según los códigos prequal de la OMS
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID profiled by https://hl7chile.cl/fhir/ig/clips/StructureDefinition/ProductID
Binding: WHO ICVP Vaccine Product Ids (required)
Constraints: has-an-icvp-vaccine-product-id-code
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier Identificador(es) por los que se conoce este registro de Inmunización. En el caso del sistema público correspondería al ID del Registro de Inmunización
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason S 0..1 CodeableConcept Razón de no realizarse la inmunización
Binding: Razones no Inmunización (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 Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Descripción de la razón por la cual no se produjo la inmunización
... vaccineCode SΣC 1..1 CodeableConcept Código de la Vacuna que fue administrada o será administrada
Binding: Vaccine Types for use in the ICVP (required)
Constraints: has-an-icvp-vaccine-type
.... 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 Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Nombre normalizado a nivel nacional de la vacuna
... patient SΣ 1..1 Reference(Paciente) Paciente inmunizado
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] SΣ 1..1 Momento de administración de la vacuna
Slice: Unordered, Closed by type:$this
.... occurrence[x]:All Slices Content/Rules for all slices
..... occurrence[x]All Types Content/Rules for all Types
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:data-absent-reason S 0..1 code occurrence[x] razón de la ausencia
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Fecha y hora de la administración
.... occurrence[x]:occurrenceString SΣ 0..1 string Momento de la administración
... recorded S 0..1 dateTime Cuando realizó el registro de la inmunización
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin S 0..1 CodeableConcept Fuente de registro
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location S 0..1 Reference(CL Localización) Dónde se produjo la inmunización
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer
... lotNumber S 0..1 string Número de lote de la vacuna
... expirationDate S 0..1 date Fecha de caducidad de la vacuna
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
... 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 SΣ 0..* BackboneElement Quién realizó la inmunización
.... 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 SΣ 1..1 Reference(CL Prestador | CL Organización) Prestador personal u organizacional que realizó la acción
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... 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
Constraints: imm-1
.... 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 S 0..* CodeableConcept Corresponde al Id del criterio de elegibilidad de la vacuna administrada
Binding: ImmunizationProgramEligibility (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 Σ 0..* 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 Código identificador del criterio
..... display SΣ 0..1 string Descripción del programa asociado al identificador del criterio
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
... reaction S 0..* BackboneElement Detalles de una reacción que proviene de la inmunización
.... 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 Cuándo comenzó la reacción
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indica si se reportó reacción adversa a la vacuna
... protocolApplied S 0..* BackboneElement Protocolo seguido por el proveedor
.... 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

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base example Razones no Inmunización 📦1.9.4 Guía de Implementación ''cl core'' FHIR R4, v1.9
Immunization.vaccineCode Base required Vaccine Types for use in the ICVP 📦0.3.0 SMART ICVP v0.3
Immunization.patient.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Immunization.reportOrigin Base example Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📦4.0.1 FHIR Std.
Immunization.route Base example Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📦4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📦4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📦4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📦4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📦4.0.1 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().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 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 **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()
has-an-icvp-vaccine-product-id-code error Immunization.extension:productID Check if there is a business identifier of a vaccine product in the ICVP product catalogue, The ICVP product catalogue consists of vaccines listed in the list of Prequalified Vaccines and the Emergency Use Listing. - https://extranet.who.int/prequal/vaccines/prequalified-vaccines - https://www.who.int/teams/regulation-prequalification/eul In FHIR R6, this could also be a reference to an InventoryItem .valueCoding.code.memberOf('http://smart.who.int/icvp/ValueSet/ICVPProductIds')
has-an-icvp-vaccine-type error Immunization.vaccineCode Ensure vaccine type is from the prequal vaccine database for ICVP vaccines memberOf('http://smart.who.int/icvp/ValueSet/ICVPVaccineType')
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()

This structure is derived from ImmunizationCL

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron