Quyết định 522/QĐ-TTYQG ngày 18/12/2025 Tài liệu kỹ thuật đặc tả API Hệ thống cơ sở dữ liệu về dược” phiên bản 10

Nơi nhận:
- Như Điều 4;
 - Bộ trưởng (để báo cáo);
 - Các đồng chí Thứ trưởng (để báo cáo);
- Cục Khoa học công nghệ và Đào tạo;
- Cục Quản lý Dược;
- Sở Y tế các tỉnh, thành phố trực thuộc Trung ương;
- Công Thông tin điện tử Bộ y tế;
 - Các đơn vị tại Điều 2(để thực hiện);
 - Lưu: VT.

GIÁM ĐỐC




 Đỗ Trường Duy

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

access^_token

string

JWT Token được sử dụng để gọi các API nghiệp vụ

2

token^_type

string

Loại token. Mặc định là: “Bearer”

3

expires^_in

integer

Thời gian hiệu lực của access^_token (giây).

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token

nhận được từ các API xác thực

TT

Thuộc tính

Kiểu dữ liệu

Bắt buộc

Mô tả

1

page

integer

Số trang cần lấy (mặc định là 1)

2

page^_size

integer

Số bản ghi trên mỗi trang (mặc định là 20, tối đa 50)

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

page

integer

Số trang dữ liệu

2

total

integer

Tổng số bản ghi

3

data

array

Danh sách các hoạt chất

3.1

id

string

Mã hoạt chất

3.2

name

string

Tên hoạt chất

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Thuộc tính

Kiểu dữ liệu

Bắt buộc

Mô tả

1

page

integer

Số trang cần lấy (mặc định là 1)

2

page^_size

integer

Số bản ghi trên mỗi trang (mặc định là 20, tối đa 50)

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Thuộc tính

Kiểu dữ liệu

Bắt buộc

Mô tả

1

page

integer

Số trang cần lấy (mặc định là 1)

2

page^_size

integer

Số bản ghi trên mỗi trang (mặc định là 20, tối đa 50)

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

page

integer

Số trang dữ liệu

2

total

integer

Tổng số bản ghi

3

data

array

Danh sách các đơn vị tính

3.1

id

string

Mã quốc gia (ISO-3166)

3.2

name

string

Tên quốc gia

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Thuộc tính

Kiểu dữ liệu

Bắt buộc

Mô tả

1

page

integer

Số trang cần lấy (mặc định là 1)

2

page^_size

integer

Số bản ghi trên mỗi trang (mặc định là 20, tối đa 50)

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

page

integer

Số trang dữ liệu

2

total

integer

Tổng số bản ghi

3

data

array

Danh sách nhóm thuốc

3.1

id

string

Mã nhóm thuốc

3.2

name

string

Tên nhóm thuốc

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Thuộc tính

Kiểu dữ liệu

Bắt buộc

Mô tả

1

page

integer

Số trang cần lấy (mặc định là 1)

2

page^_size

integer

Số bản ghi trên mỗi trang (mặc định là 20, tối đa 50)

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

page

integer

Số trang dữ liệu

2

total

integer

Tổng số bản ghi

3

data

array

Danh sách các đơn vị tính

3.1

id

string

Mã đường dùng

3.2

name

string

Tên đường dùng

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Thuộc tính

Kiểu dữ liệu

Bắt buộc

Mô tả

1

page

integer

Số trang cần lấy (mặc định là 1)

2

page^_size

integer

Số bản ghi trên mỗi trang (mặc định là 20, tối đa 50)

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

page

integer

Số trang dữ liệu

2

total

integer

Tổng số bản ghi

3

data

array

Danh sách các đơn vị tính

3.1

id

string

Mã nhà sản xuất

3.2

name

string

Tên nhà sản xuất

3.3

country^_id

string

Mã quốc gia

3.4

province^_id

string

Địa chỉ của nhà sản xuất - Mã tỉnh/thành phố

3.5

commune^_id

string

Địa chỉ của nhà sản xuất - Mã xã/phường

3.6

street

string

Địa chỉ của nhà sản xuất - Số nhà, tên đường, ....

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Thuộc tính

Kiểu dữ liệu

Bắt buộc

Mô tả

1

page

integer

Số trang cần lấy (mặc định là 1)

2

page^_size

integer

Số bản ghi trên mỗi trang (mặc định là 20, tối đa 50)

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

page

integer

Số trang dữ liệu

2

total

integer

Tổng số bản ghi

3

data

array

Danh sách Tỉnh/Thành phố

3.1

id

string

Mã tỉnh/thành phố

3.2

name

string

Tên tỉnh/thành phố

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Thuộc tính

Kiểu dữ liệu

Bắt buộc

Mô tả

1

page

integer

Số trang cần lấy (mặc định là 1)

2

page^_size

integer

Số bản ghi trên mỗi trang (mặc định là 20, tối đa 50)

3

province^_id

string

Mã tỉnh/thành phố

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

page

integer

Số trang dữ liệu

2

total

integer

Tổng số bản ghi

3

data

array

Danh sách Xã/Phường

3.1

id

string

Mã Xã/Phường

3.2

name

string

Tên Xã/Phường

3.3

province^_id

string

Mã Tỉnh/Thành phố

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Thuộc tính

Kiểu dữ liệu

Bắt buộc

Mô tả

1

page

integer

Số trang cần lấy (mặc định là 1)

2

page^_size

integer

Số bản ghi trên mỗi trang (mặc định là 20, tối đa 50)

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

page

integer

Số trang dữ liệu

2

total

integer

Tổng số bản ghi

3

data

array

Danh sách các thuốc

3.1

id

string

Mã định danh thuốc

3.2

name

string

Tên thuốc

3.3

drug^_group^_id

string

Mã nhóm thuốc

3.4

registration^_number

string

Số giấy phép lưu hành

3.5

active^_ingredient^_list

array

Danh sách các hoạt chất

3.5.1

active^_ingredient^_list[].id

string

Mã hoạt chất

3.5.2

active^_ingredient^_list[].name

string

Tên hoạt chất

3.5.3

active^_ingredient^_list[].is^_main^_active^_ingre dient

boolean

Cho biết hoạt chất có phải là hoạt chất chính không. Các giá trị:

- true: Đây là hoạt chất chính 

- false: Không phải là hoạt chất chính

3.6

strength

string

Hàm lượng

3.7

route^_id

string

Mã đường dùng

3.8

prescription^_status

integer

Phân loại thuốc kê đơn. Chi tiết tại mục 6.4.4.

3.9

special^_control^_type

integer

Phân loại thuốc kiểm soát đặc biệt. Chi tiết tại mục 6.4.5.

3.10

packagings

array

Các quy cách đóng gói của thuốc

3.10.1

packagings[].unit^_id

string

Mã đơn vị tính

3.10.2

packagings[].unit^_name

string

Tên đơn vị tính

3.10.3

packagings[].conversion^_rate^_to^_base

integer

Tỷ lệ quy đổi so với đơn vị tính cơ bản

3.10.4

packagings[].gtin

string

Mã GTIN tương ứng với cấp độ đóng gói

3.10.5

packagings[].is^_basic^_unit

boolean

Cho biết đây có phải đơn vị tính cơ bản không. 

- true: Đơn vị tính cơ bản 

- false : Không phải đơn vị tính cơ bản.

3.11

manufacturer

object

Thông tin nhà sản xuất

3.11.1

manufacturer.id

string

Mã nhà sản xuất

3.11.2

manufacturer.name

string

Tên nhà sản xuất

3.11.3

manufacturer.country

string

Mã quốc gia sản xuất

3.12

approval^_date

date

Ngày cấp số giấy phép lưu hành.

3.13

expiry^_date

date

Ngày hết hiệu lực lưu hành.

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Tên trường

Kiểu dữ liệu

Mô tả

1

id

string

Mã định danh thuốc

2

name

string

Tên thuốc

3

registration^_number

string

Số giấy phép lưu hành

4

drug^_group^_id

string

Mã nhóm thuốc

5

active^_ingredient^_list

array

Danh sách các hoạt chất

5.1

active^_ingredient^_list[].id

string

Mã hoạt chất

5.2

active^_ingredient^_list[].name

string

Tên hoạt chất

5.3

active^_ingredient^_list[].is^_main^_active^_ingredient

boolean

Cho biết hoạt chất có phải là hoạt chất chính không. Các giá trị:

- true: Đây là hoạt chất chính

- false: Không phải là hoạt chất chính

6

strength

string

Hàm lượng

7

route^_id

string

Mã đường dùng

8

prescription^_status

integer

Phân loại thuốc kê đơn. Chi tiết tại mục 6.4.4.

9

special^_control^_type

integer

Phân loại thuốc kiểm soát đặc biệt. Chi tiết tại mục 6.4.5.

10

packagings

array

Các quy cách đóng gói của thuốc

10.1

packagings[].unit^_id

string

Mã đơn vị tính

10.2

packagings[].unit^_name

string

Tên đơn vị tính

10.3

packagings[].quantity

integer

Số lượng quy đổi so với đơn vị tính cơ bản

10.4

packagings[].gtin

string

Mã GTIN tương ứng với cấp độ đóng gói

10.5

packagings[].is^_basic^_unit

boolean

Cho biết đây có phải đơn vị tính cơ bản không. Các giá trị:

- true: Đơn vị tính cơ bản

- false : Không phải đơn vị tính cơ bản.

11

manufacturer

object

Nhà sản xuất

11.1

manufacturer.id

string

Mã nhà sản xuất

11.2

manufacturer.name

string

Tên nhà sản xuất

11.3

manufacturer.country

string

Mã quốc gia sản xuất

12

approval^_date

date

Ngày cấp số giấy phép lưu hành.

13

expiry^_date

date

Ngày hết hiệu lực lưu hành.

TT

Thuộc tính

Bắt buộc

Giá trị

Mô tả

1

Content-Type

x

application/json

2

Authorization

x

Bearer {access^_token}

access^_token nhận được từ các API xác thực

TT

Tên trường

Kiểu dữ liệu

Độ dài tối đa

Bắt buộc

Mô tả

1

transaction^_date

datetime

x

Ngày/giờ nhập kho.

2

reason

string

20

x

Lý do nhập/Loại phiếu nhập kho. Chi tiết tại Mục 6.4.1.

3

supplier^_id

string

50

Mã định danh nhà cung cấp. Nếu reason là “supplier”.

4

source^_store^_id

string

50

Mã định danh chi nhánh xuất kho (nếu cơ sở có chuỗi nhà thuốc) trong trường hợp reason là “transfer-in”

5

source^_warehouse^_id

string

50

Mã kho xuất trong trường hợp reason là “transfer-in”

6

target^_store^_id

string

50

Mã định danh chi nhánh nhập kho (nếu cơ sở có chuỗi nhà thuốc) trong trường hợp reason là “transfer-in”

7

target^_warehouse^_id

string

50

Mã kho nhập trong trường hợp reason là “transfer-in”

8

reference^_number

string

50

x

Số chứng từ nhập kho

9

note

string

500

Ghi chú

10

items

array

x

Danh sách thuốc trong phiếu nhập

10.1

items[].drug^_id

string

20

x

Mã định danh thuốc

10.2

items[].unit^_id

string

20

x

Mã đơn vị tính

10.3

items[].quantity

integer

x