Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam
0.6.0 - Draft for Community Review
Bộ Hướng dẫn Triển khai Core FHIR cho Việt Nam - Draft for Community Review (v0.6.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft tại thời điểm 2026-06-10 |
Các định nghĩa cho vnHealthCheckupDataSyncEnvelopeLm mô hình logic
Guidance on how to interpret the contents of this table can be foundhere
| 0. vnHealthCheckupDataSyncEnvelopeLm | |
| Definition | Logical model cho bản tin (envelope) đồng bộ tự động tập dữ liệu khám sức khỏe định kỳ từ cơ sở KCB lên Cổng/Trục dữ liệu sức khỏe Bộ Y tế (api.emrhub.vn). API: POST /api/platform/data-sync/push. Xác thực: OAuth2 + Bearer Token (lấy từ /api/auth/login). Định dạng JSON (UTF-8). KHÁC với luồng BHYT Gateway (gdbhyt.baohiemxahoi.gov.vn, XML 4210) — đây là surface liên thông KSK quốc gia. INFORMATIVE / non-normative: đây là mô hình ánh xạ transport envelope (không phải FHIR resource normative). Các National Core IG (KR/JP) chỉ chuẩn hóa profile/search/capability RESTful; envelope được giữ làm mapping aid để implementer ánh xạ payload FHIR ↔ bản tin đồng bộ. Căn cứ: QĐ 1551/QĐ-BYT (31/5/2026) — Phụ lục 02 đặc tả API. |
| Short | Bản tin đồng bộ dữ liệu KSK lên Trục dữ liệu BYT — Logical Model (Phụ lục 02) |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. vnHealthCheckupDataSyncEnvelopeLm.header | |
| Definition | header - Thông tin header bản tin |
| Short | header - Thông tin header bản tin |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. vnHealthCheckupDataSyncEnvelopeLm.header.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. vnHealthCheckupDataSyncEnvelopeLm.header.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on vnHealthCheckupDataSyncEnvelopeLm.header.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. vnHealthCheckupDataSyncEnvelopeLm.header.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 10. vnHealthCheckupDataSyncEnvelopeLm.header.version | |
| Definition | version - Phiên bản hệ thống Trục dữ liệu BYT |
| Short | version - Phiên bản hệ thống Trục dữ liệu BYT |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. vnHealthCheckupDataSyncEnvelopeLm.header.senderId | |
| Definition | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB) |
| Short | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. vnHealthCheckupDataSyncEnvelopeLm.header.receiverId | |
| Definition | receiver_id - Mã bên nhận tin (vd: TDLBYT) |
| Short | receiver_id - Mã bên nhận tin (vd: TDLBYT) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. vnHealthCheckupDataSyncEnvelopeLm.header.txnType | |
| Definition | txn_type - Loại giao dịch (snc_checkup: đồng bộ tập dữ liệu KSK định kỳ) |
| Short | txn_type - Loại giao dịch (snc_checkup: đồng bộ tập dữ liệu KSK định kỳ) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. vnHealthCheckupDataSyncEnvelopeLm.header.msgId | |
| Definition | msg_id - Mã giao dịch = sender_id + YY + MM + NN + UUIDv4 |
| Short | msg_id - Mã giao dịch = sender_id + YY + MM + NN + UUIDv4 |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. vnHealthCheckupDataSyncEnvelopeLm.header.msgType | |
| Definition | msg_type - 101: Thông điệp phát tin đồng bộ (request); 102: Trục đã nhận dữ liệu (response). service-type=100 (data sync) |
| Short | msg_type - 101: Thông điệp phát tin đồng bộ (request); 102: Trục đã nhận dữ liệu (response). service-type=100 (data sync) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. vnHealthCheckupDataSyncEnvelopeLm.header.dataType | |
| Definition | data_type - Định dạng file (xml/base64, json/base64, png/base64, jpg/base64, pdf/base64) |
| Short | data_type - Định dạng file (xml/base64, json/base64, png/base64, jpg/base64, pdf/base64) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. vnHealthCheckupDataSyncEnvelopeLm.header.sendDatetime | |
| Definition | send_datetime - Thời điểm đẩy dữ liệu (Unix timestamp 13 số ms — dùng string vì vượt FHIR R4 integer 32-bit) |
| Short | send_datetime - Thời điểm đẩy dữ liệu (Unix timestamp 13 số ms — dùng string vì vượt FHIR R4 integer 32-bit) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. vnHealthCheckupDataSyncEnvelopeLm.data | |
| Definition | data - File dữ liệu (XML/JSON) đã encode Base64 |
| Short | data - File dữ liệu (XML/JSON) đã encode Base64 |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. vnHealthCheckupDataSyncEnvelopeLm.signature | |
| Definition | signature - Chữ ký số checksum SHA256RSA giữa header và data (bên phát tin tạo) |
| Short | signature - Chữ ký số checksum SHA256RSA giữa header và data (bên phát tin tạo) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. vnHealthCheckupDataSyncEnvelopeLm | |
| Definition | Logical model cho bản tin (envelope) đồng bộ tự động tập dữ liệu khám sức khỏe định kỳ từ cơ sở KCB lên Cổng/Trục dữ liệu sức khỏe Bộ Y tế (api.emrhub.vn). API: POST /api/platform/data-sync/push. Xác thực: OAuth2 + Bearer Token (lấy từ /api/auth/login). Định dạng JSON (UTF-8). KHÁC với luồng BHYT Gateway (gdbhyt.baohiemxahoi.gov.vn, XML 4210) — đây là surface liên thông KSK quốc gia. INFORMATIVE / non-normative: đây là mô hình ánh xạ transport envelope (không phải FHIR resource normative). Các National Core IG (KR/JP) chỉ chuẩn hóa profile/search/capability RESTful; envelope được giữ làm mapping aid để implementer ánh xạ payload FHIR ↔ bản tin đồng bộ. Căn cứ: QĐ 1551/QĐ-BYT (31/5/2026) — Phụ lục 02 đặc tả API. |
| Short | Bản tin đồng bộ dữ liệu KSK lên Trục dữ liệu BYT — Logical Model (Phụ lục 02) |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. vnHealthCheckupDataSyncEnvelopeLm.header | |
| Definition | header - Thông tin header bản tin |
| Short | header - Thông tin header bản tin |
| Control | 1..1 |
| Type | BackboneElement |
| 4. vnHealthCheckupDataSyncEnvelopeLm.header.version | |
| Definition | version - Phiên bản hệ thống Trục dữ liệu BYT |
| Short | version - Phiên bản hệ thống Trục dữ liệu BYT |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. vnHealthCheckupDataSyncEnvelopeLm.header.senderId | |
| Definition | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB) |
| Short | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. vnHealthCheckupDataSyncEnvelopeLm.header.receiverId | |
| Definition | receiver_id - Mã bên nhận tin (vd: TDLBYT) |
| Short | receiver_id - Mã bên nhận tin (vd: TDLBYT) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. vnHealthCheckupDataSyncEnvelopeLm.header.txnType | |
| Definition | txn_type - Loại giao dịch (snc_checkup: đồng bộ tập dữ liệu KSK định kỳ) |
| Short | txn_type - Loại giao dịch (snc_checkup: đồng bộ tập dữ liệu KSK định kỳ) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. vnHealthCheckupDataSyncEnvelopeLm.header.msgId | |
| Definition | msg_id - Mã giao dịch = sender_id + YY + MM + NN + UUIDv4 |
| Short | msg_id - Mã giao dịch = sender_id + YY + MM + NN + UUIDv4 |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. vnHealthCheckupDataSyncEnvelopeLm.header.msgType | |
| Definition | msg_type - 101: Thông điệp phát tin đồng bộ (request); 102: Trục đã nhận dữ liệu (response). service-type=100 (data sync) |
| Short | msg_type - 101: Thông điệp phát tin đồng bộ (request); 102: Trục đã nhận dữ liệu (response). service-type=100 (data sync) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. vnHealthCheckupDataSyncEnvelopeLm.header.dataType | |
| Definition | data_type - Định dạng file (xml/base64, json/base64, png/base64, jpg/base64, pdf/base64) |
| Short | data_type - Định dạng file (xml/base64, json/base64, png/base64, jpg/base64, pdf/base64) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. vnHealthCheckupDataSyncEnvelopeLm.header.sendDatetime | |
| Definition | send_datetime - Thời điểm đẩy dữ liệu (Unix timestamp 13 số ms — dùng string vì vượt FHIR R4 integer 32-bit) |
| Short | send_datetime - Thời điểm đẩy dữ liệu (Unix timestamp 13 số ms — dùng string vì vượt FHIR R4 integer 32-bit) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. vnHealthCheckupDataSyncEnvelopeLm.data | |
| Definition | data - File dữ liệu (XML/JSON) đã encode Base64 |
| Short | data - File dữ liệu (XML/JSON) đã encode Base64 |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. vnHealthCheckupDataSyncEnvelopeLm.signature | |
| Definition | signature - Chữ ký số checksum SHA256RSA giữa header và data (bên phát tin tạo) |
| Short | signature - Chữ ký số checksum SHA256RSA giữa header và data (bên phát tin tạo) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be foundhere
| 0. vnHealthCheckupDataSyncEnvelopeLm | |
| Definition | Logical model cho bản tin (envelope) đồng bộ tự động tập dữ liệu khám sức khỏe định kỳ từ cơ sở KCB lên Cổng/Trục dữ liệu sức khỏe Bộ Y tế (api.emrhub.vn). API: POST /api/platform/data-sync/push. Xác thực: OAuth2 + Bearer Token (lấy từ /api/auth/login). Định dạng JSON (UTF-8). KHÁC với luồng BHYT Gateway (gdbhyt.baohiemxahoi.gov.vn, XML 4210) — đây là surface liên thông KSK quốc gia. INFORMATIVE / non-normative: đây là mô hình ánh xạ transport envelope (không phải FHIR resource normative). Các National Core IG (KR/JP) chỉ chuẩn hóa profile/search/capability RESTful; envelope được giữ làm mapping aid để implementer ánh xạ payload FHIR ↔ bản tin đồng bộ. Căn cứ: QĐ 1551/QĐ-BYT (31/5/2026) — Phụ lục 02 đặc tả API. |
| Short | Bản tin đồng bộ dữ liệu KSK lên Trục dữ liệu BYT — Logical Model (Phụ lục 02) |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. vnHealthCheckupDataSyncEnvelopeLm.header | |
| Definition | header - Thông tin header bản tin |
| Short | header - Thông tin header bản tin |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. vnHealthCheckupDataSyncEnvelopeLm.header.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. vnHealthCheckupDataSyncEnvelopeLm.header.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on vnHealthCheckupDataSyncEnvelopeLm.header.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. vnHealthCheckupDataSyncEnvelopeLm.header.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. vnHealthCheckupDataSyncEnvelopeLm.header.version | |
| Definition | version - Phiên bản hệ thống Trục dữ liệu BYT |
| Short | version - Phiên bản hệ thống Trục dữ liệu BYT |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. vnHealthCheckupDataSyncEnvelopeLm.header.senderId | |
| Definition | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB) |
| Short | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. vnHealthCheckupDataSyncEnvelopeLm.header.receiverId | |
| Definition | receiver_id - Mã bên nhận tin (vd: TDLBYT) |
| Short | receiver_id - Mã bên nhận tin (vd: TDLBYT) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. vnHealthCheckupDataSyncEnvelopeLm.header.txnType | |
| Definition | txn_type - Loại giao dịch (snc_checkup: đồng bộ tập dữ liệu KSK định kỳ) |
| Short | txn_type - Loại giao dịch (snc_checkup: đồng bộ tập dữ liệu KSK định kỳ) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. vnHealthCheckupDataSyncEnvelopeLm.header.msgId | |
| Definition | msg_id - Mã giao dịch = sender_id + YY + MM + NN + UUIDv4 |
| Short | msg_id - Mã giao dịch = sender_id + YY + MM + NN + UUIDv4 |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 20. vnHealthCheckupDataSyncEnvelopeLm.header.msgType | |
| Definition | msg_type - 101: Thông điệp phát tin đồng bộ (request); 102: Trục đã nhận dữ liệu (response). service-type=100 (data sync) |
| Short | msg_type - 101: Thông điệp phát tin đồng bộ (request); 102: Trục đã nhận dữ liệu (response). service-type=100 (data sync) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. vnHealthCheckupDataSyncEnvelopeLm.header.dataType | |
| Definition | data_type - Định dạng file (xml/base64, json/base64, png/base64, jpg/base64, pdf/base64) |
| Short | data_type - Định dạng file (xml/base64, json/base64, png/base64, jpg/base64, pdf/base64) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. vnHealthCheckupDataSyncEnvelopeLm.header.sendDatetime | |
| Definition | send_datetime - Thời điểm đẩy dữ liệu (Unix timestamp 13 số ms — dùng string vì vượt FHIR R4 integer 32-bit) |
| Short | send_datetime - Thời điểm đẩy dữ liệu (Unix timestamp 13 số ms — dùng string vì vượt FHIR R4 integer 32-bit) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. vnHealthCheckupDataSyncEnvelopeLm.data | |
| Definition | data - File dữ liệu (XML/JSON) đã encode Base64 |
| Short | data - File dữ liệu (XML/JSON) đã encode Base64 |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. vnHealthCheckupDataSyncEnvelopeLm.signature | |
| Definition | signature - Chữ ký số checksum SHA256RSA giữa header và data (bên phát tin tạo) |
| Short | signature - Chữ ký số checksum SHA256RSA giữa header và data (bên phát tin tạo) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |