HL7 Vietnam VN Core FHIR Implementation Guide

Hướng dẫn triển khai FHIR cốt lõi Việt Nam — VN Core FHIR Implementation Guide
0.10.0 - Draft for Community Review Viet Nam cờ

Hướng dẫn triển khai FHIR cốt lõi Việt Nam — VN Core FHIR Implementation Guide - Draft for Community Review (v0.10.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: VN Core Citizen App Client CapabilityStatement — Yêu cầu tuân thủ tối thiểu cho client ứng dụng người dân (Thử nghiệm)

URL chính thức: http://fhir.hl7.org.vn/core/CapabilityStatement/vn-core-citizen-app-client Phiên bản: 0.10.0
Computable Name: VNCitizenAppClientCapabilityStatement
Định danh khác: OID:2.25.161089673617632664299011809196868855799.13.3

Yêu cầu tuân thủ tối thiểu theo từng vai trò triển khai dành cho ứng dụng người dân/cổng công dân/kết nối VNeID. Tập trung vào truy cập hồ sơ cá nhân, giấy tờ lâm sàng, Consent và lịch sử truy cập. / Minimum conformance requirements for citizen-facing or VNeID-connected apps.

Raw OpenAPI-Swagger Definition file | Tải xuống

Language: vi

VN Core Citizen App Client CapabilityStatement

  • Implementation Guide Version: 0.10.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2026-05-10
  • Published by: Omi HealthTech / VN Core FHIR Community Initiative

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

Ứng dụng người dân chỉ nên truy cập theo patient compartment của chính chủ thể dữ liệu hoặc người đại diện hợp pháp.

Security
Enable CORS: no
Security services supported: SMART-on-FHIR

Khuyến nghị khởi chạy ứng dụng theo SMART-on-FHIR với scope tối thiểu patient/*.read, patient/Consent.*, audit bắt buộc và kiểm soát truy cập qua người giám hộ/RelatedPerson.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Patienthttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-patientYYidentifier
RelatedPersonhttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-relatedpersonYYpatient
Coveragehttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-coverageYYbeneficiary
ExplanationOfBenefithttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-explanation-of-benefitYYpatient, created
DocumentReferencehttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-document-referenceYYpatient
Consenthttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-consentYYYYpatient
Compositionhttp://hl7.org/fhir/StructureDefinition/Composition
Additional supported profiles:
  Giấy khám sức khoẻ định kỳ VN Core — VN Core Health Checkup Composition Profile
  Sổ Sức khoẻ điện tử VN Core — VN Core Health Record Summary (Patient Summary) Profile
YYpatient, date$document
AuditEventhttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-audit-eventYYpatient
Bundlehttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-bundle
Additional supported profiles:
  Document Bundle giấy khám sức khoẻ định kỳ — VN Core Health Checkup Document Bundle
  Document Bundle Sổ Sức khoẻ điện tử — VN Core Health Record Summary Bundle
  Bundle chứng nhận sức khoẻ (SHC/SHL payload) — VN Core Health Credential Bundle
  Document Bundle bàn giao bảng kê chi phí — VN Core Cost Statement Document Bundle
Y
Immunizationhttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-immunizationYYy?y?patientImmunization:patient
MedicationStatementhttp://fhir.hl7.org.vn/core/StructureDefinition/vn-core-medication-statementYYYYpatientMedicationStatement:patient

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDidentifiertoken
 
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDpatientreference
 
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDbeneficiaryreference
 
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHOULD support read, search-type.

Documentation

Giải trình quyền lợi BHYT hiển thị cho người dân — VNCoreExplanationOfBenefit profile; bản chi tiết theo khoản mục chi phí (QĐ 697/QĐ-BYT)

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDpatientreference
SHOULDcreateddate
 
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDpatientreference
 
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDpatientreference
 
Base System Profile
Composition
Profile Conformance
SHALL
Reference Policy

Documentation

Giấy khám sức khoẻ định kỳ (QĐ 1551/QĐ-BYT hợp nhất QĐ 2062/QĐ-BYT — 3 mẫu theo nhóm tuổi + trường hiển thị VNeID Phụ lục 04) + Sổ Sức khoẻ điện tử tổng hợp/Patient Summary (QĐ 1332/QĐ-BYT) hiển thị trên VNeID. Truy xuất document qua $document hoặc đọc Bundle.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDpatientreference
SHOULDdatedate
 
Extended Operations
ConformanceOperationDocumentation
SHOULD$document

Yêu cầu máy chủ dựng gói tài liệu từ một Composition. Ứng dụng người dân NÊN dùng khi máy chủ hỗ trợ; nếu không, đọc Bundle đã có sẵn. Máy chủ có thể từ chối khi người dùng không có quyền với toàn bộ nội dung gói.

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDpatientreference
 
Profile Conformance
SHALL
Reference Policy

Documentation

Ứng dụng đọc gói tài liệu đã được máy chủ tạo sẵn — giấy khám sức khoẻ định kỳ, Sổ Sức khoẻ điện tử tổng hợp, hồ sơ chứng nhận sức khoẻ. Không tự lắp gói từ các resource lẻ: thứ tự và tính toàn vẹn của gói do bên tạo tài liệu chịu trách nhiệm.

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.
  • MAY support create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
 
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference