药物管理

药物分类列表: /medicationCategories GET

请求参数

参数名	示列值	类型	必须	说明
page	1	number	否	当前页数
pageSize	10	number	否	每页条数
name	分类 1	string	否	分类名
sort	-createdAt	string	否	排序。多个排序字段用,号隔开。sort=-a,b
expand	''	string	否	获取指定子资源数据 ''
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数

参数名	示列值	说明
page	1	当前页数
pageSize	10	每页条数
limit	10	同 pageSize
offset	2	起始条数
total	3231	符合条件的总数量
items	[{ "id": 4, "name": "test2"]	返回数据项

• items： 药物分类信息

参数名	示列值	类型	说明
id	1	number	id
name	分类 1	string	分类名
status	0	number	状态 0=禁用 1=启用
parentId	0	number	父类 id
medicationCount	0	number	分类下药物数量
createdAt	1650160322	number	创建时间
updatedAt	1650160322	number	更新时间

返回示列

HTTP/1.1 200 OK
{
    "items": [
      {
        "id": 1,
        "name": "分类1",
        "parentId": 0,
        "medicationCount": 1,
        "status": 1,
        "createdAt": 1647846587,
        "updatedAt": 1647846587,
    }],
    "total": 4070,
    "offset": 1,
    "limit": 2,
    "page": 1,
    "pageSize": 2
  }

新建药物分类: /medicationCategories POST

请求参数

参数名	示列值	类型	必须	说明
name	demo	string	是	名称

返回结果: 药物分类信息

编辑药物分类: /medicationCategories/:id PUT

请求参数

参数名	示列值	类型	必须	说明
name	demo	string	是	名称

返回结果: 药物分类信息

药物分类详情: /medicationCategories/:id GET

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	组织 id
expand	''	string	否	获取指定子资源数据 ''
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段

返回结果: 药物分类信息

删除药物分类: /medicationCategories/:id DELETE

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	资源 id

返回示列

HTTP/1.1 204 NO CONTENT

所有药物分类: /listAll/medicationCategories GET

请求参数

参数名	示列值	类型	必须	说明
name	分类 1	string	否	分类名
expand	''	string	否	获取指定子资源数据 ''
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 药物分类信息

返回示列

HTTP/1.1 200 OK
[
  {}
]

适应症列表: /medicationTags GET

请求参数

参数名	示列值	类型	必须	说明
page	1	number	否	当前页数
pageSize	10	number	否	每页条数
name	头晕	number	否	名称
sort	-createdAt	number	否	排序。多个排序字段用,号隔开。sort=-a,b
expand	''	string	否	获取指定子资源数据 ''
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数

参数名	示列值	说明
page	1	当前页数
pageSize	10	每页条数
limit	10	同 pageSize
offset	2	起始条数
total	3231	符合条件的总数量
items	[{ "id": 4, "name": "test2"]	返回数据项

• items： 适用证信息

参数名	示列值	类型	说明
id	1	number	id
name	头晕	string	名称
parentId	0	number	父类 id
medicationCount	0	number	适应症下药物数量
status	0	number	状态 0=禁用 1=启用
createdAt	1650160322	number	创建时间
updatedAt	1650160322	number	更新时间

返回示列

HTTP/1.1 200 OK
{
    "items": [
      {
        "id": 1,
        "name": "头晕",
        "parentId": 0,
        "status": 1,
        "medicationCount": 1,
        "createdAt": 1647846587,
        "updatedAt": 1647846587,
    }],
    "total": 4070,
    "offset": 1,
    "limit": 2,
    "page": 1,
    "pageSize": 2
  }

新建适应症: /medicationTags POST

请求参数

参数名	示列值	类型	必须	说明
name	demo	string	是	名称

返回结果: 适应症信息

编辑适应症: /medicationTags/:id PUT

请求参数

参数名	示列值	类型	必须	说明
name	demo	string	是	名称

返回结果: 适应症信息

适应症详情: /medicationTags/:id GET

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	组织 id
expand	''	string	否	获取指定子资源数据 ''
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段

返回结果: 适应症信息

删除适应症: /medicationTags/:id DELETE

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	资源 id

返回示列

HTTP/1.1 204 NO CONTENT

所有适应症: /listAll/medicationTags GET

请求参数

参数名	示列值	类型	必须	说明	默认值
name	头晕	number	否	名称
expand	''	string	否	获取指定子资源数据 ''
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 适应症信息

返回示列

HTTP/1.1 200 OK
[
  {}
]

药物列表: /medications GET

请求参数

参数名	示列值	类型	必须	说明
page	1	number	否	当前页数
pageSize	10	number	否	每页条数
code	0000xxx	string	否	药物编码
generic	药物 1	string	否	药物通用名
tradeName	''	string	否	药物商品名
categoryId	1	number	否	药物分类 id
medicationTagIds	[1,2]	array	否	适应症 id 数组
sort	-createdAt	number	否	排序。多个排序字段用,号隔开。sort=-a,b
expand	organization	string	否	获取指定子资源数据 ['organization,medicationCategory,medicationTags,libraryItems,medicationSideEffectMap.sideEffects']
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回参数

参数名	示列值	说明
page	1	当前页数
pageSize	10	每页条数
limit	10	同 pageSize
offset	2	起始条数
total	3231	符合条件的总数量
items	[{ "id": 4, "name": "test2"]	返回数据项

• items： 药物信息

参数名	示列值	类型	说明
id	1	number	id
organizationId	1	number	数据来源, 机构 id, 默认 0: 速眠中心
categoryId	1	number	药品分类 id
code	''	string	药物编码
generic	''	string	药物通用名
tradeName	''	string	药物商品名
tradeNamePinyin	''	string	商品名拼音
tradeNameEn	''	string	商品名英文
description	''	string	药物说明
character	tablet	string	性状，tablet: 片剂，capsule: 胶囊
spec	100	number	规格，实际数值乘以 100 来存储，单位为 mg/片 或 mg/颗，结合 character 使用
status	0	number	状态 0=禁用 1=启用
organizations	[{"id": 1, "name": "demo" }]	object	来源组织信息
medicationCategory	{ "id": 1, "name": "分组 1" }	object	药物分类信息
medicationTags	[{id: 1, name: "头晕"}]	array	适应症数组
libraryItems	[{id: 1, organization: {id:2, name: '组织名称'}}]	array	入库数组
medicationSideEffectMap	{ id: 1, name: '药物通用名', sideEffectIds: [], sideEffects: [{id: 1, name: '头晕'}]}	object	药物副作用信息
createdAt	1650160322	number	创建时间
updatedAt	1650160322	number	更新时间

返回示列

HTTP/1.1 200 OK
{
    "items": [
      {
        "id": 1,
        "organizationId": 1,
        "categoryId": 1,
        "code": "1",
        "generic": "",
        "tradeName": "video",
        "tradeNamePinyin": "",
        "tradeNameEn":'',
        "description": '',
        "character": '',
        "spec": 100,
        "medicationCategory": {
            "name": "分类1"
        },
        "medicationTags": [{
            "name": "头晕"
        }],
        "medicationSideEffectMap": {
          "id": 1,
            "name": "药物通用名",
            "sideEffects": [{
                "name": "头晕"
            }],
        },
        "status": 1,
        "organizationId": 1,
        "organization": { // 来源组织信息
            "name": "",
        },
        "createdAt": 1647846587,
        "updatedAt": 1647846587,
    }],
    "total": 4070,
    "offset": 1,
    "limit": 2,
    "page": 1,
    "pageSize": 2
  }

新建药物: /medications POST

请求参数

参数名	示列值	类型	必须	说明
categoryId	1	number	Y	药品分类 id
code	''	string	Y	药物编码
generic	''	string	Y	药物通用名
tradeName	''	string	N	药物商品名
tradeNameEn	''	string	N	商品名英文
description	''	string	N	药物说明
character	tablet	string	Y	性状，tablet: 片剂，capsule: 胶囊
spec	100	number	Y	规格，实际数值乘以 100 来存储，单位为 mg/片 或 mg/颗，结合 character 使用
tagIds	[1,2]	array	Y	适应症 id 数组

返回结果: 药物信息

编辑药物: /medications/:id PUT

请求参数

参数名	示列值	类型	必须	说明
categoryId	1	number	Y	药品分类 id
code	''	string	Y	药物编码
generic	''	string	Y	药物通用名
tradeName	''	string	N	药物商品名
tradeNameEn	''	string	N	商品名英文
description	''	string	N	药物说明
character	tablet	string	Y	性状，tablet: 片剂，capsule: 胶囊
spec	100	number	Y	规格，实际数值乘以 100 来存储，单位为 mg/片 或 mg/颗，结合 character 使用
tagIds	[1,2]	array	Y	适应症 id 数组

返回结果: 药物信息

药物详情: /medications/:id GET

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	组织 id
expand	medicationCategory	string	否	获取指定子资源数据 'organization,medicationCategory,medicationTags'
attributes	["id", "name"]	array	否	本资源的字段。不定义该字段时返回所有字段

返回结果: 药物信息

删除药物: /medias/:id DELETE

请求参数

参数名	示列值	类型	必须	说明
id	1	number	是	资源 id

返回示列

HTTP/1.1 204 NO CONTENT

所有药物: /listAll/medias GET

请求参数

参数名	示列值	类型	必须	说明	默认值
code	0000xxx	string	否	药物编码
generic	药物 1	string	否	药物通用名
tradeName	''	string	否	药物商品名
categoryId	1	number	否	药物分类 id
tagIds	[1,2]	array	否	适应症 id 数组
expand	organization	string	否	获取指定子资源数据 ['organization,medicationCategory,medicationTags']
attributes	"id,name"	string	否	本资源的字段。不定义该字段时返回所有字段；空数组不返回字段

返回结果: 药物信息

返回示列

HTTP/1.1 200 OK
[
  {}
]

药物入库: librarySetting/medications POST

请求参数

参数名	示列值	类型	必须	说明
ids	[1]	array	Y	资源 id 数组
orgIds	[1,2]	array	Y	组织 id 数组
bulk	true	boolean		是否是批量入库(true:是)

返回示列

HTTP/1.1 200

药物导入: /importExcel/medications POST

请求参数

参数名	示列值	类型	必须	说明
fileUrl	https://bs-develop-share.oss-cn-shenzhen.aliyuncs.com/%EF%6%9D%BF.xls	string	是	文件地址

返回参数

参数名	示列值	说明
data	[{id: 1, name: "123"}]	导入成功数据
errData	[{index: "序号", message: "说明"}]	错误数据

返回示列

HTTP/1.1 200 OK
{
    "data": [],
    "errData": [
      {
        "index": 2,
        "message": "暂无当前分类"
      },
    ]
  }