1. 平台概述
ABC数字医疗云开放平台,是为第三方开发者提供接口服务的官方平台,在得到授权后第三方服务可以通过调用官方接口,或订阅平台事件,实现自定义功能。
注:开放平台仅适用于大客户版本
2. 应用接入指南
2.1. 申请
第三方开发者向平台提出接入申请,提供要访问连锁(或单店)的信息,由平台分配应用Id AppId 和应用密钥 AppSecret,应用通过平台授权接口获取 AccessToken,即可访问权限内的相关接口及数据。如果需要修改应用密钥及权限,请联系平台管理员。
参数 | 类型 | 说明 |
---|---|---|
AppId |
string |
第三方应用的唯一标识 |
AppSecret |
string |
第三方应用的密钥,由平台生成,请妥善保管 |
如有疑问,请扫码加入企业微信群咨询。
2.2. 授权
AccessToken说明:
应用通过分配的 AppId 及 AppSecret 向平台换取AccessToken,然后凭借AccessToken访问接口资源
访问连锁下不同子店的数据,需要不同的AccessToken
有效期7200秒,距离失效五分钟内,才可换取新的token,客户端应对AccessToken进行缓存,在快过期时,再换取新的AccessToken
AccessToken获取方法及参数说明
接口
POST https://open.abcyun.cn/api/v2/auth/token
参数
参数 类型 必填 说明 appId
string
是
应用id
appSecret
string
是
应用密钥
grantType
string
是
值固定为 client_credentials (目前只支持客户端授权模式)
clinicId
string
否
申请获取单店资源访问凭证时可不填,申请获取连锁子店资源访问凭证时必填
响应
参数 类型 说明 accessToken
string
授权方令牌
tokenType
string
bearer
expiresIn
int
令牌有效期:单位秒
expirationTime
long
令牌过期时间戳:秒
请求示例
curl -X POST https://open.abcyun.cn/api/v2/auth/token -H "Content-Type: application/json" -d '{"grantType":"client_credentials", "appId":"2430575937595654143", "appSecret":"91e34219c29401d5af075752b608acb9", "clinicId":"fff730ccc5ee45d783d82a85b8a0e52e"}'
响应示例
{ "data": { "accessToken": "eyJhbGciOiJIUzI1Nix9.eyJzdWIiOiJmZmY3MzBjY2M1ZWU0NWQ3ODNkODJhODViOGEwZTUyZCIsImFwcElkIjoiMjQzMDU3NTkzNzU5NTY1NDE0NCIsImlhdCI6MTY0ODc4MTcyMSwiZXhwIjoxNjQ4Nzg4OTIxfQ.fZ9-78LU_gOMDei2rhVuTZgM_eJxUzwXP0nPeX4tkjQ", "tokenType": "bearer", "expiresIn": 7200, "expirationTime": 1648788921 } }
3. 接口访问
应用对平台接口资源进行访问时,需要在请求Http Header中携带签名(sign)、请求时间戳(ts)、应用Id(appId)、访问凭证(authorization)
HttpHeader参数说明
参数 类型 说明 sign
string
请求签名,签名方式见详细说明
ts
string
当前时间戳,精确到秒,注意平台只接受与北京时间时间差5分钟内的请求,请确保您的应用服务时间同步
appId
string
应用Id
authorization
string
AccessToken
签名sign的计算方法
GET请求:
原始query参数param1=v1,param2=v2…(某参数值为空时,该参数不参与签名计算),加上头部公共参数appId=APP_ID、ts=TS,加上请求路径path=PATH,按key进行字典升序排序,以k=v格式拼成参数字符串s。
s = "appId=APP_ID¶m1=v1¶m2=v2&path=PATH&ts=TS"
举例: "appId=1¶m1=2¶m2=3&path=/api/v2/open-agency/patient&ts=1648713476"
在s末尾追加appSecret=APP_SECRET得到s1。
s1 = "appId=APP_ID¶m1=v1¶m2=v2&path=PATH&ts=TS&appSecret=APP_SECRET"
举例: "appId=1¶m1=2¶m2=3&path=/api/v2/open-agency/patient&ts=1648713476&appSecret=qwer"
对s1进行md5得到sign。
举例: md5("appId=1¶m1=2¶m2=3&path=/api/v2/open-agency/patient&ts=1648713476&appSecret=qwer") = 0357972C991648DD192427C6C9FD3A78
其他请求:
头部公共参数appId=APP_ID、ts=TS,加上请求路径path=PATH,按key进行字典升序排序,并以k=v格式拼成参数字符串s。
s = "appId=APP_ID&path=PATH&ts=TS"
举例: "appId=1&path=/api/v2/open-agency/patient&ts=1648713476"
在s末尾追加appSecret=APP_SECRET得到s1。
s1 = "appId=APP_ID&path=PATH&ts=TS&appSecret=APP_SECRET"
举例: "appId=1&path=/api/v2/open-agency/patient&ts=1648713476&appSecret=qwer"
对s1进行md5得到sign
举例: md5("appId=1&path=/api/v2/open-agency/patient&ts=1648713476&appSecret=qwer") = 5F39A2BFDCC5E5F96FA9514508114551
4. 事件订阅
开放平台支持部分事件订阅,第三方应用可以向平台申请事件订阅,并提供第三方应用接收事件的请求路径URL。
平台通过POST方式向第三方应用进行推送请求,超时时间是 3 秒,失败重试最多为 2 次。
推送接口说明:
请求头部携带签名(sign)、请求时间戳(ts)、应用id(appId)、机构id(clinicId),第三方应用通过sign判断是否是来源于ABC数字医疗云开放平台的合法请求
HttpHeader参数说明
参数 类型 说明 sign
string
请求签名,签名方式与接口访问签名方式一致,但是path参数是完整的url,并且clinicId也参与签名的计算
ts
string
当前时间戳,精确到秒
appId
string
应用Id
clinicId
string
机构Id
推送请求体结构
参数 类型 说明 id
string
事件id
eventName
string
事件名称
eventModule
string
事件模块
eventType
string
事件类型
clinicId
string
机构id
eventData
object
事件数据
callbackCount
int
推送第几次(第一次请求时为1,第一次重试时为2)
推送返回说明
HTTP返回状态码为200时,则表示推送成功。除此之外其它HTTP返回状态码开放平台皆认为失败。当推送失败时,如果返回的Body为application/json类型且存在error或message字段则将字段内容推送至企业微信,此外情况则将Body直接推送至企业微信。
错误内容可支持企业微信Markdown格式,推送内容最长512个字符。
目前平台支持事件订阅的模块有及事件有:
eventName eventModule eventType eventData 说明 收费完成
1
101
收费单完成收费时,向第三方应用进行推送
收费单完成退费
1
102
收费单完成退费时,向第三方应用进行推送
收费单快递信息变更
1
103
收费单快递信息变更时,向第三方应用进行推送
收费单部分退费
1
104
收费单发生部分退费时,向第三方应用进行推送
部分收费
1
105
收费单发生部分收费时,向第三方应用进行推送
部分收费部分退费
1
106
收费单发生部分收费的部分退费时,向第三方应用进行推送
部分收费退费
1
107
收费单发生部分收费的退费时,向第三方应用进行推送
新建收费单
1
108
新建收费单时,向第三方应用进行推送
门诊完成接诊
2
201
门诊处完成接诊,向第三方应用进行推送
就诊单信息变更
2
202
就诊单被修改时,向第三方应用进行推送
预约签到
2
203
预约签到时,向第三方应用进行推送
创建商品
3
301
创建商品时,向第三方应用进行推送
修改商品
3
302
修改商品时,向第三方应用进行推送
删除商品
3
303
删除商品时,向第三方应用进行推送
修正入库单创建
3
306
修改入库单创建时,向第三方应用进行推送
入库完成
3
311
入库完成时,向第三方应用进行推送
出库完成
3
321
出库完成时,向第三方应用进行推送
退货出库申请单创建
3
322
退货出库申请单创建时,向第三方应用进行推送
盘点完成
3
331
盘点完成时,向第三方应用进行推送
调拨完成
3
341
调拨完成时,向第三方应用进行推送
采购单创建
3
350
采购单创建时,向第三方应用进行推送
新增患者
4
401
新增患者时,向第三方应用进行推送
修改患者
4
402
修改患者姓名、生日、手机号、性别、身份证、住址、档案号、职业、公司、来源时,向第三方应用进行推送
患者合并
4
403
患者合并时,向第三方应用推送合并来源及合并后的患者信息
创建发药单
5
500
收到新的发药单时,向第三方应用进行推送
更新发药单
5
501
修改发药单快递/加工/调配/审核等,向第三方应用进行推送
删除发药单
5
502
未发药情况下退费,会删除发药单,向第三方应用进行推送
发药
5
503
在一次发药动作完成时,向第三方应用进行推送
退药
5
504
在一次退药动作完成时,向第三方应用进行推送
创建检查检验单
6
601
在一次创建检查检验单完成时,向第三方应用进行推送
检查检验退费
6
602
在一次检查检验退费完成时,向第三方应用进行推送
检验样本采集
6
603
在检验样本采集时,向第三方应用进行推送
检查检验单更新
6
604
在一次检查检验单更新时,向第三方应用进行推送
挂号单创建
7
701
创建挂号单完成后,向第三方应用进行推送
挂号单更新
7
702
修改挂号单完成后,向第三方应用进行推送
执行
8
801
执行完成后,向第三方应用进行推送
取消执行
8
802
执行取消后,向第三方应用进行推送
推送请求体结构示例
{ "eventModule": 1, "eventType": 102, "eventName": "收费单退费", "clinicId": "机构id", "eventData": { "id": "ffffffff0000000021cf6a50116aa003", "doctor": { "id": "6e45706922a74966ab51e4ed1e604641", "name": "刘喜" }, "status": 2, "charger": { "id": "ffffffff000000000a9f19c805814000", "name": "李强" }, "created": "2022-03-31 07:52:42", "patient": { "id": "ffffffff000000000a9f19c805814000", "age": { "year": 51, "month": 7, "day": 17 }, "sex": "女", "name": "韩梅梅", "idCard": "511681199505224089", "mobile": "19912122121", "birthday": "2020-08-26" }, "receivableFee": 44.4, "receivedFee": 44.4, "refundFee": 0, "refundTime": "2022-03-31 07:52:42", "deliveryInfo": { "deliveryName": "张三", "addressDetail": "双桥小区", "deliveryMobile": "18888888888", "addressCityName": "成都市", "deliveryCompany": "顺丰", "deliveryOrderNo": "asdf1233", "addressDistrictName": "金牛区", "addressProvinceName": "四川省" }, "chargeFormItems": [ { "id": "ffffffff0000000021cf6a50116aa005", "unit": "个", "status": 1, "productId": "ffffffff0000000013f949480c52c000", "unitPrice": 22.2, "totalCount": 1, "productName": "三七", "receivedFee": 22.2 } ], "chargeTransactions": [ { "id": "ffffffff0000000021cf6b10116aa003", "amount": 44.4, "created": "2022-03-31 07:53:07", "isRefunded": 1, "payModeName": "美团" } ] } }
5. 接口列表
5.1. 基础信息接口
5.1.1. 获取科室列表
GET /api/v2/open-agency/clinics/departments
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/departments
HTTP响应示例
响应 200
{
"data" : {
"departmentList" : [ {
"id" : "ffffffff0000000006dddfe002e22000",
"name" : "儿保科室",
"type" : 1,
"mainMedicalName" : "儿科",
"secondMedicalName" : "小儿呼吸"
} ]
}
}
5.1.2. 获取门店信息
GET /api/v2/open-agency/clinics/info
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/info
HTTP响应示例
响应 200
{
"data" : {
"id" : "fff730ccc5ee45d783d82a85b8a0e52d",
"parentId" : "fff730ccc5ee45d783d82a85b8a0e520",
"hisType" : 0,
"name" : "中医诊所高新店",
"phone" : "13888888888",
"category" : "中医诊所",
"provinceName" : "四川省",
"cityName" : "成都市",
"districtName" : "高新区",
"addressDetail" : "高新区100号"
}
}
5.1.3. 获取科室详情
GET /api/v2/open-agency/clinics/departments/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
科室id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/departments/6209a883af8e4178b6f8d5f436cd236d
HTTP响应示例
响应 200
{
"data" : {
"employees" : [ {
"employeeId" : "10a861eb5b4d43b59721301073112029",
"name" : "张三",
"mobile" : "18088888888"
} ],
"id" : "ffffffff0000000006dddfe002e22000",
"principal" : "张三",
"name" : "儿保科室",
"phone" : "18088888888",
"created" : "2019-04-11 10:48:07",
"type" : 1,
"mainMedicalName" : "儿科",
"secondMedicalName" : "小儿呼吸"
}
}
5.1.4. 获取人员详情
GET /api/v2/open-agency/clinics/employees/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
人员id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/employees/07b47b860f9649febc9d907e2ec6f23f
HTTP响应示例
响应 200
{
"data" : {
"id" : "ffffffff0000000017ea20500df64000",
"position" : "string",
"headImgUrl" : "string",
"name" : "张三",
"mobile" : "13888888888",
"sex" : "男",
"birthday" : "1987-04-12",
"role" : "医生",
"introduction" : "毕业于陆军军医大学临床医学七年制",
"nationalDoctorCode" : "string",
"practiceInfos" : [ {
"type" : "04|护理人员",
"title" : "13|主管护师"
} ],
"practiceImgUrl" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/clinic-usage/fff730ccc5ee45d783d82a85b8a0e52d/license/dog_v2vHea4SK8gb.jpeg",
"goodAt" : "擅长中医内科",
"roles" : [ 1, 2, 3 ],
"doctorTags" : "省级名中医、市级名中医"
}
}
5.1.5. 获取门店人员列表
GET /api/v2/open-agency/clinics/employees
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/employees
HTTP响应示例
响应 200
{
"data" : {
"employeeList" : [ {
"id" : "ffffffff0000000017ea20500df64000",
"position" : "string",
"headImgUrl" : "string",
"name" : "张三",
"mobile" : "13888888888",
"sex" : "男",
"birthday" : "1987-04-12",
"role" : "医生",
"introduction" : "毕业于陆军军医大学临床医学七年制",
"nationalDoctorCode" : "string",
"practiceInfos" : [ {
"type" : "04|护理人员",
"title" : "13|主管护师"
} ],
"practiceImgUrl" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/clinic-usage/fff730ccc5ee45d783d82a85b8a0e52d/license/dog_v2vHea4SK8gb.jpeg",
"goodAt" : "擅长中医内科",
"roles" : [ 1, 2, 3 ],
"doctorTags" : "省级名中医、市级名中医"
} ]
}
}
5.2. 医生接口
5.2.1. 根据手机号获取医生信息
GET /api/v2/open-agency/doctor/query-by-mobile
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Query |
mobile |
手机号 |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/doctor/query-by-mobile?mobile=18088888888
HTTP响应示例
响应 200
{
"data" : {
"departments" : [ {
"id" : "ffffffff0000000006dddfe002e22000",
"name" : "儿保科室",
"type" : 1,
"mainMedicalName" : "儿科",
"secondMedicalName" : "小儿呼吸"
} ],
"id" : "string",
"mobile" : "18088888888",
"name" : "张三",
"sex" : "男",
"headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
"introduction" : "毕业于陆军军医大学临床医学七年制",
"practiceImgUrl" : "string",
"doctorPageUrl" : "string",
"doctorTags" : "省级名中医、市级名中医"
}
}
5.2.2. 获取医生分页列表信息
GET /api/v2/open-agency/doctor/query-list
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
limit |
每页显示条数 |
integer (int32) |
|
Query |
offset |
分页起始下标 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/doctor/query-list
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"mobile" : "18088888888",
"name" : "张三",
"sex" : "男",
"headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
"introduction" : "毕业于陆军军医大学临床医学七年制",
"practiceImgUrl" : "string",
"doctorPageUrl" : "string",
"doctorTags" : "省级名中医、市级名中医"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.3. 商品接口
5.3.1. 获取商品分类
GET /api/v2/open-agency/products/types
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/types
HTTP响应示例
响应 200
{
"data" : {
"typeTree" : [ {
"id" : 0,
"type" : 0,
"subType" : 0,
"category" : "string",
"isLeaf" : 0,
"name" : "string",
"children" : [ {
"id" : 0,
"type" : 0,
"subType" : 0,
"category" : "string",
"isLeaf" : 0,
"name" : "string",
"children" : [ "..." ]
} ]
} ]
}
}
5.3.2. 获取商品自定义分类列表
GET /api/v2/open-agency/products/custom-types
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/custom-types
HTTP响应示例
响应 200
{
"data" : {
"list" : [ {
"id" : "43794",
"typeId" : 18,
"name" : "物资"
} ]
}
}
5.3.3. 获取商品列表
GET /api/v2/open-agency/products
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
type |
类型: 1,药品; 2,物资; 3,检查; 4,治疗; 5,挂号; 7,商品; 11,套餐; 19,其他 |
integer (int32) |
|
Query |
beginDate |
开始时间(格式yyyy-MM-dd)配合查询日期类型使用 |
string |
|
Query |
dateFieldType |
查询日期类型: 1,创建时间; 2,最后修改时间 |
integer (int32) |
|
Query |
endDate |
结束时间(格式yyyy-MM-dd)配合查询日期类型使用 |
string |
|
Query |
includeDeleted |
是否包含已经删除的商品 0:不包含删除的商品 1:包含删除的商品 ,默认值为0 |
integer (int32) |
|
Query |
limit |
每页显示条数,默认20,最大为 200 |
integer (int32) |
|
Query |
offset |
分页起始下标,默认0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products?type=1
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"shortId" : "string",
"name" : "string",
"specification" : "string",
"typeId" : 0,
"typeName" : "string",
"combineType" : 0,
"pieceNum" : 5.0,
"pieceUnit" : "片",
"packageUnit" : "盒",
"lastModified" : "2022-05-13 12:22:56",
"status" : 1,
"disableSell" : 0
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.3.4. 获取商品详情
GET /api/v2/open-agency/products/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
商品id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/ffffffff0000000022195dc8114b8000
HTTP响应示例
响应 200
{
"data" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
}
}
5.3.5. 获取出库单列表
GET /api/v2/open-agency/products/out-order-list
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Query |
beginDate |
开始时间(格式yyyy-MM-dd) |
string (date) |
Query |
endDate |
结束时间(格式yyyy-MM-dd) |
string (date) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/out-order-list?beginDate=2022-04-14&endDate=2022-04-14
HTTP响应示例
响应 200
{
"data" : {
"stockOutOrderList" : [ {
"id" : 0,
"orderNo" : "CK20220526000001",
"status" : 0,
"organName" : "高新大源店",
"type" : 0,
"kindCount" : 5,
"count" : 12.0,
"amount" : 6033.23,
"receiver" : "string",
"operator" : "string",
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56",
"inOrderId" : "1928374567678",
"pharmacy" : {
"no" : 0
}
} ]
}
}
5.3.6. 获取出库单详情
GET /api/v2/open-agency/products/out-order-detail/{orderId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
orderId |
出库单id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/out-order-detail/100000767
HTTP响应示例
响应 200
{
"data" : {
"comment" : {
"time" : "string",
"content" : "string",
"employeeId" : "string",
"employeeName" : "string"
},
"id" : 0,
"outOrderItemList" : [ {
"id" : 0,
"productId" : "string",
"productShortId" : "string",
"productName" : "string",
"specification" : "string",
"pieceNum" : 5.0,
"pieceUnit" : "片",
"packageUnit" : "盒",
"packageCount" : 0.0,
"pieceCount" : 0.0,
"packageCostPrice" : 0.0,
"stockInId" : 0,
"amount" : 0.0,
"lastModified" : "2022-05-13 12:22:56",
"stockOutBatches" : [ {
"stockId" : 12312,
"stockInOutDetailId" : "12312",
"batchId" : 12312,
"supplier" : {
"id" : "string",
"name" : "string"
},
"batchNo" : "555555",
"productionDate" : "2023-01-11",
"expiryDate" : "2023-01-11",
"packageCount" : 1.0,
"pieceCount" : 1.0,
"packageCostPrice" : 1.0,
"pieceNum" : 10,
"costPrice" : 1.0
} ]
} ],
"orderNo" : "CK20220526000001",
"status" : 0,
"organName" : "高新大源店",
"type" : 0,
"kindCount" : 5,
"count" : 12.0,
"amount" : 6033.23,
"receiver" : "string",
"operator" : "string",
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56",
"inOrderId" : "1928374567678",
"pharmacy" : {
"no" : 0
}
}
}
5.3.7. 获取入库单列表
GET /api/v2/open-agency/products/in-order-list
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
beginDate |
开始时间(格式yyyy-MM-dd) |
string (date) |
|
Query |
endDate |
结束时间(格式yyyy-MM-dd) |
string (date) |
|
Query |
type |
类型 0:采购入库 10:退货出库 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/in-order-list?beginDate=2022-04-14&endDate=2022-04-14
HTTP响应示例
响应 200
{
"data" : {
"stockInOrderList" : [ {
"id" : 0,
"inOrderId" : 0,
"orderNo" : "RK20220526000001",
"status" : 0,
"organName" : "高新大源店",
"organId" : "ffffffff00000000264a75300d752999",
"amount" : 6033.23,
"count" : 12.0,
"kindCount" : 5,
"operator" : "string",
"operatorId" : "string",
"supplier" : "string",
"supplierId" : "string",
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56",
"pharmacy" : {
"no" : 0
},
"type" : 0
} ]
}
}
5.3.8. 获取入库单详情
GET /api/v2/open-agency/products/in-order-detail/{orderId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
orderId |
入库单id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/in-order-detail/100005416
HTTP响应示例
响应 200
{
"data" : {
"comment" : {
"time" : "string",
"content" : "string",
"employeeId" : "string",
"employeeName" : "string"
},
"id" : 0,
"inOrderItemList" : [ {
"id" : 123456,
"inId" : 3123456,
"originalItemId" : 123456,
"productId" : "ffffffff0000000034966c3a883ec000",
"productShortId" : "1000001",
"productName" : "阿莫西林",
"specification" : "string",
"expiryDate" : "2022-05-10",
"productionDate" : "2024-05-10",
"pieceNum" : 5.0,
"pieceUnit" : "片",
"packageUnit" : "盒",
"packageCostPrice" : 12.5,
"packageCount" : 2.0,
"pieceCount" : 10.0,
"amount" : 6033.23,
"totalCost" : 6033.23,
"batchId" : 100026529,
"batchNo" : "20220526000001",
"outDetailId" : "12312",
"stockInOutDetailId" : "12312",
"created" : "2022-05-10 12:22:56",
"lastModified" : "2022-05-13 12:22:56"
} ],
"inOrderId" : 0,
"orderNo" : "RK20220526000001",
"status" : 0,
"organName" : "高新大源店",
"organId" : "ffffffff00000000264a75300d752999",
"amount" : 6033.23,
"count" : 12.0,
"kindCount" : 5,
"operator" : "string",
"operatorId" : "string",
"supplier" : "string",
"supplierId" : "string",
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56",
"pharmacy" : {
"no" : 0
},
"type" : 0
}
}
5.3.9. 获取盘点单列表
GET /api/v2/open-agency/products/check-order-list
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Query |
beginDate |
开始时间(格式yyyy-MM-dd) |
string (date) |
Query |
endDate |
结束时间(格式yyyy-MM-dd) |
string (date) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/check-order-list?beginDate=2022-04-14&endDate=2022-04-14
HTTP响应示例
响应 200
{
"data" : {
"checkOrderList" : [ {
"id" : 0,
"orderNo" : "PD20220526000001",
"status" : 0,
"organId" : "ffffffff0000000019b354880922800a",
"organName" : "高新大源店",
"count" : 12.0,
"kindCount" : 5,
"totalCostPriceChange" : 0.0,
"totalPriceChange" : 0.0,
"operator" : "string",
"operatorId" : "123456",
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56"
} ]
}
}
5.3.10. 获取盘点单详情
GET /api/v2/open-agency/products/check-order-detail/{orderId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
orderId |
盘点单id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/check-order-detail/1540
HTTP响应示例
响应 200
{
"data" : {
"checkOrderItemList" : [ {
"id" : 0,
"productId" : "string",
"productShortId" : "string",
"productName" : "string",
"specification" : "string",
"expiryDate" : "string",
"productionDate" : "yyyy-mm-dd",
"pieceNum" : 5.0,
"pieceUnit" : "片",
"packageUnit" : "盒",
"stockId" : "string",
"packageCostPrice" : 0.0,
"beforePieceCount" : 0.0,
"beforePackageCount" : 0.0,
"afterPieceCount" : 0.0,
"afterPackageCount" : 0.0,
"changePieceCount" : 0.0,
"changePackageCount" : 0.0,
"amount" : 0.0,
"lastModified" : "2022-05-13 12:22:56",
"checkBatches" : [ {
"stockId" : 12312,
"stockInOutDetailId" : "12312",
"batchId" : 12312,
"supplier" : {
"id" : "string",
"name" : "string"
},
"batchNo" : "555555",
"productionDate" : "2023-01-11",
"expiryDate" : "2023-01-11",
"packageCount" : 1.0,
"pieceCount" : 1.0,
"packageCostPrice" : 1.0,
"pieceNum" : 10,
"costPrice" : 1.0
} ]
} ],
"comment" : {
"time" : "string",
"content" : "string",
"employeeId" : "string",
"employeeName" : "string"
},
"id" : 0,
"orderNo" : "PD20220526000001",
"status" : 0,
"organId" : "ffffffff0000000019b354880922800a",
"organName" : "高新大源店",
"count" : 12.0,
"kindCount" : 5,
"totalCostPriceChange" : 0.0,
"totalPriceChange" : 0.0,
"operator" : "string",
"operatorId" : "123456",
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56"
}
}
5.3.11. 获取结算单列表
GET /api/v2/open-agency/products/settlement-order-list
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
beginDate |
开始时间(格式yyyy-MM-dd)配合查询日期类型使用 |
string (date) |
|
Query |
dateFieldType |
查询日期类型: 1,创建时间; 2,最后修改时间; 3,入库时间; 4,出库时间; 5,结算盘点时间 |
integer (int32) |
|
Query |
endDate |
结束时间(格式yyyy-MM-dd)配合查询日期类型使用 |
string (date) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/settlement-order-list
HTTP响应示例
响应 200
{
"data" : {
"settlementOrderList" : [ {
"id" : 0,
"createdUser" : "string",
"createDate" : "2022-04-07 15:12:53",
"supplierName" : "string",
"status" : -1,
"includeTaxPrice" : 0.0,
"excludeTaxPrice" : 0.0,
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56"
} ]
}
}
5.3.12. 获取结算单详情
GET /api/v2/open-agency/products/settlement-order-detail/{orderId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
orderId |
结算单id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/settlement-order-detail/ffffffff0000000022195dc8114b8000
HTTP响应示例
响应 200
{
"data" : {
"id" : 0,
"itemsList" : [ {
"id" : 0,
"name" : "string",
"specification" : "string",
"unit" : "string",
"totalPackageCount" : 0,
"includeTaxPrice" : 0.0,
"excludeTaxPrice" : 0.0
} ],
"createdUser" : "string",
"invoicesList" : [ {
"id" : 0,
"invoicedDate" : "string",
"invoiceNo" : "string"
} ],
"createDate" : "2022-04-07 15:12:53",
"inOutList" : [ {
"id" : 0,
"includeTaxPrice" : 0.0,
"excludeTaxPrice" : 0.0,
"totalPackageCount" : 0.0,
"clinicId" : "string",
"clinicName" : "string",
"orderInOutDate" : "string",
"orderCreatedUserName" : "string",
"type" : 0
} ],
"supplierName" : "string",
"status" : -1,
"includeTaxPrice" : 0.0,
"excludeTaxPrice" : 0.0,
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56"
}
}
5.3.13. 获取供应商列表
GET /api/v2/open-agency/products/suppliers
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/suppliers
HTTP响应示例
响应 200
{
"data" : {
"supplierInfoList" : [ {
"id" : "string",
"name" : "string",
"status" : 0,
"licenseId" : "string",
"contact" : "string",
"mobile" : "string",
"mark" : "string"
} ]
}
}
5.3.14. 获取进销存明细
POST /api/v2/open-agency/products/inout-stock-details
说明
查询指定日期的进销存明细(传 date、offset、limit) 2. 出入库单、盘点单、发药单、调拨单进销存明细(传 orderIdList) 3. 查询收费单进销存明细(传 chargeSheetList)
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/inout-stock-details
请求 body
{
"date" : "2020-03-05",
"orderIdList" : [ "12334234", "456667" ],
"chargeSheetList" : [ {
"patientOrderId" : "string",
"chargeSheetId" : "string"
} ],
"type" : 1,
"offset" : 0,
"limit" : 10
}
HTTP响应示例
响应 200
{
"data" : {
"detailsList" : [ {
"stockLogId" : "123456",
"date" : "2020-03-05 12:00:00",
"productId" : "ffffffff00000000347730f37eb54000",
"productShortId" : "H12334",
"productName" : "阿莫西林",
"pieceCount" : 10.0,
"packageCount" : 1.0,
"action" : "发药",
"orderId" : "123456",
"orderItemId" : "123456789",
"patientOrderId" : "ffffffff00000000347ce07462de0001",
"sourceOrderId" : "ffffffff00000000347ce07462de0001",
"sourceOrderItemId" : "ffffffff00000000347ce07462de0001",
"packageCostPrice" : 10.0,
"batchId" : 123456,
"batchNo" : "20200305",
"productionDate" : "2020-03-05",
"expireDate" : "2020-03-05",
"inOrderId" : 123456,
"inOrderItemId" : 12345678,
"inOrderItemOutDetailId" : "X12345678",
"costPrice" : -10.0,
"salePrice" : 10.0,
"pieceNum" : 7
} ],
"total" : 10
}
}
5.3.15. 查询商品库存
POST /api/v2/open-agency/products/stock/query-by-id
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/stock/query-by-id
请求 body
{
"productIds" : [ "string" ]
}
HTTP响应示例
响应 200
{
"data" : {
"goodsStocks" : [ {
"productId" : "ffffffff000000000ef10788097b000c",
"productShortId" : "75724341",
"stockPieceCount" : 20.0,
"stockPackageCount" : 10.0,
"pharmacyStocks" : [ {
"pharmacyNo" : 0,
"pharmacyName" : "本地药房",
"stockPieceCount" : 20.0,
"stockPackageCount" : 10.0
} ]
} ]
}
}
5.3.16. 查询商品批次信息
POST /api/v2/open-agency/products/batches/query-by-id
说明
目前仅支持查询本地0号药房
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/batches/query-by-id
请求 body
{
"productIds" : [ "string" ]
}
HTTP响应示例
响应 200
{
"data" : {
"products" : [ {
"productId" : "ffffffff000000000ef10788097b000c",
"pieceNum" : 5.0,
"batches" : [ {
"batchId" : 123123,
"stockInOutDetailId" : "123123",
"batchNo" : "100012157",
"productionDate" : "2024-09-10",
"expiryDate" : "2024-09-10",
"stockPieceCount" : 20.0,
"stockPackageCount" : 10.0,
"packageCostPrice" : 10.0,
"inDate" : "2024-09-10 18:33:00"
} ]
} ]
}
}
5.3.17. 新增供应商
POST /api/v2/open-agency/products/suppliers
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
req |
req |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/suppliers
请求 body
{
"name" : "string",
"status" : 1,
"licenseId" : "string",
"contact" : "string",
"mobile" : "string",
"mark" : "string",
"operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"name" : "string",
"status" : 0,
"licenseId" : "string",
"contact" : "string",
"mobile" : "string",
"mark" : "string"
}
}
5.3.18. 修改供应商
PUT /api/v2/open-agency/products/suppliers/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Body |
req |
req |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/suppliers/string
请求 body
{
"name" : "string",
"status" : 1,
"licenseId" : "string",
"contact" : "string",
"mobile" : "string",
"mark" : "string",
"operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"name" : "string",
"status" : 0,
"licenseId" : "string",
"contact" : "string",
"mobile" : "string",
"mark" : "string"
}
}
5.3.19. 新增商品
POST /api/v2/open-agency/products
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
req |
req |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products
请求 body
{
"type" : 1,
"subType" : 1,
"medicineCadn" : "阿莫西林",
"name" : "阿莫西林",
"shortId" : "string",
"cMSpec" : "中药饮片",
"dismounting" : 0,
"extendSpec" : "净制 0.5kg",
"materialSpec" : "弹力型 70mm*18mm",
"manufacturer" : "北京同仁堂制药有限公司",
"medicineNmpn" : "国药准字Z41020748",
"barCode" : "6920705211119",
"pieceNum" : 0,
"pieceUnit" : "片",
"packageUnit" : "盒",
"componentContentUnit" : "string",
"componentContentNum" : 0.0,
"medicineDosageNum" : 0.0,
"medicineDosageUnit" : "string",
"piecePrice" : 1.0,
"packagePrice" : 10.0,
"operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
"data" : {
"cmspec" : "string",
"id" : "string",
"medicineCadn" : "阿莫西林",
"name" : "阿莫西林",
"type" : 1,
"subType" : 1,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"extendSpec" : "净制 0.5kg",
"materialSpec" : "弹力型 70mm*18mm",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"displaySpec" : "1ml:0.5mg*10支/盒",
"displayName" : "醋酸泼尼松片(华意)",
"status" : 1
}
}
5.3.20. 修改商品
PUT /api/v2/open-agency/products/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
id |
string |
Body |
req |
req |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/string
请求 body
{
"type" : 1,
"subType" : 1,
"medicineCadn" : "阿莫西林",
"name" : "阿莫西林",
"shortId" : "string",
"cMSpec" : "中药饮片",
"dismounting" : 0,
"extendSpec" : "净制 0.5kg",
"materialSpec" : "弹力型 70mm*18mm",
"manufacturer" : "北京同仁堂制药有限公司",
"medicineNmpn" : "国药准字Z41020748",
"barCode" : "6920705211119",
"pieceNum" : 0,
"pieceUnit" : "片",
"packageUnit" : "盒",
"componentContentUnit" : "string",
"componentContentNum" : 0.0,
"medicineDosageNum" : 0.0,
"medicineDosageUnit" : "string",
"piecePrice" : 1.0,
"packagePrice" : 10.0,
"operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
"data" : {
"cmspec" : "string",
"id" : "string",
"medicineCadn" : "阿莫西林",
"name" : "阿莫西林",
"type" : 1,
"subType" : 1,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"extendSpec" : "净制 0.5kg",
"materialSpec" : "弹力型 70mm*18mm",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"displaySpec" : "1ml:0.5mg*10支/盒",
"displayName" : "醋酸泼尼松片(华意)",
"status" : 1
}
}
5.3.21. 获取采购单列表
GET /api/v2/open-agency/products/purchase-orders
说明
查询间隔不能超过 30 天
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Query |
beginDate |
开始日期(格式yyyy-MM-dd) |
string (date) |
Query |
endDate |
结束日期(格式yyyy-MM-dd) |
string (date) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/purchase-orders?beginDate=2022-04-14&endDate=2022-04-14
HTTP响应示例
响应 200
{
"data" : {
"purchaseOrderList" : [ {
"id" : 0,
"orderNo" : "CG2024110600001",
"status" : 0,
"orderType" : 0,
"purchaseOrganName" : "string",
"purchaseOrganId" : "string",
"applyEmployeeId" : "string",
"applyEmployeeName" : "string",
"purchaseOrderDate" : "2024-11-06 16:51:03",
"created" : "2024-11-06 16:51:03"
} ]
}
}
5.3.22. 获取采购单详情
GET /api/v2/open-agency/products/purchase-orders/{orderId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
orderId |
采购单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/purchase-orders/50130373
HTTP响应示例
响应 200
{
"data" : {
"comment" : {
"time" : "string",
"content" : "string",
"employeeId" : "string",
"employeeName" : "string"
},
"id" : 0,
"orderNo" : "CG2024110600001",
"purchaseOrderItemList" : [ {
"id" : 123123,
"productId" : "ffffffff000000003473c049d7ab4000",
"productShortId" : "000251",
"productName" : "阿莫西林胶囊",
"pieceCount" : 0.0,
"packageCount" : "盒"
} ],
"status" : 0,
"orderType" : 0,
"purchaseOrganName" : "string",
"purchaseOrganId" : "string",
"applyEmployeeId" : "string",
"applyEmployeeName" : "string",
"purchaseOrderDate" : "2024-11-06 16:51:03",
"created" : "2024-11-06 16:51:03"
}
}
5.3.23. 审核采购单
PUT /api/v2/open-agency/products/purchase-orders/{purchaseOrderId}/review
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
purchaseOrderId |
采购单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/purchase-orders/string/review
请求 body
{
"pass" : 1,
"comment" : "药品数量超过限制"
}
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.3.24. 审核修正入库单
PUT /api/v2/open-agency/products/fixed-in-orders/{fixInOrderId}/review
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
fixInOrderId |
修正入库单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/fixed-in-orders/string/review
请求 body
{
"pass" : 1,
"comment" : "确认通过"
}
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.3.25. 创建入库单
POST /api/v2/open-agency/products/in-orders
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/in-orders
请求 body
{
"supplierId" : "string",
"outOrderNo" : "20241112001",
"pharmacyNo" : 0,
"toClinicId" : "ffffffff000000000000000000000001",
"comment" : "备注",
"inOrderItemList" : [ {
"goodsId" : "ffffffff000000000000000000000001",
"goodsShortId" : "12345",
"unit" : "瓶",
"unitCount" : 0.0,
"unitCostPrice" : 0.0,
"totalCostPrice" : 0.0,
"batchNo" : "string",
"expireDate" : "string",
"productionDate" : "string",
"outDetailId" : "string"
} ]
}
HTTP响应示例
响应 200
{
"data" : {
"comment" : {
"time" : "string",
"content" : "string",
"employeeId" : "string",
"employeeName" : "string"
},
"id" : 0,
"inOrderItemList" : [ {
"id" : 123456,
"inId" : 3123456,
"originalItemId" : 123456,
"productId" : "ffffffff0000000034966c3a883ec000",
"productShortId" : "1000001",
"productName" : "阿莫西林",
"specification" : "string",
"expiryDate" : "2022-05-10",
"productionDate" : "2024-05-10",
"pieceNum" : 5.0,
"pieceUnit" : "片",
"packageUnit" : "盒",
"packageCostPrice" : 12.5,
"packageCount" : 2.0,
"pieceCount" : 10.0,
"amount" : 6033.23,
"totalCost" : 6033.23,
"batchId" : 100026529,
"batchNo" : "20220526000001",
"outDetailId" : "12312",
"stockInOutDetailId" : "12312",
"created" : "2022-05-10 12:22:56",
"lastModified" : "2022-05-13 12:22:56"
} ],
"inOrderId" : 0,
"orderNo" : "RK20220526000001",
"status" : 0,
"organName" : "高新大源店",
"organId" : "ffffffff00000000264a75300d752999",
"amount" : 6033.23,
"count" : 12.0,
"kindCount" : 5,
"operator" : "string",
"operatorId" : "string",
"supplier" : "string",
"supplierId" : "string",
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56",
"pharmacy" : {
"no" : 0
},
"type" : 0
}
}
5.3.26. 创建退货出库单
POST /api/v2/open-agency/products/out-orders
说明
目前仅支持退指定批次号的药品,并且退的所有药要在同一个入库单中
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/out-orders
请求 body
{
"inOrderId" : 0,
"pharmacyNo" : 0,
"toClinicId" : "ffffffff000000000000000000000001",
"comment" : "备注",
"outOrderItemList" : [ {
"goodsId" : "ffffffff000000000000000000000001",
"goodsShortId" : "12345",
"pieceCount" : 0.0,
"packageCount" : 0.0,
"batchNo" : "string"
} ]
}
HTTP响应示例
响应 200
{
"data" : {
"comment" : {
"time" : "string",
"content" : "string",
"employeeId" : "string",
"employeeName" : "string"
},
"id" : 0,
"inOrderItemList" : [ {
"id" : 123456,
"inId" : 3123456,
"originalItemId" : 123456,
"productId" : "ffffffff0000000034966c3a883ec000",
"productShortId" : "1000001",
"productName" : "阿莫西林",
"specification" : "string",
"expiryDate" : "2022-05-10",
"productionDate" : "2024-05-10",
"pieceNum" : 5.0,
"pieceUnit" : "片",
"packageUnit" : "盒",
"packageCostPrice" : 12.5,
"packageCount" : 2.0,
"pieceCount" : 10.0,
"amount" : 6033.23,
"totalCost" : 6033.23,
"batchId" : 100026529,
"batchNo" : "20220526000001",
"outDetailId" : "12312",
"stockInOutDetailId" : "12312",
"created" : "2022-05-10 12:22:56",
"lastModified" : "2022-05-13 12:22:56"
} ],
"inOrderId" : 0,
"orderNo" : "RK20220526000001",
"status" : 0,
"organName" : "高新大源店",
"organId" : "ffffffff00000000264a75300d752999",
"amount" : 6033.23,
"count" : 12.0,
"kindCount" : 5,
"operator" : "string",
"operatorId" : "string",
"supplier" : "string",
"supplierId" : "string",
"effectiveDate" : "2022-04-07 15:12:53",
"lastModified" : "2022-05-13 12:22:56",
"pharmacy" : {
"no" : 0
},
"type" : 0
}
}
5.3.27. 审核退货出库申请单
PUT /api/v2/open-agency/products/out-apply-orders/{outApplyOrderId}/review
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
outApplyOrderId |
outApplyOrderId |
integer (int64) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/products/out-apply-orders/0/review
请求 body
{
"pass" : 1,
"comment" : "确认通过"
}
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.3.28. 查询门店库存
GET /api/v2/open-agency/products/batches
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
limit |
limit |
integer (int32) |
|
Query |
offset |
offset |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/batches
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"goodsId" : "ffffffff000000003473c049d7ab4004",
"goodsShortId" : "Z12312312",
"batchId" : 123123,
"pieceNum" : 8,
"pharmacyType" : 0,
"pharmacyNo" : 0,
"expiryDate" : "2025-01-17",
"productionDate" : "2025-01-17",
"inDate" : "2025-01-17 02:36:00",
"batchNo" : "100012157",
"packageCostPrice" : 10.0,
"leftCost" : 10.0,
"pieceCount" : 10.0,
"packageCount" : 20.0,
"status" : 0,
"stockInOutDetailId" : "string"
} ],
"total" : 0,
"offset" : 0,
"limit" : 0,
"keyword" : "string"
}
}
5.3.29. 获取调拨单列表
GET /api/v2/open-agency/products/trans-order-list
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
beginDate |
开始时间(格式yyyy-MM-dd) |
string |
|
Query |
endDate |
结束时间(格式yyyy-MM-dd) |
string |
|
Query |
limit |
每页显示条数,默认10,最大为 20 |
integer (int32) |
|
Query |
offset |
分页起始下标,默认0 |
integer (int32) |
|
Query |
dateFieldType |
查询日期类型: 0-创建时间 1-调拨入库时间 |
integer (int32) |
|
Query |
transType |
调拨类型: 0-店间调拨 1-店内调拨 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/trans-order-list?beginDate=2022-04-14&endDate=2022-04-14&limit=20&offset=0
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : 0,
"amount" : 0.0,
"count" : 0.0,
"kindCount" : 0,
"orderNo" : "string",
"transType" : 0,
"transCostPriceType" : 0,
"createdUser" : {
"id" : "string",
"name" : "string"
},
"created" : "string",
"reviewDate" : "string",
"reviewUser" : {
"id" : "string",
"name" : "string"
},
"inConfirmDate" : "string",
"inConfirmUser" : {
"id" : "string",
"name" : "string"
},
"toOrgan" : {
"id" : "string",
"name" : "string"
},
"inPharmacy" : {
"no" : 0
},
"fromOrgan" : {
"id" : "string",
"name" : "string"
},
"outPharmacy" : {
"no" : 0
},
"lastModified" : "string",
"lastModifiedUser" : {
"id" : "string",
"name" : "string"
},
"status" : 1
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.3.30. 获取调拨单详情
GET /api/v2/open-agency/products/trans-order-detail/{orderId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
orderId |
调拨单id |
integer (int64) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/products/trans-order-detail/1233
HTTP响应示例
响应 200
{
"data" : {
"id" : 0,
"amount" : 0.0,
"count" : 0.0,
"kindCount" : 0,
"orderNo" : "string",
"transType" : 0,
"transCostPriceType" : 0,
"createdUser" : {
"id" : "string",
"name" : "string"
},
"created" : "string",
"reviewDate" : "string",
"reviewUser" : {
"id" : "string",
"name" : "string"
},
"inConfirmDate" : "string",
"inConfirmUser" : {
"id" : "string",
"name" : "string"
},
"toOrgan" : {
"id" : "string",
"name" : "string"
},
"inPharmacy" : {
"no" : 0
},
"fromOrgan" : {
"id" : "string",
"name" : "string"
},
"outPharmacy" : {
"no" : 0
},
"lastModified" : "string",
"lastModifiedUser" : {
"id" : "string",
"name" : "string"
},
"status" : 1,
"items" : [ {
"applicationPackageCount" : 0.0,
"applicationPieceCount" : 0.0,
"packageCount" : 0.0,
"pieceCount" : 0.0,
"goods" : {
"id" : "string",
"name" : "阿莫西林",
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"outTotalCostPrice" : 0.0,
"outPackageCostPrice" : 0.0,
"bathes" : [ {
"stockId" : 0,
"batchNo" : "string",
"expiryDate" : "string",
"packageCount" : 0.0,
"pieceCount" : 0.0,
"outPackageCostPrice" : 0.0
} ],
"transInBatches" : [ {
"stockId" : 12312,
"stockInOutDetailId" : "12312",
"batchId" : 12312,
"supplier" : {
"id" : "string",
"name" : "string"
},
"batchNo" : "555555",
"productionDate" : "2023-01-11",
"expiryDate" : "2023-01-11",
"packageCount" : 1.0,
"pieceCount" : 1.0,
"packageCostPrice" : 1.0,
"pieceNum" : 10,
"costPrice" : 1.0
} ],
"lastModified" : "string"
} ]
}
}
5.4. 患者接口
5.4.1. 获取患者分页列表
GET /api/v2/open-agency/patient/query-list
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
date |
日期(格式yyyy-MM-dd) |
string |
|
Query |
limit |
每页显示条数,默认20 |
integer (int32) |
|
Query |
offset |
分页起始下标,默认0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/patient/query-list?date=2022-01-03
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.4.2. 查询患者
GET /api/v2/open-agency/patient/query
说明
根据手机号和姓名或档案号获取患者分页列表信息
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Query |
mobile |
手机号 |
string |
Query |
name |
姓名 |
string |
Query |
sn |
档案号 |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/patient/query
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
} ]
}
}
5.4.3. 获取患者详情
GET /api/v2/open-agency/patient/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
患者id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/patient/000000fc446f4dbd989857e305b00d6d
HTTP响应示例
响应 200
{
"data" : {
"createdClinicId" : "000000fc446f4dbd989857e305b00d6s",
"id" : "000000fc446f4dbd989857e305b00d6s",
"createdClinicName" : "张三",
"name" : "张三",
"created" : "2018-08-14 13:08:05",
"mobile" : "18080000000",
"patientSource" : {
"parentId" : "string",
"parentName" : "string",
"id" : "string",
"name" : "就诊推荐",
"sourceFrom" : "推荐人ID",
"sourceFromName" : "张三",
"relatedType" : 3,
"relatedId" : "ffffffff00000000094c2a500293c000",
"relateName" : "string"
},
"sex" : "男",
"birthday" : "1970-08-14",
"sn" : "031756",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "string",
"profession" : "教师",
"company" : "ABC",
"remark" : "string",
"address" : {
"addressProvinceId" : "510000",
"addressProvinceName" : "四川",
"addressCityId" : "510100",
"addressCityName" : "成都市",
"addressDistrictId" : "510109",
"addressDistrictName" : "高新区",
"addressDetail" : "交子大道180号"
},
"shebaoCardInfo" : {
"cardNo" : "shebaoCardInfo"
},
"tags" : [ {
"id" : "as123",
"name" : "糖尿病"
} ],
"memberInfo" : {
"id" : "ffffffff000000001dce673007782004",
"principal" : 2866.6,
"present" : 368.0,
"created" : "2018-08-14 13:08:05",
"memberTypeInfo" : {
"id" : "9dc6f28121a7d9ba9fa6af00b406b314",
"name" : "普通卡"
}
}
}
}
5.4.4. 查询来源分类列表
GET /api/v2/open-agency/patient/source/types
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/patient/source/types
HTTP响应示例
响应 200
{
"data" : {
"list" : [ {
"id" : "string",
"name" : "张三",
"relatedType" : 3,
"relatedId" : "ffffffff00000000094c2a500293c000",
"children" : [ {
"id" : "string",
"name" : "张三",
"relatedType" : 3,
"relatedId" : "ffffffff00000000094c2a500293c000",
"children" : [ "..." ]
} ]
} ]
}
}
5.4.5. 创建患者
POST /api/v2/open-agency/patient
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/patient
请求 body
{
"name" : "string",
"mobile" : "string",
"sex" : "男",
"birthday" : "2010-01-15",
"sourceId" : "医生推荐分类id, 导医推荐分类id, 顾客推荐分类id",
"sourceFromId" : "string",
"idCard" : "string",
"pastHistory" : "string",
"address" : {
"addressProvinceId" : "510000",
"addressProvinceName" : "四川",
"addressCityId" : "510100",
"addressCityName" : "成都市",
"addressDistrictId" : "510109",
"addressDistrictName" : "高新区",
"addressDetail" : "交子大道180号"
},
"sn" : "string",
"remark" : "string",
"profession" : "string",
"company" : "string",
"marital" : "string",
"weight" : "string"
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
}
}
5.4.6. 修改患者
PUT /api/v2/open-agency/patient/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
id |
患者id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/patient/1928374566xxx
请求 body
{
"name" : "string",
"mobile" : "string",
"sex" : "男",
"birthday" : "2010-01-15",
"sourceId" : "医生推荐分类id, 导医推荐分类id, 顾客推荐分类id",
"sourceFromId" : "string",
"idCard" : "string",
"pastHistory" : "string",
"address" : {
"addressProvinceId" : "510000",
"addressProvinceName" : "四川",
"addressCityId" : "510100",
"addressCityName" : "成都市",
"addressDistrictId" : "510109",
"addressDistrictName" : "高新区",
"addressDetail" : "交子大道180号"
},
"sn" : "string",
"remark" : "string",
"profession" : "string",
"company" : "string",
"marital" : "string",
"weight" : "string"
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
}
}
5.4.7. 查询患者家庭成员信息
GET /api/v2/open-agency/patient/{patientId}/family-member
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
patientId |
患者ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/patient/string/family-member
HTTP响应示例
响应 200
{
"data" : {
"patientId" : "string",
"familyRole" : 0,
"familyPatients" : [ {
"familyRole" : 0,
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"relation" : "儿子",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
} ]
}
}
5.4.8. 查询患者附件
GET /api/v2/open-agency/patient/{patientId}/attachments
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
patientId |
患者ID |
string |
|
Query |
limit |
每页显示条数,默认值为 10,最大为 20 |
integer (int32) |
|
Query |
offset |
分页起始下标 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/patient/ffffffff00000000220e67a8116d8000/attachments
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "123123121",
"url" : "https://test.com/aaa.xlsx",
"fileName" : "aaa.xlsx",
"displayName" : "体检报告",
"created" : "2024-08-15 19:18:50",
"businessCategory" : 1
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.4.9. 新增患者附件
POST /api/v2/open-agency/patient/{patientId}/attachments
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
patientId |
患者ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/patient/ffffffff00000000220e67a8116d8000/attachments
请求 body
{
"attachments" : [ {
"url" : "https://test.com/aaa.png",
"fileName" : "xxxx.png",
"displayName" : "体检报告",
"businessCategory" : 1
} ]
}
HTTP响应示例
响应 200
{
"data" : {
"attachments" : [ {
"id" : "123123121",
"url" : "https://test.com/aaa.xlsx",
"fileName" : "aaa.xlsx",
"displayName" : "体检报告",
"created" : "2024-08-15 19:18:50",
"businessCategory" : 1
} ]
}
}
5.4.10. 删除患者附件
DELETE /api/v2/open-agency/patient/{patientId}/attachments/{attachmentId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
attachmentId |
附件ID |
string |
Path |
patientId |
患者ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/patient/ffffffff00000000220e67a8116d8000/attachments/12312321311
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.4.11. 查询患者会员类型列表
GET /api/v2/open-agency/patient/members/types
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/patient/members/types
HTTP响应示例
响应 200
{
"data" : {
"memberTypes" : [ {
"id" : "9dc6f28121a7d9ba9fa6af00b406b314",
"name" : "普通卡"
} ]
}
}
5.4.12. 会员卡支付
PUT /api/v2/open-agency/patient/members/{memberCardId}/pay
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
memberCardId |
会员卡ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/patient/members/ffffffff0000000034c1e2173d268002/pay
请求 body
{
"transactionPatientId" : "ffffffff0000000034c1e2173d268002",
"amount" : 100.0,
"businessId" : "3808805404481667072",
"password" : "123456",
"operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
"data" : {
"transactionId" : "ffffffff0000000034c1e2173d268002",
"principalBalance" : 200.0,
"presentBalance" : 100.0,
"principal" : 100.0,
"present" : 50.0,
"businessId" : "3808805404481667072"
}
}
5.4.13. 会员卡退款
PUT /api/v2/open-agency/patient/members/{memberCardId}/refund
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
memberCardId |
会员卡ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/patient/members/ffffffff0000000034c1e2173d268002/refund
请求 body
{
"amount" : 100.0,
"transactionIds" : [ "string" ],
"businessId" : "3808805404481667072",
"operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
"data" : {
"transactionId" : "ffffffff0000000034c1e2173d268002",
"principalBalance" : 200.0,
"presentBalance" : 100.0,
"principal" : 100.0,
"present" : 50.0,
"businessId" : "3808805404481667072"
}
}
5.5. 挂号接口
5.5.1. 获取科室医生的号源详情
GET /api/v2/open-agency/registration/doctor/{doctorId}
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
doctorId |
医生id |
string |
|
Query |
workingDate |
工作日期 yyyy-MM-dd |
string (date) |
|
Query |
departmentId |
科室id,门诊预约时必填 |
string |
|
Query |
registrationType |
预约类型 0:门诊预约 1:理疗预约,默认为 0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/doctor/ffffffff00000000220e67a8116d8000?workingDate=2022-05-05
HTTP响应示例
响应 200
{
"data" : {
"doctorId" : "string",
"departmentId" : "string",
"workingDate" : "string",
"dayOfWeek" : "string",
"restCountToday" : 0,
"canReserve" : 0,
"scheduleIntervals" : [ {
"timeOfDay" : "string",
"start" : "string",
"end" : "string",
"list" : [ {
"restCount" : 0,
"timeOfDay" : "string",
"orderNo" : 0,
"type" : 2,
"start" : "string",
"end" : "string",
"available" : 0
} ]
} ]
}
}
5.5.2. 创建挂号
POST /api/v2/open-agency/registration
说明
只有开启了预约升级的门店才能进行理疗预约
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/registration
请求 body
{
"patientId" : "string",
"departmentId" : "string",
"doctorId" : "string",
"orderNo" : 0,
"reserveDate" : "string",
"reserveStart" : "string",
"reserveEnd" : "string",
"sourceId" : "医生推荐分类ID, 导医推荐分类ID, 顾客推荐分类ID",
"sourceFromId" : "string",
"sourceRemark" : "string",
"registrationType" : 0,
"registrationProductIds" : [ 0 ]
}
HTTP响应示例
响应 200
{
"data" : {
"registrationSheetId" : "string",
"patientOrderId" : "string"
}
}
5.5.3. 获取挂号详情
GET /api/v2/open-agency/registration/{registrationsSheetId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
registrationsSheetId |
挂号单id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/ffffffff0000000006dddfe002e22000
HTTP响应示例
响应 200
{
"data" : {
"clinicName" : "string",
"patientOrderId" : "string",
"registrationSheetId" : "string",
"visitSourceParentId" : "string",
"patientId" : "string",
"visitSourceParentName" : "string",
"departmentId" : "string",
"visitSourceId" : "string",
"departmentName" : "string",
"visitSourceName" : "string",
"doctorId" : "string",
"visitSourceFromId" : "string",
"doctorName" : "string",
"visitSourceFromName" : "string",
"orderNo" : "上午 01号",
"visitSourceRelatedType" : 0,
"reserveDate" : "2019-04-04",
"visitSourceRelatedId" : "string",
"reserveTime" : "10:10~10:30",
"visitSourceRelateName" : "string",
"isReserved" : 1,
"visitSourceRemark" : "string",
"registrationProducts" : [ {
"id" : "ffffffff000000000000000000000001",
"name" : "针灸"
} ],
"status" : 10,
"signIn" : 0,
"consultingRoomId" : "string",
"consultingRoomName" : "string",
"type" : 0,
"payStatus" : 0,
"code" : 0,
"registrationType" : 0,
"created" : "2022-06-23 18:45:00"
}
}
5.5.4. 通过就诊单ID获取挂号详情
GET /api/v2/open-agency/registration/by-patient-order-id/{patientOrderId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
patientOrderId |
就诊单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/by-patient-order-id/ffffffff0000000006dddfe002e22000
HTTP响应示例
响应 200
{
"data" : {
"clinicName" : "string",
"patientOrderId" : "string",
"registrationSheetId" : "string",
"visitSourceParentId" : "string",
"patientId" : "string",
"visitSourceParentName" : "string",
"departmentId" : "string",
"visitSourceId" : "string",
"departmentName" : "string",
"visitSourceName" : "string",
"doctorId" : "string",
"visitSourceFromId" : "string",
"doctorName" : "string",
"visitSourceFromName" : "string",
"orderNo" : "上午 01号",
"visitSourceRelatedType" : 0,
"reserveDate" : "2019-04-04",
"visitSourceRelatedId" : "string",
"reserveTime" : "10:10~10:30",
"visitSourceRelateName" : "string",
"isReserved" : 1,
"visitSourceRemark" : "string",
"registrationProducts" : [ {
"id" : "ffffffff000000000000000000000001",
"name" : "针灸"
} ],
"status" : 10,
"signIn" : 0,
"consultingRoomId" : "string",
"consultingRoomName" : "string",
"type" : 0,
"payStatus" : 0,
"code" : 0,
"registrationType" : 0,
"created" : "2022-06-23 18:45:00"
}
}
5.5.5. 取消挂号
PUT /api/v2/open-agency/registration/{registrationsSheetId}/cancel
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
registrationsSheetId |
挂号单id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/registration/ffffffff0000000006dddfe002e22000/cancel
HTTP响应示例
响应 200
{
"data" : {
"isSuccess" : 0,
"tips" : "string"
}
}
5.5.6. 查询预约备注模板
GET /api/v2/open-agency/registration/remark-templates
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/remark-templates
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"registrationType" : 0,
"content" : "string",
"sort" : 0,
"disableModify" : 0,
"disableDelete" : 0
} ]
}
}
5.5.7. 查询医生可预约项目列表
GET /api/v2/open-agency/registration/doctor/{doctorId}/product
说明
目前仅支持查询理疗预约项目
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
doctorId |
医生ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/doctor/string/product
HTTP响应示例
响应 200
{
"data" : {
"registrationProducts" : [ {
"id" : "ffffffff000000000000000000000001",
"introduce" : "专业按摩,疏通筋骨",
"name" : "针灸",
"price" : 100.0,
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
} ]
}
}
5.5.8. 查询门店可预约项目列表
GET /api/v2/open-agency/registration/product
说明
目前仅支持查询理疗预约项目
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/product
HTTP响应示例
响应 200
{
"data" : {
"registrationProducts" : [ {
"id" : "ffffffff000000000000000000000001",
"introduce" : "专业按摩,疏通筋骨",
"name" : "针灸",
"price" : 100.0,
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
} ]
}
}
5.5.9. 查询项目每日号源
GET /api/v2/open-agency/registration/product/{registrationProductId}/section-status
说明
目前仅支持查询理疗预约项目
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
registrationProductId |
预约项目ID |
integer (int64) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/product/0/section-status
HTTP响应示例
响应 200
{
"data" : {
"reserveSectionStatusList" : [ {
"date" : "2024-03-05",
"status" : 0
} ]
}
}
5.5.10. 查询项目指定日期排班信息
GET /api/v2/open-agency/registration/product/{registrationProductId}/days-shifts
说明
目前仅支持查询理疗预约项目
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
registrationProductId |
预约项目ID |
integer (int64) |
Query |
reserveDate |
预约日期(yyyy-MM-dd) |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/product/0/days-shifts?reserveDate=2024-03-03
HTTP响应示例
响应 200
{
"data" : {
"registrationCategoryDaysShifts" : [ {
"status" : 0,
"registrationCategory" : 0,
"dayShifts" : [ {
"start" : "08:00",
"end" : "08:30",
"timeOfDay" : "上午",
"status" : 0,
"shiftDoctors" : [ {
"doctorId" : "ffffffff000000000000000000000001",
"status" : 0
} ]
} ]
} ]
}
}
5.5.11. 查询患者预约列表
GET /api/v2/open-agency/registration/patient/{patientId}
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
patientId |
患者ID |
string |
|
Query |
beginDate |
开始日期,yyyy-MM-dd,为空则默认为三个月前 |
string (date) |
|
Query |
endDate |
结束日期,yyyy-MM-dd,为空则默认为今天 |
string (date) |
|
Query |
limit |
分页大小,默认为 10,最大为 20 |
integer (int32) |
|
Query |
offset |
分页偏移 |
integer (int32) |
|
Query |
registrationType |
预约类型 0:门诊预约 1:理疗预约,默认为 0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/patient/string
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"patientOrderId" : "string",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "张三",
"reserveDate" : "2019-04-04",
"reserveStart" : "10:10",
"reserveEnd" : "10:30",
"type" : 0,
"status" : 10,
"payStatus" : 0,
"consultingRoomId" : "string",
"consultingRoomName" : "string",
"registrationProducts" : [ {
"id" : "ffffffff000000000000000000000001",
"name" : "针灸"
} ],
"created" : "2022-06-23 18:45:00"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.5.12. 查询门店指定日期医生号源状态
GET /api/v2/open-agency/registration/doctors-shift-status
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
reserveDate |
预约日期 yyyy-MM-dd |
string |
|
Query |
registrationType |
预约类型 0:门诊预约 1:理疗预约,默认为 0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/doctors-shift-status?reserveDate=2024-04-22
HTTP响应示例
响应 200
{
"data" : {
"doctorShifts" : [ {
"showInWeClinic" : 1,
"doctor" : {
"id" : "string",
"mobile" : "18088888888",
"name" : "张三",
"sex" : "男",
"headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
"introduction" : "毕业于陆军军医大学临床医学七年制",
"practiceImgUrl" : "string",
"doctorPageUrl" : "string",
"doctorTags" : "省级名中医、市级名中医"
},
"status" : 0
} ]
}
}
5.5.13. 查询门店指定医生号源日期列表
GET /api/v2/open-agency/registration/doctor/{doctorId}/shift
说明
返回结果日期范围为:当天~(最大可预约日期+2天)
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
doctorId |
医生ID |
string |
|
Query |
beginDate |
开始日期 yyyy-MM-dd |
string |
|
Query |
endDate |
结束日期 yyyy-MM-dd |
string |
|
Query |
registrationType |
预约类型 0:门诊预约 1:理疗预约,默认为 0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration/doctor/string/shift
HTTP响应示例
响应 200
{
"data" : {
"reserveSections" : [ {
"date" : "2024-04-23",
"departments" : [ {
"id" : "ffffffff0000000022174678012e2000",
"name" : "儿科",
"restCount" : 9,
"totalCount" : 10,
"status" : 0,
"fee" : 20.0,
"registerStartTime" : "09:30",
"registrationCategoryDayShifts" : [ {
"departmentId" : "ffffffff0000000017e9b87008386000",
"registrationCategory" : 0,
"restCount" : 5,
"totalCount" : 10,
"status" : 0,
"dayShifts" : [ {
"shifts" : [ {
"orderNo" : 5,
"start" : "09:00",
"end" : "09:20",
"timeOfDay" : "上午",
"count" : 1,
"totalCount" : 1
} ],
"restCount" : 5,
"totalCount" : 10,
"status" : 0,
"start" : "09:00",
"end" : "10:00",
"timeOfDay" : "上午"
} ]
} ]
} ]
} ]
}
}
5.5.14. 查询挂号单列表
GET /api/v2/open-agency/registration
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
registrationType |
预约类型 0:门诊预约 1:理疗预约,默认为 0 |
integer (int32) |
|
Query |
limit |
分页大小,默认为 10,最大为 20 |
integer (int32) |
|
Query |
offset |
分页偏移 |
integer (int32) |
|
Query |
reserveDate |
预约日期,默认为当天 |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/registration?registrationType=0
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"patientOrderId" : "string",
"registrationSheetId" : "string",
"patientId" : "string",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"orderNo" : "上午 01号",
"reserveDate" : "2019-04-04",
"reserveTime" : "10:10~10:30",
"isReserved" : 1,
"status" : 10,
"signIn" : 0,
"consultingRoomId" : "string",
"consultingRoomName" : "string",
"type" : 0,
"payStatus" : 0,
"code" : 0,
"registrationType" : 0,
"created" : "2022-06-23 18:45:00"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.6. 门诊接口
5.6.1. 按患者查询门诊单
GET /api/v2/open-agency/outpatient/query-by-patient/{patientId}
说明
查询日期间隔不能超过 3 个月
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
patientId |
患者ID |
string |
|
Query |
beginDate |
开始日期 yyyy-MM-dd,默认为3个月前 |
string (date) |
|
Query |
endDate |
结束日期 yyyy-MM-dd,默认为当前 |
string (date) |
|
Query |
limit |
每页显示条数 |
integer (int32) |
|
Query |
offset |
分页起始下标 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/query-by-patient/ffffffff000000001bc17db00f42e000
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"patientOrderId" : "string",
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"created" : "string",
"doctorId" : "string",
"doctorName" : "string",
"patientOrderNo" : "0000000001",
"status" : 0,
"statusName" : "string"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.6.2. 获取门诊单详情
GET /api/v2/open-agency/outpatient/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
门诊单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/ffffffff00000000216fab8810cde000
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"clinicId" : "string",
"patientOrderId" : "string",
"patientOrderNo" : "00019691",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"created" : "string",
"diagnosedDate" : "string",
"status" : 0,
"statusName" : "string",
"revisitStatus" : 1,
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"medicalRecord" : {
"id" : "string",
"outpatientSheetId" : "ffffffff00000000094c2a500293c000",
"chiefComplaint" : "咽痛,干咳,咳痰",
"pastHistory" : "既往体健,既往有高血压",
"familyHistory" : "string",
"presentHistory" : "string",
"physicalExamination" : "string",
"diagnosis" : "急性上呼吸道感染",
"doctorAdvice" : "string",
"syndrome" : "string",
"therapy" : "string",
"chineseExamination" : "string",
"wearGlassesHistory" : "近视",
"obstetricalHistory" : "string",
"eyeExamination" : {
"items" : [ {
"key" : "string",
"name" : "string",
"rightEyeValue" : "string",
"leftEyeValue" : "string"
} ]
},
"allergicHistory" : "青霉素过敏",
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
},
"prescriptionChineseForms" : [ {
"id" : "string",
"type" : 1,
"specification" : "string",
"doseCount" : 0,
"dailyDosage" : "string",
"usage" : "string",
"freq" : "string",
"requirement" : "string",
"usageLevel" : "string",
"prescriptionFormItems" : [ {
"id" : "string",
"prescriptionFormId" : "string",
"productId" : "string",
"type" : 1,
"subType" : 1,
"name" : "string",
"specification" : "string",
"manufacturer" : "string",
"usage" : "string",
"ivgtt" : 0.0,
"ivgttUnit" : "string",
"freq" : "string",
"dosage" : "string",
"dosageUnit" : "string",
"days" : 0,
"specialRequirement" : "string",
"isDismounting" : 0,
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"groupId" : 0,
"isAst" : 0,
"astResult" : {
"result" : "阴性",
"description" : "执行人:王萍,执行时间:2022-04-13"
},
"productInfo" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
}
} ]
} ],
"prescriptionWesternForms" : [ {
"id" : "string",
"type" : 1,
"specification" : "string",
"doseCount" : 0,
"dailyDosage" : "string",
"usage" : "string",
"freq" : "string",
"requirement" : "string",
"usageLevel" : "string",
"prescriptionFormItems" : [ {
"id" : "string",
"prescriptionFormId" : "string",
"productId" : "string",
"type" : 1,
"subType" : 1,
"name" : "string",
"specification" : "string",
"manufacturer" : "string",
"usage" : "string",
"ivgtt" : 0.0,
"ivgttUnit" : "string",
"freq" : "string",
"dosage" : "string",
"dosageUnit" : "string",
"days" : 0,
"specialRequirement" : "string",
"isDismounting" : 0,
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"groupId" : 0,
"isAst" : 0,
"astResult" : {
"result" : "阴性",
"description" : "执行人:王萍,执行时间:2022-04-13"
},
"productInfo" : {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
}
} ]
} ],
"prescriptionInfusionForms" : [ {
"id" : "string",
"type" : 1,
"specification" : "string",
"doseCount" : 0,
"dailyDosage" : "string",
"usage" : "string",
"freq" : "string",
"requirement" : "string",
"usageLevel" : "string",
"prescriptionFormItems" : [ {
"id" : "string",
"prescriptionFormId" : "string",
"productId" : "string",
"type" : 1,
"subType" : 1,
"name" : "string",
"specification" : "string",
"manufacturer" : "string",
"usage" : "string",
"ivgtt" : 0.0,
"ivgttUnit" : "string",
"freq" : "string",
"dosage" : "string",
"dosageUnit" : "string",
"days" : 0,
"specialRequirement" : "string",
"isDismounting" : 0,
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"groupId" : 0,
"isAst" : 0,
"astResult" : {
"result" : "阴性",
"description" : "执行人:王萍,执行时间:2022-04-13"
},
"productInfo" : "..."
} ]
} ],
"prescriptionExternalForms" : [ {
"id" : "string",
"type" : 1,
"specification" : "string",
"doseCount" : 0,
"dailyDosage" : "string",
"usage" : "string",
"freq" : "string",
"requirement" : "string",
"usageLevel" : "string",
"prescriptionFormItems" : [ {
"id" : "string",
"prescriptionFormId" : "string",
"productId" : "string",
"type" : 1,
"subType" : 1,
"name" : "string",
"specification" : "string",
"manufacturer" : "string",
"usage" : "string",
"ivgtt" : 0.0,
"ivgttUnit" : "string",
"freq" : "string",
"dosage" : "string",
"dosageUnit" : "string",
"days" : 0,
"specialRequirement" : "string",
"isDismounting" : 0,
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"groupId" : 0,
"isAst" : 0,
"astResult" : {
"result" : "阴性",
"description" : "执行人:王萍,执行时间:2022-04-13"
},
"productInfo" : "..."
} ]
} ],
"productForms" : [ {
"id" : "string",
"type" : 2,
"productFormItems" : [ {
"id" : "string",
"productFormId" : "string",
"productId" : "string",
"name" : "string",
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"isDismounting" : 0,
"type" : 1,
"subType" : 0,
"days" : 0,
"dailyDosage" : 0,
"remark" : "小心使用"
} ]
} ]
}
}
5.6.3. 创建门诊单
POST /api/v2/open-agency/outpatient
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
req |
req |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/outpatient
请求 body
{
"departmentId" : "string",
"doctorId" : "string",
"patientId" : "string",
"operatorId" : "00000000000000000000000000000000",
"medicalRecord" : {
"chiefComplaint" : "咽痛,干咳,咳痰",
"pastHistory" : "既往体健,既往有高血压",
"familyHistory" : "string",
"presentHistory" : "string",
"physicalExamination" : "string",
"diagnosis" : "急性上呼吸道感染",
"doctorAdvice" : "string",
"syndrome" : "string",
"therapy" : "string",
"chineseExamination" : "string",
"obstetricalHistory" : "string"
},
"prescriptionChineseForms" : [ {
"isTotalPriceChanged" : 1,
"pharmacyNo" : 0,
"expectedTotalPrice" : 10.0,
"specification" : "中药饮片",
"doseCount" : 3,
"prescriptionFormItems" : [ {
"productId" : "483ac61f811640f5849a3d3aabceea58",
"specialRequirement" : "先煎",
"productShortId" : "1907765200",
"unitCount" : 2.0,
"expectedUnitPrice" : 5.0,
"expectedTotalPrice" : 5.0,
"useDismounting" : 0
} ],
"usage" : "煎服",
"dailyDosage" : "1日1剂",
"freq" : "1日6次",
"usageLevel" : "每次60ml",
"usageDays" : "约服35天",
"requirement" : "饭前服用",
"processInfo" : {
"usageType" : 0,
"usageSubType" : 0,
"unitCount" : 1.0,
"totalCount" : 2.0,
"price" : 0.0,
"remark" : "string"
}
} ],
"prescriptionWesternForms" : [ {
"isTotalPriceChanged" : 1,
"expectedTotalPrice" : 10.0,
"prescriptionFormItems" : [ {
"ast" : 1,
"productId" : "483ac61f811640f5849a3d3aabceea58",
"productShortId" : "1907765200",
"usage" : "含服用",
"freq" : "qd",
"unitCount" : 2.0,
"dosage" : 3.0,
"expectedUnitPrice" : 5.0,
"dosageUnit" : "片",
"expectedTotalPrice" : 5.0,
"days" : 5.0,
"useDismounting" : 0,
"specialRequirement" : "首次加倍",
"pharmacyNo" : 0
} ]
} ]
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"clinicId" : "string",
"patientOrderId" : "string",
"patientOrderNo" : "00019691",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"created" : "string",
"diagnosedDate" : "string",
"status" : 0,
"statusName" : "string",
"revisitStatus" : 1,
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"medicalRecord" : {
"id" : "string",
"outpatientSheetId" : "ffffffff00000000094c2a500293c000",
"chiefComplaint" : "咽痛,干咳,咳痰",
"pastHistory" : "既往体健,既往有高血压",
"familyHistory" : "string",
"presentHistory" : "string",
"physicalExamination" : "string",
"diagnosis" : "急性上呼吸道感染",
"doctorAdvice" : "string",
"syndrome" : "string",
"therapy" : "string",
"chineseExamination" : "string",
"wearGlassesHistory" : "近视",
"obstetricalHistory" : "string",
"eyeExamination" : {
"items" : [ {
"key" : "string",
"name" : "string",
"rightEyeValue" : "string",
"leftEyeValue" : "string"
} ]
},
"allergicHistory" : "青霉素过敏",
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
},
"prescriptionChineseForms" : [ {
"id" : "string",
"type" : 1,
"specification" : "string",
"doseCount" : 0,
"dailyDosage" : "string",
"usage" : "string",
"freq" : "string",
"requirement" : "string",
"usageLevel" : "string",
"prescriptionFormItems" : [ {
"id" : "string",
"prescriptionFormId" : "string",
"productId" : "string",
"type" : 1,
"subType" : 1,
"name" : "string",
"specification" : "string",
"manufacturer" : "string",
"usage" : "string",
"ivgtt" : 0.0,
"ivgttUnit" : "string",
"freq" : "string",
"dosage" : "string",
"dosageUnit" : "string",
"days" : 0,
"specialRequirement" : "string",
"isDismounting" : 0,
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"groupId" : 0,
"isAst" : 0,
"astResult" : {
"result" : "阴性",
"description" : "执行人:王萍,执行时间:2022-04-13"
},
"productInfo" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
}
} ]
} ],
"prescriptionWesternForms" : [ {
"id" : "string",
"type" : 1,
"specification" : "string",
"doseCount" : 0,
"dailyDosage" : "string",
"usage" : "string",
"freq" : "string",
"requirement" : "string",
"usageLevel" : "string",
"prescriptionFormItems" : [ {
"id" : "string",
"prescriptionFormId" : "string",
"productId" : "string",
"type" : 1,
"subType" : 1,
"name" : "string",
"specification" : "string",
"manufacturer" : "string",
"usage" : "string",
"ivgtt" : 0.0,
"ivgttUnit" : "string",
"freq" : "string",
"dosage" : "string",
"dosageUnit" : "string",
"days" : 0,
"specialRequirement" : "string",
"isDismounting" : 0,
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"groupId" : 0,
"isAst" : 0,
"astResult" : {
"result" : "阴性",
"description" : "执行人:王萍,执行时间:2022-04-13"
},
"productInfo" : {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
}
} ]
} ],
"prescriptionInfusionForms" : [ {
"id" : "string",
"type" : 1,
"specification" : "string",
"doseCount" : 0,
"dailyDosage" : "string",
"usage" : "string",
"freq" : "string",
"requirement" : "string",
"usageLevel" : "string",
"prescriptionFormItems" : [ {
"id" : "string",
"prescriptionFormId" : "string",
"productId" : "string",
"type" : 1,
"subType" : 1,
"name" : "string",
"specification" : "string",
"manufacturer" : "string",
"usage" : "string",
"ivgtt" : 0.0,
"ivgttUnit" : "string",
"freq" : "string",
"dosage" : "string",
"dosageUnit" : "string",
"days" : 0,
"specialRequirement" : "string",
"isDismounting" : 0,
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"groupId" : 0,
"isAst" : 0,
"astResult" : {
"result" : "阴性",
"description" : "执行人:王萍,执行时间:2022-04-13"
},
"productInfo" : "..."
} ]
} ],
"prescriptionExternalForms" : [ {
"id" : "string",
"type" : 1,
"specification" : "string",
"doseCount" : 0,
"dailyDosage" : "string",
"usage" : "string",
"freq" : "string",
"requirement" : "string",
"usageLevel" : "string",
"prescriptionFormItems" : [ {
"id" : "string",
"prescriptionFormId" : "string",
"productId" : "string",
"type" : 1,
"subType" : 1,
"name" : "string",
"specification" : "string",
"manufacturer" : "string",
"usage" : "string",
"ivgtt" : 0.0,
"ivgttUnit" : "string",
"freq" : "string",
"dosage" : "string",
"dosageUnit" : "string",
"days" : 0,
"specialRequirement" : "string",
"isDismounting" : 0,
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"groupId" : 0,
"isAst" : 0,
"astResult" : {
"result" : "阴性",
"description" : "执行人:王萍,执行时间:2022-04-13"
},
"productInfo" : "..."
} ]
} ],
"productForms" : [ {
"id" : "string",
"type" : 2,
"productFormItems" : [ {
"id" : "string",
"productFormId" : "string",
"productId" : "string",
"name" : "string",
"unitCount" : 0.0,
"unit" : "string",
"unitPrice" : 0.0,
"isDismounting" : 0,
"type" : 1,
"subType" : 0,
"days" : 0,
"dailyDosage" : 0,
"remark" : "小心使用"
} ]
} ]
}
}
5.6.4. 按天查询门诊单
GET /api/v2/open-agency/outpatient/query-by-date
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
date |
日期(格式yyyy-MM-dd) |
string |
|
Query |
limit |
每页显示条数,默认20,最大100 |
integer (int32) |
|
Query |
offset |
分页起始下标,默认0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/query-by-date?date=2022-01-03
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"patientOrderId" : "string",
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"created" : "string",
"doctorId" : "string",
"doctorName" : "string",
"patientOrderNo" : "0000000001",
"status" : 0,
"statusName" : "string"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.7. 收费接口
5.7.1. 查询指定日期的收费单
GET /api/v2/open-agency/charge/query-by-date
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Query |
date |
日期 yyyy-MM-dd |
string (date-time) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/charge/query-by-date?date=2023-03-01
HTTP响应示例
响应 200
{
"data" : {
"chargeSheets" : [ {
"id" : "string",
"patientOrderId" : "string",
"created" : "string",
"doctorName" : "string",
"isDraft" : 0,
"status" : 0,
"owedStatus" : 0,
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"type" : 1,
"isClosed" : 0
} ]
}
}
5.7.2. 获取收费单明细
GET /api/v2/open-agency/charge/query-detail/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
收费单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/charge/query-detail/ffffffff00000000220e67a8116d8000
HTTP响应示例
响应 200
{
"data" : {
"id" : "ffffffff00000000220e67a8116d8000",
"status" : 0,
"type" : 1,
"created" : "2022-04-06 15:12:53",
"receivableFee" : 0.01,
"receivedFee" : 0.0,
"refundFee" : 0.01,
"discountFee" : -10.0,
"refundTime" : "2022-04-07 15:12:53",
"charger" : {
"id" : "string",
"name" : "张三"
},
"deliveryInfo" : {
"addressProvinceName" : "四川省",
"addressCityName" : "成都市",
"addressDistrictName" : "高新区",
"addressDetail" : "四川省成都市高新区xxx街道xxx",
"deliveryName" : "张三",
"deliveryMobile" : "18088888888",
"deliveryCompany" : {
"id" : "127203805890060288",
"name" : "string"
},
"deliveryOrderNo" : "20827634879930368",
"deliveryPayType" : 1,
"deliveryFee" : 10.0
},
"doctor" : {
"id" : "string",
"mobile" : "18088888888",
"name" : "张三",
"sex" : "男",
"headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
"introduction" : "毕业于陆军军医大学临床医学七年制",
"practiceImgUrl" : "string",
"doctorPageUrl" : "string",
"doctorTags" : "省级名中医、市级名中医"
},
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"medicalRecord" : {
"id" : "string",
"outpatientSheetId" : "ffffffff00000000094c2a500293c000",
"chiefComplaint" : "咽痛,干咳,咳痰",
"pastHistory" : "既往体健,既往有高血压",
"familyHistory" : "string",
"presentHistory" : "string",
"physicalExamination" : "string",
"diagnosis" : "急性上呼吸道感染",
"doctorAdvice" : "string",
"syndrome" : "string",
"therapy" : "string",
"chineseExamination" : "string",
"wearGlassesHistory" : "近视",
"obstetricalHistory" : "string",
"eyeExamination" : {
"items" : [ {
"key" : "string",
"name" : "string",
"rightEyeValue" : "string",
"leftEyeValue" : "string"
} ]
},
"allergicHistory" : "青霉素过敏",
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
},
"chargeFormItems" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ "..." ]
} ]
} ],
"chargeTransactions" : [ {
"id" : "ffffffff00000000220e67a8116d8001",
"payMode" : 1,
"paySubMode" : 1,
"payModeName" : "ABC支付",
"payModeDisplayName" : "ABC支付-微信",
"amount" : 0.0,
"created" : "2022-04-06 15:12:53",
"isRefunded" : 0,
"chargeTransactionRecords" : [ {
"id" : "ffffffff00000000265ff80811ab200x",
"transactionId" : "ffffffff00000000265ff80811ab2004",
"chargeType" : 1,
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"created" : "2022-04-06 15:12:53",
"sceneType" : 0,
"composeChildren" : [ {
"id" : "ffffffff00000000265ff80811ab200x",
"transactionId" : "ffffffff00000000265ff80811ab2004",
"chargeType" : 1,
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"created" : "2022-04-06 15:12:53",
"sceneType" : 0,
"composeChildren" : [ "..." ]
} ]
} ]
} ],
"chargeTransactionPaidRecords" : [ {
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"records" : 0
} ],
"sellerId" : "ffffff000000xxxxx",
"sellerName" : "张三",
"registrationSheetId" : "ffffffff0000000025b0df48001ae013",
"patientOrderId" : "ffffffff00000000220e67a8116d8000",
"isDraft" : 0,
"isClosed" : 0,
"chargedTime" : "2022-04-06 15:12:53"
}
}
5.7.3. 收费单付款(支持部分收费)
PUT /api/v2/open-agency/charge/{chargeSheetId}/pay
说明
部分收费示例:例如一个收费单应收总金额为1000元。第一次部分收200元:needPayFee=1000,amount=200; 第二次部分收300元:needPayFee=800,amount=300; 第三次全收500元:needPayFee=500,amount=500;
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
chargeSheetId |
收费单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/charge/string/pay
请求 body
{
"payMode" : 1,
"amount" : 100.0,
"needPayFee" : 1000.0,
"expectedOddFee" : 0.52,
"operatorId" : "00000000000000000000000000000000",
"comment" : "来自互联网医院"
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"patientOrderId" : "string",
"status" : 2,
"statusName" : "已收费",
"needPay" : 100.0,
"receivedFee" : 100.0
}
}
5.7.4. 收费单退款(支持部分退)
PUT /api/v2/open-agency/charge/{chargeSheetId}/refund
说明
只退指定商品:chargeForms 中只传需要退的商品即可,然后 needRefundFee 和 refundFee 传指定商品的金额总和即可。 退到不同的支付方式:如果需要全退 100 块钱,但是要退到两个不同的支付方式,可以在第一次退费的时候传所有需要退费的商品到 chargeForms 中进行退费,然后传 needRefundFee=100, refundFee=50 退到支付方式A,这个时候所有的商品都已经退完了,但是“欠退50块钱”,第二次退费的时候,不传需要退费商品到 chargeForms 中(因为第一次已经把商品退完了),然后 needRefundFee=0 refundFee=50 退到支付方式B
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
chargeSheetId |
收费单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/charge/string/refund
请求 body
{
"operatorId" : "00000000000000000000000000000000",
"needRefundFee" : 0.0,
"refundFee" : 0.0,
"payMode" : 1,
"chargeForms" : [ {
"id" : "00000000000000000000000000000000",
"chargeFormItems" : [ {
"id" : "00000000000000000000000000000000",
"unitCount" : 1.0,
"doseCount" : 1.0
} ]
} ]
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"status" : 2,
"statusName" : "已收费",
"refundFee" : 10.0,
"refundedFee" : 20.0
}
}
5.7.5. 设置或修改收费单快递信息
PUT /api/v2/open-agency/charge/{chargeSheetId}/delivery
说明
支持收费完成后修改快递信息
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
chargeSheetId |
收费单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/charge/string/delivery
请求 body
{
"addressProvinceId" : "510000",
"addressProvinceName" : "四川",
"addressCityId" : "510100",
"addressCityName" : "成都市",
"addressDistrictId" : "510109",
"addressDistrictName" : "高新区",
"addressDetail" : "交子大道180号",
"deliveryName" : "张三",
"deliveryMobile" : "18012312312",
"deliveryCompanyName" : "顺丰快递",
"deliveryFee" : 12.0,
"deliveryOrderNo" : "string",
"deliveryPayType" : 0,
"operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "ffffffff00000000220e67a8116d8000",
"status" : 0,
"type" : 1,
"created" : "2022-04-06 15:12:53",
"receivableFee" : 0.01,
"receivedFee" : 0.0,
"refundFee" : 0.01,
"discountFee" : -10.0,
"refundTime" : "2022-04-07 15:12:53",
"charger" : {
"id" : "string",
"name" : "张三"
},
"deliveryInfo" : {
"addressProvinceName" : "四川省",
"addressCityName" : "成都市",
"addressDistrictName" : "高新区",
"addressDetail" : "四川省成都市高新区xxx街道xxx",
"deliveryName" : "张三",
"deliveryMobile" : "18088888888",
"deliveryCompany" : {
"id" : "127203805890060288",
"name" : "string"
},
"deliveryOrderNo" : "20827634879930368",
"deliveryPayType" : 1,
"deliveryFee" : 10.0
},
"doctor" : {
"id" : "string",
"mobile" : "18088888888",
"name" : "张三",
"sex" : "男",
"headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
"introduction" : "毕业于陆军军医大学临床医学七年制",
"practiceImgUrl" : "string",
"doctorPageUrl" : "string",
"doctorTags" : "省级名中医、市级名中医"
},
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"medicalRecord" : {
"id" : "string",
"outpatientSheetId" : "ffffffff00000000094c2a500293c000",
"chiefComplaint" : "咽痛,干咳,咳痰",
"pastHistory" : "既往体健,既往有高血压",
"familyHistory" : "string",
"presentHistory" : "string",
"physicalExamination" : "string",
"diagnosis" : "急性上呼吸道感染",
"doctorAdvice" : "string",
"syndrome" : "string",
"therapy" : "string",
"chineseExamination" : "string",
"wearGlassesHistory" : "近视",
"obstetricalHistory" : "string",
"eyeExamination" : {
"items" : [ {
"key" : "string",
"name" : "string",
"rightEyeValue" : "string",
"leftEyeValue" : "string"
} ]
},
"allergicHistory" : "青霉素过敏",
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
},
"chargeFormItems" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ "..." ]
} ]
} ],
"chargeTransactions" : [ {
"id" : "ffffffff00000000220e67a8116d8001",
"payMode" : 1,
"paySubMode" : 1,
"payModeName" : "ABC支付",
"payModeDisplayName" : "ABC支付-微信",
"amount" : 0.0,
"created" : "2022-04-06 15:12:53",
"isRefunded" : 0,
"chargeTransactionRecords" : [ {
"id" : "ffffffff00000000265ff80811ab200x",
"transactionId" : "ffffffff00000000265ff80811ab2004",
"chargeType" : 1,
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"created" : "2022-04-06 15:12:53",
"sceneType" : 0,
"composeChildren" : [ {
"id" : "ffffffff00000000265ff80811ab200x",
"transactionId" : "ffffffff00000000265ff80811ab2004",
"chargeType" : 1,
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"created" : "2022-04-06 15:12:53",
"sceneType" : 0,
"composeChildren" : [ "..." ]
} ]
} ]
} ],
"chargeTransactionPaidRecords" : [ {
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"records" : 0
} ],
"sellerId" : "ffffff000000xxxxx",
"sellerName" : "张三",
"registrationSheetId" : "ffffffff0000000025b0df48001ae013",
"patientOrderId" : "ffffffff00000000220e67a8116d8000",
"isDraft" : 0,
"isClosed" : 0,
"chargedTime" : "2022-04-06 15:12:53"
}
}
5.7.6. 通过就诊单ID查询收费单
GET /api/v2/open-agency/charge/by-patient-order-id/{patientOrderId}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
就诊单ID |
patientOrderId |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/charge/by-patient-order-id/{patientOrderId}
HTTP响应示例
响应 200
{
"data" : {
"chargeSheets" : [ {
"id" : "ffffffff00000000220e67a8116d8000",
"status" : 0,
"type" : 1,
"created" : "2022-04-06 15:12:53",
"receivableFee" : 0.01,
"receivedFee" : 0.0,
"refundFee" : 0.01,
"discountFee" : -10.0,
"refundTime" : "2022-04-07 15:12:53",
"charger" : {
"id" : "string",
"name" : "张三"
},
"deliveryInfo" : {
"addressProvinceName" : "四川省",
"addressCityName" : "成都市",
"addressDistrictName" : "高新区",
"addressDetail" : "四川省成都市高新区xxx街道xxx",
"deliveryName" : "张三",
"deliveryMobile" : "18088888888",
"deliveryCompany" : {
"id" : "127203805890060288",
"name" : "string"
},
"deliveryOrderNo" : "20827634879930368",
"deliveryPayType" : 1,
"deliveryFee" : 10.0
},
"doctor" : {
"id" : "string",
"mobile" : "18088888888",
"name" : "张三",
"sex" : "男",
"headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
"introduction" : "毕业于陆军军医大学临床医学七年制",
"practiceImgUrl" : "string",
"doctorPageUrl" : "string",
"doctorTags" : "省级名中医、市级名中医"
},
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"medicalRecord" : {
"id" : "string",
"outpatientSheetId" : "ffffffff00000000094c2a500293c000",
"chiefComplaint" : "咽痛,干咳,咳痰",
"pastHistory" : "既往体健,既往有高血压",
"familyHistory" : "string",
"presentHistory" : "string",
"physicalExamination" : "string",
"diagnosis" : "急性上呼吸道感染",
"doctorAdvice" : "string",
"syndrome" : "string",
"therapy" : "string",
"chineseExamination" : "string",
"wearGlassesHistory" : "近视",
"obstetricalHistory" : "string",
"eyeExamination" : {
"items" : [ {
"key" : "string",
"name" : "string",
"rightEyeValue" : "string",
"leftEyeValue" : "string"
} ]
},
"allergicHistory" : "青霉素过敏",
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
},
"chargeFormItems" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ "..." ]
} ]
} ],
"chargeTransactions" : [ {
"id" : "ffffffff00000000220e67a8116d8001",
"payMode" : 1,
"paySubMode" : 1,
"payModeName" : "ABC支付",
"payModeDisplayName" : "ABC支付-微信",
"amount" : 0.0,
"created" : "2022-04-06 15:12:53",
"isRefunded" : 0,
"chargeTransactionRecords" : [ {
"id" : "ffffffff00000000265ff80811ab200x",
"transactionId" : "ffffffff00000000265ff80811ab2004",
"chargeType" : 1,
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"created" : "2022-04-06 15:12:53",
"sceneType" : 0,
"composeChildren" : [ {
"id" : "ffffffff00000000265ff80811ab200x",
"transactionId" : "ffffffff00000000265ff80811ab2004",
"chargeType" : 1,
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"created" : "2022-04-06 15:12:53",
"sceneType" : 0,
"composeChildren" : [ "..." ]
} ]
} ]
} ],
"chargeTransactionPaidRecords" : [ {
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"records" : 0
} ],
"sellerId" : "ffffff000000xxxxx",
"sellerName" : "张三",
"registrationSheetId" : "ffffffff0000000025b0df48001ae013",
"patientOrderId" : "ffffffff00000000220e67a8116d8000",
"isDraft" : 0,
"isClosed" : 0,
"chargedTime" : "2022-04-06 15:12:53"
} ]
}
}
5.7.7. 查询患者的收费单
GET /api/v2/open-agency/charge/patient/{patientId}
说明
时间跨度最大为三个月
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
patientId |
患者ID |
string |
|
Query |
beginDate |
开始日期,yyyy-MM-dd,为空则默认为三个月前 |
string (date) |
|
Query |
endDate |
结束日期,yyyy-MM-dd,为空则默认为今天 |
string (date) |
|
Query |
limit |
分页大小,默认为 10,最大为 20 |
integer (int32) |
|
Query |
offset |
分页偏移 |
integer (int32) |
|
Query |
status |
收费单状态 0:未付费 1:部分付费 2:已付费 3:部分退费 4:已退费,支持传多个以逗号分割 |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/charge/patient/ffffffff00000000349018418ff74000
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "ffffffff00000000348e4da767258000",
"patientOrderId" : "ffffffff0000000034c1d861a2eb8000",
"doctorId" : "ffffffff0000000034c1ed8a86f00003",
"doctorName" : "王五",
"status" : 0,
"receivableFee" : 20.0,
"sellerId" : "ffffffff00000000287b8f500fa68000",
"sellerName" : "李四",
"chargerId" : "ffffffff00000000348e4e60e7290000",
"chargerName" : "张三",
"type" : 1,
"created" : "2022-04-06 15:12:53"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.7.8. 取消收费单快递费
PUT /api/v2/open-agency/charge/{chargeSheetId}/delivery/cancel
说明
只有在待收费状态下可取消
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
chargeSheetId |
收费单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/charge/string/delivery/cancel
请求 body
{
"operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "ffffffff00000000220e67a8116d8000",
"status" : 0,
"type" : 1,
"created" : "2022-04-06 15:12:53",
"receivableFee" : 0.01,
"receivedFee" : 0.0,
"refundFee" : 0.01,
"discountFee" : -10.0,
"refundTime" : "2022-04-07 15:12:53",
"charger" : {
"id" : "string",
"name" : "张三"
},
"deliveryInfo" : {
"addressProvinceName" : "四川省",
"addressCityName" : "成都市",
"addressDistrictName" : "高新区",
"addressDetail" : "四川省成都市高新区xxx街道xxx",
"deliveryName" : "张三",
"deliveryMobile" : "18088888888",
"deliveryCompany" : {
"id" : "127203805890060288",
"name" : "string"
},
"deliveryOrderNo" : "20827634879930368",
"deliveryPayType" : 1,
"deliveryFee" : 10.0
},
"doctor" : {
"id" : "string",
"mobile" : "18088888888",
"name" : "张三",
"sex" : "男",
"headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
"introduction" : "毕业于陆军军医大学临床医学七年制",
"practiceImgUrl" : "string",
"doctorPageUrl" : "string",
"doctorTags" : "省级名中医、市级名中医"
},
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"medicalRecord" : {
"id" : "string",
"outpatientSheetId" : "ffffffff00000000094c2a500293c000",
"chiefComplaint" : "咽痛,干咳,咳痰",
"pastHistory" : "既往体健,既往有高血压",
"familyHistory" : "string",
"presentHistory" : "string",
"physicalExamination" : "string",
"diagnosis" : "急性上呼吸道感染",
"doctorAdvice" : "string",
"syndrome" : "string",
"therapy" : "string",
"chineseExamination" : "string",
"wearGlassesHistory" : "近视",
"obstetricalHistory" : "string",
"eyeExamination" : {
"items" : [ {
"key" : "string",
"name" : "string",
"rightEyeValue" : "string",
"leftEyeValue" : "string"
} ]
},
"allergicHistory" : "青霉素过敏",
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
},
"chargeFormItems" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ "..." ]
} ]
} ],
"chargeTransactions" : [ {
"id" : "ffffffff00000000220e67a8116d8001",
"payMode" : 1,
"paySubMode" : 1,
"payModeName" : "ABC支付",
"payModeDisplayName" : "ABC支付-微信",
"amount" : 0.0,
"created" : "2022-04-06 15:12:53",
"isRefunded" : 0,
"chargeTransactionRecords" : [ {
"id" : "ffffffff00000000265ff80811ab200x",
"transactionId" : "ffffffff00000000265ff80811ab2004",
"chargeType" : 1,
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"created" : "2022-04-06 15:12:53",
"sceneType" : 0,
"composeChildren" : [ {
"id" : "ffffffff00000000265ff80811ab200x",
"transactionId" : "ffffffff00000000265ff80811ab2004",
"chargeType" : 1,
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"created" : "2022-04-06 15:12:53",
"sceneType" : 0,
"composeChildren" : [ "..." ]
} ]
} ]
} ],
"chargeTransactionPaidRecords" : [ {
"productId" : "00000000000000000000000000000001",
"productName" : "白术",
"productType" : 5,
"productSubType" : 0,
"composeType" : 0,
"productUnit" : "string",
"productUnitCount" : 1.0,
"doseCount" : 1.0,
"totalPrice" : 0.0,
"discountPrice" : 0.0,
"records" : 0
} ],
"sellerId" : "ffffff000000xxxxx",
"sellerName" : "张三",
"registrationSheetId" : "ffffffff0000000025b0df48001ae013",
"patientOrderId" : "ffffffff00000000220e67a8116d8000",
"isDraft" : 0,
"isClosed" : 0,
"chargedTime" : "2022-04-06 15:12:53"
}
}
5.8. 发药接口
5.8.1. 根据发药单ID查询发药单详情
GET /api/v2/open-agency/dispensing/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
发药单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/ffffffff00000000264a75300d752999
HTTP响应示例
响应 200
{
"data" : {
"clinicId" : "ffffffff000000002620d6280d751234",
"id" : "ffffffff000000002620d6280d751234",
"sourceSheetId" : "ffffffff000000002620d6280d751234",
"doctorId" : "ffffffff0000000022e9e9580179a123",
"patientOrderId" : "ffffffff0000000022e9e9580179a123",
"patientOrderNo" : "诊号:00003447",
"diagnosedDate" : "2022-07-14 12:00:00",
"medicalRecord" : {
"id" : "string",
"outpatientSheetId" : "ffffffff00000000094c2a500293c000",
"chiefComplaint" : "咽痛,干咳,咳痰",
"pastHistory" : "既往体健,既往有高血压",
"familyHistory" : "string",
"presentHistory" : "string",
"physicalExamination" : "string",
"diagnosis" : "急性上呼吸道感染",
"doctorAdvice" : "string",
"syndrome" : "string",
"therapy" : "string",
"chineseExamination" : "string",
"wearGlassesHistory" : "近视",
"obstetricalHistory" : "string",
"eyeExamination" : {
"items" : [ {
"key" : "string",
"name" : "string",
"rightEyeValue" : "string",
"leftEyeValue" : "string"
} ]
},
"allergicHistory" : "青霉素过敏",
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
},
"patientInfo" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"deliveryInfo" : {
"addressProvinceName" : "四川省",
"addressCityName" : "成都市",
"addressDistrictName" : "高新区",
"addressDetail" : "四川省成都市高新区xxx街道xxx",
"deliveryName" : "张三",
"deliveryMobile" : "18088888888",
"deliveryCompany" : {
"id" : "127203805890060288",
"name" : "string"
},
"deliveryOrderNo" : "20827634879930368",
"deliveryPayType" : 1,
"deliveryFee" : 10.0
},
"deliveredStatus" : 0,
"deliveryType" : 0,
"status" : 0,
"statusName" : "未发药",
"dispensedBy" : "ffffffff000000002622cbd801e7777",
"dispensedByName" : "张三",
"dispensedTime" : "2022-07-14 12:00:00",
"created" : "2022-07-14 12:00:00",
"pharmacy" : {
"no" : 0
},
"netIncomeFee" : 43.75,
"doctor" : {
"id" : "string",
"name" : "string"
},
"department" : {
"id" : "ffffffff0000000006dddfe002e22000",
"name" : "儿保科室",
"type" : 1,
"mainMedicalName" : "儿科",
"secondMedicalName" : "小儿呼吸"
},
"isShebaoPay" : 0,
"dispensingForms" : [ {
"id" : "ffffffff00000000264a75300d759999",
"dispseneFormType" : 0,
"numberOfHerbs" : 0,
"usageInfo" : {
"usage" : "煎服",
"freq" : "1日3次",
"medicineRequirement" : "先煎",
"doseCount" : 3,
"dailyDosage" : "1日3剂",
"requirement" : "饭前服用",
"usageLevel" : "每次150ml",
"processUsage" : "机器煎药(普通)",
"processRemark" : "加工备注信息",
"usageDays" : "约服30天",
"processBagUnitCount" : 3.0,
"totalProcessCount" : 9.0
},
"totalPrice" : 30.23,
"dispensingFormItems" : [ {
"id" : "ffffffff00000000264a75300d757777",
"sourceFormItemId" : "ffffffff00000000264a75300d757778",
"status" : 1,
"productId" : "02bb5357a5df05b65d028f8868472222",
"productName" : "罗红霉素胶囊",
"unit" : "12g/剂*3剂 的g",
"unitCount" : "12g/剂*3剂 的12",
"doseCount" : "12g/剂*3剂 的3 (同发药处方上的剂数相同)",
"totalCount" : "12g/剂*3剂 的36=12*3 (totalCount = unitCount * doseCount)",
"usageInfo" : {
"usage" : "煎服",
"freq" : "1日3次",
"medicineRequirement" : "先煎",
"doseCount" : 3,
"dailyDosage" : "1日3剂",
"requirement" : "饭前服用",
"usageLevel" : "每次150ml",
"processUsage" : "机器煎药(普通)",
"processRemark" : "加工备注信息",
"usageDays" : "约服30天",
"processBagUnitCount" : 3.0,
"totalProcessCount" : 9.0
},
"productInfo" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"totalPrice" : 10.3,
"dispensingBatches" : [ {
"action" : "发药",
"stockId" : 123456,
"supplier" : {
"id" : "ffffffff0000000034e6cae04206c09c",
"name" : "药品供应商"
},
"batchId" : 3123455,
"batchNo" : "Z123",
"productionDate" : "2023-01-01",
"expiryDate" : "2026-01-01",
"packageCount" : -10.0,
"piecePrice" : 1.0,
"packagePrice" : 10.0,
"pieceCount" : -10.0,
"packageCostPrice" : 10.0,
"costPrice" : -10.0,
"salePrice" : 10.0,
"stockInOutDetailId" : "Z123",
"created" : "2023-01-01 00:00:00"
} ]
} ],
"compoundInfo" : {
"compoundBy" : "ffffffff00000000264a75300d757777",
"compoundByName" : "张三",
"compoundByHandSign" : "http://www.baidu.com",
"compoundTime" : "2025-01-09 17:20:00"
},
"auditInfo" : {
"auditBy" : "ffffffff00000000264a75300d757777",
"auditByName" : "张三",
"auditByHandSign" : "http://www.baidu.com",
"auditTime" : "2025-01-09 17:20:00"
}
} ]
}
}
5.8.2. 按天查询发药单
GET /api/v2/open-agency/dispensing/query-by-date
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
date |
日期(格式yyyy-MM-dd) |
string (date) |
|
Query |
dateType |
日期类型 0:发药单创建时间 1:发药单操作时间(如果发药单在几天都发生过发药或退药操作,则这几天都能查询到该发药单),默认为0创建时间 |
integer (int32) |
|
Query |
limit |
每页显示条数 |
integer (int32) |
|
Query |
offset |
分页起始下标 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/query-by-date?date=2022-01-03
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"patientOrderId" : "string",
"patientOrderNo" : "000001",
"chargeSheetId" : "string",
"pharmacyNo" : 0,
"pharmacyType" : 0,
"status" : 0,
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
}
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.8.3. 发药
PUT /api/v2/open-agency/dispensing/{dispenseSheetId}/dispense-all
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
dispenseSheetId |
发药单id |
string |
|
Query |
operatorId |
发药员id |
string |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/ffffffff00000000264a75300d752999/dispense-all
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.8.4. 退药
PUT /api/v2/open-agency/dispensing/{dispenseSheetId}/undispense-all
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
dispenseSheetId |
发药单id |
string |
|
Query |
operatorId |
发药员id |
string |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/ffffffff00000000264a75300d752999/undispense-all
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.8.5. 修改加工状态
PUT /api/v2/open-agency/dispensing/processing-status
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/processing-status
请求 body
{
"externalTrace" : [ {
"content" : "string",
"time" : "yyyy-MM-dd HH:mm:ss"
} ],
"dispensingSheetId" : "string",
"dispensingFormId" : "string",
"processGeneralStatus" : 0
}
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.8.6. 修改快递信息
PUT /api/v2/open-agency/dispensing/delivery
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/delivery
请求 body
{
"externalTrace" : [ {
"content" : "string",
"time" : "yyyy-MM-dd HH:mm:ss"
} ],
"dispensingSheetId" : "string",
"deliveryStatus" : 700,
"deliveryOrderNo" : "string"
}
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.8.7. 更新快递物流信息
PUT /api/v2/open-agency/dispensing/delivery/trace/{deliveryOrderNo}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
deliveryOrderNo |
快递单号 |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/delivery/trace/string
请求 body
{
"deliveryTraceData" : [ {
"context" : "string",
"ftime" : "string"
} ]
}
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.8.8. 根据收费单ID查询发药单详情列表
GET /api/v2/open-agency/dispensing/by-charge-sheet-id/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
收费单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/by-charge-sheet-id/string
HTTP响应示例
响应 200
{
"data" : {
"dispensingSheets" : [ {
"clinicId" : "ffffffff000000002620d6280d751234",
"id" : "ffffffff000000002620d6280d751234",
"sourceSheetId" : "ffffffff000000002620d6280d751234",
"doctorId" : "ffffffff0000000022e9e9580179a123",
"patientOrderId" : "ffffffff0000000022e9e9580179a123",
"patientOrderNo" : "诊号:00003447",
"diagnosedDate" : "2022-07-14 12:00:00",
"medicalRecord" : {
"id" : "string",
"outpatientSheetId" : "ffffffff00000000094c2a500293c000",
"chiefComplaint" : "咽痛,干咳,咳痰",
"pastHistory" : "既往体健,既往有高血压",
"familyHistory" : "string",
"presentHistory" : "string",
"physicalExamination" : "string",
"diagnosis" : "急性上呼吸道感染",
"doctorAdvice" : "string",
"syndrome" : "string",
"therapy" : "string",
"chineseExamination" : "string",
"wearGlassesHistory" : "近视",
"obstetricalHistory" : "string",
"eyeExamination" : {
"items" : [ {
"key" : "string",
"name" : "string",
"rightEyeValue" : "string",
"leftEyeValue" : "string"
} ]
},
"allergicHistory" : "青霉素过敏",
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ]
},
"patientInfo" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"deliveryInfo" : {
"addressProvinceName" : "四川省",
"addressCityName" : "成都市",
"addressDistrictName" : "高新区",
"addressDetail" : "四川省成都市高新区xxx街道xxx",
"deliveryName" : "张三",
"deliveryMobile" : "18088888888",
"deliveryCompany" : {
"id" : "127203805890060288",
"name" : "string"
},
"deliveryOrderNo" : "20827634879930368",
"deliveryPayType" : 1,
"deliveryFee" : 10.0
},
"deliveredStatus" : 0,
"deliveryType" : 0,
"status" : 0,
"statusName" : "未发药",
"dispensedBy" : "ffffffff000000002622cbd801e7777",
"dispensedByName" : "张三",
"dispensedTime" : "2022-07-14 12:00:00",
"created" : "2022-07-14 12:00:00",
"pharmacy" : {
"no" : 0
},
"netIncomeFee" : 43.75,
"doctor" : {
"id" : "string",
"name" : "string"
},
"department" : {
"id" : "ffffffff0000000006dddfe002e22000",
"name" : "儿保科室",
"type" : 1,
"mainMedicalName" : "儿科",
"secondMedicalName" : "小儿呼吸"
},
"isShebaoPay" : 0,
"dispensingForms" : [ {
"id" : "ffffffff00000000264a75300d759999",
"dispseneFormType" : 0,
"numberOfHerbs" : 0,
"usageInfo" : {
"usage" : "煎服",
"freq" : "1日3次",
"medicineRequirement" : "先煎",
"doseCount" : 3,
"dailyDosage" : "1日3剂",
"requirement" : "饭前服用",
"usageLevel" : "每次150ml",
"processUsage" : "机器煎药(普通)",
"processRemark" : "加工备注信息",
"usageDays" : "约服30天",
"processBagUnitCount" : 3.0,
"totalProcessCount" : 9.0
},
"totalPrice" : 30.23,
"dispensingFormItems" : [ {
"id" : "ffffffff00000000264a75300d757777",
"sourceFormItemId" : "ffffffff00000000264a75300d757778",
"status" : 1,
"productId" : "02bb5357a5df05b65d028f8868472222",
"productName" : "罗红霉素胶囊",
"unit" : "12g/剂*3剂 的g",
"unitCount" : "12g/剂*3剂 的12",
"doseCount" : "12g/剂*3剂 的3 (同发药处方上的剂数相同)",
"totalCount" : "12g/剂*3剂 的36=12*3 (totalCount = unitCount * doseCount)",
"usageInfo" : {
"usage" : "煎服",
"freq" : "1日3次",
"medicineRequirement" : "先煎",
"doseCount" : 3,
"dailyDosage" : "1日3剂",
"requirement" : "饭前服用",
"usageLevel" : "每次150ml",
"processUsage" : "机器煎药(普通)",
"processRemark" : "加工备注信息",
"usageDays" : "约服30天",
"processBagUnitCount" : 3.0,
"totalProcessCount" : 9.0
},
"productInfo" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"totalPrice" : 10.3,
"dispensingBatches" : [ {
"action" : "发药",
"stockId" : 123456,
"supplier" : {
"id" : "ffffffff0000000034e6cae04206c09c",
"name" : "药品供应商"
},
"batchId" : 3123455,
"batchNo" : "Z123",
"productionDate" : "2023-01-01",
"expiryDate" : "2026-01-01",
"packageCount" : -10.0,
"piecePrice" : 1.0,
"packagePrice" : 10.0,
"pieceCount" : -10.0,
"packageCostPrice" : 10.0,
"costPrice" : -10.0,
"salePrice" : 10.0,
"stockInOutDetailId" : "Z123",
"created" : "2023-01-01 00:00:00"
} ]
} ],
"compoundInfo" : {
"compoundBy" : "ffffffff00000000264a75300d757777",
"compoundByName" : "张三",
"compoundByHandSign" : "http://www.baidu.com",
"compoundTime" : "2025-01-09 17:20:00"
},
"auditInfo" : {
"auditBy" : "ffffffff00000000264a75300d757777",
"auditByName" : "张三",
"auditByHandSign" : "http://www.baidu.com",
"auditTime" : "2025-01-09 17:20:00"
}
} ]
} ]
}
}
5.8.9. 查询患者发药单
GET /api/v2/open-agency/dispensing/patient/{patientId}
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
patientId |
patientId |
string |
|
Query |
beginDate |
开始日期,yyyy-MM-dd,为空则默认为三个月前 |
string (date) |
|
Query |
endDate |
结束日期,yyyy-MM-dd,为空则默认为今天 |
string (date) |
|
Query |
limit |
分页大小,默认为 10,最大为 20 |
integer (int32) |
|
Query |
offset |
分页偏移 |
integer (int32) |
|
Query |
status |
发药单状态 0:未发药 1:已发药 2:已退药 3:部分发药 |
integer (int32) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/patient/string
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"patientOrderId" : "string",
"chargeSheetId" : "string",
"pharmacyNo" : 0,
"pharmacyType" : 0,
"status" : 0,
"created" : "2024-05-30 08:13:00",
"sellerId" : "ffffffff000000002620d6280d751234",
"sellerName" : "张三"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.9. 检查检验接口
5.9.1. 按患者查询检查检验单
GET /api/v2/open-agency/examination/query-by-patient/{patientId}
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
patientId |
患者ID |
string |
|
Query |
endTime |
结束时间(格式yyyy-MM-dd HH:mm:ss) |
string |
|
Query |
limit |
每页显示条数 |
integer (int32) |
|
Query |
offset |
分页起始下标 |
integer (int32) |
|
Query |
startTime |
开始时间(格式yyyy-MM-dd HH:mm:ss) |
string |
|
Query |
type |
类型 1:检验 2:检查 |
integer (int32) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/examination/query-by-patient/af38e7591b864838a411c1fd9cd835ac
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"patientOrderId" : "string",
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"name" : "string",
"type" : 1,
"deviceType" : 0,
"businessType" : 0,
"created" : "string",
"status" : 0,
"statusName" : "string"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.9.2. 按时间查询检查检验单
GET /api/v2/open-agency/examination/all/query-by-date
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
dateFieldType |
查询日期类型: 1,创建时间; 2,最后修改时间; 3,检验/检查时间 4,审核时间 5,报告时间 |
integer (int32) |
|
Query |
endTime |
结束时间(格式yyyy-MM-dd HH:mm:ss) |
string |
|
Query |
limit |
每页显示条数 |
integer (int32) |
|
Query |
offset |
分页起始下标 |
integer (int32) |
|
Query |
startTime |
开始时间(格式yyyy-MM-dd HH:mm:ss) |
string |
|
Query |
type |
1:检验;2:检查 |
integer (int32) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/examination/all/query-by-date
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"orderNo" : "string",
"productId" : "string",
"products" : [ {
"productId" : "string",
"productName" : "string",
"examinationSheetId" : "string"
} ],
"productIds" : [ "string" ],
"name" : "string",
"type" : 1,
"deviceType" : 0,
"businessType" : 0,
"sampleType" : "string",
"patientOrderNo" : "string",
"patientOrderType" : "string",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"createdTime" : "string",
"patientInfo" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"status" : 0,
"statusName" : "待检"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.9.3. 按就诊号查询检查检验单
GET /api/v2/open-agency/examination/query-by-patient-order-no
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Query |
patientOrderNo |
就诊号 |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/examination/query-by-patient-order-no?patientOrderNo=12212
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"diagnosis" : "string",
"id" : "string",
"orderNo" : "string",
"productId" : "string",
"products" : [ {
"productId" : "string",
"productName" : "string",
"examinationSheetId" : "string"
} ],
"productIds" : [ "string" ],
"name" : "string",
"type" : 1,
"deviceType" : 0,
"businessType" : 0,
"sampleType" : "string",
"patientOrderNo" : "string",
"patientOrderType" : "string",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"createdTime" : "string",
"patientInfo" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"status" : 0,
"statusName" : "待检"
} ]
}
}
5.9.4. 查询检查检验单详情
GET /api/v2/open-agency/examination/examination-sheet-detail/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
检查检验单id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/examination/examination-sheet-detail/string
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"outpatientFormItemId" : "string",
"patientOrderId" : "string",
"patientOrderNumber" : "string",
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"sn" : "100",
"idCard" : "string",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
}
},
"doctorId" : "string",
"doctorName" : "string",
"doctorDepartmentId" : "string",
"doctorDepartmentName" : "string",
"sellerId" : "string",
"sellerName" : "string",
"sellerDepartmentId" : "string",
"sellerDepartmentName" : "string",
"productId" : "string",
"products" : [ {
"productId" : "string",
"productName" : "string",
"examinationSheetId" : "string"
} ],
"productIds" : [ "string" ],
"composeParentProductId" : "string",
"composeParentName" : "string",
"name" : "string",
"orderNo" : "202302140038",
"status" : 0,
"statusName" : "string",
"sampleType" : "string",
"samplerId" : "string",
"samplerName" : "string",
"sampleTime" : "string",
"collectorId" : "string",
"collectorName" : "string",
"collectTime" : "string",
"results" : [ {
"id" : "string",
"type" : 1,
"name" : "string",
"enName" : "string",
"unit" : "string",
"itemCode" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"productId" : "string",
"resultDisplayScale" : 0,
"value" : { },
"valueType" : "STRING",
"abnormalFlag" : "N",
"abnormalText" : "string"
} ],
"eyeResults" : [ {
"productId" : "string",
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"inspectType" : 0,
"children" : [ {
"items" : [ {
"id" : "string",
"productId" : "string",
"type" : 0,
"name" : "string",
"enName" : "string",
"unit" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"resultDisplayScale" : 0,
"inspectType" : 0,
"componentType" : 0,
"options" : [ "string" ],
"constraints" : [ {
"message" : "string",
"required" : true,
"precision" : 0,
"scale" : 0,
"min" : 0,
"max" : 0,
"size" : 0,
"unit" : "string",
"validateType" : 0
} ],
"value" : "string",
"sort" : 0,
"groupId" : 0,
"displayName" : "string"
} ]
} ]
} ]
} ]
} ],
"checker" : {
"id" : "string",
"name" : "string",
"date" : "string"
}
} ],
"reports" : [ {
"id" : "string",
"imageFiles" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"videoDescription" : "string",
"suggestion" : "string",
"inspectionSite" : "string",
"deviceModelDesc" : "string",
"diagnosisFlag" : 0,
"recordDoctorId" : "string",
"consultationDoctorId" : "string",
"recordDoctorName" : "string",
"consultationDoctorName" : "string",
"diagnosisEntryItems" : [ {
"id" : 0,
"name" : "string",
"abnormalFlag" : 0
} ]
} ],
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"remark" : "string",
"testerId" : "string",
"testerName" : "string",
"testTime" : "string",
"checkerId" : "string",
"checkerName" : "string",
"checkTime" : "string",
"reportTime" : "string",
"created" : "string",
"type" : 1,
"subType" : 20,
"diagnosis" : "急性上呼吸道感染",
"reportUrl" : "string",
"examinationApplySheetNo" : "string",
"bedNo" : "string",
"deviceType" : 0,
"businessType" : 0,
"relationPatientOrderId" : "string",
"registrationFormItem" : {
"patientOrderId" : "string",
"registrationSheetId" : "string",
"patientId" : "string",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"orderNo" : "上午 01号",
"reserveDate" : "2019-04-04",
"reserveTime" : "10:10~10:30",
"isReserved" : 1,
"status" : 10,
"signIn" : 0,
"consultingRoomId" : "string",
"consultingRoomName" : "string",
"type" : 0,
"payStatus" : 0,
"code" : 0,
"registrationType" : 0,
"created" : "2022-06-23 18:45:00"
}
}
}
5.9.5. 按单号查询检查检验单(条形码)
GET /api/v2/open-agency/examination/by-order-no/{orderNo}/{type}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
orderNo |
订单号 |
string |
Path |
type |
类型 1:检验 2:检查 |
integer (int32) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/examination/by-order-no/string/1
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"outpatientFormItemId" : "string",
"patientOrderId" : "string",
"patientOrderNumber" : "string",
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"sn" : "100",
"idCard" : "string",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
}
},
"doctorId" : "string",
"doctorName" : "string",
"doctorDepartmentId" : "string",
"doctorDepartmentName" : "string",
"sellerId" : "string",
"sellerName" : "string",
"sellerDepartmentId" : "string",
"sellerDepartmentName" : "string",
"productId" : "string",
"products" : [ {
"productId" : "string",
"productName" : "string",
"examinationSheetId" : "string"
} ],
"productIds" : [ "string" ],
"composeParentProductId" : "string",
"composeParentName" : "string",
"name" : "string",
"orderNo" : "202302140038",
"status" : 0,
"statusName" : "string",
"sampleType" : "string",
"samplerId" : "string",
"samplerName" : "string",
"sampleTime" : "string",
"collectorId" : "string",
"collectorName" : "string",
"collectTime" : "string",
"results" : [ {
"id" : "string",
"type" : 1,
"name" : "string",
"enName" : "string",
"unit" : "string",
"itemCode" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"productId" : "string",
"resultDisplayScale" : 0,
"value" : { },
"valueType" : "STRING",
"abnormalFlag" : "N",
"abnormalText" : "string"
} ],
"eyeResults" : [ {
"productId" : "string",
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"inspectType" : 0,
"children" : [ {
"items" : [ {
"id" : "string",
"productId" : "string",
"type" : 0,
"name" : "string",
"enName" : "string",
"unit" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"resultDisplayScale" : 0,
"inspectType" : 0,
"componentType" : 0,
"options" : [ "string" ],
"constraints" : [ {
"message" : "string",
"required" : true,
"precision" : 0,
"scale" : 0,
"min" : 0,
"max" : 0,
"size" : 0,
"unit" : "string",
"validateType" : 0
} ],
"value" : "string",
"sort" : 0,
"groupId" : 0,
"displayName" : "string"
} ]
} ]
} ]
} ]
} ],
"checker" : {
"id" : "string",
"name" : "string",
"date" : "string"
}
} ],
"reports" : [ {
"id" : "string",
"imageFiles" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"videoDescription" : "string",
"suggestion" : "string",
"inspectionSite" : "string",
"deviceModelDesc" : "string",
"diagnosisFlag" : 0,
"recordDoctorId" : "string",
"consultationDoctorId" : "string",
"recordDoctorName" : "string",
"consultationDoctorName" : "string",
"diagnosisEntryItems" : [ {
"id" : 0,
"name" : "string",
"abnormalFlag" : 0
} ]
} ],
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"remark" : "string",
"testerId" : "string",
"testerName" : "string",
"testTime" : "string",
"checkerId" : "string",
"checkerName" : "string",
"checkTime" : "string",
"reportTime" : "string",
"created" : "string",
"type" : 1,
"subType" : 20,
"diagnosis" : "急性上呼吸道感染",
"reportUrl" : "string",
"examinationApplySheetNo" : "string",
"bedNo" : "string",
"deviceType" : 0,
"businessType" : 0,
"relationPatientOrderId" : "string",
"registrationFormItem" : {
"patientOrderId" : "string",
"registrationSheetId" : "string",
"patientId" : "string",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"orderNo" : "上午 01号",
"reserveDate" : "2019-04-04",
"reserveTime" : "10:10~10:30",
"isReserved" : 1,
"status" : 10,
"signIn" : 0,
"consultingRoomId" : "string",
"consultingRoomName" : "string",
"type" : 0,
"payStatus" : 0,
"code" : 0,
"registrationType" : 0,
"created" : "2022-06-23 18:45:00"
}
}
}
5.9.6. 根据检验单号修改检验单信息
PUT /api/v2/open-agency/examination/by-order-no/{orderNo}/{type}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
orderNo |
订单号 |
string |
Path |
type |
类型 1:检验 2:检查 |
integer (int32) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/examination/by-order-no/string/1
请求 body
{
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"reports" : [ {
"id" : "string",
"imageFiles" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"videoDescription" : "string",
"suggestion" : "string",
"diagnosisFlag" : 0,
"recordDoctorId" : "string",
"consultationDoctorId" : "string",
"inspectionSite" : "string",
"deviceModelDesc" : "string",
"isDeleted" : 0,
"diagnosisEntryItems" : [ {
"id" : 0,
"name" : "string",
"abnormalFlag" : 0
} ]
} ],
"results" : [ {
"id" : "string",
"type" : 1,
"name" : "string",
"enName" : "string",
"unit" : "string",
"itemCode" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"productId" : "string",
"resultDisplayScale" : 0,
"value" : { },
"valueType" : "STRING",
"abnormalFlag" : "N",
"abnormalText" : "string"
} ],
"eyeResults" : [ {
"productId" : "string",
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"inspectType" : 0,
"children" : [ {
"items" : [ {
"id" : "string",
"productId" : "string",
"type" : 0,
"name" : "string",
"enName" : "string",
"unit" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"resultDisplayScale" : 0,
"inspectType" : 0,
"componentType" : 0,
"options" : [ "string" ],
"constraints" : [ {
"message" : "string",
"required" : true,
"precision" : 0,
"scale" : 0,
"min" : 0,
"max" : 0,
"size" : 0,
"unit" : "string",
"validateType" : 0
} ],
"value" : "string",
"sort" : 0,
"groupId" : 0,
"displayName" : "string"
} ]
} ]
} ]
} ]
} ],
"checker" : {
"id" : "string",
"name" : "string",
"date" : "string"
}
} ],
"deviceModelId" : 0,
"deviceId" : 0,
"subType" : 0,
"remark" : "string",
"testerId" : "string",
"testerName" : "string",
"checkerId" : "string",
"checkerName" : "string",
"sampleType" : "string",
"testTime" : "2022-11-14 14:00",
"checkTime" : "2022-11-14 14:00",
"reportTime" : "2022-11-14 14:00",
"status" : 0,
"relationPatientOrderId" : "string"
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"outpatientFormItemId" : "string",
"patientOrderId" : "string",
"patientOrderNumber" : "string",
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"sn" : "100",
"idCard" : "string",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
}
},
"doctorId" : "string",
"doctorName" : "string",
"doctorDepartmentId" : "string",
"doctorDepartmentName" : "string",
"sellerId" : "string",
"sellerName" : "string",
"sellerDepartmentId" : "string",
"sellerDepartmentName" : "string",
"productId" : "string",
"products" : [ {
"productId" : "string",
"productName" : "string",
"examinationSheetId" : "string"
} ],
"productIds" : [ "string" ],
"composeParentProductId" : "string",
"composeParentName" : "string",
"name" : "string",
"orderNo" : "202302140038",
"status" : 0,
"statusName" : "string",
"sampleType" : "string",
"samplerId" : "string",
"samplerName" : "string",
"sampleTime" : "string",
"collectorId" : "string",
"collectorName" : "string",
"collectTime" : "string",
"results" : [ {
"id" : "string",
"type" : 1,
"name" : "string",
"enName" : "string",
"unit" : "string",
"itemCode" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"productId" : "string",
"resultDisplayScale" : 0,
"value" : { },
"valueType" : "STRING",
"abnormalFlag" : "N",
"abnormalText" : "string"
} ],
"eyeResults" : [ {
"productId" : "string",
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"inspectType" : 0,
"children" : [ {
"items" : [ {
"id" : "string",
"productId" : "string",
"type" : 0,
"name" : "string",
"enName" : "string",
"unit" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"resultDisplayScale" : 0,
"inspectType" : 0,
"componentType" : 0,
"options" : [ "string" ],
"constraints" : [ {
"message" : "string",
"required" : true,
"precision" : 0,
"scale" : 0,
"min" : 0,
"max" : 0,
"size" : 0,
"unit" : "string",
"validateType" : 0
} ],
"value" : "string",
"sort" : 0,
"groupId" : 0,
"displayName" : "string"
} ]
} ]
} ]
} ]
} ],
"checker" : {
"id" : "string",
"name" : "string",
"date" : "string"
}
} ],
"reports" : [ {
"id" : "string",
"imageFiles" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"videoDescription" : "string",
"suggestion" : "string",
"inspectionSite" : "string",
"deviceModelDesc" : "string",
"diagnosisFlag" : 0,
"recordDoctorId" : "string",
"consultationDoctorId" : "string",
"recordDoctorName" : "string",
"consultationDoctorName" : "string",
"diagnosisEntryItems" : [ {
"id" : 0,
"name" : "string",
"abnormalFlag" : 0
} ]
} ],
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"remark" : "string",
"testerId" : "string",
"testerName" : "string",
"testTime" : "string",
"checkerId" : "string",
"checkerName" : "string",
"checkTime" : "string",
"reportTime" : "string",
"created" : "string",
"type" : 1,
"subType" : 20,
"diagnosis" : "急性上呼吸道感染",
"reportUrl" : "string",
"examinationApplySheetNo" : "string",
"bedNo" : "string",
"deviceType" : 0,
"businessType" : 0,
"relationPatientOrderId" : "string",
"registrationFormItem" : {
"patientOrderId" : "string",
"registrationSheetId" : "string",
"patientId" : "string",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"orderNo" : "上午 01号",
"reserveDate" : "2019-04-04",
"reserveTime" : "10:10~10:30",
"isReserved" : 1,
"status" : 10,
"signIn" : 0,
"consultingRoomId" : "string",
"consultingRoomName" : "string",
"type" : 0,
"payStatus" : 0,
"code" : 0,
"registrationType" : 0,
"created" : "2022-06-23 18:45:00"
}
}
}
5.9.7. 保存检查检验单数据
PUT /api/v2/open-agency/examination/examination-sheet-detail/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
id |
检查检验单id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/examination/examination-sheet-detail/string
请求 body
{
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"reports" : [ {
"id" : "string",
"imageFiles" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"videoDescription" : "string",
"suggestion" : "string",
"diagnosisFlag" : 0,
"recordDoctorId" : "string",
"consultationDoctorId" : "string",
"inspectionSite" : "string",
"deviceModelDesc" : "string",
"isDeleted" : 0,
"diagnosisEntryItems" : [ {
"id" : 0,
"name" : "string",
"abnormalFlag" : 0
} ]
} ],
"results" : [ {
"id" : "string",
"type" : 1,
"name" : "string",
"enName" : "string",
"unit" : "string",
"itemCode" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"productId" : "string",
"resultDisplayScale" : 0,
"value" : { },
"valueType" : "STRING",
"abnormalFlag" : "N",
"abnormalText" : "string"
} ],
"eyeResults" : [ {
"productId" : "string",
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"inspectType" : 0,
"children" : [ {
"items" : [ {
"id" : "string",
"productId" : "string",
"type" : 0,
"name" : "string",
"enName" : "string",
"unit" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"resultDisplayScale" : 0,
"inspectType" : 0,
"componentType" : 0,
"options" : [ "string" ],
"constraints" : [ {
"message" : "string",
"required" : true,
"precision" : 0,
"scale" : 0,
"min" : 0,
"max" : 0,
"size" : 0,
"unit" : "string",
"validateType" : 0
} ],
"value" : "string",
"sort" : 0,
"groupId" : 0,
"displayName" : "string"
} ]
} ]
} ]
} ]
} ],
"checker" : {
"id" : "string",
"name" : "string",
"date" : "string"
}
} ],
"deviceModelId" : 0,
"deviceId" : 0,
"subType" : 0,
"remark" : "string",
"testerId" : "string",
"testerName" : "string",
"checkerId" : "string",
"checkerName" : "string",
"sampleType" : "string",
"testTime" : "2022-11-14 14:00",
"checkTime" : "2022-11-14 14:00",
"reportTime" : "2022-11-14 14:00",
"status" : 0,
"relationPatientOrderId" : "string"
}
HTTP响应示例
响应 200
{
"data" : {
"id" : "string",
"outpatientFormItemId" : "string",
"patientOrderId" : "string",
"patientOrderNumber" : "string",
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"sn" : "100",
"idCard" : "string",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
}
},
"doctorId" : "string",
"doctorName" : "string",
"doctorDepartmentId" : "string",
"doctorDepartmentName" : "string",
"sellerId" : "string",
"sellerName" : "string",
"sellerDepartmentId" : "string",
"sellerDepartmentName" : "string",
"productId" : "string",
"products" : [ {
"productId" : "string",
"productName" : "string",
"examinationSheetId" : "string"
} ],
"productIds" : [ "string" ],
"composeParentProductId" : "string",
"composeParentName" : "string",
"name" : "string",
"orderNo" : "202302140038",
"status" : 0,
"statusName" : "string",
"sampleType" : "string",
"samplerId" : "string",
"samplerName" : "string",
"sampleTime" : "string",
"collectorId" : "string",
"collectorName" : "string",
"collectTime" : "string",
"results" : [ {
"id" : "string",
"type" : 1,
"name" : "string",
"enName" : "string",
"unit" : "string",
"itemCode" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"productId" : "string",
"resultDisplayScale" : 0,
"value" : { },
"valueType" : "STRING",
"abnormalFlag" : "N",
"abnormalText" : "string"
} ],
"eyeResults" : [ {
"productId" : "string",
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"name" : "string",
"children" : [ {
"inspectType" : 0,
"children" : [ {
"items" : [ {
"id" : "string",
"productId" : "string",
"type" : 0,
"name" : "string",
"enName" : "string",
"unit" : "string",
"ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
"resultDisplayScale" : 0,
"inspectType" : 0,
"componentType" : 0,
"options" : [ "string" ],
"constraints" : [ {
"message" : "string",
"required" : true,
"precision" : 0,
"scale" : 0,
"min" : 0,
"max" : 0,
"size" : 0,
"unit" : "string",
"validateType" : 0
} ],
"value" : "string",
"sort" : 0,
"groupId" : 0,
"displayName" : "string"
} ]
} ]
} ]
} ]
} ],
"checker" : {
"id" : "string",
"name" : "string",
"date" : "string"
}
} ],
"reports" : [ {
"id" : "string",
"imageFiles" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"videoDescription" : "string",
"suggestion" : "string",
"inspectionSite" : "string",
"deviceModelDesc" : "string",
"diagnosisFlag" : 0,
"recordDoctorId" : "string",
"consultationDoctorId" : "string",
"recordDoctorName" : "string",
"consultationDoctorName" : "string",
"diagnosisEntryItems" : [ {
"id" : 0,
"name" : "string",
"abnormalFlag" : 0
} ]
} ],
"attachments" : [ {
"url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
"fileName" : "NatGeo09.jpg",
"fileSize" : 4771201
} ],
"remark" : "string",
"testerId" : "string",
"testerName" : "string",
"testTime" : "string",
"checkerId" : "string",
"checkerName" : "string",
"checkTime" : "string",
"reportTime" : "string",
"created" : "string",
"type" : 1,
"subType" : 20,
"diagnosis" : "急性上呼吸道感染",
"reportUrl" : "string",
"examinationApplySheetNo" : "string",
"bedNo" : "string",
"deviceType" : 0,
"businessType" : 0,
"relationPatientOrderId" : "string",
"registrationFormItem" : {
"patientOrderId" : "string",
"registrationSheetId" : "string",
"patientId" : "string",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"orderNo" : "上午 01号",
"reserveDate" : "2019-04-04",
"reserveTime" : "10:10~10:30",
"isReserved" : 1,
"status" : 10,
"signIn" : 0,
"consultingRoomId" : "string",
"consultingRoomName" : "string",
"type" : 0,
"payStatus" : 0,
"code" : 0,
"registrationType" : 0,
"created" : "2022-06-23 18:45:00"
}
}
}
5.9.8. 创建检查检验单
POST /api/v2/open-agency/examination
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/examination
请求 body
{
"patientId" : "string",
"productSubType" : 0,
"examinationFormItems" : [ {
"productId" : "string",
"name" : "string",
"unitCount" : 0.0
} ],
"doctorId" : "string",
"doctorDepartmentId" : "string",
"operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
"data" : {
"examinationSheets" : [ {
"id" : "string",
"orderNo" : "string",
"productId" : "string",
"products" : [ {
"productId" : "string",
"productName" : "string",
"examinationSheetId" : "string"
} ],
"productIds" : [ "string" ],
"name" : "string",
"type" : 1,
"deviceType" : 0,
"businessType" : 0,
"sampleType" : "string",
"patientOrderNo" : "string",
"patientOrderType" : "string",
"departmentId" : "string",
"departmentName" : "string",
"doctorId" : "string",
"doctorName" : "string",
"createdTime" : "string",
"patientInfo" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"status" : 0,
"statusName" : "待检"
} ]
}
}
5.9.9. 作废检查检验单
PUT /api/v2/open-agency/examination/refund/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
检查检验单id |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/examination/refund/string
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.9.10. 获取检查检验设备列表
GET /api/v2/open-agency/examination/devices/{type}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
type |
类型 1:检验 2:检查 |
integer (int32) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/examination/devices/1
HTTP响应示例
响应 200
{
"data" : {
"devices" : [ {
"deviceId" : 0,
"deviceShortId" : "string",
"deviceModelId" : 0,
"name" : "string",
"model" : "string",
"deviceUuid" : "string",
"manufacture" : "string",
"iconUrl" : "string",
"buyUrl" : "string",
"installUrl" : "string",
"remarks" : "string",
"type" : 0,
"extendSpec" : "string",
"deviceType" : 0,
"usageType" : 0,
"salePrice" : 0.0,
"deviceNamePy" : "string",
"deviceStatus" : 0,
"deviceRoomId" : 0,
"deviceRoomName" : "string",
"department" : {
"id" : "ffffffff0000000006dddfe002e22000",
"name" : "儿保科室",
"type" : 1,
"mainMedicalName" : "儿科",
"secondMedicalName" : "小儿呼吸"
}
} ]
}
}
5.10. 统计接口
5.10.1. 收费明细-单据
GET /api/v2/open-agency/stat/revenue/detail/transaction
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
date |
日期(格式yyyy-MM-dd) |
string (date) |
|
Query |
limit |
每页显示条数,默认20 |
integer (int32) |
|
Query |
offset |
分页起始下标 默认0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/stat/revenue/detail/transaction?date=2020-03-05
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"clinicName" : "大源店",
"transactionId" : "ffffffff0000000034cebe945dc04002",
"clinicId" : "ffffffff00000000264a75300d752999",
"patientOrderId" : "ffffffff0000000034cebe945dc04002",
"departmentName" : "内科",
"receivableFee" : 0.0,
"chargeSheetId" : "ffffffff00000000264a75300d752999",
"departmentId" : "ffffffff00000000264a75300d752999",
"employeeName" : "张三",
"thirdPartyPayTransactionId" : "3811634313497509894",
"employeeId" : "ffffffff00000000264a75300d752999",
"visitSource" : {
"parentId" : "string",
"parentName" : "string",
"id" : "string",
"name" : "就诊推荐",
"sourceFrom" : "推荐人ID",
"sourceFromName" : "张三",
"relatedType" : 3,
"relatedId" : "ffffffff00000000094c2a500293c000",
"relateName" : "string"
},
"chargeName" : "李四",
"chargeId" : "ffffffff00000000264a75300d752999",
"totalPrice" : 20.0,
"adjustmentPrice" : 0.0,
"discountPrice" : -9.0,
"deductPrice" : 0.0,
"amount" : 11.0,
"created" : "2022-04-28 15:41:27",
"sourceType" : "门诊",
"action" : "收费",
"patientId" : "ffffffff0000000034d22e0ce272c000",
"patientName" : "张三",
"no" : 100,
"payMode" : "支付宝",
"payModeId" : 1,
"paySubModeId" : 0,
"comment" : "-",
"memberPatientId" : "fffffffff00000000349018418ff74000",
"memberPatientName" : "张三",
"memberPatientMobile" : "18012312312"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.10.2. 收费明细-分类
GET /api/v2/open-agency/stat/revenue/detail/classify
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
date |
日期(格式yyyy-MM-dd) |
string (date) |
|
Query |
limit |
每页显示条数,默认20 |
integer (int32) |
|
Query |
offset |
分页起始下标 默认0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/stat/revenue/detail/classify?date=2020-03-05
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"clinicName" : "大源店",
"feeType" : "string",
"clinicId" : "ffffffff00000000264a75300d752999",
"departmentName" : "内科",
"departmentId" : "ffffffff00000000264a75300d752999",
"employeeName" : "张三",
"employeeId" : "ffffffff00000000264a75300d752999",
"chargeName" : "李四",
"chargeId" : "ffffffff00000000264a75300d752999",
"totalPrice" : 20.0,
"adjustmentPrice" : 0.0,
"discountPrice" : -9.0,
"deductPrice" : 0.0,
"amount" : 11.0,
"created" : "2022-04-28 15:41:27",
"sourceType" : "门诊",
"action" : "收费",
"patientId" : "ffffffff0000000034d22e0ce272c000",
"patientName" : "张三",
"no" : 100,
"payMode" : "支付宝",
"payModeId" : 1,
"paySubModeId" : 0,
"comment" : "-",
"memberPatientId" : "fffffffff00000000349018418ff74000",
"memberPatientName" : "张三",
"memberPatientMobile" : "18012312312"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.10.3. 收费明细-明细
GET /api/v2/open-agency/stat/revenue/detail/items
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
date |
日期(格式yyyy-MM-dd) |
string (date) |
|
Query |
dimension |
维度 0:药品维度 1:批次维度,默认为药品维度 |
integer (int32) |
|
Query |
limit |
每页显示条数,最大不能超过 100 默认20 |
integer (int32) |
|
Query |
offset |
分页起始下标 默认0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/stat/revenue/detail/items?date=2020-03-05
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"clinicName" : "大源店",
"patientMobile" : "13800000000",
"clinicId" : "ffffffff00000000264a75300d752999",
"id" : "ffffffff0000000034e501b0275a4074",
"departmentName" : "内科",
"name" : "血清胰岛素、",
"departmentId" : "ffffffff00000000264a75300d752999",
"productId" : "ffffffff0000000034e501b0275a4074",
"employeeName" : "张三",
"productShortId" : "1000001",
"count" : 1.0,
"employeeId" : "ffffffff00000000264a75300d752999",
"chargeName" : "李四",
"price" : 5.0,
"chargeId" : "ffffffff00000000264a75300d752999",
"feeType1" : "治疗",
"feeType2" : "-",
"totalPrice" : 20.0,
"adjustmentPrice" : 0.0,
"productType" : 1,
"discountPrice" : -9.0,
"productSubType" : 20,
"deductPrice" : 0.0,
"productCustomType" : 1000,
"amount" : 11.0,
"batchId" : 1000324,
"batchNo" : "1234",
"created" : "2022-04-28 15:41:27",
"expiryDate" : "2022-03-28",
"sourceType" : "门诊",
"action" : "收费",
"productionDate" : "2022-03-28",
"chargeSheetId" : "ffffffff0000000034e501b0275a4074",
"patientId" : "ffffffff0000000034d22e0ce272c000",
"chargeFormItemId" : "ffffffff0000000034e501b0275a4074",
"patientName" : "张三",
"chargeTransactionId" : "ffffffff0000000034e501b0275a4074",
"no" : 100,
"itemAdjustmentAmount" : 5.0,
"payMode" : "支付宝",
"payModeId" : 1,
"paySubModeId" : 0,
"comment" : "-",
"memberPatientId" : "fffffffff00000000349018418ff74000",
"memberPatientName" : "张三",
"memberPatientMobile" : "18012312312"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.10.4. 执行业绩-明细
GET /api/v2/open-agency/stat/execute/detail/items
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
date |
日期(格式yyyy-MM-dd) |
string (date) |
|
Query |
limit |
每页显示条数,最大不能超过100,默认20 |
integer (int32) |
|
Query |
offset |
分页起始下标 默认0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/stat/execute/detail/items?date=2020-03-05
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "ffffffff00000000105f9cf8062ec000",
"patientId" : "ffffffff00000000105f9cf8062ec000",
"patientName" : "张三",
"patientMobile" : "18888888888",
"executeClinicId" : "ffffffff00000000105f9cf8062ec000",
"executeClinicName" : "北京朝阳医院",
"executorIds" : "ffffffff00000000105f9cf8062ec000",
"executorNames" : "张三",
"status" : 0,
"executeDate" : "2022-03-28 10:00:00",
"productId" : "ffffffff00000000105f9cf8062ec000",
"productShortId" : "0001",
"productName" : "注射",
"productType" : 1,
"productSubType" : 20,
"executeCount" : 1.0,
"totalPrice" : 20.0,
"amount" : 18.0,
"comment" : "执行备注",
"recordEffectInfo" : "【方法】头针;【部位】[穴位]云门;;【反应】麻,酸;【病因】气血亏虚,阴虚内热;【结果】好转;",
"sheetCreateClinicId" : "ffffffff00000000105f9cf8062ec000",
"sheetCreateClinicName" : "北京朝阳医院",
"sheetCreatedBy" : "张三",
"sheetCreatedByName" : "张三",
"sheetCreateDepartmentId" : "ffffffff00000000105f9cf8062ec000",
"sheetCreateDepartmentName" : "张三",
"sheetCreated" : "2022-03-28 10:00:00",
"createdBy" : "ffffffff00000000105f9cf8062ec000",
"createdByName" : "张三",
"chargeFormItemId" : "ffffffff00000000105f9cf8062ec000",
"chargeSheetId" : "ffffffff00000000105f9cf8062ec000"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.10.5. 开卡充值业绩-明细
GET /api/v2/open-agency/stat/card-recharge/detail/items
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
date |
日期(格式yyyy-MM-dd) |
string (date) |
|
Query |
limit |
每页显示条数,最大不能超过 100 |
integer (int32) |
|
Query |
offset |
分页起始下标 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/stat/card-recharge/detail/items?date=2020-03-05&limit=20&offset=0
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "3810522672384016386",
"clinicId" : "ffffffff00000000105f9cf8062ec000",
"rechargeTime" : "2025-01-06 10:00:00",
"patientId" : "ffffffff00000000105f9cf8062ec000",
"patientMobile" : "18888888888",
"cardId" : "ffffffff00000000105f9cf8062ec000",
"cardName" : "充送卡",
"operationType" : 1,
"actualAmount" : 100.0,
"rechargePrincipal" : 100.0,
"rechargePresent" : 20.0,
"principalBalance" : 100.0,
"presentBalance" : 20.0,
"sellerId" : "ffffffff00000000105f9cf8062ec000",
"sellerName" : "张三",
"createdByName" : "张三",
"createdBy" : "ffffffff00000000105f9cf8062ec000",
"originPrice" : 100.0
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.10.6. 会员充值业绩-明细
GET /api/v2/open-agency/stat/member-recharge/detail/items
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Query |
date |
日期(格式yyyy-MM-dd) |
string (date) |
|
Query |
limit |
每页显示条数,最大不能超过 100 |
integer (int32) |
|
Query |
offset |
分页起始下标 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/stat/member-recharge/detail/items?date=2020-03-05&limit=20&offset=0
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "string",
"clinicId" : "string",
"clinicName" : "string",
"sellerId" : "string",
"sellerName" : "string",
"chargeTime" : "string",
"chargePrincipal" : 0.0,
"chargePresent" : 0.0,
"patientId" : "string",
"patientName" : "string",
"patientMobile" : "string",
"chargerId" : "string",
"chargerName" : "string",
"remark" : "string"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.11. 事件推送接口
5.11.1. 查询推送失败事件列表
GET /api/v2/open-agency/app-callback/{appId}/fail
说明
获取 appId 下指定日期的推送失败事件列表,不区分 clinicId
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
appId |
应用id |
string |
|
Query |
date |
日期(格式yyyy-MM-dd) |
string (date) |
|
Query |
limit |
每页显示条数,最大值为500 |
integer (int32) |
|
Query |
offset |
分页起始下标 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/app-callback/2730297344132816890/fail?date=2022-01-03&limit=100&offset=0
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "2730297344132816890",
"appId" : "1928374655",
"appCallBackUrl" : "https://xxx.com/xx/xx",
"callBackBody" : {
"clinicId" : "string",
"eventModule" : 1,
"eventType" : 101,
"eventName" : "收费完成",
"eventData" : { }
},
"failReason" : "404 Not Found:",
"status" : 2,
"created" : "2022-04-06 15:12:53"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.12. 平台接口
5.12.1. 获取中国地区信息
GET /api/v2/open-agency/property/address/china
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/property/address/china
HTTP响应示例
响应 200
{
"data" : {
"id" : "510000",
"name" : "四川",
"children" : [ {
"id" : "510000",
"name" : "四川",
"children" : [ "..." ]
} ]
}
}
5.12.2. 获取 OSS Token
GET /api/v2/open-agency/property/oss/token
说明
该接口用于生成可以将文件上传到 OSS 的 token。引入 阿里云SDK、代码参考示例 使用临时访问凭证上传文件至OSS
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/property/oss/token
HTTP响应示例
响应 200
{
"data" : {
"endpoint" : "string",
"bucket" : "string",
"fileDir" : "string",
"securityToken" : "string",
"accessKeySecret" : "string",
"accessKeyId" : "string",
"expiration" : "2022-11-09 12:00:00"
}
}
5.12.3. 发送报警
POST /api/v2/open-agency/property/report/alert
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/property/report/alert
请求 body
{
"title" : "处理发药事件失败",
"content" : "内容"
}
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.13. 执行接口
5.13.1. 按天查询执行单列表
GET /api/v2/open-agency/execute/query-by-date
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Query |
date |
日期 yyyy-MM-dd |
string (date) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/execute/query-by-date?date=2023-08-13
HTTP响应示例
响应 200
{
"data" : {
"executeSheets" : [ {
"id" : "ffffffff000000003484c3816487c002",
"patientOrderId" : "ffffffff000000003484c3816487c002",
"status" : 1,
"patient" : {
"id" : "000000fc446f4dbd989857e305b00d6s",
"name" : "张三",
"mobile" : "18080000000",
"sex" : "男",
"birthday" : "1970-08-14",
"age" : {
"year" : 60,
"month" : 2,
"day" : 1
},
"idCard" : "630101200010075758"
},
"abstractInfo" : "string",
"created" : "2022-04-06 15:12:53"
} ]
}
}
5.13.2. 执行单详情
GET /api/v2/open-agency/execute/{id}
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
执行单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/execute/ffffffff000000003484c3816487c002
HTTP响应示例
响应 200
{
"data" : {
"id" : "ffffffff000000003484c3816487c002",
"patientOrderId" : "ffffffff000000003484c3816487c002",
"items" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"needExecutive" : 1,
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"executedUnitCount" : 2.0,
"executeStatus" : 1,
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
} ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : {
"children" : [ "..." ],
"id" : "string",
"name" : "阿莫西林",
"shebao" : {
"nationalCode" : "T001700643",
"insuranceTypes" : [ {
"insuranceType" : "391",
"reimbursementRatio" : 0.1
} ]
},
"disableSell" : 0,
"typeId" : 1,
"typeName" : "药品",
"customTypeId" : "213",
"customTypeName" : "抗生素",
"manufacturer" : "拜耳",
"medicineNmpn" : "H20000001",
"barCode" : "string",
"pieceUnit" : "支",
"pieceNum" : 10.0,
"piecePrice" : 10.5,
"packageUnit" : "盒",
"packagePrice" : 105.0,
"shortId" : "K1001",
"specification" : "1ml:0.5mg*10支/盒",
"otcType" : 1,
"status" : 1,
"lastModified" : "2022-05-13 12:22:56",
"goodsSpu" : {
"id" : "string",
"name" : "string",
"brandName" : "string",
"material" : "string"
},
"goodsSpec" : {
"color" : "string",
"spec" : "string"
}
},
"composeChildren" : [ {
"id" : "0002b62eaf9c461f85ff3fedc4583a79",
"chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
"productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
"productName" : "注射用青霉素钠",
"status" : 0,
"unit" : "支",
"receivedFee" : 40.0,
"unitPrice" : 10.0,
"displayUnitPrice" : 10.0,
"displayTotalPrice" : 40.0,
"unitCount" : 4.0,
"doseCount" : 1.0,
"totalCount" : 4.0,
"productType" : 1,
"productSubType" : 3,
"sourceItemType" : 0,
"productInfo" : "...",
"composeChildren" : [ "..." ]
} ]
} ]
} ],
"status" : 1,
"created" : "2022-04-06 15:12:53",
"sellerId" : "ffffffff000000003484c3816487c002",
"sellerName" : "张三",
"doctorId" : "ffffffff000000003484c3816487c002",
"doctorName" : "李四",
"diagnosis" : "慢性鼻窦炎,颞下间隙感染"
}
}
5.13.3. 执行
POST /api/v2/open-agency/execute/{id}/do
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
id |
执行单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/execute/ffffffff000000003484c3816487c002/do
请求 body
{
"items" : [ {
"id" : "ffffffff000000003484c3816487c002",
"executeCount" : 1
} ],
"executorIds" : [ "string" ],
"operatorId" : "string",
"comment" : "string"
}
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.13.4. 查询执行单执行历史
GET /api/v2/open-agency/execute/{id}/record
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Path |
id |
执行单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/execute/ffffffff000000003484c3816487c002/record
HTTP响应示例
响应 200
{
"data" : {
"executeRecords" : [ {
"id" : "ffffffff000000003484c3816487c002",
"status" : 0,
"executors" : [ {
"id" : "string",
"name" : "string"
} ],
"items" : [ {
"id" : 0,
"executeItemId" : "ffffffff000000003484c3816487c002",
"executeItemProductId" : "ffffffff000000003484c3816487c002",
"executeItemProductName" : "雾化吸入",
"executeCount" : 2
} ],
"executeTime" : "2022-04-06 15:12:53",
"operator" : {
"id" : "string",
"name" : "string"
}
} ]
}
}
5.13.5. 撤销执行
POST /api/v2/open-agency/execute/{id}/record/{executeRecordId}/undo
说明
撤销执行的维度是一次执行操作,而不是执行项目
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
- |
- |
|
Path |
executeRecordId |
执行记录ID |
string |
Path |
id |
执行单ID |
string |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
application/json
HTTP请求示例
请求 path
/api/v2/open-agency/execute/ffffffff000000003484c3816487c002/record/ffffffff000000003484c3816487c003/undo
请求 body
{
"operatorId" : "string"
}
HTTP响应示例
响应 200
{
"data" : {
"code" : 200,
"message" : "提示信息"
}
}
5.13.6. 查询患者执行单列表
GET /api/v2/open-agency/execute/patient/{patientId}
参数
类型 | 名称 | 说明 | 类型 | 默认值 |
---|---|---|---|---|
Path |
patientId |
患者ID |
string |
|
Query |
beginDate |
开始日期,yyyy-MM-dd,为空则默认为三个月前 |
string |
|
Query |
endDate |
结束日期,yyyy-MM-dd,为空则默认为今天 |
string |
|
Query |
executeStatus |
执行状态 1:待执行 2:已执行 3:已取消(已退费) |
integer (int32) |
|
Query |
limit |
分页大小,默认为 10,最大为 25 |
integer (int32) |
|
Query |
offset |
分页偏移,默认为 0 |
integer (int32) |
|
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
HTTP请求示例
请求 path
/api/v2/open-agency/execute/patient/ffffffff00000000287b8f500fa68000
HTTP响应示例
响应 200
{
"data" : {
"rows" : [ {
"id" : "ffffffff0000000034be47d786e44000",
"status" : 1,
"created" : "2022-04-06 15:12:53",
"items" : [ {
"id" : "ffffffff0000000034be47d5e6e44002",
"productId" : "ffffffff000000003499787109ea4003",
"productName" : "推拿",
"chargeStatus" : 1,
"totalCount" : 10.0,
"executedUnitCount" : 2.0
} ],
"sellerId" : "ffffffff0000000034be47d786e44000",
"sellerName" : "张三"
} ],
"total" : 100,
"offset" : 0,
"limit" : 10
}
}
5.14. 文件接口
5.14.1. 文件上传
POST /api/v2/open-agency/file/upload
参数
类型 | 名称 | 说明 | 类型 |
---|---|---|---|
Body |
file |
file |
string (binary) |
响应
HTTP Code | 说明 | 类型 |
---|---|---|
200 |
OK |
消耗
multipart/form-data
HTTP请求示例
请求 path
/api/v2/open-agency/file/upload
请求 body
{ }
HTTP响应示例
响应 200
{
"data" : {
"isSuccess" : 0,
"message" : "string",
"filePath" : "string"
}
}
6. 错误码定义
错误码 | 说明 |
---|---|
13903 |
会员手机号不能为空 |
13909 |
患者不存在 |
7. 模型定义
7.1. AbcListPage«OpenBatchStockView»
名称 | 说明 | 类型 |
---|---|---|
rows |
样例 : |
< OpenBatchStockView > array |
total |
样例 : |
integer (int32) |
offset |
样例 : |
integer (int32) |
limit |
样例 : |
integer (int32) |
keyword |
样例 : |
string |
7.2. JsonNode
类型 : object
7.3. OSS开放Token
名称 | 说明 | 类型 |
---|---|---|
endpoint |
endpoint |
string |
bucket |
bucket |
string |
fileDir |
文件目录 |
string |
securityToken |
安全令牌 |
string |
accessKeySecret |
临时访问密钥 |
string |
accessKeyId |
临时访问密钥ID |
string |
expiration |
过期时间 |
string |
7.4. OpenBatchStockView
商品批次信息
名称 | 说明 | 类型 |
---|---|---|
goodsId |
商品ID |
string |
goodsShortId |
商品编码 |
string |
batchId |
批次ID |
integer (int64) |
pieceNum |
制剂数量 |
integer (int32) |
pharmacyType |
药房类型 |
integer (int32) |
pharmacyNo |
药房号 |
integer (int32) |
expiryDate |
效期 |
string |
productionDate |
生产日期 |
string |
inDate |
入库日期 yyyy-MM-dd HH:mm:ss |
string (date-time) |
batchNo |
批号 |
string |
packageCostPrice |
大包装成本单价 |
number |
leftCost |
剩余成本 |
number |
pieceCount |
小包装数量 |
number |
packageCount |
大包装数量 |
number |
status |
批次状态 |
integer (int32) |
stockInOutDetailId |
外部入库明细ID |
string |
7.5. OpenGoodsStockOutApplyOrderReviewReq
名称 | 说明 | 类型 |
---|---|---|
pass |
是否通过 0:拒绝 1:通过,默认值 1 |
integer (int32) |
comment |
审核评论或备注 |
string |
7.6. OpenMemberChargeDetailInfoView
名称 | 说明 | 类型 |
---|---|---|
id |
流水id |
string |
clinicId |
门店id |
string |
clinicName |
门店名称 |
string |
sellerId |
销售员id |
string |
sellerName |
销售员名称 |
string |
chargeTime |
充值时间 |
string |
chargePrincipal |
充值本金 |
number |
chargePresent |
充值赠金 |
number |
patientId |
患者id |
string |
patientName |
患者名称 |
string |
patientMobile |
患者手机号 |
string |
chargerId |
收费员id |
string |
chargerName |
收费员名称 |
string |
remark |
备注 |
string |
7.7. R«AbcListPage«OpenBatchStockView»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.8. R«OSS开放Token»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.13. R«供应商档案信息返回体»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.16. R«分页查询结果«OpenMemberChargeDetailInfoView»»
名称 | 说明 | 类型 |
---|---|---|
data |
7.17. R«分页查询结果«事件推送详情»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.18. R«分页查询结果«医生信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.19. R«分页查询结果«发药单摘要信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.20. R«分页查询结果«商品信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.21. R«分页查询结果«库存调拨单列表视图»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.22. R«分页查询结果«开卡充值业绩明细视图»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.23. R«分页查询结果«患者发药单信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.24. R«分页查询结果«患者执行单信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.25. R«分页查询结果«患者摘要信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.26. R«分页查询结果«患者收费单摘要信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.27. R«分页查询结果«患者附件»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.28. R«分页查询结果«患者预约摘要信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.29. R«分页查询结果«执行业绩-明细»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.30. R«分页查询结果«挂号单基础信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.31. R«分页查询结果«收费明细-分类信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.32. R«分页查询结果«收费明细-单据信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.33. R«分页查询结果«收费明细-明细信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.34. R«分页查询结果«检查检验单摘要信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.35. R«分页查询结果«检查检验摘要信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.36. R«分页查询结果«检查检验项目信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.37. R«分页查询结果«门诊单摘要信息»»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.41. R«医生号源日期列表响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.42. R«医生排班号源详情响应结果»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.49. R«就诊单号查询发药单响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.53. R«库存结算单信息返回体»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.68. R«查询医生可预约项目响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.69. R«查询商品库存响应参数»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.71. R«查询就诊来源类型响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.72. R«查询患者会员类型响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.73. R«查询患者家庭成员响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.75. R«查询执行单执行记录响应参数»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.76. R«查询检查检验数据响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.77. R«查询预约备注模板响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.79. R«检查检验数据摘要信息»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.80. R«检验检查设备列表响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.84. R«科室详细信息(含科室人员列表)»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.86. R«连锁商品自定义分类响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.87. R«通过药品编码查询商品信息响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.93. R«门店医生排班状态响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.95. R«项目指定日期号源信息响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.96. R«预约项目每日号源状态响应»
名称 | 说明 | 类型 |
---|---|---|
data |
数据 |
7.97. 中药处方加工信息
名称 | 说明 | 类型 |
---|---|---|
usageType |
加工类型 1:煎药 2:制膏 3:打粉 4:制丸 5:颗粒 6:茶包 7:胶囊 |
integer (int32) |
usageSubType |
加工子类型 usageType 为 1 时 1:手工煎药 2:机器煎药(普通) 3:机器煎药(浓缩) usageType 为 2 时 1:儿童膏方 2:成人膏方 usageType 为 3 时 1:粗粉 2:细粉 3:超细粉 usageType 为 4 时 1:水丸 2:蜜丸 3:水蜜丸 4:浓缩丸 其他情况传 0 |
integer (int32) |
unitCount |
每剂加工的袋数,加工类型为 1 时有效 |
number |
totalCount |
总加工袋数,加工类型为 1 时有效 |
number |
price |
加工费 |
number |
remark |
备注 |
string |
7.98. 事件推送详情
名称 | 说明 | 类型 |
---|---|---|
id |
ID |
string |
appId |
应用ID |
string |
appCallBackUrl |
推送地址 |
string |
callBackBody |
当时推送的数据内容 |
|
failReason |
推送失败原因 |
string |
status |
事件推送状态:0:未推送 1:推送成功 2:推送失败 |
integer (int32) |
created |
推送时间 |
string (date-time) |
7.99. 事件推送请求
名称 | 说明 | 类型 |
---|---|---|
clinicId |
机构ID |
string |
eventModule |
事件模块: 参考事件订阅 |
integer (int32) |
eventType |
事件类型:参考事件订阅 |
integer (int32) |
eventName |
事件名称 |
string |
eventData |
事件数据:结构由事件决定,参考事件订阅的结构体 |
7.100. 交易记录商品明细
名称 | 说明 | 类型 |
---|---|---|
id |
唯一标识ID |
string |
transactionId |
交易流水ID |
string |
chargeType |
收费类型:0部分收费;1收费完成;-1退费 |
integer (int32) |
productId |
商品id |
string |
productName |
商品名称 |
string |
productType |
商品类型 |
integer (int32) |
productSubType |
商品子类型 |
integer (int32) |
composeType |
套餐类型:0不是套餐;1套餐母项;2套餐子项 |
integer (int32) |
productUnit |
商品单位 |
string |
productUnitCount |
商品数量 |
number |
doseCount |
商品剂量 |
number |
totalPrice |
商品总价 |
number |
discountPrice |
商品折扣价格 |
number |
created |
创建时间 |
string (date-time) |
sceneType |
场景类型:0:普通收退费,1:欠收,2:欠退 |
integer (int32) |
composeChildren |
子项列表(当前项目为套餐或多对码情况下才有)最多可能会存在三级结构 |
< 交易记录商品明细 > array |
7.101. 会员信息
名称 | 说明 | 类型 |
---|---|---|
id |
会员卡ID |
string |
principal |
本金 |
number |
present |
赠金 |
number |
created |
开卡日期 |
string (date-time) |
memberTypeInfo |
会员卡类型 |
7.102. 会员卡支付响应
名称 | 说明 | 类型 |
---|---|---|
transactionId |
会员卡交易流水ID |
string |
principalBalance |
本金余额 |
number |
presentBalance |
赠金余额 |
number |
principal |
此次扣除本金 |
number |
present |
此次扣除赠金 |
number |
businessId |
业务ID |
string |
7.103. 会员卡支付请求参数
名称 | 说明 | 类型 |
---|---|---|
transactionPatientId |
使用会员卡患者ID |
string |
amount |
支付金额 |
number |
businessId |
业务ID |
string |
password |
会员卡密码 |
string |
operatorId |
操作人ID,系统中的员工ID |
string |
7.104. 会员卡退款请求参数
会员卡退款请求参数
名称 | 说明 | 类型 |
---|---|---|
amount |
退款金额 |
number |
transactionIds |
支付交易ID列表 |
< string > array |
businessId |
业务ID |
string |
operatorId |
操作人ID,系统中的员工ID |
string |
7.105. 会员卡退费响应
名称 | 说明 | 类型 |
---|---|---|
transactionId |
会员卡交易流水ID |
string |
principalBalance |
本金余额 |
number |
presentBalance |
赠金余额 |
number |
principal |
此次扣除本金 |
number |
present |
此次扣除赠金 |
number |
businessId |
业务ID |
string |
7.106. 会员类型信息
名称 | 说明 | 类型 |
---|---|---|
id |
会员类型ID |
string |
name |
会员类型名字 |
string |
7.107. 住址
名称 | 说明 | 类型 |
---|---|---|
addressProvinceId |
省编码 |
string |
addressProvinceName |
省名称 |
string |
addressCityId |
市编码 |
string |
addressCityName |
市名称 |
string |
addressDistrictId |
区编码 |
string |
addressDistrictName |
区名称 |
string |
addressDetail |
详细地址 |
string |
7.108. 供应商信息
名称 | 说明 | 类型 |
---|---|---|
id |
供应商ID |
string |
name |
供应商名称 |
string |
status |
供应商状态 0:禁用 1:启用 |
integer (int32) |
licenseId |
供应商许可证号 |
string |
contact |
供应商联系人 |
string |
mobile |
供应商联系方式 |
string |
mark |
供应商备注 |
string |
7.110. 修改供应商请求参数
名称 | 说明 | 类型 |
---|---|---|
name |
供应商名称 |
string |
status |
供应商状态 0:禁用 1:启用 |
integer (int32) |
licenseId |
供应商许可证号 |
string |
contact |
供应商联系人 |
string |
mobile |
供应商联系方式 |
string |
mark |
供应商备注 |
string |
operatorId |
操作人ID |
string |
7.111. 修改加工状态请求参数
名称 | 说明 | 类型 |
---|---|---|
externalTrace |
外部跟踪信息列表 |
< 外部跟踪信息 > array |
dispensingSheetId |
发药单ID |
string |
dispensingFormId |
发药处方ID |
string |
processGeneralStatus |
加工通用状态 0:初始状态 100:审方中 200:调配中 300:浸泡中 400:加工中 500:包装中 600:待快递 9999:已取消 |
integer (int32) |
7.112. 修改商品请求参数
名称 | 说明 | 类型 |
---|---|---|
type |
商品类型 1:药品 2:物资 7:商品 |
integer (int32) |
subType |
商品子类型 当 type 为 1 时 1:西药 2:中药 3:中成药 当 type 为 2 时 1:医疗器械 2:后勤材料 3:固定资产 当 type 为 7 时 1:自制成品 2:保健药品 3:保健食品 4:其他商品 |
integer (int32) |
medicineCadn |
商品通用名 |
string |
name |
商品名, type为 1 ,subtype为 1 3 时可有值 |
string |
shortId |
商品编码,系统生成或自定义 |
string |
cMSpec |
中药规格, type为 1,subtype为 2 时有值,值为[中药饮片|中药颗粒] |
string |
dismounting |
拆零标识 0:不可拆零 1:可拆零, type 为 1,subType为 2 时值为 1 |
integer (int32) |
extendSpec |
规格,type为 1,subType为 2可有值 |
string |
materialSpec |
规格,type为 2 7可有值 |
string |
manufacturer |
生产厂家 |
string |
medicineNmpn |
批准文号 |
string |
barCode |
条形码 |
string |
pieceNum |
最小包装数量, type为 1,subType为 3 时值为 1 |
integer (int32) |
pieceUnit |
最小包装单位 |
string |
packageUnit |
包装单位 |
string |
componentContentUnit |
容量单位, tpe为 1,subType为 1,3时可有值 |
string |
componentContentNum |
容量数量, tpe为 1,subType为 1,3时可有值 |
number |
medicineDosageNum |
成分含量数量, tpe为 1,subType为 1,3时可有值 |
number |
medicineDosageUnit |
成分含量单位, tpe为 1,subType为 1,3时可有值 |
string |
piecePrice |
拆零价格 |
number |
packagePrice |
零售价格 |
number |
operatorId |
操作人ID |
string |
7.113. 修改快递信息请求参数
名称 | 说明 | 类型 |
---|---|---|
externalTrace |
外部跟踪信息列表 |
< 外部跟踪信息 > array |
dispensingSheetId |
发药单id |
string |
deliveryStatus |
快递状态; 700:已发货/运输中;800:已签收 |
integer (int32) |
deliveryOrderNo |
快递单号; 状态为700时需要传快递单号; |
string |
7.114. 修改患者标签请求参数
名称 | 说明 | 类型 |
---|---|---|
addTagIds |
新增患者标签列表 |
< string > array |
deleteTagIds |
删除的患者标签列表 |
< string > array |
operatorId |
操作人ID |
string |
7.115. 修改患者请求体
名称 | 说明 | 类型 |
---|---|---|
name |
姓名 |
string |
mobile |
手机号 |
string |
sex |
性别 |
string |
birthday |
生日 |
string |
sourceId |
患者来源分类ID |
string |
sourceFromId |
患者来源分类下某个具体来源id。比如:当就诊来源分类为【医生推荐】时,根据api【5.2.2. 获取医生分页列表信息】获取到医生,此时字段取值为医生id;当就诊来源分类为【导医推荐】时, 根据api【5.1.3. 获取门店成员列表】获取到成员,此时字段取值为成员id;当就诊来源分类为【顾客推荐】时, 根据api【5.4.3. 获取患者列表】获取到患者,此时字段取值为患者id; |
string |
idCard |
身份证 |
string |
pastHistory |
既往史 |
string |
address |
家庭住址 |
|
sn |
档案号 |
string |
remark |
备注 |
string |
profession |
职业 |
string |
company |
公司单位 |
string |
marital |
婚姻状态 |
string |
weight |
体重 |
string |
7.116. 修改或设置收费单快递信息请求体参数
名称 | 说明 | 类型 |
---|---|---|
addressProvinceId |
省编码 |
string |
addressProvinceName |
省名称 |
string |
addressCityId |
市编码 |
string |
addressCityName |
市名称 |
string |
addressDistrictId |
区编码 |
string |
addressDistrictName |
区名称 |
string |
addressDetail |
详细地址 |
string |
deliveryName |
收件人名称 |
string |
deliveryMobile |
收件人手机号 |
string |
deliveryCompanyName |
快递公司名称,需要预先在系统中配置好 |
string |
deliveryFee |
快递费,寄付时不传自动计算出费用 |
number |
deliveryOrderNo |
快递单号 |
string |
deliveryPayType |
快递费支付方式 0:到付 1:寄付 |
integer (int32) |
operatorId |
操作人ID |
string |
7.117. 修正入库单事件
名称 | 说明 | 类型 |
---|---|---|
fixedInOrderItemList |
修正入库明细 |
< 修正入库单明细视图 > array |
id |
修正入库单ID |
integer (int64) |
orderNo |
修正入库单单号 |
string |
status |
修正入库单状态 0:待审核 1:待确认 2:已完成 9:已拒绝 31:撤回 |
integer (int32) |
organId |
出/入库门店ID |
string |
organName |
出/入库门店名称 |
string |
amount |
含税金额 |
number |
count |
数量 |
number |
kindCount |
品种数量 |
integer (int32) |
operator |
操作人(入库人) |
string |
supplier |
供应商 |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
pharmacy |
入库药房 |
|
originalOrder |
被修正的入库单信息 |
7.118. 修正入库单审核请求
名称 | 说明 | 类型 |
---|---|---|
pass |
是否通过 0:拒绝 1:通过,默认值 1 |
integer (int32) |
comment |
审核评论或备注 |
string |
7.119. 修正入库单明细视图
修正入库单明细视图
名称 | 说明 | 类型 |
---|---|---|
id |
条目ID |
integer (int64) |
outDetailId |
外部明细ID |
string |
originalItemId |
来源条目ID |
integer (int64) |
originalOutDetailId |
来源外部明细ID |
string |
productId |
商品编码 |
string |
productShortId |
商品short编码 |
string |
productName |
商品名称 |
string |
specification |
规格 |
string |
pieceNum |
制剂数量 |
number |
pieceUnit |
制剂单位 |
string |
packageUnit |
包装单位 |
string |
originalPackageCount |
入库包装数量 |
number |
originalPieceCount |
入库制剂数量 |
number |
originalAmount |
金额 |
number |
changePackageCount |
修正入库包装数量(为正则说明实收大于应收,为负则说明实收小于应收) |
number |
changePieceCount |
修正入库制剂数量(为正则说明实收大于应收,为负则说明实收小于应收) |
number |
changeAmount |
修正金额(可正可负) |
number |
originalBatchNo |
样例 : |
string |
batchNo |
生产批号 |
string |
created |
创建时间 |
string (date-time) |
7.120. 入库单事件
名称 | 说明 | 类型 |
---|---|---|
id |
出/入库单ID |
integer (int64) |
inOrderItemList |
入库单条目列表 |
< 入库单条目 > array |
inOrderId |
退货的入库单ID |
integer (int64) |
orderNo |
入库单号 |
string |
status |
入库单状态 0:待审核 1:待确认 2:已完成 9:已拒绝 31:撤回 |
integer (int32) |
organName |
门店 |
string |
organId |
门店ID |
string |
amount |
含税金额 |
number |
count |
数量 |
number |
kindCount |
品种数量 |
integer (int32) |
operator |
操作人(入库人) |
string |
operatorId |
操作人ID |
string |
supplier |
供应商 |
string |
supplierId |
供应商ID |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
pharmacy |
入库药房 |
|
type |
类型 0:采购入库 10:退货出库 |
integer (int32) |
7.121. 入库单条目
名称 | 说明 | 类型 |
---|---|---|
id |
条目ID |
integer (int64) |
inId |
退的入库项ID |
integer (int64) |
originalItemId |
原始条目ID |
integer (int64) |
productId |
商品编码 |
string |
productShortId |
商品short编码 |
string |
productName |
商品名称 |
string |
specification |
规格 |
string |
expiryDate |
有效期 |
string |
productionDate |
生产日期 |
string |
pieceNum |
制剂数量 |
number |
pieceUnit |
制剂单位 |
string |
packageUnit |
包装单位 |
string |
packageCostPrice |
包装成本单价 |
number |
packageCount |
入库包装数量 |
number |
pieceCount |
入库制剂数量 |
number |
amount |
金额 |
number |
totalCost |
变化的成本金额 |
number |
batchId |
批次号 |
integer (int64) |
batchNo |
生产批号 |
string |
outDetailId |
外部明细ID |
string |
stockInOutDetailId |
入库外部明细ID(退货出库、退货申请有值) |
string |
created |
创建时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
7.122. 入库单详情
名称 | 说明 | 类型 |
---|---|---|
comment |
备注 |
|
id |
出/入库单ID |
integer (int64) |
inOrderItemList |
入库单条目列表 |
< 入库单条目 > array |
inOrderId |
退货的入库单ID |
integer (int64) |
orderNo |
入库单号 |
string |
status |
入库单状态 0:待审核 1:待确认 2:已完成 9:已拒绝 31:撤回 |
integer (int32) |
organName |
门店 |
string |
organId |
门店ID |
string |
amount |
含税金额 |
number |
count |
数量 |
number |
kindCount |
品种数量 |
integer (int32) |
operator |
操作人(入库人) |
string |
operatorId |
操作人ID |
string |
supplier |
供应商 |
string |
supplierId |
供应商ID |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
pharmacy |
入库药房 |
|
type |
类型 0:采购入库 10:退货出库 |
integer (int32) |
7.123. 入库明细
名称 | 说明 | 类型 |
---|---|---|
goodsId |
商品ID,商品ID和商品短ID必须要填一个 |
string |
goodsShortId |
商品短ID,商品ID和商品短ID必须要填一个 |
string |
unit |
入库单位,不能超过 10 个字符 |
string |
unitCount |
单位数量,正值 |
number |
unitCostPrice |
单位成本价 |
number |
totalCostPrice |
总成本价 |
number |
batchNo |
批次号 |
string |
expireDate |
有效期 yyyy-MM-dd |
string (date) |
productionDate |
生产日期 yyyy-MM-dd |
string (date) |
outDetailId |
外部明细ID |
string |
7.124. 出入库单信息
名称 | 说明 | 类型 |
---|---|---|
id |
出/入库单ID |
integer (int64) |
inOrderId |
退货的入库单ID |
integer (int64) |
orderNo |
入库单号 |
string |
status |
入库单状态 0:待审核 1:待确认 2:已完成 9:已拒绝 31:撤回 |
integer (int32) |
organName |
门店 |
string |
organId |
门店ID |
string |
amount |
含税金额 |
number |
count |
数量 |
number |
kindCount |
品种数量 |
integer (int32) |
operator |
操作人(入库人) |
string |
operatorId |
操作人ID |
string |
supplier |
供应商 |
string |
supplierId |
供应商ID |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
pharmacy |
入库药房 |
|
type |
类型 0:采购入库 10:退货出库 |
integer (int32) |
7.125. 出库单事件
名称 | 说明 | 类型 |
---|---|---|
id |
出库单id |
integer (int64) |
outOrderItemList |
出库单条目列表 |
< 出库单条目 > array |
orderNo |
出库单号 |
string |
status |
出库单状态 0:待确认 1:待审核 2:已完成 9:已拒绝 31:撤回 |
integer (int32) |
organName |
门店 |
string |
type |
出库单类型 1:科室出库 2:报损出库 3:退货出库 |
integer (int32) |
kindCount |
品种数量 |
integer (int32) |
count |
数量 |
number |
amount |
含税金额 |
number |
receiver |
领取人 |
string |
operator |
操作人(出库人) |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
inOrderId |
关联的入库单id |
string |
pharmacy |
出库药房 |
7.126. 出库单条目
名称 | 说明 | 类型 |
---|---|---|
id |
条目ID |
integer (int64) |
productId |
商品编码 |
string |
productShortId |
商品short编码 |
string |
productName |
商品名称 |
string |
specification |
规格 |
string |
pieceNum |
制剂数量 |
number |
pieceUnit |
制剂单位 |
string |
packageUnit |
包装单位 |
string |
packageCount |
出库包装数量 |
number |
pieceCount |
出库制剂数量 |
number |
packageCostPrice |
包装成本单价 |
number |
stockInId |
退货出库所退的入库条目id |
integer (int64) |
amount |
出库包装成本价 |
number |
lastModified |
最后修改时间 |
string (date-time) |
stockOutBatches |
门店发生的批次进销存信息 |
< 单据进销存批次信息 > array |
7.127. 出库单详情
名称 | 说明 | 类型 |
---|---|---|
comment |
备注 |
|
id |
出库单id |
integer (int64) |
outOrderItemList |
出库单条目列表 |
< 出库单条目 > array |
orderNo |
出库单号 |
string |
status |
出库单状态 0:待确认 1:待审核 2:已完成 9:已拒绝 31:撤回 |
integer (int32) |
organName |
门店 |
string |
type |
出库单类型 1:科室出库 2:报损出库 3:退货出库 |
integer (int32) |
kindCount |
品种数量 |
integer (int32) |
count |
数量 |
number |
amount |
含税金额 |
number |
receiver |
领取人 |
string |
operator |
操作人(出库人) |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
inOrderId |
关联的入库单id |
string |
pharmacy |
出库药房 |
7.128. 出库明细
名称 | 说明 | 类型 |
---|---|---|
goodsId |
商品ID |
string |
goodsShortId |
商品短ID |
string |
pieceCount |
小单位数量 |
number |
packageCount |
最小值 : |
number |
batchNo |
批次号 |
string |
7.129. 分页查询结果«OpenMemberChargeDetailInfoView»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< OpenMemberChargeDetailInfoView > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.130. 分页查询结果«事件推送详情»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 事件推送详情 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.131. 分页查询结果«医生信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 医生信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.132. 分页查询结果«发药单摘要信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 发药单摘要信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.133. 分页查询结果«商品信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 商品信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.134. 分页查询结果«库存调拨单列表视图»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 库存调拨单列表视图 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.135. 分页查询结果«开卡充值业绩明细视图»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 开卡充值业绩明细视图 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.136. 分页查询结果«患者发药单信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 患者发药单信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.137. 分页查询结果«患者执行单信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 患者执行单信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.138. 分页查询结果«患者摘要信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 患者摘要信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.139. 分页查询结果«患者收费单摘要信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 患者收费单摘要信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.140. 分页查询结果«患者附件»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 患者附件 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.141. 分页查询结果«患者预约摘要信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 患者预约摘要信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.142. 分页查询结果«执行业绩-明细»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 执行业绩-明细 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.143. 分页查询结果«挂号单基础信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 挂号单基础信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.144. 分页查询结果«收费明细-分类信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 收费明细-分类信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.145. 分页查询结果«收费明细-单据信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 收费明细-单据信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.146. 分页查询结果«收费明细-明细信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 收费明细-明细信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.147. 分页查询结果«检查检验单摘要信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 检查检验单摘要信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.148. 分页查询结果«检查检验摘要信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 检查检验摘要信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.149. 分页查询结果«检查检验项目信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 检查检验项目信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.150. 分页查询结果«门诊单摘要信息»
名称 | 说明 | 类型 |
---|---|---|
rows |
数据集 |
< 门诊单摘要信息 > array |
total |
总条数 |
integer (int32) |
offset |
查询偏移量 |
integer (int32) |
limit |
查询条数 |
integer (int32) |
7.151. 创建中药处方请求参数
名称 | 说明 | 类型 |
---|---|---|
isTotalPriceChanged |
是否议价 0:不议价 1:议价,默认值为 0 |
integer (int32) |
pharmacyNo |
药房号,默认 0:本地药房 |
integer (int32) |
expectedTotalPrice |
期望处方总价(议价时使用) |
number |
specification |
类型 中药饮片/中药颗粒 |
string |
doseCount |
剂数 |
integer (int32) |
prescriptionFormItems |
样例 : |
< 创建处方药品请求基类 > array |
usage |
用法 [煎服,冲服,制膏] |
string |
dailyDosage |
每日剂量 |
string |
freq |
用药频次 |
string |
usageLevel |
单次服用用量 |
string |
usageDays |
服用天数描述,usage 为制膏时有效 |
string |
requirement |
服用要求或备注 |
string |
processInfo |
加工信息 |
7.152. 创建供应商请求参数
名称 | 说明 | 类型 |
---|---|---|
name |
供应商名称 |
string |
status |
供应商状态 0:禁用 1:启用 |
integer (int32) |
licenseId |
供应商许可证号 |
string |
contact |
供应商联系人 |
string |
mobile |
供应商联系方式 |
string |
mark |
供应商备注 |
string |
operatorId |
操作人ID |
string |
7.153. 创建入库单请求
名称 | 说明 | 类型 |
---|---|---|
supplierId |
供应商Id |
string |
outOrderNo |
随货单号 |
string |
pharmacyNo |
药房号,默认0号药房 |
integer (int32) |
toClinicId |
入库门店ID,仅总部支持给其他子店入库,其他场景为当前门店ID |
string |
comment |
单据备注,不能超过 500 个字符 |
string |
inOrderItemList |
入库明细 |
< 入库明细 > array |
7.154. 创建出库单请求
名称 | 说明 | 类型 |
---|---|---|
inOrderId |
入库单ID,如果没有传会通过 batchNo 随机获取 |
integer (int64) |
pharmacyNo |
药房号,默认0号药房 |
integer (int32) |
toClinicId |
出库门店ID,仅总部支持给其他子店入库,其他场景为当前门店ID |
string |
comment |
单据备注,不能超过 500 个字符 |
string |
outOrderItemList |
出库明细 |
< 出库明细 > array |
7.155. 创建商品请求参数
名称 | 说明 | 类型 |
---|---|---|
type |
商品类型 1:药品 2:物资 7:商品 |
integer (int32) |
subType |
商品子类型 当 type 为 1 时 1:西药 2:中药 3:中成药 当 type 为 2 时 1:医疗器械 2:后勤材料 3:固定资产 当 type 为 7 时 1:自制成品 2:保健药品 3:保健食品 4:其他商品 |
integer (int32) |
medicineCadn |
商品通用名 |
string |
name |
商品名, type为 1 ,subtype为 1 3 时可有值 |
string |
shortId |
商品编码,系统生成或自定义 |
string |
cMSpec |
中药规格, type为 1,subtype为 2 时有值,值为[中药饮片|中药颗粒] |
string |
dismounting |
拆零标识 0:不可拆零 1:可拆零, type 为 1,subType为 2 时值为 1 |
integer (int32) |
extendSpec |
规格,type为 1,subType为 2可有值 |
string |
materialSpec |
规格,type为 2 7可有值 |
string |
manufacturer |
生产厂家 |
string |
medicineNmpn |
批准文号 |
string |
barCode |
条形码 |
string |
pieceNum |
最小包装数量, type为 1,subType为 3 时值为 1 |
integer (int32) |
pieceUnit |
最小包装单位 |
string |
packageUnit |
包装单位 |
string |
componentContentUnit |
容量单位, tpe为 1,subType为 1,3时可有值 |
string |
componentContentNum |
容量数量, tpe为 1,subType为 1,3时可有值 |
number |
medicineDosageNum |
成分含量数量, tpe为 1,subType为 1,3时可有值 |
number |
medicineDosageUnit |
成分含量单位, tpe为 1,subType为 1,3时可有值 |
string |
piecePrice |
拆零价格 |
number |
packagePrice |
零售价格 |
number |
operatorId |
操作人ID |
string |
7.156. 创建处方基类
名称 | 说明 | 类型 |
---|---|---|
isTotalPriceChanged |
是否议价 0:不议价 1:议价,默认值为 0 |
integer (int32) |
expectedTotalPrice |
期望处方总价(议价时使用) |
number |
prescriptionFormItems |
样例 : |
< 创建西药处方药品请求 > array |
7.157. 创建处方药品请求基类
名称 | 说明 | 类型 |
---|---|---|
productId |
商品ID,商品ID和商品编码任选一个,如果传了商品编码,则以商品编码为准,并且单次请求中的所有商品都只能用商品编码 |
string |
specialRequirement |
特殊要求 [先煎,后下,冲服] |
string |
productShortId |
商品编码,商品ID和商品编码任选一个,如果传了商品编码,则以商品编码为准,并且单次请求中的所有商品都只能用商品编码 |
string |
unitCount |
单位数量 |
number |
expectedUnitPrice |
期望单价(议价时使用) |
number |
expectedTotalPrice |
期望总价格(议价时使用) |
number |
useDismounting |
是否拆零销售 0:不拆零 1:拆零(需要药品物资支持拆零出售),默认为 0 |
integer (int32) |
7.158. 创建患者请求体
名称 | 说明 | 类型 |
---|---|---|
name |
姓名 |
string |
mobile |
手机号 |
string |
sex |
性别[男,女] |
string |
birthday |
生日 |
string |
sourceId |
患者来源分类id |
string |
sourceFromId |
患者来源分类下某个具体来源id。比如:当就诊来源分类为【医生推荐】时,根据api【5.2.2. 获取医生分页列表信息】获取到医生,此时字段取值为医生id;当就诊来源分类为【导医推荐】时, 根据api【5.1.3. 获取门店成员列表】获取到成员,此时字段取值为成员id;当就诊来源分类为【顾客推荐】时, 根据api【5.4.3. 获取患者列表】获取到患者,此时字段取值为患者id; |
string |
idCard |
身份证 |
string |
pastHistory |
既往史 |
string |
address |
家庭住址 |
|
sn |
档案号 |
string |
remark |
备注 |
string |
profession |
职业 |
string |
company |
公司单位 |
string |
marital |
婚姻状态 |
string |
weight |
体重 |
string |
7.159. 创建挂号单响应结果
名称 | 说明 | 类型 |
---|---|---|
registrationSheetId |
挂号单ID |
string |
patientOrderId |
就诊单ID |
string |
7.161. 创建检查检验单请求
名称 | 说明 | 类型 |
---|---|---|
patientId |
患者ID |
string |
productSubType |
商品子类型 1:检验 2:检查 |
integer (int32) |
examinationFormItems |
检查检验项列表 |
< 创建检查检验项请求 > array |
doctorId |
开单医生ID |
string |
doctorDepartmentId |
开单医生科室ID |
string |
operatorId |
操作人ID,默认为 '00000000000000000000000000000000' |
string |
7.162. 创建检查检验项请求
名称 | 说明 | 类型 |
---|---|---|
productId |
商品ID |
string |
name |
检查检验项名称 |
string |
unitCount |
单位数量 |
number |
7.163. 创建病历请求
名称 | 说明 | 类型 |
---|---|---|
chiefComplaint |
主述/现病史 |
string |
pastHistory |
既往史 |
string |
familyHistory |
家族史 |
string |
presentHistory |
现病史 |
string |
physicalExamination |
体格检查 |
string |
diagnosis |
诊断 |
string |
doctorAdvice |
医嘱 |
string |
syndrome |
辨症 |
string |
therapy |
治法 |
string |
chineseExamination |
望闻切诊 |
string |
obstetricalHistory |
妇科月经婚育史 |
string |
7.164. 创建西药处方药品请求
名称 | 说明 | 类型 |
---|---|---|
ast |
皮试标识 1:皮试 2:续用 3:免试 |
integer (int32) |
productId |
商品ID,商品ID和商品编码任选一个,如果传了商品编码,则以商品编码为准,并且单次请求中的所有商品都只能用商品编码 |
string |
productShortId |
商品编码,商品ID和商品编码任选一个,如果传了商品编码,则以商品编码为准,并且单次请求中的所有商品都只能用商品编码 |
string |
usage |
用法 |
string |
freq |
频率 qd:每天1次 bid:每天2次 tid:每天3次 qid:每天4次 qod:隔日1次 qw:每周1次 biw:每周2次 hs:临睡前 qn:每晚1次 st:立即 sos:需要时 prn:需要时(长期) qnd:每N天1次 qnw:每N周1次 qnh:每N小时1次 |
string |
unitCount |
单位数量 |
number |
dosage |
单次剂量 |
number |
expectedUnitPrice |
期望单价(议价时使用) |
number |
dosageUnit |
单次单位 |
string |
expectedTotalPrice |
期望总价格(议价时使用) |
number |
days |
用药天数 |
number |
useDismounting |
是否拆零销售 0:不拆零 1:拆零(需要药品物资支持拆零出售),默认为 0 |
integer (int32) |
specialRequirement |
特殊用法 |
string |
pharmacyNo |
药房号,默认 0:本地药房 |
integer (int32) |
7.165. 创建门诊单请求参数
名称 | 说明 | 类型 |
---|---|---|
departmentId |
医生科室ID |
string |
doctorId |
医生ID |
string |
patientId |
患者ID |
string |
operatorId |
操作人ID |
string |
medicalRecord |
病历 |
|
prescriptionChineseForms |
中药处方列表 |
< 创建中药处方请求参数 > array |
prescriptionWesternForms |
西药处方列表 |
< 创建处方基类 > array |
7.166. 删除商品响应
名称 | 说明 | 类型 |
---|---|---|
id |
商品ID |
string |
7.167. 医生信息
开方医生
名称 | 说明 | 类型 |
---|---|---|
id |
ID:唯一标识 |
string |
mobile |
手机号码 |
string |
name |
姓名 |
string |
sex |
性别 |
string |
headImgUrl |
头像 |
string |
introduction |
医生简介 |
string |
practiceImgUrl |
头像 |
string |
doctorPageUrl |
医生微诊所页面 |
string |
doctorTags |
医生标签 |
< string > array |
7.168. 医生信息详情
名称 | 说明 | 类型 |
---|---|---|
departments |
医生科室列表 |
< 科室摘要信息 > array |
id |
ID:唯一标识 |
string |
mobile |
手机号码 |
string |
name |
姓名 |
string |
sex |
性别 |
string |
headImgUrl |
头像 |
string |
introduction |
医生简介 |
string |
practiceImgUrl |
头像 |
string |
doctorPageUrl |
医生微诊所页面 |
string |
doctorTags |
医生标签 |
< string > array |
7.170. 医生排班号源详情响应结果
名称 | 说明 | 类型 |
---|---|---|
doctorId |
医生ID |
string |
departmentId |
科室ID |
string |
workingDate |
工作日期 |
string |
dayOfWeek |
周几 |
string |
restCountToday |
当天余号 |
integer (int32) |
canReserve |
是否可预约 0:否 1:是 |
integer (int32) |
scheduleIntervals |
预约时段列表 |
< 预约时段 > array |
7.171. 医生科室排班预约信息
名称 | 说明 | 类型 |
---|---|---|
id |
科室id |
string |
name |
科室名称 |
string |
restCount |
余号 |
integer (int32) |
totalCount |
总数量 |
integer (int32) |
status |
排班状态 0:有号 1:约满 2:无号(排班班次拆分后的总预约单元格为空,如:班次时长不满足最小服务时长等) 3:未放号 4:完诊(最晚排班结束时间已过) 5:无排班 |
integer (int32) |
fee |
挂号费 |
number |
registerStartTime |
预约开始时间 HH:mm(开放平台的预约挂号接口没有这个限制) |
string |
registrationCategoryDayShifts |
挂号种类号源详情信息列表 |
< 挂号种类号源信息 > array |
7.172. 医生预约排班信息
名称 | 说明 | 类型 |
---|---|---|
date |
预约日期 yyyy-MM-dd |
string |
departments |
科室列表 |
< 医生科室排班预约信息 > array |
7.173. 单据进销存批次信息
单据进销存批次信息
名称 | 说明 | 类型 |
---|---|---|
stockId |
调拨GoodsStock的Id,如果没指定批次,这个字段为空 |
integer (int64) |
stockInOutDetailId |
stockIn 外部明细ID |
string |
batchId |
批次号 |
integer (int64) |
supplier |
供应商 |
|
batchNo |
调拨批号 |
string |
productionDate |
生产日期 |
string |
expiryDate |
有效期 |
string |
packageCount |
整包装库存变化量,正数代表增加库存,负数代表扣库 |
number |
pieceCount |
入库制剂数量,正数代表增加库存,负数代表扣库 |
number |
packageCostPrice |
包装成本单价 |
number |
pieceNum |
制剂数量 |
integer (int32) |
costPrice |
变更总成本 |
number |
7.174. 发药单-处方信息
名称 | 说明 | 类型 |
---|---|---|
id |
唯一标识 |
string |
dispseneFormType |
发药单类型 4:中西药处方 5:输注处方 6:中药处方 7:门诊单新加的项目收费 8:门诊单新加的商品收费 9:材料 10:赠品 11:套餐 |
integer (int32) |
numberOfHerbs |
中药处方中药味数 |
integer (int32) |
usageInfo |
门诊处方的用法用量 医嘱等信息 |
|
totalPrice |
总金额 |
number |
dispensingFormItems |
药品发药列表 |
< 发药处方的药品发药信息 > array |
compoundInfo |
调配信息 |
|
auditInfo |
审核信息 |
7.175. 发药单事件
名称 | 说明 | 类型 |
---|---|---|
clinicId |
门店ID |
string |
id |
唯一标识 |
string |
sourceSheetId |
来源订单ID:门诊发药单-收费单ID |
string |
doctorId |
医生ID |
string |
patientOrderId |
本次发药单所属的就诊单ID |
string |
patientOrderNo |
本次发药单所属的就诊单的就诊号 |
string |
diagnosedDate |
就诊诊断时间 |
string (date-time) |
medicalRecord |
病例诊断信息 |
|
patientInfo |
患者信息 |
|
deliveryInfo |
快递信息 |
|
deliveredStatus |
快递状态 0:不需要快递 1:未发快递 2:已发快递 |
integer (int32) |
deliveryType |
快递类型 0:不需要快递 1:需要快递 |
integer (int32) |
status |
发药单状态 0:未发药 1:已发药 2:已退药 |
integer (int32) |
statusName |
发药状态名称 |
string |
dispensedBy |
发药人ID |
string |
dispensedByName |
发药人名称 |
string |
dispensedTime |
发药时间 |
string (date-time) |
created |
发药单创建时间 |
string (date-time) |
pharmacy |
药房信息 |
|
netIncomeFee |
总金额 |
number |
doctor |
医生信息 |
|
department |
科室 |
|
isShebaoPay |
是否社保支付 0:不是 1:是 |
integer (int32) |
dispensingForms |
发药单包含的处方列表 |
< 发药单-处方信息 > array |
7.176. 发药单摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
发药单ID |
string |
patientOrderId |
本次发药单所属的就诊单ID |
string |
patientOrderNo |
就诊单号 |
string |
chargeSheetId |
关联收费单ID |
string |
pharmacyNo |
药房号 |
integer (int32) |
pharmacyType |
药房类型:0:实体药房 1:空中药房 2:虚拟药房 |
integer (int32) |
status |
发药单状态 0:待发 1:已发 2:已退 3:关闭 4:取消 |
integer (int32) |
patient |
患者信息 |
7.177. 发药单详情
名称 | 说明 | 类型 |
---|---|---|
clinicId |
门店ID |
string |
id |
唯一标识 |
string |
sourceSheetId |
来源订单ID:门诊发药单-收费单ID |
string |
doctorId |
医生ID |
string |
patientOrderId |
本次发药单所属的就诊单ID |
string |
patientOrderNo |
本次发药单所属的就诊单的就诊号 |
string |
diagnosedDate |
就诊诊断时间 |
string (date-time) |
medicalRecord |
病例诊断信息 |
|
patientInfo |
患者信息 |
|
deliveryInfo |
快递信息 |
|
deliveredStatus |
快递状态 0:不需要快递 1:未发快递 2:已发快递 |
integer (int32) |
deliveryType |
快递类型 0:不需要快递 1:需要快递 |
integer (int32) |
status |
发药单状态 0:未发药 1:已发药 2:已退药 |
integer (int32) |
statusName |
发药状态名称 |
string |
dispensedBy |
发药人ID |
string |
dispensedByName |
发药人名称 |
string |
dispensedTime |
发药时间 |
string (date-time) |
created |
发药单创建时间 |
string (date-time) |
pharmacy |
药房信息 |
|
netIncomeFee |
总金额 |
number |
doctor |
医生信息 |
|
department |
科室 |
|
isShebaoPay |
是否社保支付 0:不是 1:是 |
integer (int32) |
dispensingForms |
发药单包含的处方列表 |
< 发药单-处方信息 > array |
7.178. 发药商品供应商
名称 | 说明 | 类型 |
---|---|---|
id |
供应商Id |
string |
name |
供应商的名字 |
string |
7.179. 发药处方的药品发药信息
名称 | 说明 | 类型 |
---|---|---|
id |
唯一标识 |
string |
sourceFormItemId |
来源项目ID:门诊发药单-收费项ID |
string |
status |
发药状态 0:未发药 1:已发药 2:已退药 |
integer (int32) |
productId |
发药商品ID |
string |
productName |
发药药品的名称 |
string |
unit |
发药单位 |
string |
unitCount |
每剂发药数量 |
number |
doseCount |
剂数 |
number |
totalCount |
药物总重量 |
number |
usageInfo |
药品的特别用法 |
|
productInfo |
药品信息 |
|
totalPrice |
总金额 |
number |
dispensingBatches |
发药批次 |
< 发药批次信息 > array |
7.180. 发药批次信息
名称 | 说明 | 类型 |
---|---|---|
action |
动作:发药;退药 |
string |
stockId |
GoodsStock的Id,如果没指定批次,这个字段为空 |
integer (int64) |
supplier |
库存商品供应商信息 |
|
batchId |
批次号 |
integer (int64) |
batchNo |
生产批号 |
string |
productionDate |
生产日期 |
string |
expiryDate |
有效期 |
string |
packageCount |
整包装库存变化量,发药时为负值,退药时为正值 |
number |
piecePrice |
小包装销售单价 |
number |
packagePrice |
大包装销售单价 |
number |
pieceCount |
制剂数量,发药是为负值,退药时为正值 |
number |
packageCostPrice |
包装成本单价 |
number |
costPrice |
成本价变化量 |
number |
salePrice |
变更实收 |
number |
stockInOutDetailId |
入库外部明细ID |
string |
created |
创建时间 |
string (date-time) |
7.181. 取消快递费请求参数
名称 | 说明 | 类型 |
---|---|---|
operatorId |
操作人ID |
string |
7.182. 取消挂号响应
名称 | 说明 | 类型 |
---|---|---|
isSuccess |
是否成功 |
integer (int32) |
tips |
退号提示 |
string |
7.183. 告警信息
名称 | 说明 | 类型 |
---|---|---|
title |
标题 |
string |
content |
内容 |
string |
7.184. 员工信息
名称 | 说明 | 类型 |
---|---|---|
id |
员工ID |
string |
name |
员工名字 |
string |
7.185. 商品SPU信息
名称 | 说明 | 类型 |
---|---|---|
id |
商品 SPU ID |
string |
name |
SPU 名称 |
string |
brandName |
品牌名称 |
string |
material |
材质 |
string |
7.186. 商品SPU规格属性
名称 | 说明 | 类型 |
---|---|---|
color |
颜色(仅镜架商品 typeId 为 65 有该字段) |
string |
spec |
规格(仅太阳镜商品 typeId 为 69 有该字段) |
string |
7.187. 商品信息
名称 | 说明 | 类型 |
---|---|---|
id |
商品编码 |
string |
shortId |
商品短编码 |
string |
name |
商品名称 |
string |
specification |
规格型号 |
string |
typeId |
分类id |
integer (int32) |
typeName |
商品类型 |
string |
combineType |
是否是组合类型 0:非组合类型 1:组合类型 |
integer (int32) |
pieceNum |
制剂数量 |
number |
pieceUnit |
制剂单位 |
string |
packageUnit |
包装单位 |
string |
lastModified |
最后修改时间 |
string (date-time) |
status |
商品状态 1:正常 99:删除 |
integer (int32) |
disableSell |
禁售销售 0:正常 1:禁止销售 |
integer (int32) |
7.188. 商品分类信息
名称 | 说明 | 类型 |
---|---|---|
id |
分类ID |
integer (int32) |
type |
一级分类 |
integer (int32) |
subType |
二级分类 |
integer (int32) |
category |
三级分类 |
string |
isLeaf |
是否叶子结点 0非叶子结点 1 叶子结点 |
integer (int32) |
name |
分类名称 |
string |
children |
children节点 |
< 商品分类信息 > array |
7.190. 商品库存信息
名称 | 说明 | 类型 |
---|---|---|
productId |
商品ID |
string |
productShortId |
商品编码 |
string |
stockPieceCount |
小包装可售库存数量: 总库存 - 禁售库存 - 锁定库存 |
number |
stockPackageCount |
大包装可售库存数量:总库存 - 禁售库存 - 锁定库存 |
number |
pharmacyStocks |
各药房库存列表 |
< 药房库存信息 > array |
7.191. 商品库存调拨单事件
名称 | 说明 | 类型 |
---|---|---|
id |
调拨单ID |
integer (int64) |
amount |
调拨总金额(含税) |
number |
count |
所有调拨商品转成大包装的数量的累加 |
number |
kindCount |
种类数量(调拨单里面有几种类型的药) |
integer (int32) |
orderNo |
可读的调拨库单号 |
string |
transType |
调拨单类型0:门店间调拨1:药房间调拨 |
integer (int32) |
transCostPriceType |
调拨价格类型(0:同价调拨(调出方改入库成本加,会影响到掉入方的成本)1:异价调拨) |
integer (int32) |
createdUser |
创建人 |
|
created |
出库单创建时间 |
string (date-time) |
reviewDate |
总部审核时间 |
string (date-time) |
reviewUser |
审核人 |
|
inConfirmDate |
调拨单调入确认时间 |
string (date-time) |
inConfirmUser |
调拨单调入放确认人 |
|
toOrgan |
调入的门店 |
|
inPharmacy |
调入的药房 |
|
fromOrgan |
调来的门店 |
|
outPharmacy |
调出的药房 |
|
lastModified |
最近一次修改时间 |
string (date-time) |
lastModifiedUser |
最近一次修改人 |
|
status |
调拨单状态 0:待出库房确认 5:待总部审核 9:拒绝 10:待入库方确认 20:调拨完成 31:撤回 |
integer (int32) |
items |
调拨项列表 |
< 商品库存调拨项 > array |
7.192. 商品库存调拨项
名称 | 说明 | 类型 |
---|---|---|
applicationPackageCount |
申请调拨的大包数量 |
number |
applicationPieceCount |
申请调拨的小包数量 |
number |
packageCount |
实际调拨的大包数量 |
number |
pieceCount |
实际调拨的小包数量 |
number |
goods |
goods快照信息 |
|
outTotalCostPrice |
总成本 |
number |
outPackageCostPrice |
调拨成本价 |
number |
bathes |
调拨批次(调出方指定了调拨批次时有效) |
< 调拨批次 > array |
transInBatches |
调入门店的批次信息 |
< 单据进销存批次信息 > array |
lastModified |
上次修改时间 |
string (date-time) |
7.193. 商品批次信息
名称 | 说明 | 类型 |
---|---|---|
batchId |
批次号 |
integer (int64) |
stockInOutDetailId |
stockIn 外部明细ID |
string |
batchNo |
批号 |
string |
productionDate |
生产日期 yyyy-MM-dd |
string |
expiryDate |
效期 yyyy-MM-dd |
string |
stockPieceCount |
小包装可售库存数量: 总库存 - 禁售库存 - 锁定库存 |
number |
stockPackageCount |
大包装可售库存数量:总库存 - 禁售库存 - 锁定库存 |
number |
packageCostPrice |
大包装成本价 |
number |
inDate |
入库时间 yyyy-MM-dd HH:mm:ss |
string (date-time) |
7.194. 商品批次汇总信息
名称 | 说明 | 类型 |
---|---|---|
productId |
商品ID |
string |
pieceNum |
制剂数量 |
number |
batches |
批次列表 |
< 商品批次信息 > array |
7.195. 商品明细信息
名称 | 说明 | 类型 |
---|---|---|
cmspec |
样例 : |
string |
id |
商品ID |
string |
medicineCadn |
商品通用名 |
string |
name |
商品名 |
string |
type |
商品类型 1:药品 2:物资 7:商品 |
integer (int32) |
subType |
商品子类型 当 type 为 1 时 1:西药 2:中药 3:中成药 当 type 为 2 时 1:医疗器械 2:后勤材料 3:固定资产 当 type 为 7 时 1:自制成品 2:保健药品 3:保健食品 4:其他商品 |
integer (int32) |
typeId |
系统分类ID |
integer (int32) |
typeName |
系统分类名称 |
string |
customTypeId |
自定义分类ID |
string |
customTypeName |
自定义分类名称 |
string |
manufacturer |
生产厂家 |
string |
medicineNmpn |
国药准字 |
string |
barCode |
条形码 |
string |
extendSpec |
规格,type为 1,subType为 2可有值 |
string |
materialSpec |
规格,type为 2 7可有值 |
string |
pieceUnit |
制剂单位 |
string |
pieceNum |
制剂数量(10支/盒中的10) |
number |
piecePrice |
制剂单价 |
number |
packageUnit |
包装单位 |
string |
packagePrice |
包装单价 |
number |
shortId |
药品编码 |
string |
displaySpec |
规格: 组装好的格式 |
string |
displayName |
名称:组织名称 |
string |
status |
商品状态 1:正常 99:删除 |
integer (int32) |
7.196. 商品条目信息
商品条目信息
名称 | 说明 | 类型 |
---|---|---|
id |
商品ID |
string |
name |
商品名称 |
string |
typeId |
系统分类ID |
integer (int32) |
typeName |
系统分类名称 |
string |
customTypeId |
自定义分类ID |
string |
customTypeName |
自定义分类名称 |
string |
manufacturer |
生产厂家 |
string |
medicineNmpn |
国药准字 |
string |
barCode |
条形码 |
string |
pieceUnit |
制剂单位 |
string |
pieceNum |
制剂数量(10支/盒中的10) |
number |
piecePrice |
制剂单价 |
number |
packageUnit |
包装单位 |
string |
packagePrice |
包装单价 |
number |
shortId |
药品编码 |
string |
specification |
规格: 组装好的格式 |
string |
otcType |
OTC药物 1处方药 2:甲类非处方 4:乙类非处方 |
integer (int32) |
status |
商品状态 1:正常 99:删除 |
integer (int32) |
lastModified |
最后修改时间 |
string (date-time) |
goodsSpu |
商品SPU信息(目前仅眼镜商品有值) |
|
goodsSpec |
商品SPU规格属性(目前仅眼镜商品有值) |
7.197. 商品社保信息
名称 | 说明 | 类型 |
---|---|---|
nationalCode |
社保国家码 |
string |
insuranceTypes |
险种信息列表 |
< 商品社保险种信息 > array |
7.198. 商品社保险种信息
名称 | 说明 | 类型 |
---|---|---|
insuranceType |
险种,和每个地区的医保相关 |
string |
reimbursementRatio |
报销比例(范围为0到1) |
number |
7.199. 商品详情
名称 | 说明 | 类型 |
---|---|---|
children |
商品子项 |
< 商品详情 > array |
id |
商品ID |
string |
name |
商品名称 |
string |
shebao |
社保信息 |
|
disableSell |
禁售销售 0:正常 1:禁止销售 |
integer (int32) |
typeId |
系统分类ID |
integer (int32) |
typeName |
系统分类名称 |
string |
customTypeId |
自定义分类ID |
string |
customTypeName |
自定义分类名称 |
string |
manufacturer |
生产厂家 |
string |
medicineNmpn |
国药准字 |
string |
barCode |
条形码 |
string |
pieceUnit |
制剂单位 |
string |
pieceNum |
制剂数量(10支/盒中的10) |
number |
piecePrice |
制剂单价 |
number |
packageUnit |
包装单位 |
string |
packagePrice |
包装单价 |
number |
shortId |
药品编码 |
string |
specification |
规格: 组装好的格式 |
string |
otcType |
OTC药物 1处方药 2:甲类非处方 4:乙类非处方 |
integer (int32) |
status |
商品状态 1:正常 99:删除 |
integer (int32) |
lastModified |
最后修改时间 |
string (date-time) |
goodsSpu |
商品SPU信息(目前仅眼镜商品有值) |
|
goodsSpec |
商品SPU规格属性(目前仅眼镜商品有值) |
7.200. 商品采购单审核请求
名称 | 说明 | 类型 |
---|---|---|
pass |
是否通过 0:拒绝 1:通过,默认值 1 |
integer (int32) |
comment |
审核评论或备注 |
string |
7.201. 地区信息
名称 | 说明 | 类型 |
---|---|---|
id |
地区ID |
string |
name |
地区名称 |
string |
children |
下级区域列表 |
< 地区信息 > array |
7.202. 处方-药品使用信息
名称 | 说明 | 类型 |
---|---|---|
usage |
处方用法(煎服,冲服,制膏,制丸,外用,贴敷,打粉,泡饮,泡酒,泡浴,泡脚,擦拭) |
string |
freq |
每日次数 |
string |
medicineRequirement |
处方药品特殊煎煮方式(先煎,先煎半小时,先煎一小时,后下,包煎,另煎,先炒,烊化,冲服,捣碎,另包) |
string |
doseCount |
处方剂量 |
integer (int32) |
dailyDosage |
每日使用剂数 |
string |
requirement |
处方备注 |
string |
usageLevel |
每次用量 |
string |
processUsage |
加工制法(煎药,手工煎药,机器煎药(普通),制膏,儿童膏方,成人膏方,打粉,粗粉,细粉,超细粉,制丸,水丸,蜜丸,水蜜丸,浓缩丸,机器煎药(浓缩),颗粒,茶包,胶囊) |
string |
processRemark |
加工备注 |
string |
usageDays |
服用天数描述 |
string |
processBagUnitCount |
每剂加工数量,一剂煎X袋,共煎Y袋的X。 |
number |
totalProcessCount |
总加工数量,一剂煎X袋,共煎Y袋的Y。 |
number |
7.203. 处方信息
名称 | 说明 | 类型 |
---|---|---|
id |
处方ID |
string |
type |
处方类型 1:西药 2:输液 3:中药 |
integer (int32) |
specification |
类型(饮片、颗粒) |
string |
doseCount |
剂数 |
integer (int32) |
dailyDosage |
每日剂量 |
string |
usage |
用法 |
string |
freq |
用药频次 |
string |
requirement |
服用要求 |
string |
usageLevel |
单次服用用量 |
string |
prescriptionFormItems |
处方单项 |
< 处方单项信息 > array |
7.204. 处方单项信息
名称 | 说明 | 类型 |
---|---|---|
id |
处方单项ID |
string |
prescriptionFormId |
处方单ID |
string |
productId |
药品id |
string |
type |
1:药品 2:物资 |
integer (int32) |
subType |
type = 1:药品(subType = 1:西药 subType = 2:中药 subType = 3:中成药)type = 2:物资(subType = 1:医用材料 subType = 2:后勤材料 subType = 3:固定资产) |
integer (int32) |
name |
药品商用名 |
string |
specification |
药品规格 |
string |
manufacturer |
生产厂家 |
string |
usage |
用法 |
string |
ivgtt |
输液滴速 |
number |
ivgttUnit |
输液滴塑单位 |
string |
freq |
用药频次 |
string |
dosage |
单次剂量 |
string |
dosageUnit |
剂量单位 |
string |
days |
用药天数 |
integer (int32) |
specialRequirement |
特殊要求 |
string |
isDismounting |
是否使用拆零 |
integer (int32) |
unitCount |
数量 |
number |
unit |
单位 |
string |
unitPrice |
单位价格 |
number |
groupId |
分组编号 |
integer (int32) |
isAst |
是否需要皮试 0:不需要皮试 1:需要皮试 |
integer (int32) |
astResult |
皮试结果 |
|
productInfo |
药品信息 |
7.205. 处方审核信息
处方审核信息
名称 | 说明 | 类型 |
---|---|---|
auditBy |
审核人ID |
string |
auditByName |
审核人名称 |
string |
auditByHandSign |
审核人手签 |
string |
auditTime |
审核时间 |
string (date-time) |
7.206. 处方调配信息
处方调配信息
名称 | 说明 | 类型 |
---|---|---|
compoundBy |
调配人ID |
string |
compoundByName |
调配人名称 |
string |
compoundByHandSign |
调配人手签 |
string |
compoundTime |
调配时间 yyyy-MM-dd HH:mm:ss |
string (date-time) |
7.207. 外部跟踪信息
名称 | 说明 | 类型 |
---|---|---|
content |
信息内容 |
string |
time |
时间 |
string |
7.209. 就诊来源类型
名称 | 说明 | 类型 |
---|---|---|
id |
类型ID |
string |
name |
类型名称或关联ID名称(当关联类型为单个员工时为员工名称;当关联类型为单个患者时为患者名称;当关联类型为员工角色时为角色名称,其他情况就是类型名称) |
string |
relatedType |
关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色 |
integer (int32) |
relatedId |
关联ID,由 relatedType 确定关联的是什么ID,关联单个患者时,是患者ID;关联单个医生时,是医生ID;关联的是医生角色时,是角色ID;其他情况为空 |
string |
children |
就诊来源子类(和 relatedType 有关,只有在关联类型为 0 的时候才可能有值) |
< 就诊来源类型 > array |
7.212. 库存出库单摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
出库单id |
integer (int64) |
orderNo |
出库单号 |
string |
status |
出库单状态 0:待确认 1:待审核 2:已完成 9:已拒绝 31:撤回 |
integer (int32) |
organName |
门店 |
string |
type |
出库单类型 1:科室出库 2:报损出库 3:退货出库 |
integer (int32) |
kindCount |
品种数量 |
integer (int32) |
count |
数量 |
number |
amount |
含税金额 |
number |
receiver |
领取人 |
string |
operator |
操作人(出库人) |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
inOrderId |
关联的入库单id |
string |
pharmacy |
出库药房 |
7.213. 库存商品供应商
名称 | 说明 | 类型 |
---|---|---|
id |
供应商Id |
string |
name |
供应商的名字 |
string |
7.215. 库存盘点单摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
盘点单ID |
integer (int64) |
orderNo |
盘点单号 |
string |
status |
盘点单状态 0:未知初始状态 10:新建待审批 20:审批被拒绝 30:完成(审批通过) 40:撤回 |
integer (int32) |
organId |
门店ID |
string |
organName |
门店 |
string |
count |
数量 |
number |
kindCount |
品种数量 |
integer (int32) |
totalCostPriceChange |
盈亏金额(进价) |
number |
totalPriceChange |
盈亏金额(售价) |
number |
operator |
操作人(入库人) |
string |
operatorId |
操作人ID |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
7.216. 库存结算单信息
名称 | 说明 | 类型 |
---|---|---|
id |
结算单ID |
integer (int64) |
createdUser |
结算单创建人 |
string |
createDate |
创建时间 |
string (date-time) |
supplierName |
供应商名称 |
string |
status |
结算单状态 -1:未结算 0:审批中 1:通过审批 6:审批被拒绝 9:撤回申请 |
integer (int32) |
includeTaxPrice |
含税金额 |
number |
excludeTaxPrice |
不含税金额 |
number |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
7.218. 库存结算单详情
名称 | 说明 | 类型 |
---|---|---|
id |
结算单ID |
integer (int64) |
itemsList |
结算单条目列表 |
< 结算单条目列表 > array |
createdUser |
结算单创建人 |
string |
invoicesList |
结算单发票列表 |
< 结算单发票列表 > array |
createDate |
创建时间 |
string (date-time) |
inOutList |
结算单入库单出库单列表 |
< 结算单入库单出库单列表 > array |
supplierName |
供应商名称 |
string |
status |
结算单状态 -1:未结算 0:审批中 1:通过审批 6:审批被拒绝 9:撤回申请 |
integer (int32) |
includeTaxPrice |
含税金额 |
number |
excludeTaxPrice |
不含税金额 |
number |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
7.219. 库存调拨单列表视图
名称 | 说明 | 类型 |
---|---|---|
id |
调拨单ID |
integer (int64) |
amount |
调拨总金额(含税) |
number |
count |
所有调拨商品转成大包装的数量的累加 |
number |
kindCount |
种类数量(调拨单里面有几种类型的药) |
integer (int32) |
orderNo |
可读的调拨库单号 |
string |
transType |
调拨单类型0:门店间调拨1:药房间调拨 |
integer (int32) |
transCostPriceType |
调拨价格类型(0:同价调拨(调出方改入库成本加,会影响到掉入方的成本)1:异价调拨) |
integer (int32) |
createdUser |
创建人 |
|
created |
出库单创建时间 |
string (date-time) |
reviewDate |
总部审核时间 |
string (date-time) |
reviewUser |
审核人 |
|
inConfirmDate |
调拨单调入确认时间 |
string (date-time) |
inConfirmUser |
调拨单调入放确认人 |
|
toOrgan |
调入的门店 |
|
inPharmacy |
调入的药房 |
|
fromOrgan |
调来的门店 |
|
outPharmacy |
调出的药房 |
|
lastModified |
最近一次修改时间 |
string (date-time) |
lastModifiedUser |
最近一次修改人 |
|
status |
调拨单状态 0:待出库方确认 5:待总部审核 9:拒绝 10:待入库方确认 20:调拨完成 31:撤回 |
integer (int32) |
7.220. 库存调拨单详情
名称 | 说明 | 类型 |
---|---|---|
id |
调拨单ID |
integer (int64) |
amount |
调拨总金额(含税) |
number |
count |
所有调拨商品转成大包装的数量的累加 |
number |
kindCount |
种类数量(调拨单里面有几种类型的药) |
integer (int32) |
orderNo |
可读的调拨库单号 |
string |
transType |
调拨单类型0:门店间调拨1:药房间调拨 |
integer (int32) |
transCostPriceType |
调拨价格类型(0:同价调拨(调出方改入库成本加,会影响到掉入方的成本)1:异价调拨) |
integer (int32) |
createdUser |
创建人 |
|
created |
出库单创建时间 |
string (date-time) |
reviewDate |
总部审核时间 |
string (date-time) |
reviewUser |
审核人 |
|
inConfirmDate |
调拨单调入确认时间 |
string (date-time) |
inConfirmUser |
调拨单调入放确认人 |
|
toOrgan |
调入的门店 |
|
inPharmacy |
调入的药房 |
|
fromOrgan |
调来的门店 |
|
outPharmacy |
调出的药房 |
|
lastModified |
最近一次修改时间 |
string (date-time) |
lastModifiedUser |
最近一次修改人 |
|
status |
调拨单状态 0:待出库房确认 5:待总部审核 9:拒绝 10:待入库方确认 20:调拨完成 31:撤回 |
integer (int32) |
items |
调拨项列表 |
< 商品库存调拨项 > array |
7.221. 库存采购单信息
名称 | 说明 | 类型 |
---|---|---|
id |
采购单ID |
integer (int64) |
orderNo |
采购单号 |
string |
status |
采购单状态,0:待审核 1:审核通过 9:审核驳回 31:撤回 |
integer (int32) |
orderType |
采购类型,0:线下集采,10:ABC商城采购 |
integer (int32) |
purchaseOrganName |
采购门店名称 |
string |
purchaseOrganId |
采购门店ID |
string |
applyEmployeeId |
申请人ID |
string |
applyEmployeeName |
申请人 |
string |
purchaseOrderDate |
采购日期 |
string (date-time) |
created |
创建时间 |
string (date-time) |
7.222. 开卡充值业绩明细视图
名称 | 说明 | 类型 |
---|---|---|
id |
id |
string |
clinicId |
门店id |
string |
rechargeTime |
操作时间 yyyy-MM-dd HH:mm:ss |
string |
patientId |
患者id |
string |
patientMobile |
患者手机号 |
string |
cardId |
卡id |
string |
cardName |
卡名称 |
string |
operationType |
操作类型:1-开卡 2-销卡 4-充值 5-退储蓄金 |
integer (int32) |
actualAmount |
实收金额 |
number (double) |
rechargePrincipal |
充值本金 |
number (double) |
rechargePresent |
充值赠金 |
number (double) |
principalBalance |
剩余本金 |
number (double) |
presentBalance |
剩余赠金 |
number (double) |
sellerId |
销售员ID |
string |
sellerName |
销售员 |
string |
createdByName |
操作人 |
string |
createdBy |
操作人id |
string |
originPrice |
原价金额 |
number (double) |
7.223. 当前时段可用的号源
名称 | 说明 | 类型 |
---|---|---|
restCount |
当前号源剩余号数;0:当前号源不可用 |
integer (int32) |
timeOfDay |
号源对应 上午/下午/晚上 |
string |
orderNo |
号数 |
integer (int32) |
type |
预留号类型 0:非预留号 1:PC预留 2:会员预留号 |
integer (int32) |
start |
号源开始时间 HH:mm |
string |
end |
号源结束时间 HH:mm |
string |
available |
当前号源是否可用 |
integer (int32) |
7.224. 快递信息
名称 | 说明 | 类型 |
---|---|---|
addressProvinceName |
省 |
string |
addressCityName |
市 |
string |
addressDistrictName |
区 |
string |
addressDetail |
详细信息 |
string |
deliveryName |
收件人姓名 |
string |
deliveryMobile |
收件人手机号 |
string |
deliveryCompany |
快递公司 |
|
deliveryOrderNo |
快递单号 |
string |
deliveryPayType |
快递费用支付方式 0:到付 1:寄付 |
integer (int32) |
deliveryFee |
快递费用 |
number |
7.225. 快递公司
名称 | 说明 | 类型 |
---|---|---|
id |
快递公司ID |
string |
name |
快递公司名称 |
string |
7.226. 快递物流轨迹节点信息
名称 | 说明 | 类型 |
---|---|---|
context |
节点内容 |
string |
ftime |
节点时间 |
string |
7.228. 患者发药单信息
名称 | 说明 | 类型 |
---|---|---|
id |
发药单ID |
string |
patientOrderId |
本次发药单所属的就诊单ID |
string |
chargeSheetId |
关联收费单ID |
string |
pharmacyNo |
药房号 |
integer (int32) |
pharmacyType |
药房类型:0:实体药房 1:空中药房 2:虚拟药房 |
integer (int32) |
status |
发药单状态 0:待发 1:已发 2:已退 3:关闭 4:取消 |
integer (int32) |
created |
发药单创建时间 |
string (date-time) |
sellerId |
开单人ID |
string |
sellerName |
开单人姓名 |
string |
7.229. 患者合并事件信息
名称 | 说明 | 类型 |
---|---|---|
sourcePatientIds |
参与合并的患者ID列表(目前只会有两个) |
< string > array |
mergedPatient |
合并后的患者信息 |
7.230. 患者家庭成员信息
名称 | 说明 | 类型 |
---|---|---|
familyRole |
家庭角色 0:不是家庭成员 1:家长 2:家庭成员 |
integer (int32) |
id |
患者ID:唯一标识 |
string |
name |
姓名 |
string |
relation |
关系 |
string |
mobile |
手机号 |
string |
sex |
性别 |
string |
birthday |
出生日期 |
string |
age |
患者年龄大小 |
|
idCard |
身份证号 |
string |
7.231. 患者年龄
名称 | 说明 | 类型 |
---|---|---|
year |
岁 |
integer (int32) |
month |
月 |
integer (int32) |
day |
天 |
integer (int32) |
7.232. 患者执行单信息
名称 | 说明 | 类型 |
---|---|---|
id |
执行单ID |
string |
status |
执行状态 1:待执行 2:已执行 3:已取消(已退费) |
integer (int32) |
created |
创建时间 |
string (date-time) |
items |
执行项列表 |
< 患者执行项信息 > array |
sellerId |
开单人ID |
string |
sellerName |
开单人姓名 |
string |
7.233. 患者执行项信息
名称 | 说明 | 类型 |
---|---|---|
id |
执行项ID |
string |
productId |
商品ID |
string |
productName |
商品名称 |
string |
chargeStatus |
执行项收费状态 0:未收费 1:已收费 2:已退费 |
integer (int32) |
totalCount |
总次数(已退费的情况下为 null) |
number |
executedUnitCount |
已执行数量(已退费的情况下为null) |
number |
7.234. 患者摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
患者ID:唯一标识 |
string |
name |
姓名 |
string |
mobile |
手机号 |
string |
sex |
性别 |
string |
birthday |
出生日期 |
string |
age |
患者年龄大小 |
|
idCard |
身份证号 |
string |
7.235. 患者收费单摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
收费单ID |
string |
patientOrderId |
就诊单ID |
string |
doctorId |
医生ID |
string |
doctorName |
医生名称 |
string |
status |
收费单状态 0:未付费 1:部分付费 2:已付费 3:部分退费 4:已退费 |
integer (int32) |
receivableFee |
应收金额 |
number |
sellerId |
开单人ID |
string |
sellerName |
开单人名称 |
string |
chargerId |
收费员ID |
string |
chargerName |
收费员名称 |
string |
type |
收费单类型 0:未知 1:挂号 2:门诊 3:零售 5:会员充值 6:执行站开单 7:在线问诊 |
integer (int32) |
created |
创建时间 |
string (date-time) |
7.236. 患者更新事件信息
名称 | 说明 | 类型 |
---|---|---|
id |
患者ID:唯一标识 |
string |
name |
姓名 |
string |
birthday |
出生日期 |
string |
mobile |
手机号 |
string |
sex |
性别 |
string |
idCard |
身份证号 |
string |
address |
住址 |
|
sn |
档案号 |
string |
profession |
职业 |
string |
company |
公司 |
string |
patientSource |
来源 |
|
remark |
备注信息 |
string |
7.237. 患者来源
名称 | 说明 | 类型 |
---|---|---|
parentId |
来源类型上级ID |
string |
parentName |
来源类型上级名称 |
string |
id |
来源类型ID |
string |
name |
就诊推荐 |
string |
sourceFrom |
就诊推荐人ID,当关联类型为所有员工、员工角色时为员工ID;当关联类型为所有患者时为患者ID; |
string |
sourceFromName |
推荐人名称,当关联类型为所有员工、员工角色时为员工名称;当关联类型为所有患者时为患者名称; |
string |
relatedType |
关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色 |
integer (int32) |
relatedId |
关联ID,由 relatedType 确定关联的是什么ID,关联单个患者时是患者ID;关联单个医生时是医生ID;关联的是医生角色时是角色ID; |
string |
relateName |
就诊关联来源关联名称,和 relatedId 有关 |
string |
7.238. 患者标签
名称 | 说明 | 类型 |
---|---|---|
id |
标签ID |
string |
name |
标签名称 |
string |
7.239. 患者详细信息
名称 | 说明 | 类型 |
---|---|---|
createdClinicId |
患者创建门店ID |
string |
id |
患者ID:唯一标识 |
string |
createdClinicName |
患者创建门店名称 |
string |
name |
姓名 |
string |
created |
创建日期 |
string (date-time) |
mobile |
手机号 |
string |
patientSource |
来源 |
|
sex |
性别 |
string |
birthday |
出生日期 |
string |
sn |
档案号 |
string |
age |
患者年龄大小 |
|
idCard |
身份证号 |
string |
profession |
职业 |
string |
company |
公司 |
string |
remark |
remark |
string |
address |
住址 |
|
shebaoCardInfo |
社保信息 |
|
tags |
标签信息 |
< 患者标签 > array |
memberInfo |
会员卡信息 |
7.240. 患者附件
名称 | 说明 | 类型 |
---|---|---|
id |
附件ID |
string |
url |
附件路径 |
string |
fileName |
文件名称 |
string |
displayName |
展示名称 |
string |
created |
上传时间 yyyy-MM-dd HH:mm:ss |
string (date-time) |
businessCategory |
业务分类 0:其他 100:未知 101:CT 102:DR 103:CR 104:XR 105:ECG 106:BMD 107:VA 108:CC 109:MR 110:GI 111:BC 112:EEG 113:其他 |
integer (int32) |
7.241. 患者附件信息
名称 | 说明 | 类型 |
---|---|---|
url |
附件路径,长度不能超过512个字符,通过接口 【5.12.2 获取 OSS Token】上传到阿里云得到 |
string |
fileName |
文件名称,长度不能超过50个字符 |
string |
displayName |
展示名称,用于显示在界面上,长度不能超过50个字符 |
string |
businessCategory |
业务分类(默认为0) 0:其他 100:未知 101:CT 102:DR 103:CR 104:XR 105:ECG 106:BMD 107:VA 108:CC 109:MR 110:GI 111:BC 112:EEG 113:其他 |
integer (int32) |
7.242. 患者预约摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
挂号单ID |
string |
patientOrderId |
就诊单ID |
string |
departmentId |
科室ID |
string |
departmentName |
科室名称 |
string |
doctorId |
医生ID |
string |
doctorName |
医生名称 |
string |
reserveDate |
预约就诊日期 |
string |
reserveStart |
预约开始时间 |
string |
reserveEnd |
预约开始时间 |
string |
type |
类型 0:pc预约/挂号;2:门诊快速接诊挂号Direct;3:微诊所预约/挂号;4:open api 预约;5:在线咨询预约 |
integer (int32) |
status |
状态 10:待支付;12:已预约(理疗预约);20:待签到;21:已签到(理疗预约);30:待诊;40:已诊;90:已退号;92:已取消 |
integer (int32) |
payStatus |
支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费 |
integer (int32) |
consultingRoomId |
诊室ID |
string |
consultingRoomName |
诊室名称 |
string |
registrationProducts |
预约项目 |
< 预约项目摘要信息 > array |
created |
创建时间 |
string (date-time) |
7.243. 执行业绩-明细
名称 | 说明 | 类型 |
---|---|---|
id |
执行明细ID |
string |
patientId |
患者ID |
string |
patientName |
患者名称 |
string |
patientMobile |
患者手机号 |
string |
executeClinicId |
执行门店ID |
string |
executeClinicName |
执行门店名称 |
string |
executorIds |
执行人ID |
string |
executorNames |
执行人名称 |
string |
status |
状态 0:有效 1:撤销 |
integer (int32) |
executeDate |
执行时间 yyyy-MM-dd HH:mm:ss |
string |
productId |
执行项目ID |
string |
productShortId |
执行项目编码 |
string |
productName |
执行项目名称 |
string |
productType |
商品类型 |
integer (int32) |
productSubType |
商品子类型 |
integer (int32) |
executeCount |
执行次数 |
number |
totalPrice |
原价 |
number |
amount |
实收金额 |
number |
comment |
备注 |
string |
recordEffectInfo |
执行记录 |
string |
sheetCreateClinicId |
开单门店ID |
string |
sheetCreateClinicName |
开单门店名称 |
string |
sheetCreatedBy |
开单人 |
string |
sheetCreatedByName |
开单人名称 |
string |
sheetCreateDepartmentId |
开单科室ID |
string |
sheetCreateDepartmentName |
开单科室名称 |
string |
sheetCreated |
开单时间 yyyy-MM-dd HH:mm:ss |
string |
createdBy |
登记人ID |
string |
createdByName |
登记人名称 |
string |
chargeFormItemId |
收费项ID |
string |
chargeSheetId |
收费单ID |
string |
7.244. 执行事件消息
执行事件消息
名称 | 说明 | 类型 |
---|---|---|
id |
执行记录ID |
string |
executeSheetId |
执行单ID |
string |
patientOrderId |
就诊单ID |
string |
patient |
患者信息 |
|
executors |
执行人ID |
< 员工信息 > array |
items |
执行项目列表 |
< 执行记录执行项目信息 > array |
operator |
操作人 |
|
executeTime |
执行时间 |
string (date-time) |
7.245. 执行单执行请求参数
执行单执行请求参数
名称 | 说明 | 类型 |
---|---|---|
items |
执行项列表 |
< 治疗项目执行请求 > array |
executorIds |
执行人列表 |
< string > array |
operatorId |
操作人ID,如果不指定则取第一个执行人ID |
string |
comment |
备注 |
string |
7.246. 执行单摘要信息
执行单摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
执行单ID |
string |
patientOrderId |
就诊单ID |
string |
status |
执行状态 0:没有可执行项 1:待执行 2:已执行 3:已取消(已退费) |
integer (int32) |
patient |
患者信息 |
|
abstractInfo |
执行内容摘要信息 |
string |
created |
创建时间 |
string (date-time) |
7.247. 执行单详情
执行单详情
名称 | 说明 | 类型 |
---|---|---|
id |
执行单ID |
string |
patientOrderId |
就诊单ID |
string |
items |
执行项列表 |
< 执行项 > array |
status |
执行状态 0:没有可执行项 1:待执行 2:已执行 3:已取消(已退费) |
integer (int32) |
created |
创建时间 |
string (date-time) |
sellerId |
开单人ID |
string |
sellerName |
开单人姓名 |
string |
doctorId |
医生ID |
string |
doctorName |
医生名称 |
string |
diagnosis |
诊断 |
string |
7.248. 执行记录
执行记录
名称 | 说明 | 类型 |
---|---|---|
id |
执行记录ID |
string |
status |
执行状态 0:已执行 1:已取消 |
integer (int32) |
executors |
执行人ID |
< 员工信息 > array |
items |
执行项目列表 |
< 执行记录执行项目信息 > array |
executeTime |
执行时间 |
string (date-time) |
operator |
操作人 |
7.249. 执行记录执行项目信息
执行记录执行项目信息
名称 | 说明 | 类型 |
---|---|---|
id |
执行项执行记录ID |
integer (int64) |
executeItemId |
执行项目ID |
string |
executeItemProductId |
执行项商品ID |
string |
executeItemProductName |
执行项商品名称 |
string |
executeCount |
执行次数 |
integer (int32) |
7.250. 执行项
名称 | 说明 | 类型 |
---|---|---|
id |
ID:唯一标识 |
string |
needExecutive |
是否可以执行 0:不可以执行 1:可以执行 |
integer (int32) |
chargeFormId |
收费项FormId |
string |
executedUnitCount |
已执行数量 |
number |
executeStatus |
执行状态 1:待执行 2:已执行 3:已取消(已退费) |
integer (int32) |
productId |
收费商品ID |
string |
productName |
收费商品名称 |
string |
status |
收费项状态 0未收费 1已收费 2已退费 |
integer (int32) |
unit |
单位 |
string |
receivedFee |
实收,总金额,收费完成后有值 |
number |
unitPrice |
实收单价,收费完成后有值 |
number |
displayUnitPrice |
显示单价(待收费时是不使用任何优惠时的应收,部分收费或已收费时是优惠抵扣后的应收) |
number |
displayTotalPrice |
显示总价(待收费时是不使用任何优惠时的总应收,部分收费或已收费时是优惠抵扣后的总应收) |
number |
unitCount |
单位数量 |
number |
doseCount |
剂数 |
number |
totalCount |
总数量:totalCount = unitCount * doseCount |
number |
productType |
商品一级分类: 参考api 5.3.5. 获取商品分类 |
integer (int32) |
productSubType |
商品二级分类: 参考api 5.3.5. 获取商品分类 |
integer (int32) |
sourceItemType |
收费项来源类型 0:普通 1:自备 |
integer (int32) |
productInfo |
商品信息 |
|
composeChildren |
套餐项目列表 |
< 收费项目明细 > array |
7.251. 挂号事件
名称 | 说明 | 类型 |
---|---|---|
patientOrderId |
就诊单ID |
string |
visitSourceParentId |
就诊来源分类上级ID |
string |
registrationSheetId |
挂号单ID |
string |
visitSourceParentName |
就诊来源分类上级名称 |
string |
patientId |
患者ID |
string |
visitSourceId |
就诊来源分类ID |
string |
departmentId |
科室ID |
string |
visitSourceName |
就诊来源分类名称 |
string |
departmentName |
科室名称 |
string |
visitSourceFromId |
就诊来源分类下具体来源ID,当关联类型为所有员工、员工角色时为员工ID;当关联类型为所有患者时为患者ID; |
string |
doctorId |
医生ID |
string |
visitSourceFromName |
就诊来源分类下具体来源名称,当关联类型为所有员工、员工角色时为员工名称;当关联类型为所有患者时为患者名称; |
string |
doctorName |
医生名称 |
string |
visitSourceRelatedType |
就诊来源关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色 |
integer (int32) |
orderNo |
号数 |
string |
visitSourceRelatedId |
就诊来源关联ID,由 relatedType 确定关联的是什么ID,关联单个患者时是患者ID;关联单个医生时是医生ID;关联的是医生角色时是角色ID; |
string |
reserveDate |
预约就诊日期 |
string |
visitSourceRelateName |
就诊关联来源关联名称,和 visitSourceRelateId 有关 |
string |
reserveTime |
预约具体的时间 |
string |
visitSourceRemark |
就诊备注 |
string |
isReserved |
是否是预约号 1:是 0:否 |
integer (int32) |
status |
状态 10:待支付;12:已预约(理疗预约);20:待签到;21:已签到(理疗预约);30:待诊;40:已诊;90:已退号;92:已取消 |
integer (int32) |
signIn |
签到状态 0:无需签到 1:待签到 2:已签到 |
integer (int32) |
consultingRoomId |
诊室id |
string |
consultingRoomName |
诊室名称 |
string |
type |
预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号 |
integer (int32) |
payStatus |
支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费 |
integer (int32) |
code |
取号码 |
integer (int32) |
registrationType |
预约类型 0:门诊预约 1:理疗预约 10:检查预约 |
integer (int32) |
created |
创建时间 |
string (date-time) |
7.252. 挂号单基础信息
名称 | 说明 | 类型 |
---|---|---|
patientOrderId |
就诊单ID |
string |
registrationSheetId |
挂号单ID |
string |
patientId |
患者ID |
string |
departmentId |
科室ID |
string |
departmentName |
科室名称 |
string |
doctorId |
医生ID |
string |
doctorName |
医生名称 |
string |
orderNo |
号数 |
string |
reserveDate |
预约就诊日期 |
string |
reserveTime |
预约具体的时间 |
string |
isReserved |
是否是预约号 1:是 0:否 |
integer (int32) |
status |
状态 10:待支付;12:已预约(理疗预约);20:待签到;21:已签到(理疗预约);30:待诊;40:已诊;90:已退号;92:已取消 |
integer (int32) |
signIn |
签到状态 0:无需签到 1:待签到 2:已签到 |
integer (int32) |
consultingRoomId |
诊室id |
string |
consultingRoomName |
诊室名称 |
string |
type |
预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号 |
integer (int32) |
payStatus |
支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费 |
integer (int32) |
code |
取号码 |
integer (int32) |
registrationType |
预约类型 0:门诊预约 1:理疗预约 10:检查预约 |
integer (int32) |
created |
创建时间 |
string (date-time) |
7.253. 挂号种类号源信息
名称 | 说明 | 类型 |
---|---|---|
departmentId |
科室id |
string |
registrationCategory |
挂号种类;0:普通门诊;1:专家门诊;2:便民门诊; |
integer (int32) |
restCount |
剩余号源数量 |
integer (int32) |
totalCount |
总号源数量 |
integer (int32) |
status |
状态 |
integer (int32) |
dayShifts |
按时段展示,上午/下午/晚上 或者 自定义时段 |
< 时间段信息 > array |
7.254. 挂号详细信息
名称 | 说明 | 类型 |
---|---|---|
clinicName |
门店名称 |
string |
patientOrderId |
就诊单ID |
string |
registrationSheetId |
挂号单ID |
string |
visitSourceParentId |
就诊来源分类上级ID |
string |
patientId |
患者ID |
string |
visitSourceParentName |
就诊来源分类上级名称 |
string |
departmentId |
科室ID |
string |
visitSourceId |
就诊来源分类ID |
string |
departmentName |
科室名称 |
string |
visitSourceName |
就诊来源分类名称 |
string |
doctorId |
医生ID |
string |
visitSourceFromId |
就诊来源分类下具体来源ID,当关联类型为所有员工、员工角色时为员工ID;当关联类型为所有患者时为患者ID; |
string |
doctorName |
医生名称 |
string |
visitSourceFromName |
就诊来源分类下具体来源名称,当关联类型为所有员工、员工角色时为员工名称;当关联类型为所有患者时为患者名称; |
string |
orderNo |
号数 |
string |
visitSourceRelatedType |
就诊来源关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色 |
integer (int32) |
reserveDate |
预约就诊日期 |
string |
visitSourceRelatedId |
就诊来源关联ID,由 relatedType 确定关联的是什么ID,关联单个患者时是患者ID;关联单个医生时是医生ID;关联的是医生角色时是角色ID; |
string |
reserveTime |
预约具体的时间 |
string |
visitSourceRelateName |
就诊关联来源关联名称,和 visitSourceRelateId 有关 |
string |
isReserved |
是否是预约号 1:是 0:否 |
integer (int32) |
visitSourceRemark |
就诊备注 |
string |
registrationProducts |
预约项目列表 |
< 预约项目摘要信息 > array |
status |
状态 10:待支付;12:已预约(理疗预约);20:待签到;21:已签到(理疗预约);30:待诊;40:已诊;90:已退号;92:已取消 |
integer (int32) |
signIn |
签到状态 0:无需签到 1:待签到 2:已签到 |
integer (int32) |
consultingRoomId |
诊室id |
string |
consultingRoomName |
诊室名称 |
string |
type |
预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号 |
integer (int32) |
payStatus |
支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费 |
integer (int32) |
code |
取号码 |
integer (int32) |
registrationType |
预约类型 0:门诊预约 1:理疗预约 10:检查预约 |
integer (int32) |
created |
创建时间 |
string (date-time) |
7.255. 推送内容
名称 | 说明 | 类型 |
---|---|---|
eventModule |
事件模块 |
integer (int32) |
id |
事件id |
string |
clinicId |
机构ID |
string |
eventType |
事件类型 |
integer (int32) |
eventName |
事件名称 |
string |
eventData |
事件数据 |
object |
callbackCount |
回调次数,第一次请求时 1,失败后第一次重试时为 2 |
integer (int32) |
7.256. 推送内容«JsonNode»
名称 | 说明 | 类型 |
---|---|---|
eventModule |
事件模块 |
integer (int32) |
id |
事件id |
string |
clinicId |
机构ID |
string |
eventType |
事件类型 |
integer (int32) |
eventName |
事件名称 |
string |
eventData |
事件数据 |
|
callbackCount |
回调次数,第一次请求时 1,失败后第一次重试时为 2 |
integer (int32) |
7.257. 撤销执行请求参数
撤销执行请求参数
名称 | 说明 | 类型 |
---|---|---|
operatorId |
操作人ID |
string |
7.258. 操作响应结果
名称 | 说明 | 类型 |
---|---|---|
code |
返回码 |
integer (int32) |
message |
返回提示 |
string |
7.259. 收费单事件详细信息
名称 | 说明 | 类型 |
---|---|---|
id |
收费单唯一标识 |
string |
status |
收费单状态 0:未收费 1:部分收费 2:收费完成 3:部分退费 4:退费完成 |
integer (int32) |
type |
收费单类型 1:挂号 2:门诊 3:零售收费 5:会员卡充值\退费 6:执行站开单 7:咨询单 8:自主续方 9:家庭医生签约 10:营销卡开卡\销卡 11:营销卡项充值\退费 |
integer (int32) |
created |
创建时间 |
string (date-time) |
receivableFee |
应收金额 |
number |
receivedFee |
实收金额 |
number |
refundFee |
退费金额 |
number |
discountFee |
优惠金额(负值) |
number |
refundTime |
退费时间 |
string (date-time) |
charger |
收费员 |
|
deliveryInfo |
收货信息 |
|
doctor |
开方医生 |
|
patient |
患者信息 |
|
medicalRecord |
病历信息 |
|
chargeFormItems |
收费项目明细 |
< 收费项目明细 > array |
chargeTransactions |
收费记录:一张收费单可以分多次收费 |
< 收退费交易记录 > array |
chargeTransactionPaidRecords |
收费记录:一张收费单可以有多个收费项 只对收费记录进行合并 |
< 收费项详细信息 > array |
sellerId |
销售员id |
string |
sellerName |
销售员名字 |
string |
registrationSheetId |
挂号单ID,注意:零售收费、在线咨询等与挂号不相关的途径产生的收退费事件,该字段返回的值为空 |
string |
patientOrderId |
就诊单ID |
string |
isDraft |
是否是草稿 0:不是草稿 1:是草稿 |
integer (int32) |
isClosed |
是否关闭 0:未关闭 1:已关闭 |
integer (int32) |
chargedTime |
收费完成时间 |
string (date-time) |
7.261. 收费单摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
收费单ID |
string |
patientOrderId |
就诊单ID |
string |
created |
收费单创建时间,而不是在收费台展示的时间,在任何可能会产生收费单场景都会预先创建收费单(例如与挂号预约时) |
string (date-time) |
doctorName |
医生名称 |
string |
isDraft |
是否是草稿 0:不是草稿 1:是草稿 |
integer (int32) |
status |
收费单状态 0:未付费 1:部分付费 2:已付费 3:部分退费 4:已退费 |
integer (int32) |
owedStatus |
欠费状态 0:无欠费 10:欠费中 |
integer (int32) |
patient |
患者信息 |
|
type |
收费单类型 0:未知 1:挂号 2:门诊 3:零售 5:会员充值 7:在线问诊 |
integer (int32) |
isClosed |
是否关闭 0:未关闭 1:已关闭 |
integer (int32) |
7.263. 收费单支付请求
名称 | 说明 | 类型 |
---|---|---|
payMode |
支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项 |
integer (int32) |
amount |
当次支付金额(小数点前最多为12位,小数点后最多4位) |
number |
needPayFee |
收费单剩余需要支付的金额(小数点前最多为12位,小数点后最多4位),部分收费场景该字段必填 |
number |
expectedOddFee |
期望凑整抹零金额(不能小于-1,不能大于1),就算没有开启凑整抹零的开关依然生效!!!,如果是部分收费,只有第一次收费的时候这个值有效。 |
number |
operatorId |
操作人ID |
string |
comment |
备注信息(长度最大为 200 个字符) |
string |
7.264. 收费单收费结果
名称 | 说明 | 类型 |
---|---|---|
id |
收费单ID |
string |
patientOrderId |
就诊单ID |
string |
status |
收费单状态 0:未收费 1:部分收费 2:已收费 3:部分退费 4:已退费 |
integer (int32) |
statusName |
状态名称 |
string |
needPay |
收费单总共支付的金额 |
number |
receivedFee |
收费单已经收费单的金额 |
number |
7.265. 收费单详细信息
名称 | 说明 | 类型 |
---|---|---|
id |
收费单唯一标识 |
string |
status |
收费单状态 0:未收费 1:部分收费 2:收费完成 3:部分退费 4:退费完成 |
integer (int32) |
type |
收费单类型 1:挂号 2:门诊 3:零售收费 5:会员卡充值\退费 6:执行站开单 7:咨询单 8:自主续方 9:家庭医生签约 10:营销卡开卡\销卡 11:营销卡项充值\退费 |
integer (int32) |
created |
创建时间 |
string (date-time) |
receivableFee |
应收金额 |
number |
receivedFee |
实收金额 |
number |
refundFee |
退费金额 |
number |
discountFee |
优惠金额(负值) |
number |
refundTime |
退费时间 |
string (date-time) |
charger |
收费员 |
|
deliveryInfo |
收货信息 |
|
doctor |
开方医生 |
|
patient |
患者信息 |
|
medicalRecord |
病历信息 |
|
chargeFormItems |
收费项目明细 |
< 收费项目明细 > array |
chargeTransactions |
收费记录:一张收费单可以分多次收费 |
< 收退费交易记录 > array |
chargeTransactionPaidRecords |
收费记录:一张收费单可以有多个收费项 只对收费记录进行合并 |
< 收费项详细信息 > array |
sellerId |
销售员id |
string |
sellerName |
销售员名字 |
string |
registrationSheetId |
挂号单ID,注意:零售收费、在线咨询等与挂号不相关的途径产生的收退费事件,该字段返回的值为空 |
string |
patientOrderId |
就诊单ID |
string |
isDraft |
是否是草稿 0:不是草稿 1:是草稿 |
integer (int32) |
isClosed |
是否关闭 0:未关闭 1:已关闭 |
integer (int32) |
chargedTime |
收费完成时间 |
string (date-time) |
7.266. 收费单退费响应
名称 | 说明 | 类型 |
---|---|---|
id |
收费单ID |
string |
status |
收费单状态 0:未收费 1:部分收费 2:已收费 3:部分退费 4:已退费 |
integer (int32) |
statusName |
状态名称 |
string |
refundFee |
本次已退金额 |
number |
refundedFee |
累积已退金额 |
number |
7.267. 收费单退费请求
名称 | 说明 | 类型 |
---|---|---|
operatorId |
操作人ID |
string |
needRefundFee |
收费项需要退费金额(如果不传默认为收费单的实收金额),最大值为 chargeForms 中商品实收金额总和 |
number |
refundFee |
本次退费金额(如果不传默认为收费单的实收金额),最大值为 [needRefundFee] + 欠退金额 |
number |
payMode |
支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项(如果不传则默认为任意一次收费交易的支付方式) |
integer (int32) |
chargeForms |
收费form列表,如果需要部分退的场景才传该值 |
< 退费form请求 > array |
7.268. 收费员
名称 | 说明 | 类型 |
---|---|---|
id |
ID:唯一标识 |
string |
name |
姓名 |
string |
7.269. 收费明细-分类信息
名称 | 说明 | 类型 |
---|---|---|
clinicName |
门店 |
string |
feeType |
费用分类 |
string |
clinicId |
门店ID |
string |
departmentName |
科室 |
string |
departmentId |
科室ID |
string |
employeeName |
开单人 |
string |
employeeId |
开单人ID |
string |
chargeName |
收费员 |
string |
chargeId |
收费员ID |
string |
totalPrice |
原价 |
number |
adjustmentPrice |
整单议价金额 |
number |
discountPrice |
优惠金额 |
number |
deductPrice |
服务折扣金额 |
number |
amount |
实收金额 |
number |
created |
收费时间 |
string |
sourceType |
来源 |
string |
action |
类型 收费、退费、欠费、销欠费 |
string |
patientId |
患者ID |
string |
patientName |
患者姓名 |
string |
no |
患者就诊号 |
integer (int32) |
payMode |
支付方式名称 |
string |
payModeId |
支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项 |
integer (int32) |
paySubModeId |
支付子类型 |
integer (int32) |
comment |
备注 |
string |
memberPatientId |
会员患者ID |
string |
memberPatientName |
会员患者姓名 |
string |
memberPatientMobile |
会员患者手机号 |
string |
7.270. 收费明细-单据信息
名称 | 说明 | 类型 |
---|---|---|
clinicName |
门店 |
string |
transactionId |
交易流水ID |
string |
clinicId |
门店ID |
string |
patientOrderId |
就诊单ID |
string |
departmentName |
科室 |
string |
receivableFee |
应收 |
number |
chargeSheetId |
收费单ID |
string |
departmentId |
科室ID |
string |
employeeName |
开单人 |
string |
thirdPartyPayTransactionId |
三方支付交易流水号 |
string |
employeeId |
开单人ID |
string |
visitSource |
推荐来源 |
|
chargeName |
收费员 |
string |
chargeId |
收费员ID |
string |
totalPrice |
原价 |
number |
adjustmentPrice |
整单议价金额 |
number |
discountPrice |
优惠金额 |
number |
deductPrice |
服务折扣金额 |
number |
amount |
实收金额 |
number |
created |
收费时间 |
string |
sourceType |
来源 |
string |
action |
类型 收费、退费、欠费、销欠费 |
string |
patientId |
患者ID |
string |
patientName |
患者姓名 |
string |
no |
患者就诊号 |
integer (int32) |
payMode |
支付方式名称 |
string |
payModeId |
支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项 |
integer (int32) |
paySubModeId |
支付子类型 |
integer (int32) |
comment |
备注 |
string |
memberPatientId |
会员患者ID |
string |
memberPatientName |
会员患者姓名 |
string |
memberPatientMobile |
会员患者手机号 |
string |
7.271. 收费明细-明细信息
名称 | 说明 | 类型 |
---|---|---|
clinicName |
门店 |
string |
patientMobile |
患者手机号 |
string |
clinicId |
门店ID |
string |
id |
收费明细ID |
string |
departmentName |
科室 |
string |
name |
收费项名称 |
string |
departmentId |
科室ID |
string |
productId |
商品ID |
string |
employeeName |
开单人 |
string |
productShortId |
商品编码 |
string |
count |
数量 |
number |
employeeId |
开单人ID |
string |
chargeName |
收费员 |
string |
price |
单价 |
number |
chargeId |
收费员ID |
string |
feeType1 |
收费项一级分类名称 |
string |
feeType2 |
收费项二级分类名称 |
string |
totalPrice |
原价 |
number |
adjustmentPrice |
整单议价金额 |
number |
productType |
商品类型 |
integer (int32) |
discountPrice |
优惠金额 |
number |
productSubType |
商品子类型 |
integer (int32) |
deductPrice |
服务折扣金额 |
number |
productCustomType |
用户自定义商品类型 |
integer (int32) |
amount |
实收金额 |
number |
batchId |
批次号(批次维度有值) |
integer (int64) |
batchNo |
批号(批次维度有值) |
string |
created |
收费时间 |
string |
expiryDate |
效期(批次维度有值) |
string |
sourceType |
来源 |
string |
action |
类型 收费、退费、欠费、销欠费 |
string |
productionDate |
生产日期(批次维度有值) |
string |
chargeSheetId |
收费单ID |
string |
patientId |
患者ID |
string |
chargeFormItemId |
收费项ID |
string |
patientName |
患者姓名 |
string |
chargeTransactionId |
收费交易ID |
string |
no |
患者就诊号 |
integer (int32) |
itemAdjustmentAmount |
项目议价金额 |
number |
payMode |
支付方式名称 |
string |
payModeId |
支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项 |
integer (int32) |
paySubModeId |
支付子类型 |
integer (int32) |
comment |
备注 |
string |
memberPatientId |
会员患者ID |
string |
memberPatientName |
会员患者姓名 |
string |
memberPatientMobile |
会员患者手机号 |
string |
7.272. 收费项目明细
名称 | 说明 | 类型 |
---|---|---|
id |
ID:唯一标识 |
string |
chargeFormId |
收费项FormId |
string |
productId |
收费商品ID |
string |
productName |
收费商品名称 |
string |
status |
收费项状态 0未收费 1已收费 2已退费 |
integer (int32) |
unit |
单位 |
string |
receivedFee |
实收,总金额,收费完成后有值 |
number |
unitPrice |
实收单价,收费完成后有值 |
number |
displayUnitPrice |
显示单价(待收费时是不使用任何优惠时的应收,部分收费或已收费时是优惠抵扣后的应收) |
number |
displayTotalPrice |
显示总价(待收费时是不使用任何优惠时的总应收,部分收费或已收费时是优惠抵扣后的总应收) |
number |
unitCount |
单位数量 |
number |
doseCount |
剂数 |
number |
totalCount |
总数量:totalCount = unitCount * doseCount |
number |
productType |
商品一级分类: 参考api 5.3.5. 获取商品分类 |
integer (int32) |
productSubType |
商品二级分类: 参考api 5.3.5. 获取商品分类 |
integer (int32) |
sourceItemType |
收费项来源类型 0:普通 1:自备 |
integer (int32) |
productInfo |
商品信息 |
|
composeChildren |
套餐项目列表 |
< 收费项目明细 > array |
7.273. 收费项详细信息
名称 | 说明 | 类型 |
---|---|---|
productId |
商品id |
string |
productName |
商品名称 |
string |
productType |
商品类型 |
integer (int32) |
productSubType |
商品子类型 |
integer (int32) |
composeType |
套餐类型:0不是套餐;1套餐母项;2套餐子项 |
integer (int32) |
productUnit |
商品单位 |
string |
productUnitCount |
商品数量 |
number |
doseCount |
商品剂量 |
number |
totalPrice |
商品总价 |
number |
discountPrice |
商品折扣价格 |
number |
records |
收费记录详情 只包含收费记录 |
< 交易记录商品明细 > array |
7.274. 收费项退费请求
名称 | 说明 | 类型 |
---|---|---|
id |
收费项ID |
string |
unitCount |
退费单位数量 |
number |
doseCount |
退费剂数 |
number |
7.275. 收退费交易记录
名称 | 说明 | 类型 |
---|---|---|
id |
ID:唯一表示 |
string |
payMode |
支付方式 |
integer (int32) |
paySubMode |
支付子方式 |
integer (int32) |
payModeName |
支付方式 |
string |
payModeDisplayName |
用于展示的支付方式 |
string |
amount |
金额 |
number |
created |
创建时间 |
string (date-time) |
isRefunded |
是否已退费 0:否 1:是 |
integer (int32) |
chargeTransactionRecords |
交易记录商品明细列表 |
< 交易记录商品明细 > array |
7.276. 文件上传响应
名称 | 说明 | 类型 |
---|---|---|
isSuccess |
是否成功:0否,1是 |
integer (int32) |
message |
信息:失败的时候有值 |
string |
filePath |
文件路径 |
string |
7.277. 新增或修改患者会员请求
名称 | 说明 | 类型 |
---|---|---|
memberTypeId |
会员类型ID |
string |
sourceId |
患者来源ID |
string |
sourceFromId |
患者具体来源ID |
string |
remark |
备注信息(不能超过200个字符) |
string |
7.278. 新增挂号请求参数
名称 | 说明 | 类型 |
---|---|---|
patientId |
患者ID |
string |
departmentId |
科室ID,门诊预约时必传 |
string |
doctorId |
医生ID |
string |
orderNo |
号数,门诊预约必填 |
integer (int32) |
reserveDate |
预约日期 yyyy-MM-dd |
string |
reserveStart |
预约号源开始时间, HH:mm |
string |
reserveEnd |
预约号源结束时间, HH:mm |
string |
sourceId |
就诊来源分类ID |
string |
sourceFromId |
就诊来源分类下某个具体来源ID。比如:当就诊来源分类为【医生推荐】时,根据api【5.2.2. 获取医生分页列表信息】获取到医生,此时字段取值为医生ID;当就诊来源分类为【导医推荐】时, 根据api【5.1.3. 获取门店成员列表】获取到成员,此时字段取值为成员ID;当就诊来源分类为【顾客推荐】时, 根据api【5.4.3. 获取患者列表】获取到患者,此时字段取值为患者ID; |
string |
sourceRemark |
就诊备注 |
string |
registrationType |
预约类型 0:门诊预约 1:理疗预约,默认为门诊预约 |
integer (int32) |
registrationProductIds |
预约项目列表,仅在理疗预约时有效 |
< integer (int64) > array |
7.279. 时间段信息
名称 | 说明 | 类型 |
---|---|---|
shifts |
时间单元格列表 |
< 预约号单元格信息 > array |
restCount |
余号 |
integer (int32) |
totalCount |
总号 |
integer (int32) |
status |
排班状态 0:有号 1:约满 2:无号(排班班次拆分后的总预约单元格为空,如:班次时长不满足最小服务时长等) 3:未放号 4:完诊(最晚排班结束时间已过) 5:无排班 |
integer (int32) |
start |
开始时间 HH:mm |
string |
end |
结束时间 HH:mm |
string |
timeOfDay |
start对应的时段;上午/下午/晚上 |
string |
7.280. 更新快递物流状态请求体
名称 | 说明 | 类型 |
---|---|---|
deliveryTraceData |
物流轨迹列表 |
< 快递物流轨迹节点信息 > array |
7.286. 查询患者家庭成员响应
名称 | 说明 | 类型 |
---|---|---|
patientId |
查询患者的ID |
string |
familyRole |
查询患者的家庭角色 0:不是家庭成员 1:家长 2:家庭成员 |
integer (int32) |
familyPatients |
家庭成员列表(包含查询患者) |
< 患者家庭成员信息 > array |
7.289. 查询检查检验数据响应
名称 | 说明 | 类型 |
---|---|---|
rows |
检查检验列表 |
< 检查检验数据摘要信息 > array |
7.291. 根据收费单查询进销存明细
名称 | 说明 | 类型 |
---|---|---|
patientOrderId |
就诊单ID |
string |
chargeSheetId |
收费单ID |
string |
7.292. 检查人
名称 | 说明 | 类型 |
---|---|---|
id |
检查人ID |
string |
name |
检查人姓名 |
string |
date |
检查时间 |
string |
7.293. 检查检验单摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
检查检验ID |
string |
patientOrderId |
就诊单ID |
string |
patient |
患者信息 |
|
name |
项目名称 |
string |
type |
类型 1:检验 2:检查 |
integer (int32) |
deviceType |
设备类型 检验:1-临床检验 2-生化检验 3-免疫检验 4-微生物检验 5-PCR检验 6-未知分类 ;检查:1-CT 2-DR 3-CR 4-透视 5-心电图 6-骨密度 7-试光类 8-彩超 9-MR 10-内窥镜 11-B超 12-脑电图 13-其他分类 14-一般检查 15-内科检查 16-外科检查 17-耳鼻喉检查 18-口腔检查 19-体检眼科 20-公卫检查 21-动脉硬化 22-妇科常规 23-CBCT |
integer (int32) |
businessType |
业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检 |
integer (int32) |
created |
创建时间 |
string (date-time) |
status |
状态 0:等检状态 1:已检状态 2:已退款状态 3:待审核状态 |
integer (int32) |
statusName |
状态名称 |
string |
7.294. 检查检验单设备信息
名称 | 说明 | 类型 |
---|---|---|
deviceId |
设备id |
integer (int64) |
deviceShortId |
设备编号 |
string |
deviceModelId |
设备型号id |
integer (int64) |
name |
设备名字 |
string |
model |
设备型号 |
string |
deviceUuid |
设备唯一识别码 |
string |
manufacture |
设备生产商 |
string |
iconUrl |
设备图标链接 |
string |
buyUrl |
设备购买链接 |
string |
installUrl |
设备安装链接 |
string |
remarks |
设备备注信息 |
string |
type |
设备分类 1:检验 2:检查 |
integer (int32) |
extendSpec |
设备扩展分类 检验:无意义 检查:10-RIS检查 20-眼科检查 |
string |
deviceType |
设备类型 |
integer (int32) |
usageType |
设备用途类型 检验:0 未知类型 1 血液分析 2 生化分析 3尿液分析 4免疫分析 5 微生物分析 |
integer (int32) |
salePrice |
售价 |
number |
deviceNamePy |
设备名称拼音 |
string |
deviceStatus |
设备状态 0 初始化 10启用 20停用 99删除 |
integer (int32) |
deviceRoomId |
设备机房id |
integer (int64) |
deviceRoomName |
设备机房名称 |
string |
department |
设备科室 |
7.295. 检查检验单详情信息
名称 | 说明 | 类型 |
---|---|---|
id |
检查检验单ID |
string |
outpatientFormItemId |
门诊单子项ID |
string |
patientOrderId |
门诊单ID |
string |
patientOrderNumber |
门诊号/住院号/体检号 |
string |
patient |
患者信息 |
|
doctorId |
医生ID |
string |
doctorName |
医生名称 |
string |
doctorDepartmentId |
医生科室ID |
string |
doctorDepartmentName |
医生科室名称 |
string |
sellerId |
开单人id |
string |
sellerName |
开单人名称 |
string |
sellerDepartmentId |
开单人科室id |
string |
sellerDepartmentName |
开单人科室名称 |
string |
productId |
检验项目ID,在开启了合并模式的情况下为空 |
string |
products |
检验项目列表,在开启了合并模式下可能会返回多个,在未开启的情况下只会返回单个 |
< 检验项目摘要信息 > array |
productIds |
检验项目ID列表,在开启了合并模式下可能会返回多个,在未开启的情况下只会返回单个 |
< string > array |
composeParentProductId |
套餐商品ID |
string |
composeParentName |
套餐名称 |
string |
name |
检验项名称 |
string |
orderNo |
检验单号(条形码) yyyyMMdd000X |
string |
status |
状态 0:等检状态 1:已检状态 2:已退款状态 3:设备回传 4:待审核状态 |
integer (int32) |
statusName |
状态名称 |
string |
sampleType |
样本类型 |
string |
samplerId |
采集人id |
string |
samplerName |
采集人名称 |
string |
sampleTime |
采集时间 |
string (date-time) |
collectorId |
核收人id |
string |
collectorName |
核收人名称 |
string |
collectTime |
核收时间 |
string (date-time) |
results |
检查检验结果 |
< 检查检验结果 > array |
eyeResults |
眼科检查结果 |
< 眼科检查结果 > array |
reports |
检查检验报告 |
< 检查检验报告 > array |
attachments |
附件 |
< 附件 > array |
remark |
检验结果备注 |
string |
testerId |
检验人ID |
string |
testerName |
检验人名称 |
string |
testTime |
检验时间 |
string (date-time) |
checkerId |
审核人ID |
string |
checkerName |
审核人名称 |
string |
checkTime |
审核时间 |
string (date-time) |
reportTime |
报告时间 |
string (date-time) |
created |
创建时间 |
string (date-time) |
type |
类型 1:检验 2:检查 |
integer (int32) |
subType |
子类型 检验:无意义;检查: 10-RIS检查 20-眼科检查 |
integer (int32) |
diagnosis |
诊断 |
string |
reportUrl |
报告url |
string |
examinationApplySheetNo |
检查申请单号 |
string |
bedNo |
床位号 |
string |
deviceType |
设备类型 检验:1-临床检验 2-生化检验 3-免疫检验 4-微生物检验 5-PCR检验 6-未知分类 ;检查:1-CT 2-DR 3-CR 4-透视 5-心电图 6-骨密度 7-试光类 8-彩超 9-MR 10-内窥镜 11-B超 12-脑电图 13-其他分类 14-一般检查 15-内科检查 16-外科检查 17-耳鼻喉检查 18-口腔检查 19-体检眼科 20-公卫检查 21-动脉硬化 22-妇科常规 23-CBCT |
integer (int32) |
businessType |
业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检 |
integer (int32) |
relationPatientOrderId |
关联的门诊单id(眼科检查特有) |
string |
registrationFormItem |
关联的挂号单(眼科检查特有) |
7.296. 检查检验患者摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
患者ID:唯一标识 |
string |
sn |
患者SN号,同一连锁下SN号唯一 |
string |
idCard |
患者身份证号 |
string |
name |
姓名 |
string |
mobile |
手机号 |
string |
sex |
性别 |
string |
birthday |
出生日期 |
string |
age |
患者年龄大小 |
7.297. 检查检验报告
名称 | 说明 | 类型 |
---|---|---|
id |
检查/检验报告id |
string |
imageFiles |
检查图像 |
< 附件 > array |
videoDescription |
影像描述 |
string |
suggestion |
建议 |
string |
inspectionSite |
检查部位 |
string |
deviceModelDesc |
设备型号描述 |
string |
diagnosisFlag |
诊断标志 0-阴性 10-阳性 |
integer (int32) |
recordDoctorId |
记录医生id |
string |
consultationDoctorId |
会诊医生id |
string |
recordDoctorName |
记录医生名字 |
string |
consultationDoctorName |
会诊医生名字 |
string |
diagnosisEntryItems |
诊断建议 |
< 检查诊断信息 > array |
7.298. 检查检验报告修改请求
名称 | 说明 | 类型 |
---|---|---|
id |
检查/检验报告id |
string |
imageFiles |
检查图像 |
< 附件 > array |
videoDescription |
影像描述 |
string |
suggestion |
建议 |
string |
diagnosisFlag |
诊断标志 0-阴性 10-阳性 |
integer (int32) |
recordDoctorId |
记录医生id |
string |
consultationDoctorId |
会诊医生id |
string |
inspectionSite |
检查部位 |
string |
deviceModelDesc |
设备型号描述 |
string |
isDeleted |
是否删除(删除时需要显式的指定) 0-否 1-是 |
integer (int32) |
diagnosisEntryItems |
诊断建议 |
< 检查诊断信息 > array |
7.299. 检查检验摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
检验单ID |
string |
orderNo |
订单号(新条码) |
string |
productId |
检验项目ID,在开启了合并模式的情况下为空 |
string |
products |
检验项目列表,在开启了合并模式下可能会返回多个,在未开启的情况下只会返回单个 |
< 检验项目摘要信息 > array |
productIds |
检验项目ID列表,在开启了合并模式下可能会返回多个,在未开启的情况下只会返回单个 |
< string > array |
name |
检查项目名称 |
string |
type |
类型 1:检验 2:检查 |
integer (int32) |
deviceType |
设备类型 检验:1-临床检验 2-生化检验 3-免疫检验 4-微生物检验 5-PCR检验 6-未知分类 ;检查:1-CT 2-DR 3-CR 4-透视 5-心电图 6-骨密度 7-试光类 8-彩超 9-MR 10-内窥镜 11-B超 12-脑电图 13-其他分类 14-一般检查 15-内科检查 16-外科检查 17-耳鼻喉检查 18-口腔检查 19-体检眼科 20-公卫检查 21-动脉硬化 22-妇科常规 23-CBCT |
integer (int32) |
businessType |
业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检 |
integer (int32) |
sampleType |
样本类型 |
string |
patientOrderNo |
就诊单号 |
string |
patientOrderType |
就诊单类型 |
string |
departmentId |
科室ID |
string |
departmentName |
科室名称 |
string |
doctorId |
医生ID |
string |
doctorName |
送检医生 |
string |
createdTime |
创建时间 |
string |
patientInfo |
患者信息 |
|
status |
状态 |
integer (int32) |
statusName |
状态名称 |
string |
7.300. 检查检验数据摘要信息
名称 | 说明 | 类型 |
---|---|---|
diagnosis |
诊断 |
string |
id |
检验单ID |
string |
orderNo |
订单号(新条码) |
string |
productId |
检验项目ID,在开启了合并模式的情况下为空 |
string |
products |
检验项目列表,在开启了合并模式下可能会返回多个,在未开启的情况下只会返回单个 |
< 检验项目摘要信息 > array |
productIds |
检验项目ID列表,在开启了合并模式下可能会返回多个,在未开启的情况下只会返回单个 |
< string > array |
name |
检查项目名称 |
string |
type |
类型 1:检验 2:检查 |
integer (int32) |
deviceType |
设备类型 检验:1-临床检验 2-生化检验 3-免疫检验 4-微生物检验 5-PCR检验 6-未知分类 ;检查:1-CT 2-DR 3-CR 4-透视 5-心电图 6-骨密度 7-试光类 8-彩超 9-MR 10-内窥镜 11-B超 12-脑电图 13-其他分类 14-一般检查 15-内科检查 16-外科检查 17-耳鼻喉检查 18-口腔检查 19-体检眼科 20-公卫检查 21-动脉硬化 22-妇科常规 23-CBCT |
integer (int32) |
businessType |
业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检 |
integer (int32) |
sampleType |
样本类型 |
string |
patientOrderNo |
就诊单号 |
string |
patientOrderType |
就诊单类型 |
string |
departmentId |
科室ID |
string |
departmentName |
科室名称 |
string |
doctorId |
医生ID |
string |
doctorName |
送检医生 |
string |
createdTime |
创建时间 |
string |
patientInfo |
患者信息 |
|
status |
状态 |
integer (int32) |
statusName |
状态名称 |
string |
7.301. 检查检验结果
名称 | 说明 | 类型 |
---|---|---|
id |
指标项id |
string |
type |
指标项类型 1 数值型 2 文字型 3 阴阳型 |
integer (int32) |
name |
指标项名称 |
string |
enName |
指标项编码 |
string |
unit |
单位 |
string |
itemCode |
检查子项 code |
string |
ref |
指标项参考范围 json字符串 |
string |
productId |
检验项目id |
string |
resultDisplayScale |
指标项检查结果页面展示小数位数 |
integer (int32) |
value |
检查检验结果值 String|List<Attachment>|List<ExaminationDiagnosisItem>,根据valueType对应不同的value:valueType为STRING时,value为字符串;valueType为IMAGE,value为url字符串;valueType为ATTACHMENTS时,value为附件列表类型,附件结构详情见6.134 |
|
valueType |
值类型 STRING、IMAGE、ATTACHMENTS 默认STRING |
string |
abnormalFlag |
异常标志 “H”- 结果高于参考范围上限; “L” – 结果低于参考范围下限; “HH”-危机值高; “LL”-危机值低; “A” 阴阳型异常; “TA” 文字型异常; “N” 正常 |
string |
abnormalText |
异常描述 abnormalFlag为TA时有效 |
string |
7.302. 检查检验退费摘要
名称 | 说明 | 类型 |
---|---|---|
id |
指标项ID |
string |
chargeSheetId |
收费单ID |
string |
chargeFormItemId |
收费单子项ID |
string |
outpatientFormItemId |
门诊单子项ID |
string |
patientOrderId |
门诊单ID |
string |
patientId |
患者ID |
string |
doctorId |
医生ID |
string |
productId |
检验项目ID,在开启了合并模式的情况下为空 |
string |
products |
检验项目列表,在开启了合并模式下可能会返回多个,在未开启的情况下只会返回单个 |
< 检验项目摘要信息 > array |
productIds |
检验项目ID列表,在开启了合并模式下可能会返回多个,在未开启的情况下只会返回单个 |
< string > array |
composeParentProductId |
套餐商品ID |
string |
composeParentName |
套餐名称 |
string |
name |
检验项名称 |
string |
orderNo |
检查单号 |
string |
remark |
检验结果备注 |
string |
testerId |
检验人ID |
string |
checkerId |
审核人ID |
string |
count |
检查报告次数 |
integer (int32) |
createdBy |
创建人 |
string |
created |
创建时间 |
string (date-time) |
type |
类型 1 检验 2 检查 |
integer (int32) |
subType |
子类型 检验:无意义;检查: 10-RIS检查 20-眼科检查 |
integer (int32) |
deviceType |
设备类型 检验:1-临床检验 2-生化检验 3-免疫检验 4-微生物检验 5-PCR检验 6-未知分类 ;检查:1-CT 2-DR 3-CR 4-透视 5-心电图 6-骨密度 7-试光类 8-彩超 9-MR 10-内窥镜 11-B超 12-脑电图 13-其他分类 14-一般检查 15-内科检查 16-外科检查 17-耳鼻喉检查 18-口腔检查 19-体检眼科 20-公卫检查 21-动脉硬化 22-妇科常规 23-CBCT |
integer (int32) |
businessType |
业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检 |
integer (int32) |
7.303. 检查检验项目信息
名称 | 说明 | 类型 |
---|---|---|
id |
主键ID |
string |
shortId |
检查检验项目shortId |
string |
name |
项目名称 |
string |
code |
项目代码 |
string |
7.304. 检查诊断信息
名称 | 说明 | 类型 |
---|---|---|
id |
诊断id |
integer (int64) |
name |
诊断名称 |
string |
abnormalFlag |
异常关注 0-正常 10-异常 |
integer (int32) |
7.305. 检验单修改信息
名称 | 说明 | 类型 |
---|---|---|
attachments |
附件 |
< 附件 > array |
reports |
检查报告 |
< 检查检验报告修改请求 > array |
results |
检查结果 |
< 检查检验结果 > array |
eyeResults |
眼科检查结果 |
< 眼科检查结果 > array |
deviceModelId |
设备型号id |
integer (int64) |
deviceId |
设备id |
integer (int64) |
subType |
检验单子类型 检验:无意义;检查: 10-RIS检查 20-眼科检查 |
integer (int32) |
remark |
备注 |
string |
testerId |
检验人id,检验人ID和名称必须填一个 |
string |
testerName |
检验人名称 |
string |
checkerId |
审核人id,审核人ID和名称必须填一个 |
string |
checkerName |
审核人名称 |
string |
sampleType |
样本类型 |
string |
testTime |
检验时间 yyyy-MM-dd HH:mm |
string |
checkTime |
审核时间 yyyy-MM-dd HH:mm |
string |
reportTime |
报告时间 yyyy-MM-dd HH:mm |
string |
status |
状态 0:待检 1:已检(已审核) 2:已退 3:设备回传数据(检验待查看、检查待写报告) 4:待审核 |
integer (int32) |
relationPatientOrderId |
门诊单id |
string |
7.307. 检验项目摘要信息
名称 | 说明 | 类型 |
---|---|---|
productId |
检验项目ID |
string |
productName |
检验项目名称 |
string |
examinationSheetId |
检查检验单id |
string |
7.308. 治疗单信息
名称 | 说明 | 类型 |
---|---|---|
id |
治疗单ID |
string |
type |
类别 2:检查检验 3:治疗理疗 8:商品 9:材料 |
integer (int32) |
productFormItems |
治疗单子项 |
< 治疗单子项信息 > array |
7.309. 治疗单子项信息
名称 | 说明 | 类型 |
---|---|---|
id |
治疗单子项ID |
string |
productFormId |
治疗单ID |
string |
productId |
治疗项ID |
string |
name |
治疗项名称 |
string |
unitCount |
单位次数 |
number |
unit |
单位 |
string |
unitPrice |
单位价格 |
number |
isDismounting |
是否拆零 0:未拆零 1:拆零 |
integer (int32) |
type |
类型 1:药品 2:物资 3:检查 4:治疗 5:挂号(保) |
integer (int32) |
subType |
子类型 |
integer (int32) |
days |
诊疗项目天数 |
integer (int32) |
dailyDosage |
每天次数 |
integer (int32) |
remark |
备注 |
string |
7.310. 治疗项目执行请求
治疗项目执行请求
名称 | 说明 | 类型 |
---|---|---|
id |
治疗项目ID |
string |
executeCount |
执行次数 |
integer (int32) |
7.313. 病历信息
名称 | 说明 | 类型 |
---|---|---|
id |
病历ID |
string |
outpatientSheetId |
门诊单ID |
string |
chiefComplaint |
主述/现病史 |
string |
pastHistory |
既往史 |
string |
familyHistory |
家族史 |
string |
presentHistory |
现病史 |
string |
physicalExamination |
体格检查 |
string |
diagnosis |
诊断 |
string |
doctorAdvice |
医嘱 |
string |
syndrome |
辨症 |
string |
therapy |
治法 |
string |
chineseExamination |
望闻切诊 |
string |
wearGlassesHistory |
戴镜史 |
string |
obstetricalHistory |
妇科月经婚育史 |
string |
eyeExamination |
眼科检查 |
|
allergicHistory |
过敏史 |
string |
attachments |
附件列表 |
< 附件 > array |
7.314. 皮试结果
名称 | 说明 | 类型 |
---|---|---|
result |
结果 |
string |
description |
描述 |
string |
7.315. 盘点单事件
名称 | 说明 | 类型 |
---|---|---|
checkOrderItemList |
盘点条目列表 |
< 盘点条目 > array |
id |
盘点单ID |
integer (int64) |
orderNo |
盘点单号 |
string |
status |
盘点单状态 0:未知初始状态 10:新建待审批 20:审批被拒绝 30:完成(审批通过) 40:撤回 |
integer (int32) |
organId |
门店ID |
string |
organName |
门店 |
string |
count |
数量 |
number |
kindCount |
品种数量 |
integer (int32) |
totalCostPriceChange |
盈亏金额(进价) |
number |
totalPriceChange |
盈亏金额(售价) |
number |
operator |
操作人(入库人) |
string |
operatorId |
操作人ID |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
7.316. 盘点单详情
名称 | 说明 | 类型 |
---|---|---|
checkOrderItemList |
盘点条目列表 |
< 盘点条目 > array |
comment |
备注 |
|
id |
盘点单ID |
integer (int64) |
orderNo |
盘点单号 |
string |
status |
盘点单状态 0:未知初始状态 10:新建待审批 20:审批被拒绝 30:完成(审批通过) 40:撤回 |
integer (int32) |
organId |
门店ID |
string |
organName |
门店 |
string |
count |
数量 |
number |
kindCount |
品种数量 |
integer (int32) |
totalCostPriceChange |
盈亏金额(进价) |
number |
totalPriceChange |
盈亏金额(售价) |
number |
operator |
操作人(入库人) |
string |
operatorId |
操作人ID |
string |
effectiveDate |
生效时间 |
string (date-time) |
lastModified |
最后修改时间 |
string (date-time) |
7.317. 盘点条目
名称 | 说明 | 类型 |
---|---|---|
id |
条目ID |
integer (int64) |
productId |
商品编码 |
string |
productShortId |
商品short编码 |
string |
productName |
商品名称 |
string |
specification |
规格 |
string |
expiryDate |
有效期 |
string |
productionDate |
生产日期 |
string |
pieceNum |
制剂数量 |
number |
pieceUnit |
制剂单位 |
string |
packageUnit |
包装单位 |
string |
stockId |
盘点批次ID |
string |
packageCostPrice |
包装成本单价 |
number |
beforePieceCount |
盘点前包装数量 |
number |
beforePackageCount |
盘点前制剂数量 |
number |
afterPieceCount |
盘点后包装数量 |
number |
afterPackageCount |
盘点后制剂数量 |
number |
changePieceCount |
盘点变更包装数量 |
number |
changePackageCount |
盘点变更制剂数量 |
number |
amount |
盘点变更总金额 |
number |
lastModified |
最后修改时间 |
string (date-time) |
checkBatches |
盘点发生的批次进销存信息 |
< 单据进销存批次信息 > array |
7.319. 眼科检查三级标题信息
名称 | 说明 | 类型 |
---|---|---|
name |
标题名称 |
string |
children |
眼科检查眼位信息 |
< 眼科检查眼位信息 > array |
7.320. 眼科检查二级标题信息
名称 | 说明 | 类型 |
---|---|---|
name |
标题名称 |
string |
children |
三级标题信息 |
< 眼科检查三级标题信息 > array |
7.322. 眼科检查指标约束
名称 | 说明 | 类型 |
---|---|---|
message |
消息 |
string |
required |
是否必传 |
boolean |
precision |
精度 |
integer (int32) |
scale |
小数位 |
integer (int32) |
min |
最小值 |
integer (int32) |
max |
最大值 |
integer (int32) |
size |
大小 |
integer (int32) |
unit |
单位 |
string |
validateType |
验证类型 |
integer (int32) |
7.323. 眼科检查指标项信息
名称 | 说明 | 类型 |
---|---|---|
id |
主键id |
string |
productId |
商品id |
string |
type |
指标项类型 1 数值型 2 文字型 3 阴阳型 |
integer (int32) |
name |
指标项名称 |
string |
enName |
指标项名称编码 |
string |
unit |
单位 |
string |
ref |
指标项参考范围 json字符串 |
string |
resultDisplayScale |
指标项检查结果页面展示小数位数 |
integer (int32) |
inspectType |
指标眼位类型 0 左眼 1 右眼 2 双眼 |
integer (int32) |
componentType |
指标组件类型 |
integer (int32) |
options |
指标项选项列表 |
< string > array |
constraints |
指标项约束 |
< 眼科检查指标约束 > array |
value |
检查结果值 |
string |
sort |
排序编号 |
integer (int32) |
groupId |
分组id |
integer (int32) |
displayName |
指标项展示名称 |
string |
7.324. 眼科检查眼位信息
名称 | 说明 | 类型 |
---|---|---|
inspectType |
眼位类型 1 单眼 2 双眼 |
integer (int32) |
children |
眼位信息 |
< 眼科检查指标信息 > array |
7.325. 眼科检查结果
名称 | 说明 | 类型 |
---|---|---|
productId |
眼科检查项目ID |
string |
name |
眼科检查项目名称 |
string |
children |
眼科检查二级指标 |
< 眼科检查二级标题信息 > array |
checker |
检查人 |
7.326. 眼科检查项
名称 | 说明 | 类型 |
---|---|---|
key |
眼科部位-key |
string |
name |
眼科部位-名称 |
string |
rightEyeValue |
左眼 |
string |
leftEyeValue |
右眼 |
string |
7.327. 社保信息
名称 | 说明 | 类型 |
---|---|---|
cardNo |
医保卡号 |
string |
7.328. 科室人员信息
名称 | 说明 | 类型 |
---|---|---|
employeeId |
员工ID |
string |
name |
员工姓名 |
string |
mobile |
手机号 |
string |
7.330. 科室摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
科室ID |
string |
name |
科室名称 |
string |
type |
科室类型 0:普通科室;1:门诊科室; |
integer (int32) |
mainMedicalName |
一级科目 |
string |
secondMedicalName |
二级科目 |
string |
7.331. 科室详细信息(含科室人员列表)
名称 | 说明 | 类型 |
---|---|---|
employees |
科室人员列表 |
< 科室人员信息 > array |
id |
科室ID |
string |
principal |
负责人 |
string |
name |
科室名称 |
string |
phone |
联系电话 |
string |
created |
创建时间 |
string (date-time) |
type |
科室类型 0:普通科室;1:门诊科室; |
integer (int32) |
mainMedicalName |
一级科目 |
string |
secondMedicalName |
二级科目 |
string |
7.332. 结算单入库单出库单列表
名称 | 说明 | 类型 |
---|---|---|
id |
出入库单ID |
integer (int64) |
includeTaxPrice |
出入库单含税金额 |
number |
excludeTaxPrice |
出入库单不含税金额 |
number |
totalPackageCount |
出入库单数量 |
number |
clinicId |
出入库单门店ID |
string |
clinicName |
出入库单门店名称 |
string |
orderInOutDate |
出入库时间 |
string (date-time) |
orderCreatedUserName |
单据创建人名字 |
string |
type |
出入库单类型 0:入库 1:出库 |
integer (int32) |
7.333. 结算单发票列表
名称 | 说明 | 类型 |
---|---|---|
id |
发票ID |
integer (int64) |
invoicedDate |
发票日期 |
string |
invoiceNo |
发票号 |
string |
7.334. 结算单条目列表
名称 | 说明 | 类型 |
---|---|---|
id |
结算单条目ID |
integer (int64) |
name |
名称 |
string |
specification |
规格型号 |
string |
unit |
单位 |
string |
totalPackageCount |
数量 |
integer (int32) |
includeTaxPrice |
含税金额 |
number |
excludeTaxPrice |
不含税金额 |
number |
7.335. 职称信息
名称 | 说明 | 类型 |
---|---|---|
type |
类别 |
string |
title |
名称 |
string |
7.336. 药房库存信息
名称 | 说明 | 类型 |
---|---|---|
pharmacyNo |
样例 : |
integer (int32) |
pharmacyName |
药房名称 |
string |
stockPieceCount |
可售小包装库存 |
number |
stockPackageCount |
可售大包装库存 |
number |
7.337. 药房详情
名称 | 说明 | 类型 |
---|---|---|
no |
药房号 |
integer (int32) |
7.338. 被修正的入库单信息
被修正的入库单信息
名称 | 说明 | 类型 |
---|---|---|
id |
入库单ID |
integer (int64) |
orderNo |
入库单号 |
string |
outOrderNo |
入库随货单号 |
string |
7.339. 评论
名称 | 说明 | 类型 |
---|---|---|
time |
评论时间 |
string (date-time) |
content |
评论内容 |
string |
employeeId |
评论人ID |
string |
employeeName |
评论人名称 |
string |
7.340. 调拨批次
名称 | 说明 | 类型 |
---|---|---|
stockId |
调拨库存ID(如果没指定批次,这个字段为空) |
integer (int64) |
batchNo |
调拨批次号 |
string |
expiryDate |
过期时间 yyyy-MM-dd |
string |
packageCount |
大包装数量 |
number |
pieceCount |
小包装数量 |
number |
outPackageCostPrice |
调拨成本价 |
number |
7.341. 进销存明细
名称 | 说明 | 类型 |
---|---|---|
stockLogId |
进销存明细ID |
string |
date |
进销存发生日期 yyyy-MM-dd HH:mm:ss |
string |
productId |
商品ID |
string |
productShortId |
商品编码 |
string |
productName |
商品名称 |
string |
pieceCount |
制剂库存变化量 |
number |
packageCount |
整包装库存变化量 |
number |
action |
进销存类型:发药、退药、采购入库、退货出库… |
string |
orderId |
单据ID |
string |
orderItemId |
订单条目ID |
string |
patientOrderId |
就诊单ID,仅发药、退药时有值 |
string |
sourceOrderId |
来源单据ID 发药、退药:收费单ID |
string |
sourceOrderItemId |
来源订单条目ID 发药、退药:收费项ID |
string |
packageCostPrice |
大包装单位成本价 |
number |
batchId |
批次ID |
integer (int64) |
batchNo |
生产批号 |
string |
productionDate |
生产日期 |
string |
expireDate |
效期 |
string |
inOrderId |
进销存关联的入库单ID |
integer (int64) |
inOrderItemId |
进销存关联的入库单条目ID |
integer (int64) |
inOrderItemOutDetailId |
入库单明细外部明细ID |
string |
costPrice |
成本价变化量 |
number |
salePrice |
变更实收 |
number |
pieceNum |
制剂数量 |
integer (int32) |
7.342. 进销存明细返回体
名称 | 说明 | 类型 |
---|---|---|
detailsList |
进销存明细列表 |
< 进销存明细 > array |
total |
总数 |
integer (int32) |
7.343. 进销存:进销存明细
名称 | 说明 | 类型 |
---|---|---|
date |
日期(格式yyyy-MM-dd) |
string (date) |
orderIdList |
入库单、出库单、盘点单、发药单ID |
< string > array |
chargeSheetList |
收费单列表,仅 type 为 3 时有效,orderIdList 的优先级更高 |
< 根据收费单查询进销存明细 > array |
type |
进销存单据类型 1:出库 2:盘点 3:发退药 4:调拨 |
integer (int32) |
offset |
页偏移,如果按照日期拉取,则必填,默认值为0 |
integer (int32) |
limit |
每页大小,如果按照日期拉取,则必填,默认值为 10,最大值为 100 |
integer (int32) |
7.344. 连锁商品自定义分类
名称 | 说明 | 类型 |
---|---|---|
id |
自定义分类ID |
string |
typeId |
所属系统分类ID |
integer (int32) |
name |
自定义分类名称 |
string |
7.346. 退费form请求
名称 | 说明 | 类型 |
---|---|---|
id |
收费formId |
string |
chargeFormItems |
收费项列表 |
< 收费项退费请求 > array |
7.347. 通过商品ID查询商品库存请求参数
名称 | 说明 | 类型 |
---|---|---|
productIds |
商品ID列表 |
< string > array |
7.348. 通过商品ID查询商品批次请求参数
名称 | 说明 | 类型 |
---|---|---|
productIds |
商品ID列表,最大不能超过 10 个 |
< string > array |
7.350. 通过药品编码查询药品信息请求
名称 | 说明 | 类型 |
---|---|---|
productShortIds |
商品短ID |
< string > array |
7.351. 采购单事件
名称 | 说明 | 类型 |
---|---|---|
comment |
备注 |
|
id |
采购单ID |
integer (int64) |
orderNo |
采购单号 |
string |
purchaseOrderItemList |
采购单条目列表 |
< 采购单条目 > array |
status |
采购单状态,0:待审核 1:审核通过 9:审核驳回 31:撤回 |
integer (int32) |
orderType |
采购类型,0:线下集采,10:ABC商城采购 |
integer (int32) |
purchaseOrganName |
采购门店名称 |
string |
purchaseOrganId |
采购门店ID |
string |
applyEmployeeId |
申请人ID |
string |
applyEmployeeName |
申请人 |
string |
purchaseOrderDate |
采购日期 |
string (date-time) |
created |
创建时间 |
string (date-time) |
7.353. 采购单条目
名称 | 说明 | 类型 |
---|---|---|
id |
条目ID |
integer (int64) |
productId |
商品ID |
string |
productShortId |
商品编码 |
string |
productName |
商品名称 |
string |
pieceCount |
采购小包装数量 |
number |
packageCount |
采购大包装数量 |
number |
7.354. 采购单详情
名称 | 说明 | 类型 |
---|---|---|
comment |
备注 |
|
id |
采购单ID |
integer (int64) |
orderNo |
采购单号 |
string |
purchaseOrderItemList |
采购单条目列表 |
< 采购单条目 > array |
status |
采购单状态,0:待审核 1:审核通过 9:审核驳回 31:撤回 |
integer (int32) |
orderType |
采购类型,0:线下集采,10:ABC商城采购 |
integer (int32) |
purchaseOrganName |
采购门店名称 |
string |
purchaseOrganId |
采购门店ID |
string |
applyEmployeeId |
申请人ID |
string |
applyEmployeeName |
申请人 |
string |
purchaseOrderDate |
采购日期 |
string (date-time) |
created |
创建时间 |
string (date-time) |
7.356. 门店人员详细信息
名称 | 说明 | 类型 |
---|---|---|
id |
员工ID |
string |
position |
职务 |
string |
headImgUrl |
头像 |
string |
name |
员工姓名 |
string |
mobile |
手机号 |
string |
sex |
性别 |
string |
birthday |
出生日期 |
string |
role |
角色 |
string |
introduction |
介绍 |
string |
nationalDoctorCode |
国家医生编码 |
string |
practiceInfos |
职称信息列表 |
< 职称信息 > array |
practiceImgUrl |
执业照 |
string |
goodAt |
医生擅长 |
string |
roles |
员工角色列表 0-管理员:1-医生 2-护士 3-检验师 4-理疗师 5-医助 6-其他 7-库管 8-采购 9-视光师 10-检查技师 11-咨询师 … |
< integer (int32) > array |
doctorTags |
医生标签 |
< string > array |
7.357. 门店信息
名称 | 说明 | 类型 |
---|---|---|
id |
门店ID |
string |
parentId |
连锁ID(总部ID) |
string |
hisType |
门店类型 0:ABC诊所管家 1:口腔管家 2:眼科管家 |
integer (int32) |
name |
门店名称 |
string |
phone |
联系电话 |
string |
category |
门店类型 |
string |
provinceName |
门店所处省份 |
string |
cityName |
门店所处城市 |
string |
districtName |
门店所处区域 |
string |
addressDetail |
门店详细地址 |
string |
7.359. 门店排班医生信息
名称 | 说明 | 类型 |
---|---|---|
showInWeClinic |
是否展示在微诊所 0:否 1:是,因为开放平台的接口返回的是所有排版的医生,如果接入方想要保持和微诊所一致的话,就能自己通过这个标识做过滤 |
integer (int32) |
doctor |
医生信息 |
|
status |
排班状态 0:有号 1:约满 2:无号(排班班次拆分后的总预约单元格为空,如:班次时长不满足最小服务时长等) 3:未放号 4:完诊(最晚排班结束时间已过) 5:无排班 |
integer (int32) |
7.360. 门店摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
机构ID |
string |
name |
机构名称 |
string |
7.361. 门诊单信息
名称 | 说明 | 类型 |
---|---|---|
id |
门诊单ID |
string |
patientId |
患者ID |
string |
patientOrderId |
就诊单ID |
string |
registrationSheetId |
挂号单ID |
string |
departmentId |
就诊科室ID |
string |
departmentName |
就诊科室名称 |
string |
doctorId |
就诊医生ID |
string |
doctorName |
就诊医生名字 |
string |
created |
创建时间 |
string (date-time) |
diagnosedDate |
首次完成诊断时间 |
string (date-time) |
status |
状态 0:未诊 1:已诊 |
integer (int32) |
statusName |
状态名称 |
string |
medicalRecord |
病历记录信息 |
|
prescriptionChineseForms |
中药处方 |
< 处方信息 > array |
prescriptionWesternForms |
西药处方 |
< 处方信息 > array |
prescriptionInfusionForms |
输注处方 |
< 处方信息 > array |
prescriptionExternalForms |
外治处方 |
< 处方信息 > array |
productForms |
治疗单处方 |
< 治疗单信息 > array |
7.362. 门诊单摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
门诊单ID |
string |
patientOrderId |
就诊单ID |
string |
patient |
患者信息 |
|
created |
创建时间 |
string (date-time) |
doctorId |
就诊医生ID |
string |
doctorName |
就诊医生名字 |
string |
patientOrderNo |
诊号 |
string |
status |
状态 0:未诊 1:已诊 |
integer (int32) |
statusName |
状态名称 |
string |
7.363. 门诊单详细信息
名称 | 说明 | 类型 |
---|---|---|
id |
门诊单ID |
string |
clinicId |
门店ID |
string |
patientOrderId |
就诊单ID |
string |
patientOrderNo |
诊号 |
string |
departmentId |
就诊科室ID |
string |
departmentName |
就诊科室名称 |
string |
doctorId |
就诊医生ID |
string |
doctorName |
就诊医生名字 |
string |
created |
创建时间 |
string (date-time) |
diagnosedDate |
首次完成诊断时间 |
string (date-time) |
status |
状态 0:未诊 1:已诊 |
integer (int32) |
statusName |
状态名称 |
string |
revisitStatus |
初复诊标识 1:初诊 2:复诊 |
integer (int32) |
patient |
患者信息 |
|
medicalRecord |
病历记录信息 |
|
prescriptionChineseForms |
中药处方 |
< 处方信息 > array |
prescriptionWesternForms |
西药处方 |
< 处方信息 > array |
prescriptionInfusionForms |
输注处方 |
< 处方信息 > array |
prescriptionExternalForms |
外治处方 |
< 处方信息 > array |
productForms |
治疗单处方 |
< 治疗单信息 > array |
7.364. 附件
名称 | 说明 | 类型 |
---|---|---|
url |
url |
string |
fileName |
文件名称 |
string |
fileSize |
文件大小 |
integer (int32) |
7.365. 项目指定日期号源信息响应
名称 | 说明 | 类型 |
---|---|---|
registrationCategoryDaysShifts |
挂号种类号源信息 |
< 项目预约种类号源信息 > array |
7.366. 项目预约号源信息
名称 | 说明 | 类型 |
---|---|---|
date |
日期(yyyy-MM-dd) |
string |
status |
排班状态 0:有号 1:约满 2:无号(排班班次拆分后的总预约单元格为空,如:班次时长不满足最小服务时长等) 3:未放号 4:完诊(最晚排班结束时间已过) 5:无排班 |
integer (int32) |
7.367. 项目预约种类号源信息
名称 | 说明 | 类型 |
---|---|---|
status |
排班状态 0:有号 1:约满 2:无号(排班班次拆分后的总预约单元格为空,如:班次时长不满足最小服务时长等) 3:未放号 4:完诊(最晚排班结束时间已过) 5:无排班 |
integer (int32) |
registrationCategory |
挂号种类;0:普通门诊;1:专家门诊;2:便民门诊; |
integer (int32) |
dayShifts |
按时段展示,上午/下午/晚上 或者 自定义时段 |
< 预约项目排班信息 > array |
7.368. 预约号单元格信息
名称 | 说明 | 类型 |
---|---|---|
orderNo |
号数,目前只针对精确预约、自定义时段预约有效 |
integer (int32) |
start |
开始时间 HH:mm |
string |
end |
结束时间 HH:mm |
string |
timeOfDay |
时段;上午/下午/晚上 |
string |
count |
剩余号数 |
integer (int32) |
totalCount |
总号数 |
integer (int32) |
7.369. 预约备注模板
名称 | 说明 | 类型 |
---|---|---|
id |
主键ID |
string |
registrationType |
预约类型 0:门诊预约 |
integer (int32) |
content |
内容 |
string |
sort |
顺序 |
integer (int32) |
disableModify |
是否禁止修改 0:不禁止 1:禁止 |
integer (int32) |
disableDelete |
是否禁止删除 0:不禁止 1:禁止 |
integer (int32) |
7.370. 预约时段
名称 | 说明 | 类型 |
---|---|---|
timeOfDay |
上午/下午/晚上 |
string |
start |
时段开始时间; HH:mm |
string |
end |
时段结束时间; HH:mm |
string |
list |
当前时段可用的号源集合 |
< 当前时段可用的号源 > array |
7.371. 预约项目信息
名称 | 说明 | 类型 |
---|---|---|
id |
预约项目ID |
string |
introduce |
介绍 |
string |
name |
预约项目名称 |
string |
price |
预约项目价格(仅仅用于展示,到店再支付项目费用) |
number |
attachments |
附件介绍 |
< 附件 > array |
7.372. 预约项目排班信息
名称 | 说明 | 类型 |
---|---|---|
start |
开始时间 |
string |
end |
结束时间 |
string |
timeOfDay |
上午/下午/晚上 |
string |
status |
排班状态 0:有号 1:约满 2:无号(排班班次拆分后的总预约单元格为空,如:班次时长不满足最小服务时长等) 3:未放号 4:完诊(最晚排班结束时间已过) 5:无排班 |
integer (int32) |
shiftDoctors |
排班医生列表 |
< 预约项目排班医生信息 > array |
7.373. 预约项目排班医生信息
名称 | 说明 | 类型 |
---|---|---|
doctorId |
医生id |
string |
status |
排班状态 0:有号 1:约满 2:无号(排班班次拆分后的总预约单元格为空,如:班次时长不满足最小服务时长等) 3:未放号 4:完诊(最晚排班结束时间已过) 5:无排班 |
integer (int32) |
7.374. 预约项目摘要信息
名称 | 说明 | 类型 |
---|---|---|
id |
预约项目ID |
string |
name |
预约项目名称 |
string |
8. 更新日志
8.1. 2024年09月30日
新增
[患者] 查询会员类型列表
[患者] 修改患者会员
8.2. 2024年08月30日
新增
[发药] 发药单详情和发药单事件快递信息新增“快递费用支付方式”字段
[患者] 新增患者附件上传、删除、查询接口
[认证授权] 连锁总部支持获取 accessToken
8.3. 2024年06月30日
新增
[收费] 5.7.7查询患者收费单列表接口
[执行] 5.13.6查询患者执行单列表接口
[预约] 5.5.8查询门店可预约项目列表接口
[预约] 5.5.9查询项目每日号源
[预约] 5.5.10查询项目指定日期排班信息
[预约] 5.5.11查询患者预约列表
[预约] 5.5.12查询门店指定日期医生号源状态
[预约] 5.5.13查询门店指定医生号源日期列表
修改
[医生] 5.2.1根据手机号获取医生信息:新增医生标签字段
[医生] 5.2.2获取医生分页列表信息:新增医生标签字段
[执行] 5.13.2执行单详情:新增开单人信息
[门诊] 5.6.2获取门诊单详情:新增过敏史字段
[收费] 5.7.3收费单付款:支持传收费备注
8.4. 2024年06月03日
修改
5.4.2查询患者表信息:支持按照患者档案号查询患者信息
5.9.1按患者查询检查检验单:由默认查询近3个月,调整为支持传递不超过3个月的时间范围,支持单独查询检查单或检验单,支持根据检查检验合并开关返回数据
5.9.2按创建时间查询检查检验单:由仅支持查一天,调整为支持传递不超过3天的时间范围,支持单独查询检查单或检验单,支持根据检查检验合并开关返回数据
5.9.4查询检查检验单详情、5.9.5按单号查询检查检验单(条形码):检查结果`results`旧节点`诊断意见`将不再维护
5.9.6根据检验单号修改检验单信息、5.9.7保存检查检验单数据:检查结果`results`旧节点`诊断意见`将不再维护,支持按照设备更新数据
新增
5.9.10获取检查检验设备列表
8.5. 2024年05月29日
修改
5.6.1按患者查询门诊单:由默认查询近3个月,调整为支持传递不超过3个月的时间范围
8.6. 2024年04月29日
修改
5.7.4退费接口:支持部分退费
5.13.4查询执行单执行历史接口返回执行时间
801执行事件:新增执行时间字段
802执行取消事件:新增执行时间字段
8.7. 2024年03月07日
增加收费模块功能完善
修改
5.7.3收费接口:支持部分收费
5.7.5修改快递信息接口:支持收费完成后修改快递信息
8.8. 2024年01月22日
本次更新增加对患者合并事件的支持
新增
新增 403 患者合并事件
8.9. 2023年10月20日
本次更新增加对执行事件的支持
新增
新增 801 执行事件
新增 802 执行取消事件
新增 5.5.4 通过就诊单ID获取挂号详情接口
8.10. 2023年8月29日
本次更新增加对理疗预约的支持和执行接口支持
新增
新增 5.13 执行功能支持(不支持输注处方)
新增 5.5.6 查询医生可预约项目
支持理疗预约
新增 701 挂号单创建事件
新增 702 挂号单修改事件
8.11. 2023年8月7日
本次更新增加了门诊单的创建到收费单的收费和退款的支持
新增
新增 5.6.3 创建门诊单接口(仅支持中药处方和中西成药处方)
新增 5.7.3 收费单收费接口(仅支持全部收费)
新增 5.7.4 收费单退费接口(仅支持全部退费)
新增 5.7.5 设置或修改快递信息接口
新增 108 收费单创建事件
修复
修复收费单详情没有返回患者年龄问题