Thông tin tài liệu Liên thông dữ liệu Suy dinh dưỡng giữa hệ thống Y tế cơ sở và hệ thống Cổng dữ liệu Y tế cơ sở V20

Thông tin tài li u Liên thông d li u Suy dinh d Ngày ban hành: Ngày hi u l c: L n ban hành: n v ban hành: ng gi a h th ng Y t c s h th ng C ng d li u Y t c s V20 M cl c API tìm ki m đ i t 1.1 ng suy dinh d ng Mô t 1.2 D li u đ u vào 1.3 D li u tr v API t o đ i t 2.1 ng suy dinh d ng Mô t 2.2 D li u đ u vào 2.3 D li u đ u 10 API c p nh t đ i t 3.1 ng suy dinh d ng 11 Mô t 11 3.2 D li u đ u vào 12 3.3 D li u đ u 14 API xóa đ i t 4.1 ng suy dinh d ng 15 Mô t 15 4.2 D li u đ u vào 15 4.3 D li u đ u 15 API tìm ki m ng 5.1 i ch m sóc 17 Mô t 17 5.2 D li u đ u vào 17 5.3 D li u tr v 17 API thêm m i ng 6.1 i ch m sóc 19 Mô t 19 6.2 D li u đ u vào 20 6.3 D li u đ u 20 API c p nh t thông tin ng 7.1 i ch m sóc 22 Mô t 22 7.2 D li u đ u vào 22 7.3 D li u đ u 23 API xóa thơng tin ng 8.1 i ch m sóc 24 Mô t 24 8.2 D li u đ u vào 24 8.3 D li u đ u 25 API tìm ki m đ a m 26 9.1 Mô t 26 9.2 D li u đ u vào 26 9.3 D li u tr v 27 10 10.1 API t o m i đ a m 28 Mô t 28 10.2 D li u đ u vào 29 10.3 D li u đ u 29 11 11.1 API c p nh t đ a m 31 Mô t 31 11.2 D li u đ u vào 31 11.3 D li u đ u 32 12 12.1 API xóa đ a m 33 Mô t 33 12.2 D li u đ u vào 33 12.3 D li u đ u 34 13 13.1 API tìm ki m l ch s cân đo 35 Mô t 35 13.2 D li u đ u vào 35 13.3 D li u tr v 36 14 14.1 API t o m i l ch s cân đo 38 Mô t 38 14.2 D li u đ u vào 39 14.3 D li u đ u 40 15 15.1 API c p nh t l ch s cân đo 41 Mô t 41 15.2 D li u đ u vào 42 15.3 D li u đ u 44 16 16.1 API xóa l ch s cân đo 45 Mô t 45 16.2 D li u đ u vào 45 16.3 D li u đ u 45 17.API đ ng nh p l y phiên làm vi c 47 17.1 Mô t 47 17.2 D li u đ u vào 47 17.3 D li u tr v 48 API tìm ki m đ i t 1.1 Mơ t ng suy dinh d ng Request URL {{url_realtime}}/api/sdd-doi-tuongs-search Request Method GET Request Header Content-Type: application/json Authorization: bearer {token} Ghi chú: token l y đ c hàm đ ng nh p Body data 1.2 D li u đ u vào Tên tr ng Ki u d li u Kích th c t i đa B t bu c Ghi PAGE_SIZE (là s nguyên d ng l n h n ho c b ng 1) PAGE_NUMBER number (là s nguyên d ng, nh h n ho c b ng 50) PAGE_SIZE S x PAGE_NUMBER S x MA_DOI_TUONG Chu i 20 Mã đ i t HO_TEN 40 H tên H kh u - Mã huy n- l y theo danh m c đ n v hành VN (TCTK ban hành) H kh u – mã Xã- l y theo danh m c đ n v hành VN (TCTK ban hành) Chu i ng HK_MA_TINH HK_MA_HUYEN S HK_MA_XA S TT_MA_TINH T m trú - Mã T nh - l y theo danh m c đ n v hành VN (TCTK ban hành) T m trú – Mã Huy n - l y theo danh m c đ n v hành VN (TCTK ban hành) T m trú – Mã Xã - l y theo danh m c đ n v hành VN (TCTK ban hành) Mã dân t c S TT_MA_HUYEN S TT_MA_XA S MA_DAN_TOC S 1.3 D li u tr v - Tr ng h p l i: Tr ng Header status:500 Header status:401 K t qu - Serivice b l i y đ thông tin nh ng token g i lên không đ nh d ng l y t api getToken Khơng có quy n truy c p vào h th ng v i user sau l y token t api getToken Tr v m t object bao g m thu c tính sau: { "error": "invalid_token", "error_description": "Cannot convert access token to JSON" } Header status: 404 { "STATUS": 404, "DATA": 0, "ERROR": "Không tìm th y d li u phù h p." } - Tr ng h p thành công: H th ng tr v : Tr ng K t qu Header status 200 Header ContentType application/json; charset=UTF-8 Jstringson data Tr v m t object bao g m thu c tính sau: { "code": "200", "data": [ { "SERIAL_VERSION_UID": interger, "TRANSACTION_ID": "string", "LT_DOITUONG_ID": interger, "MA_DINH_DANH": "string", "MA_DOI_TUONG": "string", "HO_TEN": "string", "NGAY_SINH": "string", "GIOI_TINH": interger, "SO_DIEN_THOAI": "string", "CMND": "string", "HK_DIA_CHI": "string", "TT_DIA_CHI": "string", "MA_HGD": "string", "LIEN_THONG": interger, "LUOT_LIEN_THONG": interger, "HK_MA_TINH": "string", "HK_MA_HUYEN": "string", "HK_MA_XA": "string", "TT_MA_TINH": "string", "TT_MA_HUYEN": "string", "TT_MA_XA": "string", "MA_DAN_TOC": "string" } ], "message": "string" } API t o đ i t 2.1 Mô t ng suy dinh d ng Request URL {{url}}/api/receive/suydinhduong/sdd_doi_tuong_c Request Method POST Request Header Content-Type: application/json Authorization: bearer {token} Ghi chú: token l y đ Request data c hàm đ ng nh p { "MA_DOI_TUONG": "string", "CMND": "string", "GIOI_TINH": interger, "HK_DIA_CHI": "string", "HO_TEN": "string", "LIEN_THONG": interger, "LT_DOITUONG_ID": interger, "LUOT_LIEN_THONG": interger, "MA_DINH_DANH": "string", "MA_HGD": "string", "NGAY_SINH": "string", "SO_DIEN_THOAI": "string", "TRANSACTION_ID": "string", "TT_DIA_CHI": "string", "HK_MA_HUYEN": "string", "HK_MA_TINH": "string", "HK_MA_XA": "string", "MA_DAN_TOC": "string", "TT_MA_HUYEN": "string", "TT_MA_TINH": "string", “TT_MA_XA”: “string” } 2.2 D li u đ u vào Tên tr ng Ki u d li u Kích th c t i đa B t bu c x MA_DOI_TUONG Chu i 20 CMND Chu i 20 GIOI_TINH Ghi Mã đ i t ng S ch ng minh nhân dân x S Gi i tính; Mã hóa (1: Nam; 2: N ; 3: Ch a xác đ nh) HK_DIA_CHI Chu i 255 HO_TEN Chu i 40 x H tên MA_DINH_DANH Chu i 13 x Mã đ nh danh MA_HGD Chu i 10 x Mã h gia đình 12 x Ví d : ngày 31/03/2020 15:20 đ c hi n th là: 20203311520 NGAY_SINH Chu i H kh u - a ch chi ti t SO_DIEN_THOAI Chu i 20 S n tho i TT_DIA_CHI Chu i 255 T m trú - a ch chi ti t HK_MA_TINH x H kh u - Mã huy n- l y theo danh m c đ n v hành VN (TCTK ban hành) x H kh u – mã Xã- l y theo danh m c đ n v hành VN (TCTK ban hành) 255 x H kh u - x Mã dân t c S HK_MA_HUYEN S HK_MA_XA Chu i MA_DAN_TOC S TT_MA_TINH T m trú - Mã T nh - l y theo danh m c đ n v hành VN (TCTK ban hành) T m trú – Mã Huy n - l y theo danh m c đ n v hành VN (TCTK ban hành) T m trú – Mã Xã - l y theo danh m c đ n v hành VN (TCTK ban hành) S TT_MA_HUYEN S TT_MA_XA a ch chi ti t S 2.3 D li u đ u Tr ng h p l i: Tr Header status:500 Header status:401 ng K t qu - Serivice b l i y đ thông tin nh ng token g i lên không đ nh d ng l y t api getToken Khơng có quy n truy c p vào h th ng v i user sau l y token t api getToken { "errorCode": "success", "errorMessage": integer, "result": "string" } 13 API tìm ki m l ch s cân đo 13.1 Mô t Request URL {{url_realtime}}/api/sdd-ls-can-dos-search? Request Method GET Request Header Content-Type: application/json Authorization: bearer {token} Ghi chú: token l y đ c hàm đ ng nh p Body data 13.2 D li u đ u vào Tên tr ng Ki u d li u Kích th c t i đa B t bu c Ghi PAGE_SIZE (là s nguyên d ng l n h n ho c b ng 1) PAGE_NUMBER number (là s nguyên d ng, nh h n ho c b ng 50) PAGE_SIZE S x PAGE_NUMBER S x LICH_SU_CAN_DO_ID S 20 Mã l ch s cân đo c a đ i t ng MA_DOI_TUONG S NGAY_CAN Chu i MA_DIA_DIEM Chu i TRANG_THAI 20 Mã đ i t 'Ngày cân đo dd/MM/yyyy' 10 Mã đ a m Tr ng thái 0: ch a th c hi n 1: th c hi n Bú m 1.Có Khơng Ph c h i dinh dũng 1.Có Không Theo dõi suy dinh d ng 1.Hàng tháng 2 tháng/ l n 3 tháng/ l n tháng/ l n tháng/ l n S BU_ME S PHUC_HOI_DD S THEO_DOI S ng nh d ng: 13.3 D li u tr v - Tr ng h p l i: Tr Header status:500 Header status:401 ng K t qu - Serivice b l i y đ thông tin nh ng token g i lên không đ nh d ng l y t api getToken Khơng có quy n truy c p vào h th ng v i user sau l y token t api getToken Tr v m t object bao g m thu c tính sau: { "error": "invalid_token", "error_description": "Cannot convert access token to JSON" } Header status: 404 { "STATUS": 404, "DATA": 0, "ERROR": "Không tìm th y d li u phù h p." } - Tr ng h p thành công: H th ng tr v : Tr ng K t qu Header status 200 Header ContentType application/json; charset=UTF-8 Json data Tr v m t object bao g m thu c tính sau: [ { "SERIAL_VERSION_UID": interger, "TRANSACTION_ID": "string", "LS_CAN_DO": interger, "LICH_SU_CAN_DO_ID": "string", "CAN_NANG": interger, "DON_VI_CAN_NANG": interger, "CHIEU_CAO": interger, "DON_VI_CHIEU_CAO": interger, "NGAY_CAN": "string", "TRANG_THAI": interger, "BU_ME": interger, "PHUC_HOI_DD": interger, "THEO_DOI": interger, "CHI_TIET_THEO_DOI": "string", "KET_LUAN": "string", "GHI_CHU": "string", "LIEN_THONG": interger, "LUOT_LIEN_THONG": interger, "MA_DOI_TUONG": "string", "MA_DIA_DIEM": "string" } ] 14 API t o m i l ch s cân đo 14.1 Mô t Request URL {{url}}/api/receive/suydinhduong/sdd_dia_diem_c Request Method POST Request Header Content-Type: application/json Authorization: bearer {token} Ghi chú: token l y đ Request data c hàm đ ng nh p { "LICH_SU_CAN_DO_ID": "string", "BU_ME": interger, "CAN_NANG": interger, "CHI_TIET_THEO_DOI": "string", "CHIEU_CAO": interger, "DON_VI_CAN_NANG": interger, "DON_VI_CHIEU_CAO": interger, "GHI_CHU": "string", "KET_LUAN": "string", "LIEN_THONG": interger, "LS_CAN_DO": interger, "LUOT_LIEN_THONG": interger, "NGAY_CAN": "string", "PHUC_HOI_DD": interger, "THEO_DOI": interger, "TRANG_THAI": interger, "TRANSACTION_ID": "string", "MA_DIA_DIEM": "string", "MA_DOI_TUONG": "string" } 14.2 D li u đ u vào Tên tr ng LICH_SU_CAN_DO_ID MA_DOI_TUONG Ki u d li u S S BU_ME Kích th c t i đa B t bu c 20 X Mã l ch s cân đo c a đ i t ng 20 x Mã đ i t x Bú m Ghi ng 1.Có S Khơng CAN_NANG s CHI_TIET_THEO_DOI Chu i CHIEU_CAO S DON_VI_CAN_NANG S x 1000 Cân n ng Thông tin chi ti t theo dõi suy dinh d ng x x Chi u cao n v cân n ng Gram Kilogram DON_VI_CHIEU_CAO x S n v chi u cao cm m GHI_CHU Chu i 1000 Ghi KET_LUAN Chu i 1000 K t lu n LS_CAN_DO Chu i x L n cân đo x 'Ngày cân đo dd/MM/yyyy' x x x 10 x Ph c h i dinh dũng 1.Có Khơng Theo dõi suy dinh d ng 1.Hàng tháng 2 tháng/ l n 3 tháng/ l n tháng/ l n tháng/ l n Tr ng thái 0: ch a th c hi n 1: th c hi n Mã đ a m NGAY_CAN Chu i PHUC_HOI_DD S THEO_DOI S TRANG_THAI S MA_DIA_DIEM Chu i nh d ng: 14.3 D li u đ u Tr ng h p l i: Tr Header status:500 Header status:401 ng K t qu - Serivice b l i y đ thông tin nh ng token g i lên không đ nh d ng l y t api getToken Khơng có quy n truy c p vào h th ng v i user sau l y token t api getToken Tr v m t object bao g m thu c tính sau: { "error": "invalid_token", "error_description": "Cannot convert access token to JSON" } Header status: 404 { "STATUS": 404, "DATA": 0, "ERROR": "Không tìm th y d li u phù h p." } - Tr ng h p thành công: H th ng tr v : Tr ng K t qu Header status 200 Header ContentType application/json; charset=UTF-8 Json data Tr v m t object bao g m thu c tính sau: { "errorCode": "success", "errorMessage": integer, "result": "string" } 15 API c p nh t l ch s cân đo 15.1 Mô t Request URL {{url}}/api/receive/suydinhduong/sdd_dia_diem_u Request Method POST Request Header Content-Type: application/json Authorization: bearer {token} Ghi chú: token l y đ Request data c hàm đ ng nh p { "LICH_SU_CAN_DO_ID": "string", "BU_ME": interger, "CAN_NANG": interger, "CHI_TIET_THEO_DOI": "string", "CHIEU_CAO": interger, "DON_VI_CAN_NANG": interger, "DON_VI_CHIEU_CAO": interger, "GHI_CHU": "string", "KET_LUAN": "string", "LIEN_THONG": interger, "LS_CAN_DO": interger, "LUOT_LIEN_THONG": interger, "NGAY_CAN": "string", "PHUC_HOI_DD": interger, "THEO_DOI": interger, "TRANG_THAI": interger, "TRANSACTION_ID": "string", "MA_DIA_DIEM": "string", "MA_DOI_TUONG": "string" } 15.2 D li u đ u vào Tên tr ng LICH_SU_CAN_DO_ID Ki u d li u S Kích th c t i đa B t bu c 20 X Ghi Mã l ch s cân đo c a đ i t ng MA_DOI_TUONG S BU_ME 20 x Mã đ i t x Bú m ng 1.Có S Không CAN_NANG s CHI_TIET_THEO_DOI Chu i CHIEU_CAO S DON_VI_CAN_NANG S DON_VI_CHIEU_CAO x 1000 Cân n ng Thông tin chi ti t theo dõi suy dinh d ng x x x S Chi u cao n v cân n ng Gram Kilogram n v chi u cao cm m GHI_CHU Chu i 1000 Ghi KET_LUAN Chu i 1000 K t lu n LS_CAN_DO Chu i x L n cân đo x 'Ngày cân đo dd/MM/yyyy' x x x Ph c h i dinh dũng 1.Có Không Theo dõi suy dinh d ng 1.Hàng tháng 2 tháng/ l n 3 tháng/ l n tháng/ l n tháng/ l n Tr ng thái 0: ch a th c hi n NGAY_CAN Chu i PHUC_HOI_DD S THEO_DOI S TRANG_THAI S nh d ng: MA_DIA_DIEM Chu i 10 x 1: th c hi n Mã đ a m 15.3 D li u đ u Tr ng h p l i: Tr ng Header status:500 K t qu - Serivice b l i y đ thông tin nh ng token g i lên không đ nh d ng l y t api getToken Header status:401 Khơng có quy n truy c p vào h th ng v i user sau l y token t api getToken Tr v m t object bao g m thu c tính sau: { "error": "invalid_token", "error_description": "Cannot convert access token to JSON" } Header status: 404 { "STATUS": 404, "DATA": 0, "ERROR": "Khơng tìm th y d li u phù h p." } - Tr ng h p thành công: H th ng tr v : Tr ng K t qu Header status 200 Header ContentType application/json; charset=UTF-8 Tr v m t object bao g m thu c tính sau: Json data { "errorCode": "success", "errorMessage": integer, "result": "string" } 16 API xóa l ch s cân đo 16.1 Mô t Request URL {{url}}/api/receive/suydinhduong/sdd_dia_diem_d Request Method POST Request Header Content-Type: application/json Authorization: bearer {token} Ghi chú: token l y đ c hàm đ ng nh p Request data 16.2 D li u đ u vào Tên tr ng LICH_SU_CAN_DO_ID Ki u d li u S Kích th c t i đa B t bu c 20 X 16.3 D li u đ u Tr ng h p l i: Tr ng K t qu Ghi Mã l ch s cân đo c a đ i t ng Header status:500 - Serivice b l i y đ thông tin nh ng token g i lên không đ nh d ng l y t api getToken Header status:401 Khơng có quy n truy c p vào h th ng v i user sau l y token t api getToken Tr v m t object bao g m thu c tính sau: { "error": "invalid_token", "error_description": "Cannot convert access token to JSON" } Header status: 404 { "STATUS": 404, "DATA": 0, "ERROR": "Khơng tìm th y d li u phù h p." } - Tr ng h p thành công: H th ng tr v : Tr ng K t qu Header status 200 Header ContentType application/json; charset=UTF-8 Json data Tr v m t object bao g m thu c tính sau: { "errorCode": "success", "errorMessage": integer, "result": "string" } 17.API đ ng nh p l y phiên làm vi c 17.1 Mô t Request URL {{url_token}}/auth/token Request Method POST Request Header Content-Type: application/json Form data { "username": "Tên đ ng nh p", "password": "M t kh u", "grant_type": "password", "clinic": "Mã CSYT" } Ph n m n qu n lý c a tr m y t xã ph ng th tr n g i yêu c u c p phiên làm vi c lên h th ng C ng tích h p d li u Y t c s V20 H th ng s tr v Token t ng ng v i phiên làm vi c 17.2 D li u đ u vào D li u Tên Field đ u vào Ki u d li u Kích th c t i đa B t bu c Ghi Tên đ ng nh p username Chu i ký t (b t bu c) 50 x Tên đ ng nh p vào h th ng M t kh u password Chu i ký t (b t bu c) 30 x M t kh u tài kho n grant_type Chu i ký t 50 x Mã CSYT Chu i ký t clinic x 17.3 D li u tr v - Tr ng h p l i: Tr ng K t qu Header status:401 Tài kho n b khóa Header status: 201 Sai tên đ ng nh p - Tr ng h p thành công: H th ng tr v : Tr ng K t qu Header status 200 Header ContentType application/json; charset=UTF-8 Json data Tr v m t object bao g m thu c tính sau: { "access_token": “string”, "token_type": “string”, "refresh_token": “string”, "expires_in": integer, "scope": “string”, "iat": integer, "clinic": “string”, L y theo mã đ ng ký n i khám ch a b nh c ac s yt "module": “string”, "jti": “string” }