Hướng dẫn triển khai FHIR cốt lõi Việt Nam — VN Core FHIR Implementation Guide
0.9.0 - Draft for Community Review
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.9.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| URL chính thức: http://fhir.hl7.org.vn/core/StructureDefinition/vnHealthCheckupDataSyncEnvelopeLm | Phiên bản: 0.9.0 | ||||
| Computable Name: VNHealthCheckupDataSyncEnvelopeLM | |||||
| Định danh khác: OID:2.25.161089673617632664299011809196868855799.42.161 | |||||
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ộ. Môi trường (PL02 mục 2): Cổng dữ liệu sức khỏe BYT — admin https://csdlksk.vn (sandbox https://sandbox.csdlksk.vn); Trục dữ liệu BYT — admin https://admin.emrhub.vn (sandbox https://admin-sandbox.emrhub.vn), API https://api.emrhub.vn (sandbox https://api-sandbox.emrhub.vn). Căn cứ: QĐ 2062/QĐ-BYT (07/7/2026) Phụ lục 02 (Hướng dẫn kết nối, liên thông dữ liệu) — THAY Phụ lục 02 QĐ 1551/QĐ-BYT (31/5/2026); đọc hợp nhất. API OAuth2 + Bearer, POST /api/platform/data-sync/push (service-type=100, msg_type=101/102, txn_type=sync_checkup), checksum RSASHA256. ĐÃ ĐỐI CHIẾU TOÀN VĂN PL02 ngày 23/07/2026 (file 'Phu luc 2-5.pdf' nhúng trong bản docx user cung cấp).
Usages:
You can also check for usages in the FHIR IG Statistics
Mô tả profile, differential, snapshot và các biểu diễn liên quan.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  vnHealthCheckupDataSyncEnvelopeLm |
0..* | Base | Bản tin đồng bộ dữ liệu KSK lên Trục dữ liệu BYT — Logical Model (Phụ lục 02) | |
  httpHeader |
1..1 | BackboneElement | HTTP headers của request | |
   contentType |
1..1 | string | Content-Type = application/json | |
| accept |
1..1 | string | Accept = */* | |
| acceptEncoding |
1..1 | string | Accept-Encoding = gzip,deflate,br | |
| authorization |
1..1 | string | Authorization = Bearer + Authorization Token (văn bản gọi 'Authorization Token'; lấy từ POST /api/auth/login — response cấp token/refresh_token/duration giây/role: facility=Cơ sở KCB, doh=Sở Y tế) | |
 serviceType |
1..1 | string | service-type = 100 (Dịch vụ data sync vào Trục dữ liệu Bộ Y tế) | |
| header |
1..1 | BackboneElement | header - Thông tin header bản tin (JSON Object) | |
| version |
1..1 | string | version - Phiên bản hệ thống Trục dữ liệu BYT | |
| senderId |
1..1 | string | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB từ Cục KCB) | |
| receiverId |
1..1 | string | receiver_id - Mã bên nhận tin (vd: TDLBYT) | |
| txnType |
1..1 | string | txn_type - Loại giao dịch. Giá trị cố định: sync_checkup (đồng bộ tập dữ liệu KSK định kỳ) | |
| msgId |
1..1 | string | msg_id - Mã giao dịch = sender_id + YY (2 ký tự năm) + MM (2 ký tự tháng) + DD (2 ký tự ngày) + UUIDv4 (không gạch) | |
| msgType |
1..1 | string | msg_type - REQUEST cố định = 101 (thông điệp phát tin đồng bộ). Response dùng 102 (xem nhóm response bên dưới). service-type=100 | |
| dataType |
1..1 | string | data_type - Định dạng file. Giá trị: xml/base64 HOẶC json/base64 (chỉ 2 giá trị này theo Phụ lục 02) | |
| sendDatetime |
1..1 | string | send_datetime - Thời điểm đẩy dữ liệu, Unix timestamp 13 số. VĂN BẢN GỐC kiểu Long; mô hình hóa string vì vượt phạm vi FHIR R4 integer 32-bit (INFORMATIVE) | |
| data |
1..1 | string | data - File dữ liệu (XML/JSON) đã encode Base64 (STRING BASE64 theo quy tắc mục 4 PL02). Bắt buộc trong thực tế dù bảng gốc không đánh dấu 'x' | |
| signature |
1..1 | string | signature - Chữ ký số checksum RSASHA256 giữa header và data (bên phát tin tạo). Công thức PL02 mục 4: A=Uppercase(SHA256(header)); B=Uppercase(SHA256(data)); C=A+'.'+B; SIGNATURE=Uppercase(RSASHA256(C, Private Key)). Quy tắc: bỏ whitespace/xuống dòng trước khi hash; header rỗng truyền {}; data là STRING BASE64. BYT cấp cặp khóa cho đơn vị; bản tin còn phải KÝ SỐ TỔ CHỨC trước khi gửi (Trục xác thực trước khi nhận). Bắt buộc trong thực tế dù bảng gốc không đánh dấu 'x' | |
| response |
0..1 | BackboneElement | Bản tin phản hồi từ Trục BYT (msg_type=102) | |
| version |
0..1 | string | version - Phiên bản hệ thống Trục dữ liệu BYT | |
| senderId |
0..1 | string | sender_id (response) - Mã bên nhận-nay-phát (ví dụ TDLBYT) | |
| receiverId |
0..1 | string | receiver_id (response) - Mã bên phát tin gốc (13 số mã định danh CSKCB) | |
| txnId |
0..1 | string | txn_id - Mã giao dịch do Trục sinh = XX (2 ký tự dịch vụ) + '-' + sender_id + '-' + YY + MM + DD + UUIDv4 không gạch (cấu trúc KHÁC msg_id) | |
| txnType |
0..1 | string | txn_type (response) = sync_checkup | |
| msgType |
0..1 | string | msg_type (response) = 102 (Trục đã nhận dữ liệu và thực hiện đồng bộ) | |
| msgId |
0..1 | string | msg_id (response) - sender_id + YY + MM + DD + UUIDv4 không gạch | |
| refMsgId |
0..1 | string | ref_msg_id - msg_id của bên phát tin gốc | |
| sendDatetime |
0..1 | string | send_datetime (response) - Ngày gửi của bên phát tin, Unix timestamp 13 số | |
| resDatetime |
0..1 | string | res_datetime - Ngày phản hồi của bên nhận tin (Unix timestamp 13 số) | |
| resCode |
0..1 | string | res_code - Mã trạng thái tiếp nhận, đủ 10 mã theo PL02: CM_SUCCESS | CM_INVALID_REQUEST | PS_DS_RSA_SIGNATURE_INVALID | PS_DS_RSA_SIGNATURE_MISSING | PS_DS_CA_SIGNATURE_INVALID | PS_DS_CA_SIGNATURE_MISSING | PS_DS_VERIFY_SUCCESS | PS_DS_VERIFY_FAIL | PS_DS_SAVE_SUCCESS | PS_DS_SAVE_FAIL | |
| resMsg |
0..1 | string | res_msg - Diễn giải trạng thái tiếp nhận | |
| dataState |
0..1 | string | data.data_state - Mã trạng thái dữ liệu sau khi về kho (vd '0') | |
| dataStateMsg |
0..1 | string | data.data_state_msg - Chi tiết trạng thái dữ liệu (vd 'Data is received') | |
| messageCheckCa |
0..1 | string | data.message_check_ca - Trạng thái kiểm tra chữ ký số bản tin (vd 'Digitally signed XML data') | |
| messageNotify |
0..1 | string | data.message_notify - Trạng thái hệ thống với bản tin (vd 'Successfully inserted data to DATA LAKE') | |
| signature |
0..1 | string | signature (response) - Chữ ký RSASHA256 của Trục BYT | |
 authLogin |
0..1 | BackboneElement | Xác thực tài khoản liên thông (POST /api/auth/login) — INFORMATIVE, TRANSPORT-ONLY: username/password/token là thông tin phiên truyền tải, TUYỆT ĐỐI không persist vào FHIR store/clinical Bundle/log; quản lý trong lớp IAM của hệ thống gửi | |
 username |
1..1 | string | username - Tên đăng nhập tài khoản liên thông do Trục dữ liệu BYT cấp | |
| password |
1..1 | string | password - Mật khẩu | |
| token |
0..1 | string | data.token - Token gọi API nghiệp vụ (response) | |
| refreshToken |
0..1 | string | data.refresh_token - Cấp lại token khi hết hiệu lực | |
| duration |
0..1 | string | data.duration - Thời gian hiệu lực token, đơn vị giây (VĂN BẢN GỐC kiểu Long) | |
| role |
0..1 | string | data.role - Phân quyền: facility (Cơ sở KCB) | doh (Sở Y tế) | |
| resCode |
0..1 | string | header.res_code - CM_SUCCESS | CM_AUTH_ACCOUNT_FAIL | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
 vnHealthCheckupDataSyncEnvelopeLm |
0..* | Base | Bản tin đồng bộ dữ liệu KSK lên Trục dữ liệu BYT — Logical Model (Phụ lục 02) | |
| httpHeader |
1..1 | BackboneElement | HTTP headers của request | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| contentType |
1..1 | string | Content-Type = application/json | |
| accept |
1..1 | string | Accept = */* | |
| acceptEncoding |
1..1 | string | Accept-Encoding = gzip,deflate,br | |
| authorization |
1..1 | string | Authorization = Bearer + Authorization Token (văn bản gọi 'Authorization Token'; lấy từ POST /api/auth/login — response cấp token/refresh_token/duration giây/role: facility=Cơ sở KCB, doh=Sở Y tế) | |
| serviceType |
1..1 | string | service-type = 100 (Dịch vụ data sync vào Trục dữ liệu Bộ Y tế) | |
| header |
1..1 | BackboneElement | header - Thông tin header bản tin (JSON Object) | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| version |
1..1 | string | version - Phiên bản hệ thống Trục dữ liệu BYT | |
| senderId |
1..1 | string | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB từ Cục KCB) | |
| receiverId |
1..1 | string | receiver_id - Mã bên nhận tin (vd: TDLBYT) | |
| txnType |
1..1 | string | txn_type - Loại giao dịch. Giá trị cố định: sync_checkup (đồng bộ tập dữ liệu KSK định kỳ) | |
| msgId |
1..1 | string | msg_id - Mã giao dịch = sender_id + YY (2 ký tự năm) + MM (2 ký tự tháng) + DD (2 ký tự ngày) + UUIDv4 (không gạch) | |
| msgType |
1..1 | string | msg_type - REQUEST cố định = 101 (thông điệp phát tin đồng bộ). Response dùng 102 (xem nhóm response bên dưới). service-type=100 | |
| dataType |
1..1 | string | data_type - Định dạng file. Giá trị: xml/base64 HOẶC json/base64 (chỉ 2 giá trị này theo Phụ lục 02) | |
| sendDatetime |
1..1 | string | send_datetime - Thời điểm đẩy dữ liệu, Unix timestamp 13 số. VĂN BẢN GỐC kiểu Long; mô hình hóa string vì vượt phạm vi FHIR R4 integer 32-bit (INFORMATIVE) | |
| data |
1..1 | string | data - File dữ liệu (XML/JSON) đã encode Base64 (STRING BASE64 theo quy tắc mục 4 PL02). Bắt buộc trong thực tế dù bảng gốc không đánh dấu 'x' | |
| signature |
1..1 | string | signature - Chữ ký số checksum RSASHA256 giữa header và data (bên phát tin tạo). Công thức PL02 mục 4: A=Uppercase(SHA256(header)); B=Uppercase(SHA256(data)); C=A+'.'+B; SIGNATURE=Uppercase(RSASHA256(C, Private Key)). Quy tắc: bỏ whitespace/xuống dòng trước khi hash; header rỗng truyền {}; data là STRING BASE64. BYT cấp cặp khóa cho đơn vị; bản tin còn phải KÝ SỐ TỔ CHỨC trước khi gửi (Trục xác thực trước khi nhận). Bắt buộc trong thực tế dù bảng gốc không đánh dấu 'x' | |
| response |
0..1 | BackboneElement | Bản tin phản hồi từ Trục BYT (msg_type=102) | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| version |
0..1 | string | version - Phiên bản hệ thống Trục dữ liệu BYT | |
| senderId |
0..1 | string | sender_id (response) - Mã bên nhận-nay-phát (ví dụ TDLBYT) | |
| receiverId |
0..1 | string | receiver_id (response) - Mã bên phát tin gốc (13 số mã định danh CSKCB) | |
| txnId |
0..1 | string | txn_id - Mã giao dịch do Trục sinh = XX (2 ký tự dịch vụ) + '-' + sender_id + '-' + YY + MM + DD + UUIDv4 không gạch (cấu trúc KHÁC msg_id) | |
| txnType |
0..1 | string | txn_type (response) = sync_checkup | |
| msgType |
0..1 | string | msg_type (response) = 102 (Trục đã nhận dữ liệu và thực hiện đồng bộ) | |
| msgId |
0..1 | string | msg_id (response) - sender_id + YY + MM + DD + UUIDv4 không gạch | |
| refMsgId |
0..1 | string | ref_msg_id - msg_id của bên phát tin gốc | |
| sendDatetime |
0..1 | string | send_datetime (response) - Ngày gửi của bên phát tin, Unix timestamp 13 số | |
| resDatetime |
0..1 | string | res_datetime - Ngày phản hồi của bên nhận tin (Unix timestamp 13 số) | |
| resCode |
0..1 | string | res_code - Mã trạng thái tiếp nhận, đủ 10 mã theo PL02: CM_SUCCESS | CM_INVALID_REQUEST | PS_DS_RSA_SIGNATURE_INVALID | PS_DS_RSA_SIGNATURE_MISSING | PS_DS_CA_SIGNATURE_INVALID | PS_DS_CA_SIGNATURE_MISSING | PS_DS_VERIFY_SUCCESS | PS_DS_VERIFY_FAIL | PS_DS_SAVE_SUCCESS | PS_DS_SAVE_FAIL | |
| resMsg |
0..1 | string | res_msg - Diễn giải trạng thái tiếp nhận | |
| dataState |
0..1 | string | data.data_state - Mã trạng thái dữ liệu sau khi về kho (vd '0') | |
| dataStateMsg |
0..1 | string | data.data_state_msg - Chi tiết trạng thái dữ liệu (vd 'Data is received') | |
| messageCheckCa |
0..1 | string | data.message_check_ca - Trạng thái kiểm tra chữ ký số bản tin (vd 'Digitally signed XML data') | |
| messageNotify |
0..1 | string | data.message_notify - Trạng thái hệ thống với bản tin (vd 'Successfully inserted data to DATA LAKE') | |
| signature |
0..1 | string | signature (response) - Chữ ký RSASHA256 của Trục BYT | |
| authLogin |
0..1 | BackboneElement | Xác thực tài khoản liên thông (POST /api/auth/login) — INFORMATIVE, TRANSPORT-ONLY: username/password/token là thông tin phiên truyền tải, TUYỆT ĐỐI không persist vào FHIR store/clinical Bundle/log; quản lý trong lớp IAM của hệ thống gửi | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| username |
1..1 | string | username - Tên đăng nhập tài khoản liên thông do Trục dữ liệu BYT cấp | |
| password |
1..1 | string | password - Mật khẩu | |
| token |
0..1 | string | data.token - Token gọi API nghiệp vụ (response) | |
| refreshToken |
0..1 | string | data.refresh_token - Cấp lại token khi hết hiệu lực | |
| duration |
0..1 | string | data.duration - Thời gian hiệu lực token, đơn vị giây (VĂN BẢN GỐC kiểu Long) | |
| role |
0..1 | string | data.role - Phân quyền: facility (Cơ sở KCB) | doh (Sở Y tế) | |
| resCode |
0..1 | string | header.res_code - CM_SUCCESS | CM_AUTH_ACCOUNT_FAIL | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| 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: |
|---|---|---|---|---|
| vnHealthCheckupDataSyncEnvelopeLm |
0..* | Base | Bản tin đồng bộ dữ liệu KSK lên Trục dữ liệu BYT — Logical Model (Phụ lục 02) | |
| httpHeader |
1..1 | BackboneElement | HTTP headers của request | |
| contentType |
1..1 | string | Content-Type = application/json | |
| accept |
1..1 | string | Accept = */* | |
| acceptEncoding |
1..1 | string | Accept-Encoding = gzip,deflate,br | |
| authorization |
1..1 | string | Authorization = Bearer + Authorization Token (văn bản gọi 'Authorization Token'; lấy từ POST /api/auth/login — response cấp token/refresh_token/duration giây/role: facility=Cơ sở KCB, doh=Sở Y tế) | |
| serviceType |
1..1 | string | service-type = 100 (Dịch vụ data sync vào Trục dữ liệu Bộ Y tế) | |
| header |
1..1 | BackboneElement | header - Thông tin header bản tin (JSON Object) | |
| version |
1..1 | string | version - Phiên bản hệ thống Trục dữ liệu BYT | |
| senderId |
1..1 | string | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB từ Cục KCB) | |
| receiverId |
1..1 | string | receiver_id - Mã bên nhận tin (vd: TDLBYT) | |
| txnType |
1..1 | string | txn_type - Loại giao dịch. Giá trị cố định: sync_checkup (đồng bộ tập dữ liệu KSK định kỳ) | |
| msgId |
1..1 | string | msg_id - Mã giao dịch = sender_id + YY (2 ký tự năm) + MM (2 ký tự tháng) + DD (2 ký tự ngày) + UUIDv4 (không gạch) | |
| msgType |
1..1 | string | msg_type - REQUEST cố định = 101 (thông điệp phát tin đồng bộ). Response dùng 102 (xem nhóm response bên dưới). service-type=100 | |
| dataType |
1..1 | string | data_type - Định dạng file. Giá trị: xml/base64 HOẶC json/base64 (chỉ 2 giá trị này theo Phụ lục 02) | |
| sendDatetime |
1..1 | string | send_datetime - Thời điểm đẩy dữ liệu, Unix timestamp 13 số. VĂN BẢN GỐC kiểu Long; mô hình hóa string vì vượt phạm vi FHIR R4 integer 32-bit (INFORMATIVE) | |
| data |
1..1 | string | data - File dữ liệu (XML/JSON) đã encode Base64 (STRING BASE64 theo quy tắc mục 4 PL02). Bắt buộc trong thực tế dù bảng gốc không đánh dấu 'x' | |
| signature |
1..1 | string | signature - Chữ ký số checksum RSASHA256 giữa header và data (bên phát tin tạo). Công thức PL02 mục 4: A=Uppercase(SHA256(header)); B=Uppercase(SHA256(data)); C=A+'.'+B; SIGNATURE=Uppercase(RSASHA256(C, Private Key)). Quy tắc: bỏ whitespace/xuống dòng trước khi hash; header rỗng truyền {}; data là STRING BASE64. BYT cấp cặp khóa cho đơn vị; bản tin còn phải KÝ SỐ TỔ CHỨC trước khi gửi (Trục xác thực trước khi nhận). Bắt buộc trong thực tế dù bảng gốc không đánh dấu 'x' | |
| response |
0..1 | BackboneElement | Bản tin phản hồi từ Trục BYT (msg_type=102) | |
| version |
0..1 | string | version - Phiên bản hệ thống Trục dữ liệu BYT | |
| senderId |
0..1 | string | sender_id (response) - Mã bên nhận-nay-phát (ví dụ TDLBYT) | |
| receiverId |
0..1 | string | receiver_id (response) - Mã bên phát tin gốc (13 số mã định danh CSKCB) | |
| txnId |
0..1 | string | txn_id - Mã giao dịch do Trục sinh = XX (2 ký tự dịch vụ) + '-' + sender_id + '-' + YY + MM + DD + UUIDv4 không gạch (cấu trúc KHÁC msg_id) | |
| txnType |
0..1 | string | txn_type (response) = sync_checkup | |
| msgType |
0..1 | string | msg_type (response) = 102 (Trục đã nhận dữ liệu và thực hiện đồng bộ) | |
| msgId |
0..1 | string | msg_id (response) - sender_id + YY + MM + DD + UUIDv4 không gạch | |
| refMsgId |
0..1 | string | ref_msg_id - msg_id của bên phát tin gốc | |
| sendDatetime |
0..1 | string | send_datetime (response) - Ngày gửi của bên phát tin, Unix timestamp 13 số | |
| resDatetime |
0..1 | string | res_datetime - Ngày phản hồi của bên nhận tin (Unix timestamp 13 số) | |
| resCode |
0..1 | string | res_code - Mã trạng thái tiếp nhận, đủ 10 mã theo PL02: CM_SUCCESS | CM_INVALID_REQUEST | PS_DS_RSA_SIGNATURE_INVALID | PS_DS_RSA_SIGNATURE_MISSING | PS_DS_CA_SIGNATURE_INVALID | PS_DS_CA_SIGNATURE_MISSING | PS_DS_VERIFY_SUCCESS | PS_DS_VERIFY_FAIL | PS_DS_SAVE_SUCCESS | PS_DS_SAVE_FAIL | |
| resMsg |
0..1 | string | res_msg - Diễn giải trạng thái tiếp nhận | |
| dataState |
0..1 | string | data.data_state - Mã trạng thái dữ liệu sau khi về kho (vd '0') | |
| dataStateMsg |
0..1 | string | data.data_state_msg - Chi tiết trạng thái dữ liệu (vd 'Data is received') | |
| messageCheckCa |
0..1 | string | data.message_check_ca - Trạng thái kiểm tra chữ ký số bản tin (vd 'Digitally signed XML data') | |
| messageNotify |
0..1 | string | data.message_notify - Trạng thái hệ thống với bản tin (vd 'Successfully inserted data to DATA LAKE') | |
| signature |
0..1 | string | signature (response) - Chữ ký RSASHA256 của Trục BYT | |
| authLogin |
0..1 | BackboneElement | Xác thực tài khoản liên thông (POST /api/auth/login) — INFORMATIVE, TRANSPORT-ONLY: username/password/token là thông tin phiên truyền tải, TUYỆT ĐỐI không persist vào FHIR store/clinical Bundle/log; quản lý trong lớp IAM của hệ thống gửi | |
| username |
1..1 | string | username - Tên đăng nhập tài khoản liên thông do Trục dữ liệu BYT cấp | |
| password |
1..1 | string | password - Mật khẩu | |
| token |
0..1 | string | data.token - Token gọi API nghiệp vụ (response) | |
| refreshToken |
0..1 | string | data.refresh_token - Cấp lại token khi hết hiệu lực | |
| duration |
0..1 | string | data.duration - Thời gian hiệu lực token, đơn vị giây (VĂN BẢN GỐC kiểu Long) | |
| role |
0..1 | string | data.role - Phân quyền: facility (Cơ sở KCB) | doh (Sở Y tế) | |
| resCode |
0..1 | string | header.res_code - CM_SUCCESS | CM_AUTH_ACCOUNT_FAIL | |
| Documentation for this format | ||||
Dạng xem SnapshotView
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| vnHealthCheckupDataSyncEnvelopeLm |
0..* | Base | Bản tin đồng bộ dữ liệu KSK lên Trục dữ liệu BYT — Logical Model (Phụ lục 02) | |
| httpHeader |
1..1 | BackboneElement | HTTP headers của request | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| contentType |
1..1 | string | Content-Type = application/json | |
| accept |
1..1 | string | Accept = */* | |
| acceptEncoding |
1..1 | string | Accept-Encoding = gzip,deflate,br | |
| authorization |
1..1 | string | Authorization = Bearer + Authorization Token (văn bản gọi 'Authorization Token'; lấy từ POST /api/auth/login — response cấp token/refresh_token/duration giây/role: facility=Cơ sở KCB, doh=Sở Y tế) | |
| serviceType |
1..1 | string | service-type = 100 (Dịch vụ data sync vào Trục dữ liệu Bộ Y tế) | |
| header |
1..1 | BackboneElement | header - Thông tin header bản tin (JSON Object) | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| version |
1..1 | string | version - Phiên bản hệ thống Trục dữ liệu BYT | |
| senderId |
1..1 | string | sender_id - Mã định danh bên phát tin (13 số mã định danh CSKCB từ Cục KCB) | |
| receiverId |
1..1 | string | receiver_id - Mã bên nhận tin (vd: TDLBYT) | |
| txnType |
1..1 | string | txn_type - Loại giao dịch. Giá trị cố định: sync_checkup (đồng bộ tập dữ liệu KSK định kỳ) | |
| msgId |
1..1 | string | msg_id - Mã giao dịch = sender_id + YY (2 ký tự năm) + MM (2 ký tự tháng) + DD (2 ký tự ngày) + UUIDv4 (không gạch) | |
| msgType |
1..1 | string | msg_type - REQUEST cố định = 101 (thông điệp phát tin đồng bộ). Response dùng 102 (xem nhóm response bên dưới). service-type=100 | |
| dataType |
1..1 | string | data_type - Định dạng file. Giá trị: xml/base64 HOẶC json/base64 (chỉ 2 giá trị này theo Phụ lục 02) | |
| sendDatetime |
1..1 | string | send_datetime - Thời điểm đẩy dữ liệu, Unix timestamp 13 số. VĂN BẢN GỐC kiểu Long; mô hình hóa string vì vượt phạm vi FHIR R4 integer 32-bit (INFORMATIVE) | |
| data |
1..1 | string | data - File dữ liệu (XML/JSON) đã encode Base64 (STRING BASE64 theo quy tắc mục 4 PL02). Bắt buộc trong thực tế dù bảng gốc không đánh dấu 'x' | |
| signature |
1..1 | string | signature - Chữ ký số checksum RSASHA256 giữa header và data (bên phát tin tạo). Công thức PL02 mục 4: A=Uppercase(SHA256(header)); B=Uppercase(SHA256(data)); C=A+'.'+B; SIGNATURE=Uppercase(RSASHA256(C, Private Key)). Quy tắc: bỏ whitespace/xuống dòng trước khi hash; header rỗng truyền {}; data là STRING BASE64. BYT cấp cặp khóa cho đơn vị; bản tin còn phải KÝ SỐ TỔ CHỨC trước khi gửi (Trục xác thực trước khi nhận). Bắt buộc trong thực tế dù bảng gốc không đánh dấu 'x' | |
| response |
0..1 | BackboneElement | Bản tin phản hồi từ Trục BYT (msg_type=102) | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| version |
0..1 | string | version - Phiên bản hệ thống Trục dữ liệu BYT | |
| senderId |
0..1 | string | sender_id (response) - Mã bên nhận-nay-phát (ví dụ TDLBYT) | |
| receiverId |
0..1 | string | receiver_id (response) - Mã bên phát tin gốc (13 số mã định danh CSKCB) | |
| txnId |
0..1 | string | txn_id - Mã giao dịch do Trục sinh = XX (2 ký tự dịch vụ) + '-' + sender_id + '-' + YY + MM + DD + UUIDv4 không gạch (cấu trúc KHÁC msg_id) | |
| txnType |
0..1 | string | txn_type (response) = sync_checkup | |
| msgType |
0..1 | string | msg_type (response) = 102 (Trục đã nhận dữ liệu và thực hiện đồng bộ) | |
| msgId |
0..1 | string | msg_id (response) - sender_id + YY + MM + DD + UUIDv4 không gạch | |
| refMsgId |
0..1 | string | ref_msg_id - msg_id của bên phát tin gốc | |
| sendDatetime |
0..1 | string | send_datetime (response) - Ngày gửi của bên phát tin, Unix timestamp 13 số | |
| resDatetime |
0..1 | string | res_datetime - Ngày phản hồi của bên nhận tin (Unix timestamp 13 số) | |
| resCode |
0..1 | string | res_code - Mã trạng thái tiếp nhận, đủ 10 mã theo PL02: CM_SUCCESS | CM_INVALID_REQUEST | PS_DS_RSA_SIGNATURE_INVALID | PS_DS_RSA_SIGNATURE_MISSING | PS_DS_CA_SIGNATURE_INVALID | PS_DS_CA_SIGNATURE_MISSING | PS_DS_VERIFY_SUCCESS | PS_DS_VERIFY_FAIL | PS_DS_SAVE_SUCCESS | PS_DS_SAVE_FAIL | |
| resMsg |
0..1 | string | res_msg - Diễn giải trạng thái tiếp nhận | |
| dataState |
0..1 | string | data.data_state - Mã trạng thái dữ liệu sau khi về kho (vd '0') | |
| dataStateMsg |
0..1 | string | data.data_state_msg - Chi tiết trạng thái dữ liệu (vd 'Data is received') | |
| messageCheckCa |
0..1 | string | data.message_check_ca - Trạng thái kiểm tra chữ ký số bản tin (vd 'Digitally signed XML data') | |
| messageNotify |
0..1 | string | data.message_notify - Trạng thái hệ thống với bản tin (vd 'Successfully inserted data to DATA LAKE') | |
| signature |
0..1 | string | signature (response) - Chữ ký RSASHA256 của Trục BYT | |
| authLogin |
0..1 | BackboneElement | Xác thực tài khoản liên thông (POST /api/auth/login) — INFORMATIVE, TRANSPORT-ONLY: username/password/token là thông tin phiên truyền tải, TUYỆT ĐỐI không persist vào FHIR store/clinical Bundle/log; quản lý trong lớp IAM của hệ thống gửi | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| username |
1..1 | string | username - Tên đăng nhập tài khoản liên thông do Trục dữ liệu BYT cấp | |
| password |
1..1 | string | password - Mật khẩu | |
| token |
0..1 | string | data.token - Token gọi API nghiệp vụ (response) | |
| refreshToken |
0..1 | string | data.refresh_token - Cấp lại token khi hết hiệu lực | |
| duration |
0..1 | string | data.duration - Thời gian hiệu lực token, đơn vị giây (VĂN BẢN GỐC kiểu Long) | |
| role |
0..1 | string | data.role - Phân quyền: facility (Cơ sở KCB) | doh (Sở Y tế) | |
| resCode |
0..1 | string | header.res_code - CM_SUCCESS | CM_AUTH_ACCOUNT_FAIL | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
