Guía implementación interoperabilidad FHIR sectorial e intersectorial
0.10.1 - ci-build

Guía implementación interoperabilidad FHIR sectorial e intersectorial - Local Development build (v0.10.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HCEU - Immunization

Defining URL:https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-ProfileImmunizationHCEU
Version:0.10.1
Name:ProfileImmunizationHCEU
Title:HCEU - Immunization
Status:Draft as of 2025-07-10 20:24:14-0500
Definition:

Recurso que permite registrar información de un evento de administración de una vacuna a un paciente

Publisher:minsait - An Indra Company. Secretaría de Salud de Bogotá,
Copyright:

Secretaría de Salud de Bogotá

Source Resource:XML / JSON / Turtle

La URL oficial para este perfil es: 

https://ohapi-fhir-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-ProfileImmunizationHCEU

Vistas formales para el perfil

Descripción de perfiles, diferenciales, resumenes y cómo deben ser las representaciones en XML y JSON.

Esta estructura se deriva de Immunization

Summary

Mandatory: 6 elements
Must-Support: 3 elements
Fixed: 2 elements
Prohibited: 15 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.identifier

Esta estructura se deriva de Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization Immunization
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier 1..1 Identifier Business identifier
..... use 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Example HIS uri: http://hospitalSystemInformation.example.org/Immunization/
..... value 1..1 string The value that is unique
..... period 0..0
..... assigner 0..0
... status 1..1 code completed
Fixed Value: completed
... statusReason 0..0
... encounter 0..1 Reference(HCEU - Intramural - Encounter) Encounter immunization was part of
... occurrence[x] 1..1 dateTime Vaccine administration date
... recorded 0..0
... primarySource 0..0
... reportOrigin 0..0
... location S 0..1 Reference(HCEU - Intramural - Location) Where immunization occurred
... manufacturer 0..1 Reference(HCEU - Organization) Vaccine manufacturer
... performer 1..1 BackboneElement Who performed event
.... function 0..0
.... actor 1..1 Reference(HCEU - Practitioner | HCEU - PractitionerRole | HCEU - Organization) Individual or organization who was performing
... reasonCode 0..0
... reasonReference 0..* Reference(HCEU - Condition | HCEU - Intramural - Observation | HCEU - Observation vital signs | HCEU - Diagnostic Report) Why immunization occurred
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction S 0..* BackboneElement Details of a reaction that follows immunization
.... detail 0..1 Reference(HCEU - Intramural - Observation) Additional information on reaction
... protocolApplied 0..0

doco Documentation for this format
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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier 1..1 Identifier Business identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example HIS uri: http://hospitalSystemInformation.example.org/Immunization/
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code completed
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Fixed Value: completed
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
... patient Σ 1..1 Reference(HCEU - Patient) Who was immunized
... encounter 0..1 Reference(HCEU - Intramural - Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... location S 0..1 Reference(HCEU - Intramural - Location) Where immunization occurred
... manufacturer 0..1 Reference(HCEU - Organization) Vaccine manufacturer
... lotNumber 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... 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 Σ 1..1 BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(HCEU - Practitioner | HCEU - PractitionerRole | HCEU - Organization) Individual or organization who was performing
... note Σ 0..* Annotation Additional immunization notes
... reasonReference 0..* Reference(HCEU - Condition | HCEU - Intramural - Observation | HCEU - Observation vital signs | HCEU - Diagnostic Report) Why immunization occurred
... reaction S 0..* BackboneElement Details of a reaction that follows immunization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(HCEU - Intramural - Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... identifier 1..* Identifier Business identifier
Slice: Unordered, Open by pattern:use
... location 0..1 Reference(HCEU - Intramural - Location) Where immunization occurred
... reaction 0..* BackboneElement Details of a reaction that follows immunization

doco Documentation for this format

Esta estructura se deriva de Immunization

Summary

Mandatory: 6 elements
Must-Support: 3 elements
Fixed: 2 elements
Prohibited: 15 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.identifier

Vista de diferencias

Esta estructura se deriva de Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization Immunization
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier 1..1 Identifier Business identifier
..... use 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Example HIS uri: http://hospitalSystemInformation.example.org/Immunization/
..... value 1..1 string The value that is unique
..... period 0..0
..... assigner 0..0
... status 1..1 code completed
Fixed Value: completed
... statusReason 0..0
... encounter 0..1 Reference(HCEU - Intramural - Encounter) Encounter immunization was part of
... occurrence[x] 1..1 dateTime Vaccine administration date
... recorded 0..0
... primarySource 0..0
... reportOrigin 0..0
... location S 0..1 Reference(HCEU - Intramural - Location) Where immunization occurred
... manufacturer 0..1 Reference(HCEU - Organization) Vaccine manufacturer
... performer 1..1 BackboneElement Who performed event
.... function 0..0
.... actor 1..1 Reference(HCEU - Practitioner | HCEU - PractitionerRole | HCEU - Organization) Individual or organization who was performing
... reasonCode 0..0
... reasonReference 0..* Reference(HCEU - Condition | HCEU - Intramural - Observation | HCEU - Observation vital signs | HCEU - Diagnostic Report) Why immunization occurred
... isSubpotent 0..0
... subpotentReason 0..0
... education 0..0
... programEligibility 0..0
... fundingSource 0..0
... reaction S 0..* BackboneElement Details of a reaction that follows immunization
.... detail 0..1 Reference(HCEU - Intramural - Observation) Additional information on reaction
... protocolApplied 0..0

doco Documentation for this format

Tabla de resumen

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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier Business identifier
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier 1..1 Identifier Business identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example HIS uri: http://hospitalSystemInformation.example.org/Immunization/
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code completed
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Fixed Value: completed
... vaccineCode Σ 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
... patient Σ 1..1 Reference(HCEU - Patient) Who was immunized
... encounter 0..1 Reference(HCEU - Intramural - Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... location S 0..1 Reference(HCEU - Intramural - Location) Where immunization occurred
... manufacturer 0..1 Reference(HCEU - Organization) Vaccine manufacturer
... lotNumber 0..1 string Vaccine lot number
... expirationDate 0..1 date Vaccine expiration date
... 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 Σ 1..1 BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(HCEU - Practitioner | HCEU - PractitionerRole | HCEU - Organization) Individual or organization who was performing
... note Σ 0..* Annotation Additional immunization notes
... reasonReference 0..* Reference(HCEU - Condition | HCEU - Intramural - Observation | HCEU - Observation vital signs | HCEU - Diagnostic Report) Why immunization occurred
... reaction S 0..* BackboneElement Details of a reaction that follows immunization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(HCEU - Intramural - Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction

doco Documentation for this format

 

Otras representaciones de este perfil: Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.identifier:HISdentifier.userequiredFixed Value: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Immunization.statusrequiredFixed Value: completed
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
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.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard

Constraints

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