HL7 Vietnam VN Core FHIR Implementation Guide

Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam
0.5.0 - Draft for Community Review

Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam - Local Development build (v0.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Hồ sơ tài nguyên: Tiêm chủng — VN Core Immunization

URL chính thức: http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-immunization | Phiên bản: 0.5.0 | Làm nổi bật phần thay đổi?
| Computable Name: VNCoreImmunization
Bản quyền/Pháp lý: Căn cứ pháp lý Việt Nam: Luật 114/2025/QH15 (ban hành 10/12/2025, hiệu lực 01/07/2026 — future-effective); QĐ 2780/QĐ-BYT ngày 29/08/2025; TT 13/2025/TT-BYT ngày 06/06/2025.

Profile Immunization cho Việt Nam. Hỗ trợ mã loại vaccine theo danh mục VN, CVX cho interoperability quốc tế, loại chương trình tiêm chủng (TCMR/dịch vụ/chiến dịch), nguồn chi trả, lô vaccine và thông tin người/cơ sở thực hiện. Căn cứ: Luật 114/2025/QH15 (ban hành 10/12/2025, hiệu lực 01/07/2026 — future-effective) — Luật Phòng bệnh (thay thế Luật Phòng, chống bệnh truyền nhiễm 03/2007/QH12 từ 01/07/2026), QĐ 2780/QĐ-BYT ngày 29/08/2025 — Kế hoạch Tiêm chủng mở rộng giai đoạn 2026-2028, TT 13/2025/TT-BYT ngày 06/06/2025 về hồ sơ bệnh án điện tử. Nguồn TVPL Luật 114/2025/QH15: https://thuvienphapluat.vn/van-ban/The-thao-Y-te/Luat-Phong-benh-658530.aspx

Usages:

- Examples for this Profile: Immunization/ExampleImmunizationNotDone, Immunization/ExampleImmunizationTCMR and Immunization/ExampleImmunizationVoluntary

You can also check for usages in the FHIR IG Statistics

### Các dạng xem hình thức của nội dung hồ sơ

Mô tả profile, differential, snapshot và các biểu diễn liên quan.

- Bảng phần tử chính
- Bảng Differential
- Bảng Snapshot
- Thống kê/Tham chiếu
- Tất cả

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:programType | S | 0..1 | code | Loại chương trình tiêm chủng (TCMR/dịch vụ/chiến dịch) URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-immunization-program-type Binding: Loại chương trình tiêm chủng — Vietnam Immunization Program Type ValueSet (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | Trạng thái tiêm chủng Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason | S | 0..1 | CodeableConcept | Lý do không tiêm hoặc không hoàn tất Binding: Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet (extensible)
vaccineCode | S Σ | 1..1 | CodeableConcept | Loại vaccine đã tiêm hoặc dự kiến tiêm Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:vnVaccineType | S Σ | 1..* | Coding | Mã loại vaccine Việt Nam Binding: Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet (required)
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-vaccine-type-cs
code | S Σ | 1..1 | code | Mã loại vaccine VN
display | S Σ | 0..1 | string | Tên loại vaccine
coding:cvx | Σ | 0..* | Coding | Mã CVX tương đương
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
code | Σ | 1..1 | code | Mã CVX
display | Σ | 0..1 | string | Tên CVX
patient | S Σ | 1..1 | Reference(Bệnh nhân VN Core — VN Core Patient Profile) | Người được tiêm
encounter | S | 0..1 | Reference(Lượt khám/nhập viện VN Core — VN Core Encounter Profile) | Lượt khám/liên hệ y tế liên quan
occurrence[x] | S Σ | 1..1 | dateTime | Ngày giờ tiêm chủng
primarySource | S Σ | 0..1 | boolean | Dữ liệu từ nguồn sơ cấp
lotNumber | S | 0..1 | string | Số lô vaccine
performer | S Σ | 0..* | BackboneElement | Người hoặc cơ sở thực hiện tiêm chủng
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actor | S Σ | 1..1 | Reference(Nhân viên y tế VN Core — VN Core Practitioner Profile | Cơ sở y tế VN Core — VN Core Organization Profile) | Nhân viên y tế hoặc cơ sở tiêm chủng
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
fundingSource |  | 0..1 | CodeableConcept | Nguồn chi trả tiêm chủng Binding: Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet (extensible)
protocolApplied | S | 0..* | BackboneElement | Phác đồ/lịch tiêm áp dụng
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
doseNumber[x] | S | 1..1 | positiveInt | Số mũi trong phác đồ
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.statusReason | Base | extensible | Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet | 📦0.5.0 | This IG
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode.​coding:vnVaccineType | Base | required | Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet | 📦0.5.0 | This IG
Immunization.fundingSource | Base | extensible | Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet | 📦0.5.0 | This IG

#### Constraints

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:programType | S | 0..1 | code | Loại chương trình tiêm chủng (TCMR/dịch vụ/chiến dịch) URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-immunization-program-type Binding: Loại chương trình tiêm chủng — Vietnam Immunization Program Type ValueSet (required)
status | S | 1..1 | code | Trạng thái tiêm chủng
statusReason | S | 0..1 | CodeableConcept | Lý do không tiêm hoặc không hoàn tất Binding: Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet (extensible)
vaccineCode | S | 1..1 | CodeableConcept | Loại vaccine đã tiêm hoặc dự kiến tiêm
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:vnVaccineType | S | 1..* | Coding | Mã loại vaccine Việt Nam Binding: Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet (required)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-vaccine-type-cs
code | S | 1..1 | code | Mã loại vaccine VN
display | S | 0..1 | string | Tên loại vaccine
coding:cvx |  | 0..* | Coding | Mã CVX tương đương
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
code |  | 1..1 | code | Mã CVX
display |  | 0..1 | string | Tên CVX
patient | S | 1..1 | Reference(Bệnh nhân VN Core — VN Core Patient Profile) | Người được tiêm
encounter | S | 0..1 | Reference(Lượt khám/nhập viện VN Core — VN Core Encounter Profile) | Lượt khám/liên hệ y tế liên quan
occurrence[x] | S | 1..1 | dateTime | Ngày giờ tiêm chủng
primarySource | S | 0..1 | boolean | Dữ liệu từ nguồn sơ cấp
lotNumber | S | 0..1 | string | Số lô vaccine
performer | S | 0..* | BackboneElement | Người hoặc cơ sở thực hiện tiêm chủng
actor | S | 1..1 | Reference(Nhân viên y tế VN Core — VN Core Practitioner Profile | Cơ sở y tế VN Core — VN Core Organization Profile) | Nhân viên y tế hoặc cơ sở tiêm chủng
fundingSource |  | 0..1 | CodeableConcept | Nguồn chi trả tiêm chủng Binding: Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet (extensible)
protocolApplied | S | 0..* | BackboneElement | Phác đồ/lịch tiêm áp dụng
doseNumber[x] | S | 1..1 | positiveInt | Số mũi trong phác đồ
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Immunization.statusReason | Base | extensible | Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet | 📦0.5.0 | This IG
Immunization.vaccineCode.​coding:vnVaccineType | Base | required | Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet | 📦0.5.0 | This IG
Immunization.fundingSource | Base | extensible | Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet | 📦0.5.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:programType | S | 0..1 | code | Loại chương trình tiêm chủng (TCMR/dịch vụ/chiến dịch) URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-immunization-program-type Binding: Loại chương trình tiêm chủng — Vietnam Immunization Program Type ValueSet (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Business identifier
status | ?!S Σ | 1..1 | code | Trạng thái tiêm chủng Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason | S | 0..1 | CodeableConcept | Lý do không tiêm hoặc không hoàn tất Binding: Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet (extensible)
vaccineCode | S Σ | 1..1 | CodeableConcept | Loại vaccine đã tiêm hoặc dự kiến tiêm Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:vnVaccineType | S Σ | 1..* | Coding | Mã loại vaccine Việt Nam Binding: Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet (required)
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 | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-vaccine-type-cs
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | Mã loại vaccine VN
display | S Σ | 0..1 | string | Tên loại vaccine
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:cvx | Σ | 0..* | Coding | Mã CVX tương đương
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 | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Mã CVX
display | Σ | 0..1 | string | Tên CVX
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
patient | S Σ | 1..1 | Reference(Bệnh nhân VN Core — VN Core Patient Profile) | Người được tiêm
encounter | S | 0..1 | Reference(Lượt khám/nhập viện VN Core — VN Core Encounter Profile) | Lượt khám/liên hệ y tế liên quan
occurrence[x] | S Σ | 1..1 | dateTime | Ngày giờ tiêm chủng
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | S Σ | 0..1 | boolean | Dữ liệu từ nguồn sơ cấp
reportOrigin |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location |  | 0..1 | Reference(Location) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber | S | 0..1 | string | Số lô vaccine
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(4.0.1) | Amount of vaccine administered
performer | S Σ | 0..* | BackboneElement | Người hoặc cơ sở thực hiện tiêm chủng
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(Nhân viên y tế VN Core — VN Core Practitioner Profile | Cơ sở y tế VN Core — VN Core Organization Profile) | Nhân viên y tế hoặc cơ sở tiêm chủng
note | Σ | 0..* | Annotation | Additional immunization notes
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Nguồn chi trả tiêm chủng Binding: Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet (extensible)
reaction |  | 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(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied | S | 0..* | BackboneElement | Phác đồ/lịch tiêm áp dụng
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x] | S | 1..1 | positiveInt | Số mũi trong phác đồ
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.statusReason | Base | extensible | Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet | 📦0.5.0 | This IG
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode.​coding:vnVaccineType | Base | required | Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet | 📦0.5.0 | This IG
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std.
Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.0.1 | FHIR Std.
Immunization.route | Base | example | Immunization Route Codes | 📍4.0.1 | FHIR Std.
Immunization.performer.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std.
Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | FHIR Std.
Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.0.1 | FHIR Std.
Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | FHIR Std.
Immunization.fundingSource | Base | extensible | Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet | 📦0.5.0 | This IG
Immunization.protocolApplied.​targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present | `documentType.exists() or reference.exists()`

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 16 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- Bệnh nhân VN Core — VN Core Patient Profile (http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-patient)
- Lượt khám/nhập viện VN Core — VN Core Encounter Profile (http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-encounter)
- Nhân viên y tế VN Core — VN Core Practitioner Profile (http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-practitioner)
- Cơ sở y tế VN Core — VN Core Organization Profile (http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-organization)

Extensions

This structure refers to these extensions:

- http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-immunization-program-type

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the values of Immunization.vaccineCode.coding

Dạng xem phần tử chính

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:programType | S | 0..1 | code | Loại chương trình tiêm chủng (TCMR/dịch vụ/chiến dịch) URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-immunization-program-type Binding: Loại chương trình tiêm chủng — Vietnam Immunization Program Type ValueSet (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | Trạng thái tiêm chủng Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason | S | 0..1 | CodeableConcept | Lý do không tiêm hoặc không hoàn tất Binding: Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet (extensible)
vaccineCode | S Σ | 1..1 | CodeableConcept | Loại vaccine đã tiêm hoặc dự kiến tiêm Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:vnVaccineType | S Σ | 1..* | Coding | Mã loại vaccine Việt Nam Binding: Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet (required)
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-vaccine-type-cs
code | S Σ | 1..1 | code | Mã loại vaccine VN
display | S Σ | 0..1 | string | Tên loại vaccine
coding:cvx | Σ | 0..* | Coding | Mã CVX tương đương
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
code | Σ | 1..1 | code | Mã CVX
display | Σ | 0..1 | string | Tên CVX
patient | S Σ | 1..1 | Reference(Bệnh nhân VN Core — VN Core Patient Profile) | Người được tiêm
encounter | S | 0..1 | Reference(Lượt khám/nhập viện VN Core — VN Core Encounter Profile) | Lượt khám/liên hệ y tế liên quan
occurrence[x] | S Σ | 1..1 | dateTime | Ngày giờ tiêm chủng
primarySource | S Σ | 0..1 | boolean | Dữ liệu từ nguồn sơ cấp
lotNumber | S | 0..1 | string | Số lô vaccine
performer | S Σ | 0..* | BackboneElement | Người hoặc cơ sở thực hiện tiêm chủng
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actor | S Σ | 1..1 | Reference(Nhân viên y tế VN Core — VN Core Practitioner Profile | Cơ sở y tế VN Core — VN Core Organization Profile) | Nhân viên y tế hoặc cơ sở tiêm chủng
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
fundingSource |  | 0..1 | CodeableConcept | Nguồn chi trả tiêm chủng Binding: Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet (extensible)
protocolApplied | S | 0..* | BackboneElement | Phác đồ/lịch tiêm áp dụng
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
doseNumber[x] | S | 1..1 | positiveInt | Số mũi trong phác đồ
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.statusReason | Base | extensible | Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet | 📦0.5.0 | This IG
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode.​coding:vnVaccineType | Base | required | Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet | 📦0.5.0 | This IG
Immunization.fundingSource | Base | extensible | Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet | 📦0.5.0 | This IG

#### Constraints

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

Dạng xem Differential

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:programType | S | 0..1 | code | Loại chương trình tiêm chủng (TCMR/dịch vụ/chiến dịch) URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-immunization-program-type Binding: Loại chương trình tiêm chủng — Vietnam Immunization Program Type ValueSet (required)
status | S | 1..1 | code | Trạng thái tiêm chủng
statusReason | S | 0..1 | CodeableConcept | Lý do không tiêm hoặc không hoàn tất Binding: Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet (extensible)
vaccineCode | S | 1..1 | CodeableConcept | Loại vaccine đã tiêm hoặc dự kiến tiêm
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:vnVaccineType | S | 1..* | Coding | Mã loại vaccine Việt Nam Binding: Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet (required)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-vaccine-type-cs
code | S | 1..1 | code | Mã loại vaccine VN
display | S | 0..1 | string | Tên loại vaccine
coding:cvx |  | 0..* | Coding | Mã CVX tương đương
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
code |  | 1..1 | code | Mã CVX
display |  | 0..1 | string | Tên CVX
patient | S | 1..1 | Reference(Bệnh nhân VN Core — VN Core Patient Profile) | Người được tiêm
encounter | S | 0..1 | Reference(Lượt khám/nhập viện VN Core — VN Core Encounter Profile) | Lượt khám/liên hệ y tế liên quan
occurrence[x] | S | 1..1 | dateTime | Ngày giờ tiêm chủng
primarySource | S | 0..1 | boolean | Dữ liệu từ nguồn sơ cấp
lotNumber | S | 0..1 | string | Số lô vaccine
performer | S | 0..* | BackboneElement | Người hoặc cơ sở thực hiện tiêm chủng
actor | S | 1..1 | Reference(Nhân viên y tế VN Core — VN Core Practitioner Profile | Cơ sở y tế VN Core — VN Core Organization Profile) | Nhân viên y tế hoặc cơ sở tiêm chủng
fundingSource |  | 0..1 | CodeableConcept | Nguồn chi trả tiêm chủng Binding: Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet (extensible)
protocolApplied | S | 0..* | BackboneElement | Phác đồ/lịch tiêm áp dụng
doseNumber[x] | S | 1..1 | positiveInt | Số mũi trong phác đồ
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Immunization.statusReason | Base | extensible | Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet | 📦0.5.0 | This IG
Immunization.vaccineCode.​coding:vnVaccineType | Base | required | Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet | 📦0.5.0 | This IG
Immunization.fundingSource | Base | extensible | Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet | 📦0.5.0 | This IG

Dạng xem SnapshotView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:programType | S | 0..1 | code | Loại chương trình tiêm chủng (TCMR/dịch vụ/chiến dịch) URL: http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-immunization-program-type Binding: Loại chương trình tiêm chủng — Vietnam Immunization Program Type ValueSet (required)
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Business identifier
status | ?!S Σ | 1..1 | code | Trạng thái tiêm chủng Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason | S | 0..1 | CodeableConcept | Lý do không tiêm hoặc không hoàn tất Binding: Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet (extensible)
vaccineCode | S Σ | 1..1 | CodeableConcept | Loại vaccine đã tiêm hoặc dự kiến tiêm Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:vnVaccineType | S Σ | 1..* | Coding | Mã loại vaccine Việt Nam Binding: Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet (required)
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 | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.hl7.org.vn/core/CodeSystem/vn-vaccine-type-cs
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | Mã loại vaccine VN
display | S Σ | 0..1 | string | Tên loại vaccine
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:cvx | Σ | 0..* | Coding | Mã CVX tương đương
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 | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Mã CVX
display | Σ | 0..1 | string | Tên CVX
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
patient | S Σ | 1..1 | Reference(Bệnh nhân VN Core — VN Core Patient Profile) | Người được tiêm
encounter | S | 0..1 | Reference(Lượt khám/nhập viện VN Core — VN Core Encounter Profile) | Lượt khám/liên hệ y tế liên quan
occurrence[x] | S Σ | 1..1 | dateTime | Ngày giờ tiêm chủng
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | S Σ | 0..1 | boolean | Dữ liệu từ nguồn sơ cấp
reportOrigin |  | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location |  | 0..1 | Reference(Location) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer
lotNumber | S | 0..1 | string | Số lô vaccine
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(4.0.1) | Amount of vaccine administered
performer | S Σ | 0..* | BackboneElement | Người hoặc cơ sở thực hiện tiêm chủng
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(Nhân viên y tế VN Core — VN Core Practitioner Profile | Cơ sở y tế VN Core — VN Core Organization Profile) | Nhân viên y tế hoặc cơ sở tiêm chủng
note | Σ | 0..* | Annotation | Additional immunization notes
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Nguồn chi trả tiêm chủng Binding: Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet (extensible)
reaction |  | 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(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied | S | 0..* | BackboneElement | Phác đồ/lịch tiêm áp dụng
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x] | S | 1..1 | positiveInt | Số mũi trong phác đồ
seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Immunization.status | Base | required | Immunization Status Codes | 📍4.0.1 | FHIR Std.
Immunization.statusReason | Base | extensible | Lý do không tiêm chủng — Vietnam Immunization Status Reason ValueSet | 📦0.5.0 | This IG
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📍4.0.1 | FHIR Std.
Immunization.vaccineCode.​coding:vnVaccineType | Base | required | Loại vaccine Việt Nam — Vietnam Vaccine Type ValueSet | 📦0.5.0 | This IG
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📍4.0.1 | FHIR Std.
Immunization.site | Base | example | Codes for Immunization Site of Administration | 📍4.0.1 | FHIR Std.
Immunization.route | Base | example | Immunization Route Codes | 📍4.0.1 | FHIR Std.
Immunization.performer.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std.
Immunization.reasonCode | Base | example | Immunization Reason Codes | 📍4.0.1 | FHIR Std.
Immunization.subpotentReason | Base | example | Immunization Subpotent Reason | 📍4.0.1 | FHIR Std.
Immunization.programEligibility | Base | example | Immunization Program Eligibility | 📍4.0.1 | FHIR Std.
Immunization.fundingSource | Base | extensible | Nguồn chi trả tiêm chủng — Vietnam Immunization Funding Source ValueSet | 📦0.5.0 | This IG
Immunization.protocolApplied.​targetDisease | Base | example | Immunization Target Disease Codes | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Immunization | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization.education | One of documentType or reference SHALL be present | `documentType.exists() or reference.exists()`

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 16 elements
Fixed: 2 elements

Structures

This structure refers to these other structures:

- Bệnh nhân VN Core — VN Core Patient Profile (http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-patient)
- Lượt khám/nhập viện VN Core — VN Core Encounter Profile (http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-encounter)
- Nhân viên y tế VN Core — VN Core Practitioner Profile (http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-practitioner)
- Cơ sở y tế VN Core — VN Core Organization Profile (http://fhir.hl7.org.vn/core/StructureDefinition/vn-core-organization)

Extensions

This structure refers to these extensions:

- http://fhir.hl7.org.vn/core/StructureDefinition/vn-ext-immunization-program-type

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the values of Immunization.vaccineCode.coding

Biểu diễn khác của hồ sơ: CSV, Excel, Schematron