Resumen Clínico de Paciente de Chile (IPS-CL), published by HL7 Chile. This guide is not an authorized publication; it is the continuous build for version 0.2.0 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Immunización (IPS-CL)

Este perfil representa las restricciones aplicadas al recurso Inmunización por la Guía de Implementación FHIR del Resumen Internacional del Paciente (IPS). Un registro de una vacunación se representa en el resumen del paciente como una instancia de un recurso Inmunización restringido por este perfil.

Describe el evento de un paciente al que se le ha administrado una vacuna o un registro de una vacuna notificado por un paciente, un clínico u otra parte.

Usage:

• Use this Resource Profile: Bundle Resumen Clínico
• Refer to this Resource Profile: Documento (IPS-CL)
• Examples for this Resource Profile: Immunization/Inmunizacion-CL-Ejemplo

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from ImmunizationCL

Name	Flags	Card.	Type	Description & Constraints
Immunization			ImmunizationCL
vaccineCode		1..1	CodeableConceptIPS	Código de la Vacuna que fue administrada o será administrada Binding: Vaccines - IPS (preferred): El tipo de vacuna para la enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente, o un código para inmunización ausente/desconocida. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate Para cuando se prefiera el sistema de códigos ATC de la OMS Tipos de Vacunas RNI candidate Conjunto de códigos para vacunas según la descripción nacional
patient		1..1	Reference(Paciente (IPS-CL))	Paciente inmunizado
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
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)
site		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
protocolApplied
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred): La enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationCL	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
ClaseVacuna	S	0..1	Coding	Clase de Vacuna URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ClaseVacuna Binding: Códigos de clases de Vacuna (required)
Campana	S	0..1	string	Nombre Campaña de Vacunación URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Campana
Dosis	S	0..1	string	Dosis Administrada URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Dosis
ProxFecha	S	0..1	date	Proxima fecha de vacunación URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ProxFecha
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)
text	SΣ	0..1	string	Descripción de la razon por la cual noi se produjo la inmunizción
vaccineCode	S	1..1	CodeableConceptIPS	Código de la Vacuna que fue administrada o será administrada Binding: Vaccines - IPS (preferred): El tipo de vacuna para la enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente, o un código para inmunización ausente/desconocida. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate Para cuando se prefiera el sistema de códigos ATC de la OMS Tipos de Vacunas RNI candidate Conjunto de códigos para vacunas según la descripción nacional
text	SΣ	0..1	string	Nombre normalizado a nivel nacional de la vacuna
patient	SΣ	1..1	Reference(Paciente (IPS-CL))	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
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	Σ	0..1	dateTime	Fecha y hora de la administración
occurrence[x]:occurrenceString	Σ	0..1	string	Momento de la administración
recorded	S	0..1	dateTime	Cuando se realizo el regstro del 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
site		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
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
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred): La enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente.
doseNumber[x]		1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status from the FHIR Standard
Immunization.statusReason	example	VSRazonNOTinmCL https://hl7chile.cl/fhir/ig/clcore/ValueSet/VSRazonNOTinm
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationCL	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 Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ClaseVacuna	S	0..1	Coding	Clase de Vacuna URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ClaseVacuna Binding: Códigos de clases de Vacuna (required)
Campana	S	0..1	string	Nombre Campaña de Vacunación URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Campana
Dosis	S	0..1	string	Dosis Administrada URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Dosis
ProxFecha	S	0..1	date	Proxima fecha de vacunación URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ProxFecha
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 razon por la cual noi se produjo la inmunizción
vaccineCode	S	1..1	CodeableConceptIPS	Código de la Vacuna que fue administrada o será administrada Binding: Vaccines - IPS (preferred): El tipo de vacuna para la enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente, o un código para inmunización ausente/desconocida. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate Para cuando se prefiera el sistema de códigos ATC de la OMS Tipos de Vacunas RNI candidate Conjunto de códigos para vacunas según la descripción nacional
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 (IPS-CL))	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
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	Σ	0..1	dateTime	Fecha y hora de la administración
occurrence[x]:occurrenceString	Σ	0..1	string	Momento de la administración
recorded	S	0..1	dateTime	Cuando se realizo el regstro del 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	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
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 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	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 reporto 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: Vaccine Target Diseases - IPS (preferred): La enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente.
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status from the FHIR Standard
Immunization.statusReason	example	VSRazonNOTinmCL https://hl7chile.cl/fhir/ig/clcore/ValueSet/VSRazonNOTinm
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
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: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• Paciente (IPS-CL) (https://hl7chile.cl/fhir/ig/clips/StructureDefinition/Paciente-cl-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/data-absent-reason

Maturity: 1

Differential View

This structure is derived from ImmunizationCL

Name	Flags	Card.	Type	Description & Constraints
Immunization			ImmunizationCL
vaccineCode		1..1	CodeableConceptIPS	Código de la Vacuna que fue administrada o será administrada Binding: Vaccines - IPS (preferred): El tipo de vacuna para la enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente, o un código para inmunización ausente/desconocida. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate Para cuando se prefiera el sistema de códigos ATC de la OMS Tipos de Vacunas RNI candidate Conjunto de códigos para vacunas según la descripción nacional
patient		1..1	Reference(Paciente (IPS-CL))	Paciente inmunizado
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
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)
site		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
protocolApplied
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred): La enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente.
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationCL	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
ClaseVacuna	S	0..1	Coding	Clase de Vacuna URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ClaseVacuna Binding: Códigos de clases de Vacuna (required)
Campana	S	0..1	string	Nombre Campaña de Vacunación URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Campana
Dosis	S	0..1	string	Dosis Administrada URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Dosis
ProxFecha	S	0..1	date	Proxima fecha de vacunación URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ProxFecha
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)
text	SΣ	0..1	string	Descripción de la razon por la cual noi se produjo la inmunizción
vaccineCode	S	1..1	CodeableConceptIPS	Código de la Vacuna que fue administrada o será administrada Binding: Vaccines - IPS (preferred): El tipo de vacuna para la enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente, o un código para inmunización ausente/desconocida. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate Para cuando se prefiera el sistema de códigos ATC de la OMS Tipos de Vacunas RNI candidate Conjunto de códigos para vacunas según la descripción nacional
text	SΣ	0..1	string	Nombre normalizado a nivel nacional de la vacuna
patient	SΣ	1..1	Reference(Paciente (IPS-CL))	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
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	Σ	0..1	dateTime	Fecha y hora de la administración
occurrence[x]:occurrenceString	Σ	0..1	string	Momento de la administración
recorded	S	0..1	dateTime	Cuando se realizo el regstro del 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
site		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
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
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred): La enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente.
doseNumber[x]		1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status from the FHIR Standard
Immunization.statusReason	example	VSRazonNOTinmCL https://hl7chile.cl/fhir/ig/clcore/ValueSet/VSRazonNOTinm
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	ImmunizationCL	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 Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
ClaseVacuna	S	0..1	Coding	Clase de Vacuna URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ClaseVacuna Binding: Códigos de clases de Vacuna (required)
Campana	S	0..1	string	Nombre Campaña de Vacunación URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Campana
Dosis	S	0..1	string	Dosis Administrada URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/Dosis
ProxFecha	S	0..1	date	Proxima fecha de vacunación URL: https://hl7chile.cl/fhir/ig/clcore/StructureDefinition/ProxFecha
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 razon por la cual noi se produjo la inmunizción
vaccineCode	S	1..1	CodeableConceptIPS	Código de la Vacuna que fue administrada o será administrada Binding: Vaccines - IPS (preferred): El tipo de vacuna para la enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente, o un código para inmunización ausente/desconocida. Additional Bindings Purpose Documentation Vaccines WHO ATC - IPS candidate Para cuando se prefiera el sistema de códigos ATC de la OMS Tipos de Vacunas RNI candidate Conjunto de códigos para vacunas según la descripción nacional
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 (IPS-CL))	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
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	Σ	0..1	dateTime	Fecha y hora de la administración
occurrence[x]:occurrenceString	Σ	0..1	string	Momento de la administración
recorded	S	0..1	dateTime	Cuando se realizo el regstro del 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	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
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 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	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 reporto 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: Vaccine Target Diseases - IPS (preferred): La enfermedad o enfermedades concretas contra las que se ha inmunizado al paciente.
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status from the FHIR Standard
Immunization.statusReason	example	VSRazonNOTinmCL https://hl7chile.cl/fhir/ig/clcore/ValueSet/VSRazonNOTinm
Immunization.vaccineCode	preferred	VaccinesUvIps http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Immunization.route	preferred	MedicineRouteOfAdministrationUvIps http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	preferred	VaccineTargetDiseasesUvIps http://hl7.org/fhir/uv/ips/ValueSet/target-diseases-uv-ips

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
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: 1 element
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• Paciente (IPS-CL) (https://hl7chile.cl/fhir/ig/clips/StructureDefinition/Paciente-cl-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/data-absent-reason

Maturity: 1

Other representations of profile: CSV, Excel, Schematron