Guías de Implementación HL7 FHIR: CR Core
0.1.1-draft - ci-build Costa Rica flag

Guías de Implementación HL7 FHIR: CR Core, published by Ministerio de Salud de Costa Rica. This guide is not an authorized publication; it is the continuous build for version 0.1.1-draft built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HIE-cr/core-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Inmunización

Official URL: https://ministeriodesalud.go.cr/fhir/core/StructureDefinition/immunization-cr-core Version: 0.1.1-draft
Standards status: Draft Maturity Level: 0 Computable Name: ImmunizationCrCore

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

Perfil CORE de Vacunas (Immunization)

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... 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: ImmunizationStatusReasonCodes (required)
.... text SΣ 0..1 string Descripción de la razón por la cual no se produjo la inmunización
... vaccineCode SΣ 1..1 CodeableConcept Vacuna que se administró o se iba a administrar
Binding: Listado de vacunas (required)
.... text SΣ 0..1 string Nombre normalizado a nivel nacional de la vacuna
... lotNumber S 0..1 string Número de lote de la vacuna
... expirationDate S 0..1 date Fecha de caducidad de la vacuna
... patient SΣ 1..1 Reference(Paciente) Paciente inmunizado
... Slices for occurrence[x] SΣ 1..1 Momento de administración de la vacuna
Slice: Unordered, Closed by type:$this
.... 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
... informationSource S 0..1 CodeableReference(Paciente | Profesional de Salud | Rol de Profesional de la Salud | Organizaciones) Fuente de la información
Binding: ImmunizationOriginCodes (example)
... location S 0..1 Reference(Ubicación de eventos) Dónde se produjo la inmunización
... 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(Profesional de Salud | Organizaciones) Prestador personal u organizacional que realizó la acción
... isSubpotent ?!Σ 0..1 boolean Dose potency
... programEligibility S 0..* BackboneElement Corresponde al Id del criterio de elegibilidad de la vacuna administrada
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... program 1..1 CodeableConcept The program that eligibility is declared for
Binding: CodesForVaccineFundingPrograms (example)
.... programStatus 1..1 CodeableConcept Descripción del programa asociado al identificador del criterio
Binding: ImmunizationProgramEligibility (example)
... 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
.... date 0..1 dateTime Cuándo comenzó la reacción
.... reported 0..1 boolean Indica si se reportó reacción adversa a la vacuna
... protocolApplied S 0..* BackboneElement Protocolo seguido por el proveedor
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber 1..1 string Dose number within series

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
From the FHIR Standard
Immunization.statusReasonrequiredImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredVaccineCode(a valid code from Catálogo de vacunas administradas)
https://ministeriodesalud.go.cr/fhir/core/ValueSet/vaccine-code
From this IG
Immunization.informationSourceexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From the FHIR Standard
Immunization.programEligibility.programexampleCodesForVaccineFundingPrograms
http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program
From the FHIR Standard
Immunization.programEligibility.programStatusexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... 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: ImmunizationStatusReasonCodes (required)
.... text S 0..1 string Descripción de la razón por la cual no se produjo la inmunización
.... text S 0..1 string Nombre normalizado a nivel nacional de la vacuna
... lotNumber S 0..1 string Número de lote de la vacuna
... expirationDate S 0..1 date Fecha de caducidad de la vacuna
... patient S 1..1 Reference(Paciente) Paciente inmunizado
... Slices for occurrence[x] S 1..1 dateTime, string Momento de administración de la vacuna
Slice: Unordered, Open by type:$this
.... 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
... informationSource S 0..1 CodeableReference(Paciente | Profesional de Salud | Rol de Profesional de la Salud | Organizaciones) Fuente de la información
... location S 0..1 Reference(Ubicación de eventos) Dónde se produjo la inmunización
... performer S 0..* BackboneElement Quién realizó la inmunización
.... actor S 1..1 Reference(Profesional de Salud | Organizaciones) Prestador personal u organizacional que realizó la acción
... programEligibility S 0..* BackboneElement Corresponde al Id del criterio de elegibilidad de la vacuna administrada
.... programStatus 1..1 CodeableConcept Descripción del programa asociado al identificador del criterio
Binding: ImmunizationProgramEligibility (example)
... reaction S 0..* BackboneElement Detalles de una reacción que proviene de la inmunización
.... date 0..1 dateTime Cuándo comenzó la reacción
.... reported 0..1 boolean Indica si se reportó reacción adversa a la vacuna
... protocolApplied S 0..* BackboneElement Protocolo seguido por el proveedor

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
From the FHIR Standard
Immunization.statusReasonrequiredImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredVaccineCode(a valid code from Catálogo de vacunas administradas)
https://ministeriodesalud.go.cr/fhir/core/ValueSet/vaccine-code
From this IG
Immunization.programEligibility.programStatusexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Authority that the immunization event is based on
... 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: ImmunizationStatusReasonCodes (required)
.... id 0..1 id 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Σ 1..1 CodeableConcept Vacuna que se administró o se iba a administrar
Binding: Listado de vacunas (required)
.... id 0..1 id 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
... administeredProduct 0..1 CodeableReference(Medication) Product that was administered
... manufacturer 0..1 CodeableReference(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
... patient SΣ 1..1 Reference(Paciente) Paciente inmunizado
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... supportingInformation 0..* Reference(Resource) Additional information in support of the immunization
... Slices for occurrence[x] SΣ 1..1 Momento de administración de la vacuna
Slice: Unordered, Closed by type:$this
.... 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
... primarySource Σ 0..1 boolean Indicates context the data was captured in
... informationSource S 0..1 CodeableReference(Paciente | Profesional de Salud | Rol de Profesional de la Salud | Organizaciones) Fuente de la información
Binding: ImmunizationOriginCodes (example)
... location S 0..1 Reference(Ubicación de eventos) Dónde se produjo la inmunización
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity 0..1 SimpleQuantity 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)
.... actor SΣ 1..1 Reference(Profesional de Salud | Organizaciones) Prestador personal u organizacional que realizó la acción
... note Σ 0..* Annotation Additional immunization notes
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport) Why immunization occurred
Binding: ImmunizationReasonCodes (example)
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
... programEligibility S 0..* BackboneElement Corresponde al Id del criterio de elegibilidad de la vacuna administrada
.... 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
.... program 1..1 CodeableConcept The program that eligibility is declared for
Binding: CodesForVaccineFundingPrograms (example)
.... programStatus 1..1 CodeableConcept Descripción del programa asociado al identificador del criterio
Binding: ImmunizationProgramEligibility (example)
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example)
... 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
.... manifestation 0..1 CodeableReference(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 targeted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber 1..1 string Dose number within series
.... seriesDoses 0..1 string Recommended number of doses for immunity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
From the FHIR Standard
Immunization.statusReasonrequiredImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredVaccineCode(a valid code from Catálogo de vacunas administradas)
https://ministeriodesalud.go.cr/fhir/core/ValueSet/vaccine-code
From this IG
Immunization.informationSourceexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From the FHIR Standard
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
From the FHIR Standard
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
From the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From the FHIR Standard
Immunization.reasonexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
From the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
From the FHIR Standard
Immunization.programEligibility.programexampleCodesForVaccineFundingPrograms
http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program
From the FHIR Standard
Immunization.programEligibility.programStatusexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
From the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... 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: ImmunizationStatusReasonCodes (required)
.... text SΣ 0..1 string Descripción de la razón por la cual no se produjo la inmunización
... vaccineCode SΣ 1..1 CodeableConcept Vacuna que se administró o se iba a administrar
Binding: Listado de vacunas (required)
.... text SΣ 0..1 string Nombre normalizado a nivel nacional de la vacuna
... lotNumber S 0..1 string Número de lote de la vacuna
... expirationDate S 0..1 date Fecha de caducidad de la vacuna
... patient SΣ 1..1 Reference(Paciente) Paciente inmunizado
... Slices for occurrence[x] SΣ 1..1 Momento de administración de la vacuna
Slice: Unordered, Closed by type:$this
.... 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
... informationSource S 0..1 CodeableReference(Paciente | Profesional de Salud | Rol de Profesional de la Salud | Organizaciones) Fuente de la información
Binding: ImmunizationOriginCodes (example)
... location S 0..1 Reference(Ubicación de eventos) Dónde se produjo la inmunización
... 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(Profesional de Salud | Organizaciones) Prestador personal u organizacional que realizó la acción
... isSubpotent ?!Σ 0..1 boolean Dose potency
... programEligibility S 0..* BackboneElement Corresponde al Id del criterio de elegibilidad de la vacuna administrada
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... program 1..1 CodeableConcept The program that eligibility is declared for
Binding: CodesForVaccineFundingPrograms (example)
.... programStatus 1..1 CodeableConcept Descripción del programa asociado al identificador del criterio
Binding: ImmunizationProgramEligibility (example)
... 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
.... date 0..1 dateTime Cuándo comenzó la reacción
.... reported 0..1 boolean Indica si se reportó reacción adversa a la vacuna
... protocolApplied S 0..* BackboneElement Protocolo seguido por el proveedor
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... doseNumber 1..1 string Dose number within series

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
From the FHIR Standard
Immunization.statusReasonrequiredImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredVaccineCode(a valid code from Catálogo de vacunas administradas)
https://ministeriodesalud.go.cr/fhir/core/ValueSet/vaccine-code
From this IG
Immunization.informationSourceexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From the FHIR Standard
Immunization.programEligibility.programexampleCodesForVaccineFundingPrograms
http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program
From the FHIR Standard
Immunization.programEligibility.programStatusexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... 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: ImmunizationStatusReasonCodes (required)
.... text S 0..1 string Descripción de la razón por la cual no se produjo la inmunización
.... text S 0..1 string Nombre normalizado a nivel nacional de la vacuna
... lotNumber S 0..1 string Número de lote de la vacuna
... expirationDate S 0..1 date Fecha de caducidad de la vacuna
... patient S 1..1 Reference(Paciente) Paciente inmunizado
... Slices for occurrence[x] S 1..1 dateTime, string Momento de administración de la vacuna
Slice: Unordered, Open by type:$this
.... 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
... informationSource S 0..1 CodeableReference(Paciente | Profesional de Salud | Rol de Profesional de la Salud | Organizaciones) Fuente de la información
... location S 0..1 Reference(Ubicación de eventos) Dónde se produjo la inmunización
... performer S 0..* BackboneElement Quién realizó la inmunización
.... actor S 1..1 Reference(Profesional de Salud | Organizaciones) Prestador personal u organizacional que realizó la acción
... programEligibility S 0..* BackboneElement Corresponde al Id del criterio de elegibilidad de la vacuna administrada
.... programStatus 1..1 CodeableConcept Descripción del programa asociado al identificador del criterio
Binding: ImmunizationProgramEligibility (example)
... reaction S 0..* BackboneElement Detalles de una reacción que proviene de la inmunización
.... date 0..1 dateTime Cuándo comenzó la reacción
.... reported 0..1 boolean Indica si se reportó reacción adversa a la vacuna
... protocolApplied S 0..* BackboneElement Protocolo seguido por el proveedor

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
From the FHIR Standard
Immunization.statusReasonrequiredImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredVaccineCode(a valid code from Catálogo de vacunas administradas)
https://ministeriodesalud.go.cr/fhir/core/ValueSet/vaccine-code
From this IG
Immunization.programEligibility.programStatusexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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
... basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Authority that the immunization event is based on
... 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: ImmunizationStatusReasonCodes (required)
.... id 0..1 id 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Σ 1..1 CodeableConcept Vacuna que se administró o se iba a administrar
Binding: Listado de vacunas (required)
.... id 0..1 id 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
... administeredProduct 0..1 CodeableReference(Medication) Product that was administered
... manufacturer 0..1 CodeableReference(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
... patient SΣ 1..1 Reference(Paciente) Paciente inmunizado
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... supportingInformation 0..* Reference(Resource) Additional information in support of the immunization
... Slices for occurrence[x] SΣ 1..1 Momento de administración de la vacuna
Slice: Unordered, Closed by type:$this
.... 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
... primarySource Σ 0..1 boolean Indicates context the data was captured in
... informationSource S 0..1 CodeableReference(Paciente | Profesional de Salud | Rol de Profesional de la Salud | Organizaciones) Fuente de la información
Binding: ImmunizationOriginCodes (example)
... location S 0..1 Reference(Ubicación de eventos) Dónde se produjo la inmunización
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity 0..1 SimpleQuantity 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)
.... actor SΣ 1..1 Reference(Profesional de Salud | Organizaciones) Prestador personal u organizacional que realizó la acción
... note Σ 0..* Annotation Additional immunization notes
... reason 0..* CodeableReference(Condition | Observation | DiagnosticReport) Why immunization occurred
Binding: ImmunizationReasonCodes (example)
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
... programEligibility S 0..* BackboneElement Corresponde al Id del criterio de elegibilidad de la vacuna administrada
.... 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
.... program 1..1 CodeableConcept The program that eligibility is declared for
Binding: CodesForVaccineFundingPrograms (example)
.... programStatus 1..1 CodeableConcept Descripción del programa asociado al identificador del criterio
Binding: ImmunizationProgramEligibility (example)
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example)
... 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
.... manifestation 0..1 CodeableReference(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 targeted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber 1..1 string Dose number within series
.... seriesDoses 0..1 string Recommended number of doses for immunity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status
From the FHIR Standard
Immunization.statusReasonrequiredImmunizationStatusReasonCodes
http://hl7.org/fhir/ValueSet/immunization-status-reason
From the FHIR Standard
Immunization.vaccineCoderequiredVaccineCode(a valid code from Catálogo de vacunas administradas)
https://ministeriodesalud.go.cr/fhir/core/ValueSet/vaccine-code
From this IG
Immunization.informationSourceexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From the FHIR Standard
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
http://hl7.org/fhir/ValueSet/immunization-site
From the FHIR Standard
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
From the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From the FHIR Standard
Immunization.reasonexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
From the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
From the FHIR Standard
Immunization.programEligibility.programexampleCodesForVaccineFundingPrograms
http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program
From the FHIR Standard
Immunization.programEligibility.programStatusexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
From the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron