1. 平台概述

ABC数字医疗云开放平台，是为第三方开发者提供接口服务的官方平台，在得到授权后第三方服务可以通过调用官方接口，或订阅平台事件，实现自定义功能。

注：开放平台仅适用于大客户版本

2. 应用接入指南

2.1. 申请

第三方开发者向平台提出接入申请，向客户经理提供要访问连锁（或单店）的信息，机构负责人信息（姓名、手机号、邮箱），由平台分配应用Id AppId 和应用密钥 AppSecret，分配后会发送至相应的邮箱。应用通过平台授权接口获取 AccessToken，即可访问权限内的相关接口及数据。如果需要修改应用密钥及权限，请联系客户经理。

参数 类型 说明

AppId

string

第三方应用的唯一标识

AppSecret

string

第三方应用的密钥，由平台生成，请妥善保管

如有疑问，请扫码加入企业微信群咨询。

企业微信群二维码

2.2. 授权

  1. AccessToken说明：

    • 应用通过分配的 AppId 及 AppSecret 向平台换取AccessToken，然后凭借AccessToken访问接口资源

    • 访问连锁下不同子店的数据，需要不同的AccessToken

    • 有效期7200秒，距离失效五分钟内，才可换取新的token，客户端应对AccessToken进行缓存，在快过期时，再换取新的AccessToken

  2. 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请求：

      1. 原始query参数param1=v1，param2=v2…​（某参数值为空时，该参数不参与签名计算），加上头部公共参数appId=APP_ID、ts=TS，加上请求路径path=PATH，按key进行字典升序排序，以k=v格式拼成参数字符串s。

        s = "appId=APP_ID&param1=v1&param2=v2&path=PATH&ts=TS"

        举例: "appId=1&param1=2&param2=3&path=/api/v2/open-agency/patient&ts=1648713476"

      2. 在s末尾追加appSecret=APP_SECRET得到s1。

        s1 = "appId=APP_ID&param1=v1&param2=v2&path=PATH&ts=TS&appSecret=APP_SECRET"

        举例: "appId=1&param1=2&param2=3&path=/api/v2/open-agency/patient&ts=1648713476&appSecret=qwer"

      3. 对s1进行md5得到sign。

        举例: md5("appId=1&param1=2&param2=3&path=/api/v2/open-agency/patient&ts=1648713476&appSecret=qwer") = 0357972C991648DD192427C6C9FD3A78

    • 其他请求：

      1. 头部公共参数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"

      2. 在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"

      3. 对s1进行md5得到sign

        举例: md5("appId=1&path=/api/v2/open-agency/patient&ts=1648713476&appSecret=qwer") = 5F39A2BFDCC5E5F96FA9514508114551

  • 签名sign计算Postman前置脚本示例

    // 获取预先设置为环境变量的 APPKEY
let appId = pm.environment.get("appId");
let key = pm.environment.get("secret");
let paths = pm.request.url.path;
let path = '/' + paths.join('/');


let ts =Math.round(new Date().getTime()/1000).toString();

var headers = pm.request.headers;
// 增加 header_ts 参数
headers.add({
  key: "ts",
  value: ts,
});

// 存放所有需要用来签名的参数
let param = {'appId':appId,'path':path,'ts':ts};

// 获取当前请求方法
let mtd = pm.request.method

// 加入 query 参数
let queryParams = pm.request.url.query;
queryParams.each(item => {
    // GET方法，启用且非空参数值的参数才参与签名
    if (!item.disabled && item.value !== '' && mtd == 'GET') {
        param[item.key] = item.value;
    }
});

// 取 key
let keys = [];
for (let key in param) {
    // 注意这里，要剔除掉 sign 参数本身
    if (key !== 'sign') {
        keys.push(key);
    }
}

// 参数名 ASCII 码从小到大排序（字典序）
keys.sort();

// 转成键值对
let paramPair = [];
for (let i = 0, len = keys.length; i < len; i++) {
    let k = keys[i];
    paramPair.push(k + '=' + param[k]) // urlencode 编码
}

// 最后加上 key
paramPair.push("appSecret=" + key);
// console.log(paramPair);

// 拼接
let stringSignTemp = paramPair.join('&');
console.log(stringSignTemp);

let sign = CryptoJS.MD5(stringSignTemp).toString().toUpperCase();
console.log(sign);

4. 事件订阅

  1. 开放平台支持部分事件订阅，第三方应用可以向平台申请事件订阅，并提供第三方应用接收事件的请求路径URL。

  2. 平台通过POST方式向第三方应用进行推送请求，超时时间是 3 秒，失败重试最多为 2 次。

  3. 推送接口说明：

    • 请求头部携带签名(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

      采购单信息

      采购单创建时，向第三方应用进行推送

      采购单完成

      3

      351

      采购单信息

      采购单完成时，向第三方应用进行推送

      库存变更

      3

      360

      商品库存信息

      库存变更时，向第三方应用进行推送

      要货单完成

      3

      381

      要货单信息

      要货单审批完成时，向第三方应用进行推送

      新增患者

      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

R«科室列表返回体»
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/departments
HTTP响应示例
响应 200
{
  "data" : {
    "departmentList" : [ {
      "id" : "ffffffff0000000006dddfe002e22000",
      "name" : "儿保科室",
      "type" : 1,
      "isClinical" : 1,
      "mainMedicalName" : "儿科",
      "mainMedicalCode" : "50",
      "secondMedicalName" : "小儿呼吸",
      "secondMedicalCode" : "5001",
      "customId" : "5001"
    } ]
  }
}

5.1.2. 获取门店信息

GET /api/v2/open-agency/clinics/info
响应
HTTP Code 说明 类型

200

OK

R«门店信息»
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

R«科室详细信息（含科室人员列表）»
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,
    "isClinical" : 1,
    "mainMedicalName" : "儿科",
    "mainMedicalCode" : "50",
    "secondMedicalName" : "小儿呼吸",
    "secondMedicalCode" : "5001",
    "customId" : "5001"
  }
}

5.1.4. 获取人员详情

GET /api/v2/open-agency/clinics/employees/{id}
参数
类型 名称 说明 类型

Path

id
必填

人员id

string
响应
HTTP Code 说明 类型

200

OK

R«门店人员详细信息»
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/employees/07b47b860f9649febc9d907e2ec6f23f
HTTP响应示例
响应 200
{
  "data" : {
    "departmentList" : [ {
      "id" : "ffffffff0000000006dddfe002e22000",
      "name" : "儿保科室",
      "type" : 1,
      "isClinical" : 1,
      "mainMedicalName" : "儿科",
      "mainMedicalCode" : "50",
      "secondMedicalName" : "小儿呼吸",
      "secondMedicalCode" : "5001",
      "customId" : "5001"
    } ],
    "id" : "ffffffff0000000017ea20500df64000",
    "position" : "string",
    "headImgUrl" : "string",
    "name" : "张三",
    "mobile" : "13888888888",
    "sex" : "男",
    "birthday" : "1987-04-12",
    "role" : "医生",
    "certNo" : "string",
    "nationalDoctorCode" : "string",
    "practiceCertCode" : "string",
    "introduction" : "毕业于陆军军医大学临床医学七年制",
    "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

R«门店人员列表返回体»
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/employees
HTTP响应示例
响应 200
{
  "data" : {
    "employeeList" : [ {
      "departmentList" : [ {
        "id" : "ffffffff0000000006dddfe002e22000",
        "name" : "儿保科室",
        "type" : 1,
        "isClinical" : 1,
        "mainMedicalName" : "儿科",
        "mainMedicalCode" : "50",
        "secondMedicalName" : "小儿呼吸",
        "secondMedicalCode" : "5001",
        "customId" : "5001"
      } ],
      "id" : "ffffffff0000000017ea20500df64000",
      "position" : "string",
      "headImgUrl" : "string",
      "name" : "张三",
      "mobile" : "13888888888",
      "sex" : "男",
      "birthday" : "1987-04-12",
      "role" : "医生",
      "certNo" : "string",
      "nationalDoctorCode" : "string",
      "practiceCertCode" : "string",
      "introduction" : "毕业于陆军军医大学临床医学七年制",
      "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.6. 获取门店人员科室列表

POST /api/v2/open-agency/clinics/department-employees
参数
类型 名称 说明 类型

Body

request
必填

request

ClinicEmployeeDepartmentReq
响应
HTTP Code 说明 类型

200

OK

R«OpenClinicEmployeeDepartmentRsp»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/clinics/department-employees
请求 body
{
  "showInWeClinic" : 0,
  "businessScope" : 0,
  "departmentIds" : [ "string" ],
  "employeeIds" : [ "string" ],
  "moduleIds" : [ 0 ],
  "roleIds" : [ 0 ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "employeeList" : [ {
      "departmentList" : [ {
        "id" : "ffffffff0000000006dddfe002e22000",
        "name" : "儿保科室",
        "type" : 1,
        "isClinical" : 1,
        "mainMedicalName" : "儿科",
        "mainMedicalCode" : "50",
        "secondMedicalName" : "小儿呼吸",
        "secondMedicalCode" : "5001",
        "customId" : "5001"
      } ],
      "id" : "ffffffff0000000017ea20500df64000",
      "position" : "string",
      "headImgUrl" : "string",
      "name" : "张三",
      "mobile" : "13888888888",
      "sex" : "男",
      "birthday" : "1987-04-12",
      "role" : "医生",
      "certNo" : "string",
      "nationalDoctorCode" : "string",
      "practiceCertCode" : "string",
      "introduction" : "毕业于陆军军医大学临床医学七年制",
      "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

R«医生信息详情»
HTTP请求示例
请求 path
/api/v2/open-agency/doctor/query-by-mobile?mobile=18088888888
HTTP响应示例
响应 200
{
  "data" : {
    "departments" : [ {
      "id" : "ffffffff0000000006dddfe002e22000",
      "name" : "儿保科室",
      "type" : 1,
      "isClinical" : 1,
      "mainMedicalName" : "儿科",
      "mainMedicalCode" : "50",
      "secondMedicalName" : "小儿呼吸",
      "secondMedicalCode" : "5001",
      "customId" : "5001"
    } ],
    "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)

20

Query

offset
可选

分页起始下标

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«医生信息»»
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

R«商品分类信息响应»
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

R«连锁商品自定义分类响应»
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)

0

Query

keyword
可选

关键词过滤

string

Query

limit
可选

每页显示条数，默认20，最大为 200

integer (int32)

20

Query

offset
可选

分页起始下标，默认0

integer (int32)

0

Query

typeId
可选

分类Id

integer (int32)
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«商品信息»»
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

R«商品详情»
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,
      "dismounting" : 0,
      "typeName" : "药品",
      "customTypeId" : "213",
      "isSell" : 1,
      "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"
      },
      "remark" : "abc",
      "dosageFormType" : 0,
      "dosageFormTypeName" : "string"
    } ],
    "id" : "string",
    "name" : "阿莫西林",
    "shebao" : {
      "nationalCode" : "T001700643",
      "insuranceTypes" : [ {
        "insuranceType" : "391",
        "reimbursementRatio" : 0.1
      } ]
    },
    "disableSell" : 0,
    "typeId" : 1,
    "dismounting" : 0,
    "typeName" : "药品",
    "customTypeId" : "213",
    "isSell" : 1,
    "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"
    },
    "remark" : "abc",
    "dosageFormType" : 0,
    "dosageFormTypeName" : "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

R«库存出库单列表»
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

R«出库单详情»
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,
        "packagePrice" : 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

pharmacyNo
可选

药房号，默认本地药房

integer (int32)

0

Query

status
可选

单据状态，默认已完成(2)。示例：0=待审核，1=待确认，2=已完成，9=已拒绝，31=撤回

integer (int32)

Query

type
可选

类型 0:采购入库 10:退货出库

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«库存入库单列表»
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

R«入库单详情»
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",
      "traceableCodeList" : [ {
        "no" : "86975041000000000000",
        "type" : 0,
        "hisPieceCount" : 10.0,
        "hisPackageCount" : 1.0,
        "count" : 1.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.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

R«库存盘点单列表»
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

R«盘点单详情»
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,
        "packagePrice" : 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)

1

Query

endDate
可选

结束时间（格式yyyy-MM-dd）配合查询日期类型使用

string (date)
响应
HTTP Code 说明 类型

200

OK

R«库存结算单信息返回体»
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

R«库存结算单详情»
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

R«供应商档案信息返回体»
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
说明

  1. 查询指定日期的进销存明细（传 date、offset、limit） 2. 出入库单、盘点单、发药单、调拨单进销存明细（传 orderIdList） 3. 查询收费单进销存明细（传 chargeSheetList）

参数
类型 名称 说明 类型

Body

-
必填

-

进销存：进销存明细
响应
HTTP Code 说明 类型

200

OK

R«进销存明细返回体»
消耗

  • 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,
      "traceableCodeList" : [ {
        "no" : "86975041000000000000",
        "type" : 0,
        "hisPieceCount" : 10.0,
        "hisPackageCount" : 1.0,
        "count" : 1.0
      } ]
    } ],
    "total" : 10
  }
}

5.3.15. 查询商品库存

POST /api/v2/open-agency/products/stock/query-by-id
参数
类型 名称 说明 类型

Body

-
必填

-

通过商品ID查询商品库存请求参数
响应
HTTP Code 说明 类型

200

OK

R«查询商品库存响应参数»
消耗

  • 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

-
必填

-

通过商品ID查询商品批次请求参数
响应
HTTP Code 说明 类型

200

OK

R«查询商品批次响应»
消耗

  • 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

R«供应商信息»
消耗

  • 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

R«供应商信息»
消耗

  • 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

R«商品明细信息»
消耗

  • 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

R«商品明细信息»
消耗

  • 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

R«采购单列表»
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

R«采购单详情»
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,
    "supplierId" : "ffffffff0000000034af4ae82d69c000",
    "orderType" : 0,
    "supplier" : "测试供应商",
    "purchaseOrganName" : "string",
    "receiveOrganId" : "ffffffff0000000034d6d4adbec04000",
    "purchaseOrganId" : "string",
    "receiveOrganName" : "abc",
    "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

R«操作响应结果»
消耗

  • 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

R«操作响应结果»
消耗

  • 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

R«入库单详情»
消耗

  • 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",
    "traceableCodeList" : [ {
      "no" : "86975041000000000000",
      "hisPieceCount" : 10.0,
      "hisPackageCount" : 1.0
    } ]
  } ]
}
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",
      "traceableCodeList" : [ {
        "no" : "86975041000000000000",
        "type" : 0,
        "hisPieceCount" : 10.0,
        "hisPackageCount" : 1.0,
        "count" : 1.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.26. 创建退货出库单

POST /api/v2/open-agency/products/out-orders
说明

目前仅支持退指定批次号的药品，并且退的所有药要在同一个入库单中

参数
类型 名称 说明 类型

Body

-
必填

-

创建出库单请求
响应
HTTP Code 说明 类型

200

OK

R«入库单详情»
消耗

  • 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",
    "batchId" : 0
  } ]
}
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",
      "traceableCodeList" : [ {
        "no" : "86975041000000000000",
        "type" : 0,
        "hisPieceCount" : 10.0,
        "hisPackageCount" : 1.0,
        "count" : 1.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.27. 审核退货出库申请单

PUT /api/v2/open-agency/products/out-apply-orders/{outApplyOrderId}/review
参数
类型 名称 说明 类型

Body

-
必填

-

出库申请单审核请求

Path

outApplyOrderId
必填

outApplyOrderId

integer (int64)
响应
HTTP Code 说明 类型

200

OK

R«操作响应结果»
消耗

  • 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)

20

Query

offset
可选

offset

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«AbcListPage«商品批次库存信息»»
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)

0

Query

transType
可选

调拨类型: 0-店间调拨 1-店内调拨

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«库存调拨单列表视图»»
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

R«库存调拨单详情»
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"
        },
        "remark" : "abc",
        "dosageFormType" : 0,
        "dosageFormTypeName" : "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,
        "packagePrice" : 1.0
      } ],
      "lastModified" : "string"
    } ]
  }
}

5.3.31. 获取要货单详情

GET /api/v2/open-agency/products/claim-orders/{orderId}
参数
类型 名称 说明 类型

Path

orderId
必填

要货单ID

string
响应
HTTP Code 说明 类型

200

OK

R«要货单详情»
HTTP请求示例
请求 path
/api/v2/open-agency/products/claim-orders/50130373
HTTP响应示例
响应 200
{
  "data" : {
    "comment" : {
      "time" : "string",
      "content" : "string",
      "employeeId" : "string",
      "employeeName" : "string"
    },
    "id" : 0,
    "claimOrderItemList" : [ {
      "id" : 123123,
      "productId" : "ffffffff000000003473c049d7ab4000",
      "productShortId" : "000251",
      "productName" : "阿莫西林胶囊",
      "pieceCount" : 0.0,
      "packageCount" : 1.0,
      "approvePieceCount" : 0.0,
      "approvePackageCount" : 1.0
    } ],
    "orderNo" : "YH2025101000001",
    "status" : 0,
    "kindCount" : 2,
    "claimOrganName" : "string",
    "claimOrganId" : "string",
    "applyEmployeeId" : "string",
    "applyEmployeeName" : "string",
    "claimOrderDate" : "2024-11-06 16:51:03",
    "created" : "2024-11-06 16:51:03"
  }
}

5.3.32. 创建收货单

POST /api/v2/open-agency/products/receive-orders
参数
类型 名称 说明 类型

Body

clientReq
必填

clientReq

创建收货单请求
响应
HTTP Code 说明 类型

200

OK

R«收货单详情»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/products/receive-orders
请求 body
{
  "erpOrderNo" : "XHCX00000182466",
  "erpOrderId" : "CX00000182466",
  "purchaseOrderId" : "100001697",
  "claimOrderId" : "100001697",
  "supplierId" : "ffffffff00000000349179dde6fd0000",
  "receiveOrganId" : "ffffffff0000000013186d180b520000",
  "list" : [ {
    "purchaseOrderItemId" : 100002498,
    "claimOrderItemId" : 100002498,
    "productId" : "0021650c11444ed9ad05e07f3ccc5c1f",
    "shortId" : "2481526",
    "batchNo" : "202311008",
    "expiryDate" : "2025-12-10",
    "productionDate" : "2021-01-20",
    "totalPrice" : 10.0,
    "packageCostPrice" : 5.0,
    "receiveCount" : 2.0,
    "unit" : "盒",
    "erpProductData" : {
      "erpProductId" : "SPZ00015757",
      "name" : "盐酸贝尼地平片",
      "manufacturer" : "四川中庸药业有限公司",
      "medicineNmpn" : "国药准字Z20043621",
      "displaySpec" : "2ml*10支/盒"
    }
  } ],
  "sourceType" : 100
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : 3796368496350265344,
    "receiveOrderItemList" : [ {
      "id" : 123456,
      "productId" : "ffffffff0000000034966c3a883ec000",
      "productShortId" : "1000001",
      "productName" : "阿莫西林",
      "expiryDate" : "2022-05-10",
      "productionDate" : "2024-05-10",
      "batchNo" : "20220526000001",
      "totalPrice" : 10.0,
      "packageCostPrice" : 5.0,
      "receiveCount" : 2.0,
      "unit" : "盒"
    } ],
    "orderNo" : "SH2024013000001",
    "status" : 10,
    "kindCount" : 5,
    "sum" : 100.0,
    "outOrderNo" : "035040",
    "receiveDate" : "string",
    "receiveOrganId" : "ffffffff0000000034d6d4adbec04000",
    "receiveOrganName" : "abc",
    "receiveEmployeeId" : "6e45706922a74966ab51e4ed1e604641",
    "receiveEmployeeName" : "张三",
    "supplier" : "测试供应商",
    "supplierId" : "ffffffff0000000034af4ae82d69c000"
  }
}

5.3.33. 获取收货单详情

GET /api/v2/open-agency/products/receive-orders/{receiveOrderId}
参数
类型 名称 说明 类型

Path

receiveOrderId
必填

receiveOrderId

integer (int64)
响应
HTTP Code 说明 类型

200

OK

R«收货单详情»
HTTP请求示例
请求 path
/api/v2/open-agency/products/receive-orders/0
HTTP响应示例
响应 200
{
  "data" : {
    "id" : 3796368496350265344,
    "receiveOrderItemList" : [ {
      "id" : 123456,
      "productId" : "ffffffff0000000034966c3a883ec000",
      "productShortId" : "1000001",
      "productName" : "阿莫西林",
      "expiryDate" : "2022-05-10",
      "productionDate" : "2024-05-10",
      "batchNo" : "20220526000001",
      "totalPrice" : 10.0,
      "packageCostPrice" : 5.0,
      "receiveCount" : 2.0,
      "unit" : "盒"
    } ],
    "orderNo" : "SH2024013000001",
    "status" : 10,
    "kindCount" : 5,
    "sum" : 100.0,
    "outOrderNo" : "035040",
    "receiveDate" : "string",
    "receiveOrganId" : "ffffffff0000000034d6d4adbec04000",
    "receiveOrganName" : "abc",
    "receiveEmployeeId" : "6e45706922a74966ab51e4ed1e604641",
    "receiveEmployeeName" : "张三",
    "supplier" : "测试供应商",
    "supplierId" : "ffffffff0000000034af4ae82d69c000"
  }
}

5.3.34. 更新第三方库存数量

POST /api/v2/open-agency/products/third-party-stock
参数
类型 名称 说明 类型

Body

clientReq
必填

clientReq

同步第三方库存请求
响应
HTTP Code 说明 类型

200

OK

R«操作响应结果»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/products/third-party-stock
请求 body
{
  "supplierId" : "ffffffff0000000034fe0a2cd8564000",
  "list" : [ {
    "productShortId" : "000001",
    "productId" : "001e3d44f92946d28feabfd750a43c51",
    "erpPackageCount" : 10.0,
    "erpPackageUnit" : "盒",
    "erpPackagePrice" : 0.0,
    "erpPackageCostPrice" : 0.0,
    "erpProductId" : "SPZ00015757",
    "erpBatchId" : "00015757",
    "erpBatchNo" : "202311008",
    "erpExpiryDate" : "2025-12-10",
    "erpProductionDate" : "2021-01-20"
  } ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.4. 患者接口

5.4.1. 获取患者分页列表

GET /api/v2/open-agency/patient/query-list
参数
类型 名称 说明 类型 默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string

Query

limit
可选

每页显示条数，默认20

integer (int32)

20

Query

offset
可选

分页起始下标，默认0

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«患者摘要信息»»
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",
      "idCardType" : "身份证"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.4.2. 查询患者

GET /api/v2/open-agency/patient/query
说明

根据手机号or姓名or档案号获取患者分页列表信息

参数
类型 名称 说明 类型

Query

mobile
可选

手机号

string

Query

name
可选

姓名

string

Query

sn
可选

档案号

string
响应
HTTP Code 说明 类型

200

OK

R«患者列表响应»
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",
      "idCardType" : "身份证"
    } ]
  }
}

5.4.3. 获取患者详情

GET /api/v2/open-agency/patient/{id}
参数
类型 名称 说明 类型

Path

id
必填

患者id

string
响应
HTTP Code 说明 类型

200

OK

R«患者详细信息»
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",
    "idCardType" : "身份证",
    "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" : "普通卡"
      }
    },
    "weChatInfo" : {
      "chainMpOpenId" : "202394712938192",
      "chainWeappOpenId" : "202394712938192"
    }
  }
}

5.4.4. 查询来源分类列表

GET /api/v2/open-agency/patient/source/types
响应
HTTP Code 说明 类型

200

OK

R«查询就诊来源类型响应»
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

R«患者摘要信息»
消耗

  • 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",
    "idCardType" : "身份证"
  }
}

5.4.6. 修改患者

PUT /api/v2/open-agency/patient/{id}
参数
类型 名称 说明 类型

Body

-
必填

-

修改患者请求体

Path

id
必填

患者id

string
响应
HTTP Code 说明 类型

200

OK

R«患者摘要信息»
消耗

  • 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",
    "idCardType" : "身份证"
  }
}

5.4.7. 查询患者家庭成员信息

GET /api/v2/open-agency/patient/{patientId}/family-member
参数
类型 名称 说明 类型

Path

patientId
必填

患者ID

string
响应
HTTP Code 说明 类型

200

OK

R«查询患者家庭成员响应»
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",
      "idCardType" : "身份证"
    } ]
  }
}

5.4.8. 查询患者附件

GET /api/v2/open-agency/patient/{patientId}/attachments
参数
类型 名称 说明 类型 默认值

Path

patientId
必填

患者ID

string

Query

limit
可选

每页显示条数，默认值为 10，最大为 20

integer (int32)

10

Query

offset
可选

分页起始下标

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«患者附件»»
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

R«添加患者附件响应»
消耗

  • 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

R«操作响应结果»
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

R«查询患者会员类型响应»
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

R«会员卡支付响应»
消耗

  • 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

R«会员卡退费响应»
消耗

  • 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)

0
响应
HTTP Code 说明 类型

200

OK

R«医生排班号源详情响应结果»
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

R«创建挂号单响应结果»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/registration
请求 body
{
  "source" : 4,
  "reserveMustPay" : 0,
  "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",
    "chargeSheetId" : "ffffffff00000000220e67a8116d8000",
    "patientOrderId" : "string"
  }
}

5.5.3. 获取挂号详情

GET /api/v2/open-agency/registration/{registrationsSheetId}
参数
类型 名称 说明 类型

Path

registrationsSheetId
必填

挂号单id

string
响应
HTTP Code 说明 类型

200

OK

R«挂号详细信息»
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",
    "orderNoNum" : 1,
    "visitSourceRelatedType" : 0,
    "orderNo" : "上午 01号",
    "visitSourceRelatedId" : "string",
    "reserveDate" : "2019-04-04",
    "visitSourceRelateName" : "string",
    "reserveTime" : "10:10～10:30",
    "visitSourceRemark" : "string",
    "isReserved" : 1,
    "registrationProducts" : [ {
      "id" : "ffffffff000000000000000000000001",
      "name" : "针灸"
    } ],
    "revisitStatus" : 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.5.4. 通过就诊单ID获取挂号详情

GET /api/v2/open-agency/registration/by-patient-order-id/{patientOrderId}
参数
类型 名称 说明 类型

Path

patientOrderId
必填

就诊单ID

string
响应
HTTP Code 说明 类型

200

OK

R«挂号详细信息»
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",
    "orderNoNum" : 1,
    "visitSourceRelatedType" : 0,
    "orderNo" : "上午 01号",
    "visitSourceRelatedId" : "string",
    "reserveDate" : "2019-04-04",
    "visitSourceRelateName" : "string",
    "reserveTime" : "10:10～10:30",
    "visitSourceRemark" : "string",
    "isReserved" : 1,
    "registrationProducts" : [ {
      "id" : "ffffffff000000000000000000000001",
      "name" : "针灸"
    } ],
    "revisitStatus" : 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.5.5. 取消挂号

PUT /api/v2/open-agency/registration/{registrationsSheetId}/cancel
参数
类型 名称 说明 类型

Path

registrationsSheetId
必填

挂号单id

string
响应
HTTP Code 说明 类型

200

OK

R«取消挂号响应»
消耗

  • 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

R«查询预约备注模板响应»
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

R«查询医生可预约项目响应»
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

R«查询医生可预约项目响应»
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

R«预约项目每日号源状态响应»
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

R«项目指定日期号源信息响应»
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)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

registrationType
可选

预约类型 0:门诊预约 1:理疗预约，默认为 0

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«患者预约摘要信息»»
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)

0
响应
HTTP Code 说明 类型

200

OK

R«门店医生排班状态响应»
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)

0
响应
HTTP Code 说明 类型

200

OK

R«医生号源日期列表响应»
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,
        "revisitedFee" : 30.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)

0

Query

limit
可选

分页大小，默认为 10，最大为 20

integer (int32)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

reserveDate
可选

预约日期，默认为当天

string
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«挂号单基础信息»»
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",
      "orderNoNum" : 1,
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "revisitStatus" : 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)

20

Query

offset
可选

分页起始下标

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«门诊单摘要信息»»
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",
        "idCardType" : "身份证"
      },
      "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

R«门诊单详细信息»
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",
      "idCardType" : "身份证"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosisInfos" : "JX.001.001,急性上呼吸道感染",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "epidemiologicalHistory" : "无",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "auxiliaryExamination" : "无",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "prescriptionChineseForms" : [ {
      "id" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "verifySignatures" : [ {
          "productId" : "483ac61f811640f5849a3d3aabceea58",
          "productName" : "三七",
          "status" : 1
        } ],
        "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,
            "dismounting" : 0,
            "typeName" : "药品",
            "customTypeId" : "213",
            "isSell" : 1,
            "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"
            },
            "remark" : "abc",
            "dosageFormType" : 0,
            "dosageFormTypeName" : "string"
          } ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        }
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "prescriptionWesternForms" : [ {
      "id" : "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        }
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "prescriptionInfusionForms" : [ {
      "id" : "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" : "..."
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "prescriptionExternalForms" : [ {
      "id" : "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" : "..."
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "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,
        "freq" : "每日2次",
        "remark" : "小心使用",
        "toothNos" : [ 12, 23 ]
      } ]
    } ]
  }
}

5.6.3. 创建门诊单

POST /api/v2/open-agency/outpatient
参数
类型 名称 说明 类型

Body

req
必填

req

门诊单请求参数
响应
HTTP Code 说明 类型

200

OK

R«门诊单详细信息»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient
请求 body
{
  "departmentId" : "string",
  "doctorId" : "string",
  "patientId" : "string",
  "operatorId" : "00000000000000000000000000000000",
  "medicalRecord" : {
    "id" : "0",
    "chiefComplaint" : "咽痛，干咳，咳痰",
    "pastHistory" : "既往体健，既往有高血压",
    "allergicHistory" : "鸡蛋过敏，青霉素过敏",
    "familyHistory" : "string",
    "presentHistory" : "string",
    "physicalExamination" : "string",
    "diagnosis" : "急性上呼吸道感染",
    "doctorAdvice" : "string",
    "syndrome" : "string",
    "therapy" : "string",
    "chineseExamination" : "string",
    "obstetricalHistory" : "string"
  },
  "prescriptionChineseForms" : [ {
    "id" : "0",
    "pharmacyNo" : 0,
    "isTotalPriceChanged" : 1,
    "specification" : "中药饮片",
    "doseCount" : 3,
    "expectedTotalPrice" : 10.0,
    "prescriptionFormItems" : [ {
      "id" : "483ac61f811640f5849a3d3aabceea58",
      "specialRequirement" : "先煎",
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "productShortId" : "1907765200",
      "verifySignatures" : [ {
        "productShortId" : "1907765200",
        "productId" : "483ac61f811640f5849a3d3aabceea58",
        "productName" : "三七",
        "status" : 1
      } ],
      "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" : [ {
    "id" : "0",
    "isTotalPriceChanged" : 1,
    "expectedTotalPrice" : 10.0,
    "prescriptionFormItems" : [ {
      "ast" : 1,
      "id" : "483ac61f811640f5849a3d3aabceea58",
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "usage" : "含服用",
      "freq" : "qd",
      "productShortId" : "1907765200",
      "dosage" : 3.0,
      "unitCount" : 2.0,
      "dosageUnit" : "片",
      "expectedUnitPrice" : 5.0,
      "days" : 5.0,
      "expectedTotalPrice" : 5.0,
      "specialRequirement" : "首次加倍",
      "useDismounting" : 0,
      "pharmacyNo" : 0
    } ]
  } ],
  "prescriptionInfusionForms" : [ {
    "id" : "0",
    "usage" : "静脉滴注",
    "freq" : "qd",
    "isTotalPriceChanged" : 1,
    "days" : 5,
    "expectedTotalPrice" : 10.0,
    "ivgtt" : 50.0,
    "prescriptionFormItems" : [ {
      "ast" : 1,
      "id" : "483ac61f811640f5849a3d3aabceea58",
      "dosage" : 3.0,
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "dosageUnit" : "片",
      "productShortId" : "1907765200",
      "specialRequirement" : "首次加倍",
      "unitCount" : 2.0,
      "expectedUnitPrice" : 5.0,
      "pharmacyNo" : 0,
      "expectedTotalPrice" : 5.0,
      "useDismounting" : 0
    } ],
    "ivgttUnit" : "滴/分钟"
  } ],
  "prescriptionExternalForms" : [ {
    "id" : "0",
    "usageType" : 1,
    "isTotalPriceChanged" : 1,
    "usageSubType" : 1,
    "expectedTotalPrice" : 10.0,
    "prescriptionFormItems" : [ {
      "acupoints" : [ {
        "name" : "string",
        "position" : "左｜右｜双｜单｜-",
        "acupointType" : 0
      } ],
      "id" : "483ac61f811640f5849a3d3aabceea58",
      "dosage" : "12",
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "dosageUnit" : "次",
      "productShortId" : "1907765200",
      "freq" : "1日1次",
      "unitCount" : 2.0,
      "expectedUnitPrice" : 5.0,
      "specialRequirement" : "贴敷30分钟",
      "expectedTotalPrice" : 5.0,
      "unitCountType" : 0,
      "unit" : "部位",
      "useDismounting" : 0
    } ]
  } ],
  "productForms" : [ {
    "id" : "0",
    "sourceFromType" : 2,
    "productFormItems" : [ {
      "id" : "0",
      "pharmacyNo" : 0,
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "productShortId" : "1907765200",
      "freq" : "每日2次",
      "dailyDosage" : 3,
      "days" : 1,
      "unitCount" : 2.0,
      "unit" : "次",
      "remark" : "穴位经渠；",
      "expectedUnitPrice" : 5.0,
      "expectedTotalPrice" : 5.0,
      "useDismounting" : 0,
      "toothNos" : [ 12, 23 ]
    } ]
  } ],
  "revisitStatus" : 1,
  "shebaoChargeType" : 1
}
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",
      "idCardType" : "身份证"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosisInfos" : "JX.001.001,急性上呼吸道感染",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "epidemiologicalHistory" : "无",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "auxiliaryExamination" : "无",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "prescriptionChineseForms" : [ {
      "id" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "verifySignatures" : [ {
          "productId" : "483ac61f811640f5849a3d3aabceea58",
          "productName" : "三七",
          "status" : 1
        } ],
        "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,
            "dismounting" : 0,
            "typeName" : "药品",
            "customTypeId" : "213",
            "isSell" : 1,
            "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"
            },
            "remark" : "abc",
            "dosageFormType" : 0,
            "dosageFormTypeName" : "string"
          } ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        }
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "prescriptionWesternForms" : [ {
      "id" : "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        }
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "prescriptionInfusionForms" : [ {
      "id" : "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" : "..."
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "prescriptionExternalForms" : [ {
      "id" : "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" : "..."
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "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,
        "freq" : "每日2次",
        "remark" : "小心使用",
        "toothNos" : [ 12, 23 ]
      } ]
    } ]
  }
}

5.6.4. 更新门诊单

PUT /api/v2/open-agency/outpatient/{id}
参数
类型 名称 说明 类型

Path

id
必填

id

string

Path

outpatientSheetId
必填

门诊单ID

string

Body

req
必填

req

门诊单请求参数
响应
HTTP Code 说明 类型

200

OK

R«门诊单详细信息»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/string
请求 body
{
  "departmentId" : "string",
  "doctorId" : "string",
  "patientId" : "string",
  "operatorId" : "00000000000000000000000000000000",
  "medicalRecord" : {
    "id" : "0",
    "chiefComplaint" : "咽痛，干咳，咳痰",
    "pastHistory" : "既往体健，既往有高血压",
    "allergicHistory" : "鸡蛋过敏，青霉素过敏",
    "familyHistory" : "string",
    "presentHistory" : "string",
    "physicalExamination" : "string",
    "diagnosis" : "急性上呼吸道感染",
    "doctorAdvice" : "string",
    "syndrome" : "string",
    "therapy" : "string",
    "chineseExamination" : "string",
    "obstetricalHistory" : "string"
  },
  "prescriptionChineseForms" : [ {
    "id" : "0",
    "pharmacyNo" : 0,
    "isTotalPriceChanged" : 1,
    "specification" : "中药饮片",
    "doseCount" : 3,
    "expectedTotalPrice" : 10.0,
    "prescriptionFormItems" : [ {
      "id" : "483ac61f811640f5849a3d3aabceea58",
      "specialRequirement" : "先煎",
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "productShortId" : "1907765200",
      "verifySignatures" : [ {
        "productShortId" : "1907765200",
        "productId" : "483ac61f811640f5849a3d3aabceea58",
        "productName" : "三七",
        "status" : 1
      } ],
      "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" : [ {
    "id" : "0",
    "isTotalPriceChanged" : 1,
    "expectedTotalPrice" : 10.0,
    "prescriptionFormItems" : [ {
      "ast" : 1,
      "id" : "483ac61f811640f5849a3d3aabceea58",
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "usage" : "含服用",
      "freq" : "qd",
      "productShortId" : "1907765200",
      "dosage" : 3.0,
      "unitCount" : 2.0,
      "dosageUnit" : "片",
      "expectedUnitPrice" : 5.0,
      "days" : 5.0,
      "expectedTotalPrice" : 5.0,
      "specialRequirement" : "首次加倍",
      "useDismounting" : 0,
      "pharmacyNo" : 0
    } ]
  } ],
  "prescriptionInfusionForms" : [ {
    "id" : "0",
    "usage" : "静脉滴注",
    "freq" : "qd",
    "isTotalPriceChanged" : 1,
    "days" : 5,
    "expectedTotalPrice" : 10.0,
    "ivgtt" : 50.0,
    "prescriptionFormItems" : [ {
      "ast" : 1,
      "id" : "483ac61f811640f5849a3d3aabceea58",
      "dosage" : 3.0,
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "dosageUnit" : "片",
      "productShortId" : "1907765200",
      "specialRequirement" : "首次加倍",
      "unitCount" : 2.0,
      "expectedUnitPrice" : 5.0,
      "pharmacyNo" : 0,
      "expectedTotalPrice" : 5.0,
      "useDismounting" : 0
    } ],
    "ivgttUnit" : "滴/分钟"
  } ],
  "prescriptionExternalForms" : [ {
    "id" : "0",
    "usageType" : 1,
    "isTotalPriceChanged" : 1,
    "usageSubType" : 1,
    "expectedTotalPrice" : 10.0,
    "prescriptionFormItems" : [ {
      "acupoints" : [ {
        "name" : "string",
        "position" : "左｜右｜双｜单｜-",
        "acupointType" : 0
      } ],
      "id" : "483ac61f811640f5849a3d3aabceea58",
      "dosage" : "12",
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "dosageUnit" : "次",
      "productShortId" : "1907765200",
      "freq" : "1日1次",
      "unitCount" : 2.0,
      "expectedUnitPrice" : 5.0,
      "specialRequirement" : "贴敷30分钟",
      "expectedTotalPrice" : 5.0,
      "unitCountType" : 0,
      "unit" : "部位",
      "useDismounting" : 0
    } ]
  } ],
  "productForms" : [ {
    "id" : "0",
    "sourceFromType" : 2,
    "productFormItems" : [ {
      "id" : "0",
      "pharmacyNo" : 0,
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "productShortId" : "1907765200",
      "freq" : "每日2次",
      "dailyDosage" : 3,
      "days" : 1,
      "unitCount" : 2.0,
      "unit" : "次",
      "remark" : "穴位经渠；",
      "expectedUnitPrice" : 5.0,
      "expectedTotalPrice" : 5.0,
      "useDismounting" : 0,
      "toothNos" : [ 12, 23 ]
    } ]
  } ],
  "revisitStatus" : 1,
  "shebaoChargeType" : 1
}
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",
      "idCardType" : "身份证"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosisInfos" : "JX.001.001,急性上呼吸道感染",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "epidemiologicalHistory" : "无",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "auxiliaryExamination" : "无",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "prescriptionChineseForms" : [ {
      "id" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "verifySignatures" : [ {
          "productId" : "483ac61f811640f5849a3d3aabceea58",
          "productName" : "三七",
          "status" : 1
        } ],
        "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,
            "dismounting" : 0,
            "typeName" : "药品",
            "customTypeId" : "213",
            "isSell" : 1,
            "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"
            },
            "remark" : "abc",
            "dosageFormType" : 0,
            "dosageFormTypeName" : "string"
          } ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        }
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "prescriptionWesternForms" : [ {
      "id" : "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        }
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "prescriptionInfusionForms" : [ {
      "id" : "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" : "..."
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "prescriptionExternalForms" : [ {
      "id" : "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" : "..."
      } ],
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string"
    } ],
    "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,
        "freq" : "每日2次",
        "remark" : "小心使用",
        "toothNos" : [ 12, 23 ]
      } ]
    } ]
  }
}

5.6.5. 按天查询门诊单

GET /api/v2/open-agency/outpatient/query-by-date
参数
类型 名称 说明 类型 默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string

Query

limit
可选

每页显示条数，默认20，最大100

integer (int32)

20

Query

offset
可选

分页起始下标，默认0

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«门诊单摘要信息»»
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",
        "idCardType" : "身份证"
      },
      "created" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "patientOrderNo" : "0000000001",
      "status" : 0,
      "statusName" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.6.6. 修改预诊信息

PUT /api/v2/open-agency/outpatient/{outpatientSheetId}/pre-diagnose
说明

为 NULL 不会覆盖已有的值

参数
类型 名称 说明 类型

Body

-
必填

-

修改预诊信息请求参数

Path

outpatientSheetId
必填

门诊单ID

string
响应
HTTP Code 说明 类型

200

OK

R«操作响应结果»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/ffffffff00000000216fab8810cde000/pre-diagnose
请求 body
{
  "chiefComplaint" : "咽痛，干咳，咳痰",
  "presentHistory" : "无",
  "pastHistory" : "既往体健，既往有高血压",
  "familyHistory" : "无",
  "allergicHistory" : "青霉素过敏",
  "obstetricalHistory" : "月经初潮13岁，月经规则，末次月经2023-06-15，末次月经量中等，末次月经痛经轻度，末次月经有血块，末次月经...",
  "epidemiologicalHistory" : "无",
  "chineseExamination" : "无",
  "auxiliaryExamination" : "无",
  "diagnosis" : "急性上呼吸道感染",
  "syndrome" : "风热感冒",
  "doctorAdvice" : "口服感冒清热颗粒",
  "operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

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

R«收费单摘要信息列表»
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",
        "idCardType" : "身份证"
      },
      "type" : 1,
      "isClosed" : 0
    } ]
  }
}

5.7.2. 获取收费单明细

GET /api/v2/open-agency/charge/query-detail/{id}
参数
类型 名称 说明 类型

Path

id
必填

收费单ID

string
响应
HTTP Code 说明 类型

200

OK

R«收费单详细信息»
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",
      "idCardType" : "身份证"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosisInfos" : "JX.001.001,急性上呼吸道感染",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "epidemiologicalHistory" : "无",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "auxiliaryExamination" : "无",
      "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        } ],
        "id" : "string",
        "name" : "阿莫西林",
        "shebao" : {
          "nationalCode" : "T001700643",
          "insuranceTypes" : [ {
            "insuranceType" : "391",
            "reimbursementRatio" : 0.1
          } ]
        },
        "disableSell" : 0,
        "typeId" : 1,
        "dismounting" : 0,
        "typeName" : "药品",
        "customTypeId" : "213",
        "isSell" : 1,
        "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"
        },
        "remark" : "abc",
        "dosageFormType" : 0,
        "dosageFormTypeName" : "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        },
        "composeChildren" : [ "..." ],
        "extraInfo" : "string"
      } ],
      "extraInfo" : "string"
    } ],
    "chargeTransactions" : [ {
      "id" : "ffffffff00000000220e67a8116d8001",
      "payMode" : 1,
      "paySubMode" : 1,
      "payModeName" : "ABC支付",
      "payModeDisplayName" : "ABC支付-微信",
      "amount" : 0.0,
      "created" : "2022-04-06 15:12:53",
      "isRefunded" : 0,
      "thirdTransactionId" : "123456789",
      "thirdPartyPayInfo" : {
        "transactionId" : "string",
        "thirdPartyTransactionId" : "string",
        "channelTransactionId" : "string"
      },
      "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",
    "fromSource" : 1
  }
}

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

R«收费单收费结果»
消耗

  • 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

R«收费单退费响应»
消耗

  • 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

R«收费单详细信息»
消耗

  • 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",
      "idCardType" : "身份证"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosisInfos" : "JX.001.001,急性上呼吸道感染",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "epidemiologicalHistory" : "无",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "auxiliaryExamination" : "无",
      "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        } ],
        "id" : "string",
        "name" : "阿莫西林",
        "shebao" : {
          "nationalCode" : "T001700643",
          "insuranceTypes" : [ {
            "insuranceType" : "391",
            "reimbursementRatio" : 0.1
          } ]
        },
        "disableSell" : 0,
        "typeId" : 1,
        "dismounting" : 0,
        "typeName" : "药品",
        "customTypeId" : "213",
        "isSell" : 1,
        "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"
        },
        "remark" : "abc",
        "dosageFormType" : 0,
        "dosageFormTypeName" : "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        },
        "composeChildren" : [ "..." ],
        "extraInfo" : "string"
      } ],
      "extraInfo" : "string"
    } ],
    "chargeTransactions" : [ {
      "id" : "ffffffff00000000220e67a8116d8001",
      "payMode" : 1,
      "paySubMode" : 1,
      "payModeName" : "ABC支付",
      "payModeDisplayName" : "ABC支付-微信",
      "amount" : 0.0,
      "created" : "2022-04-06 15:12:53",
      "isRefunded" : 0,
      "thirdTransactionId" : "123456789",
      "thirdPartyPayInfo" : {
        "transactionId" : "string",
        "thirdPartyTransactionId" : "string",
        "channelTransactionId" : "string"
      },
      "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",
    "fromSource" : 1
  }
}

5.7.6. 通过就诊单ID查询收费单

GET /api/v2/open-agency/charge/by-patient-order-id/{patientOrderId}
参数
类型 名称 说明 类型

Path

就诊单ID
必填

patientOrderId

string
响应
HTTP Code 说明 类型

200

OK

R«收费单列表»
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",
        "idCardType" : "身份证"
      },
      "medicalRecord" : {
        "id" : "string",
        "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
        "chiefComplaint" : "咽痛，干咳，咳痰",
        "pastHistory" : "既往体健，既往有高血压",
        "familyHistory" : "string",
        "presentHistory" : "string",
        "physicalExamination" : "string",
        "diagnosisInfos" : "JX.001.001,急性上呼吸道感染",
        "diagnosis" : "急性上呼吸道感染",
        "doctorAdvice" : "string",
        "syndrome" : "string",
        "therapy" : "string",
        "chineseExamination" : "string",
        "wearGlassesHistory" : "近视",
        "epidemiologicalHistory" : "无",
        "obstetricalHistory" : "string",
        "eyeExamination" : {
          "items" : [ {
            "key" : "string",
            "name" : "string",
            "rightEyeValue" : "string",
            "leftEyeValue" : "string"
          } ]
        },
        "allergicHistory" : "青霉素过敏",
        "auxiliaryExamination" : "无",
        "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,
            "dismounting" : 0,
            "typeName" : "药品",
            "customTypeId" : "213",
            "isSell" : 1,
            "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"
            },
            "remark" : "abc",
            "dosageFormType" : 0,
            "dosageFormTypeName" : "string"
          } ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "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,
            "dismounting" : 0,
            "typeName" : "药品",
            "customTypeId" : "213",
            "isSell" : 1,
            "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"
            },
            "remark" : "abc",
            "dosageFormType" : 0,
            "dosageFormTypeName" : "string"
          },
          "composeChildren" : [ "..." ],
          "extraInfo" : "string"
        } ],
        "extraInfo" : "string"
      } ],
      "chargeTransactions" : [ {
        "id" : "ffffffff00000000220e67a8116d8001",
        "payMode" : 1,
        "paySubMode" : 1,
        "payModeName" : "ABC支付",
        "payModeDisplayName" : "ABC支付-微信",
        "amount" : 0.0,
        "created" : "2022-04-06 15:12:53",
        "isRefunded" : 0,
        "thirdTransactionId" : "123456789",
        "thirdPartyPayInfo" : {
          "transactionId" : "string",
          "thirdPartyTransactionId" : "string",
          "channelTransactionId" : "string"
        },
        "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",
      "fromSource" : 1
    } ]
  }
}

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)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

status
可选

收费单状态 0:未付费 1:部分付费 2:已付费 3:部分退费 4:已退费，支持传多个以逗号分割

string
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«患者收费单摘要信息»»
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

R«收费单详细信息»
消耗

  • 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",
      "idCardType" : "身份证"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosisInfos" : "JX.001.001,急性上呼吸道感染",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "epidemiologicalHistory" : "无",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "auxiliaryExamination" : "无",
      "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        } ],
        "id" : "string",
        "name" : "阿莫西林",
        "shebao" : {
          "nationalCode" : "T001700643",
          "insuranceTypes" : [ {
            "insuranceType" : "391",
            "reimbursementRatio" : 0.1
          } ]
        },
        "disableSell" : 0,
        "typeId" : 1,
        "dismounting" : 0,
        "typeName" : "药品",
        "customTypeId" : "213",
        "isSell" : 1,
        "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"
        },
        "remark" : "abc",
        "dosageFormType" : 0,
        "dosageFormTypeName" : "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        },
        "composeChildren" : [ "..." ],
        "extraInfo" : "string"
      } ],
      "extraInfo" : "string"
    } ],
    "chargeTransactions" : [ {
      "id" : "ffffffff00000000220e67a8116d8001",
      "payMode" : 1,
      "paySubMode" : 1,
      "payModeName" : "ABC支付",
      "payModeDisplayName" : "ABC支付-微信",
      "amount" : 0.0,
      "created" : "2022-04-06 15:12:53",
      "isRefunded" : 0,
      "thirdTransactionId" : "123456789",
      "thirdPartyPayInfo" : {
        "transactionId" : "string",
        "thirdPartyTransactionId" : "string",
        "channelTransactionId" : "string"
      },
      "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",
    "fromSource" : 1
  }
}

5.7.9. 查询支付方式

GET /api/v2/open-agency/charge/pay/modes
响应
HTTP Code 说明 类型

200

OK

R«OpenChargePayModeView»
HTTP请求示例
请求 path
/api/v2/open-agency/charge/pay/modes
HTTP响应示例
响应 200
{
  "data" : {
    "payModes" : [ {
      "id" : "string",
      "name" : "string"
    } ]
  }
}

5.7.10. 创建零售收费单

POST /api/v2/open-agency/charge/sheets
参数
类型 名称 说明 类型

Body

req
必填

req

创建零售收费单请求参数
响应
HTTP Code 说明 类型

200

OK

R«创建零售收费单响应参数»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/charge/sheets
请求 body
{
  "chargeForms" : [ {
    "doseCount" : 1.0,
    "pharmacyNo" : 0,
    "chargeFormItems" : [ {
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "productShortId" : "1907765200",
      "unitCount" : 2.0,
      "expectedUnitPrice" : 5.0,
      "expectedTotalPrice" : 5.0,
      "useDismounting" : 1,
      "specialRequirement" : "煎法(先煎、后下、包煎、另煎、先炒、烊化、冲服、捣碎、吞服、煎汤代水、兑入、打粉、另包)",
      "extraInfo" : "string"
    } ],
    "usageInfo" : {
      "usage" : "煎服",
      "freq" : "1日3次",
      "doseCount" : 3,
      "dailyDosage" : "1日3剂",
      "requirement" : "饭前服用",
      "usageLevel" : "每次150ml"
    }
  } ],
  "patientId" : "ffffffff0000000034de380221984001",
  "sellerId" : "ffffffff000000001b6cf51810e0e000",
  "sellerDepartmentId" : "38e4085cb61ef7ac520cbd6e7508ead2",
  "doctorId" : "ffffffff0000000022174678012e2000",
  "doctorDepartmentId" : "38e4085cb61ef7ac520cbd6e7508ead2",
  "diagnosis" : "急性上呼吸道感染",
  "prescriptionUrls" : [ "string" ],
  "operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "ffffffff0000000035094935b30b8000",
    "patientOrderId" : "ffffffff0000000035094935ade28000",
    "status" : 0,
    "needPay" : 100.0
  }
}

5.8. 发药接口

5.8.1. 根据发药单ID查询发药单详情

GET /api/v2/open-agency/dispensing/{id}
参数
类型 名称 说明 类型

Path

id
必填

发药单ID

string
响应
HTTP Code 说明 类型

200

OK

R«发药单详情»
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",
      "diagnosisInfos" : "JX.001.001,急性上呼吸道感染",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "epidemiologicalHistory" : "无",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "auxiliaryExamination" : "无",
      "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",
      "idCardType" : "身份证"
    },
    "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,
      "isClinical" : 1,
      "mainMedicalName" : "儿科",
      "mainMedicalCode" : "50",
      "secondMedicalName" : "小儿呼吸",
      "secondMedicalCode" : "5001",
      "customId" : "5001"
    },
    "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,
        "isDecoction" : 0
      },
      "totalPrice" : 30.23,
      "vendorId" : "ffffffff0000000034e6cae04206c09c",
      "vendorName" : "供应商A",
      "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,
          "isDecoction" : 0
        },
        "productInfo" : {
          "children" : [ {
            "children" : [ "..." ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "disableSell" : 0,
            "typeId" : 1,
            "dismounting" : 0,
            "typeName" : "药品",
            "customTypeId" : "213",
            "isSell" : 1,
            "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"
            },
            "remark" : "abc",
            "dosageFormType" : 0,
            "dosageFormTypeName" : "string"
          } ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        },
        "totalPrice" : 10.3,
        "dispensingBatches" : [ {
          "stockLogId" : "123456",
          "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"
        } ],
        "composeChildren" : [ {
          "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,
            "isDecoction" : 0
          },
          "productInfo" : {
            "children" : [ "..." ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "disableSell" : 0,
            "typeId" : 1,
            "dismounting" : 0,
            "typeName" : "药品",
            "customTypeId" : "213",
            "isSell" : 1,
            "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"
            },
            "remark" : "abc",
            "dosageFormType" : 0,
            "dosageFormTypeName" : "string"
          },
          "totalPrice" : 10.3,
          "dispensingBatches" : [ {
            "stockLogId" : "123456",
            "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"
          } ],
          "composeChildren" : [ {
            "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,
              "isDecoction" : 0
            },
            "productInfo" : "...",
            "totalPrice" : 10.3,
            "dispensingBatches" : [ {
              "stockLogId" : "123456",
              "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"
            } ],
            "composeChildren" : [ "..." ],
            "traceableCodeList" : [ {
              "no" : "86975041000000000000",
              "type" : 0,
              "hisPieceCount" : 10.0,
              "hisPackageCount" : 1.0,
              "count" : 1.0
            } ]
          } ],
          "traceableCodeList" : [ {
            "no" : "86975041000000000000",
            "type" : 0,
            "hisPieceCount" : 10.0,
            "hisPackageCount" : 1.0,
            "count" : 1.0
          } ]
        } ],
        "traceableCodeList" : [ {
          "no" : "86975041000000000000",
          "type" : 0,
          "hisPieceCount" : 10.0,
          "hisPackageCount" : 1.0,
          "count" : 1.0
        } ]
      } ],
      "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)

0

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«发药单摘要信息»»
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",
        "idCardType" : "身份证"
      }
    } ],
    "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

"00000000000000000000000000000000"
响应
HTTP Code 说明 类型

200

OK

R«操作响应结果»
消耗

  • 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

"00000000000000000000000000000000"
响应
HTTP Code 说明 类型

200

OK

R«操作响应结果»
消耗

  • 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

R«操作响应结果»
消耗

  • 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

R«操作响应结果»
消耗

  • 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

R«操作响应结果»
消耗

  • 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

R«就诊单号查询发药单响应»
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",
        "diagnosisInfos" : "JX.001.001,急性上呼吸道感染",
        "diagnosis" : "急性上呼吸道感染",
        "doctorAdvice" : "string",
        "syndrome" : "string",
        "therapy" : "string",
        "chineseExamination" : "string",
        "wearGlassesHistory" : "近视",
        "epidemiologicalHistory" : "无",
        "obstetricalHistory" : "string",
        "eyeExamination" : {
          "items" : [ {
            "key" : "string",
            "name" : "string",
            "rightEyeValue" : "string",
            "leftEyeValue" : "string"
          } ]
        },
        "allergicHistory" : "青霉素过敏",
        "auxiliaryExamination" : "无",
        "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",
        "idCardType" : "身份证"
      },
      "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,
        "isClinical" : 1,
        "mainMedicalName" : "儿科",
        "mainMedicalCode" : "50",
        "secondMedicalName" : "小儿呼吸",
        "secondMedicalCode" : "5001",
        "customId" : "5001"
      },
      "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,
          "isDecoction" : 0
        },
        "totalPrice" : 30.23,
        "vendorId" : "ffffffff0000000034e6cae04206c09c",
        "vendorName" : "供应商A",
        "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,
            "isDecoction" : 0
          },
          "productInfo" : {
            "children" : [ {
              "children" : [ "..." ],
              "id" : "string",
              "name" : "阿莫西林",
              "shebao" : {
                "nationalCode" : "T001700643",
                "insuranceTypes" : [ {
                  "insuranceType" : "391",
                  "reimbursementRatio" : 0.1
                } ]
              },
              "disableSell" : 0,
              "typeId" : 1,
              "dismounting" : 0,
              "typeName" : "药品",
              "customTypeId" : "213",
              "isSell" : 1,
              "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"
              },
              "remark" : "abc",
              "dosageFormType" : 0,
              "dosageFormTypeName" : "string"
            } ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "disableSell" : 0,
            "typeId" : 1,
            "dismounting" : 0,
            "typeName" : "药品",
            "customTypeId" : "213",
            "isSell" : 1,
            "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"
            },
            "remark" : "abc",
            "dosageFormType" : 0,
            "dosageFormTypeName" : "string"
          },
          "totalPrice" : 10.3,
          "dispensingBatches" : [ {
            "stockLogId" : "123456",
            "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"
          } ],
          "composeChildren" : [ {
            "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,
              "isDecoction" : 0
            },
            "productInfo" : {
              "children" : [ "..." ],
              "id" : "string",
              "name" : "阿莫西林",
              "shebao" : {
                "nationalCode" : "T001700643",
                "insuranceTypes" : [ {
                  "insuranceType" : "391",
                  "reimbursementRatio" : 0.1
                } ]
              },
              "disableSell" : 0,
              "typeId" : 1,
              "dismounting" : 0,
              "typeName" : "药品",
              "customTypeId" : "213",
              "isSell" : 1,
              "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"
              },
              "remark" : "abc",
              "dosageFormType" : 0,
              "dosageFormTypeName" : "string"
            },
            "totalPrice" : 10.3,
            "dispensingBatches" : [ {
              "stockLogId" : "123456",
              "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"
            } ],
            "composeChildren" : [ {
              "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,
                "isDecoction" : 0
              },
              "productInfo" : "...",
              "totalPrice" : 10.3,
              "dispensingBatches" : [ {
                "stockLogId" : "123456",
                "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"
              } ],
              "composeChildren" : [ "..." ],
              "traceableCodeList" : [ {
                "no" : "86975041000000000000",
                "type" : 0,
                "hisPieceCount" : 10.0,
                "hisPackageCount" : 1.0,
                "count" : 1.0
              } ]
            } ],
            "traceableCodeList" : [ {
              "no" : "86975041000000000000",
              "type" : 0,
              "hisPieceCount" : 10.0,
              "hisPackageCount" : 1.0,
              "count" : 1.0
            } ]
          } ],
          "traceableCodeList" : [ {
            "no" : "86975041000000000000",
            "type" : 0,
            "hisPieceCount" : 10.0,
            "hisPackageCount" : 1.0,
            "count" : 1.0
          } ]
        } ],
        "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)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

status
可选

发药单状态 0:未发药 1:已发药 2:已退药 3:部分发药

integer (int32)
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«患者发药单信息»»
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.8.10. 发药单退药，支持部分退药

PUT /api/v2/open-agency/dispensing/{dispensingSheetId}/undispense
参数
类型 名称 说明 类型

Path

dispensingSheetId
必填

发药单ID

string

Body

req
必填

req

退药请求参数
响应
HTTP Code 说明 类型

200

OK

R«操作响应结果»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/string/undispense
请求 body
{
  "dispensingForms" : [ {
    "id" : "ffffffff00000000350895c78a404002",
    "doseCount" : 1.0,
    "dispensingFormItems" : [ {
      "id" : "ffffffff00000000350895c78a404003",
      "unitCount" : 12.0
    } ]
  } ],
  "operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

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)

20

Query

offset
可选

分页起始下标

integer (int32)

0

Query

startTime
可选

开始时间（格式yyyy-MM-dd HH:mm:ss）

string

Query

type
可选

类型 1:检验 2:检查

integer (int32)
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«检查检验单摘要信息»»
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",
        "idCardType" : "身份证"
      },
      "name" : "string",
      "type" : 1,
      "deviceType" : 0,
      "businessType" : 0,
      "created" : "string",
      "reportTime" : "string",
      "status" : 0,
      "statusName" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.9.2. 按照检查检验单id获取检查检验单信息

GET /api/v2/open-agency/examination/chain/{sheetId}
参数
类型 名称 说明 类型

Path

sheetId
必填

检查检验单

string
响应
HTTP Code 说明 类型

200

OK

R«检查检验单摘要信息»
HTTP请求示例
请求 path
/api/v2/open-agency/examination/chain/06174f8075a44028ba22d2e5122f8ae2
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "patientOrderId" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758",
      "idCardType" : "身份证"
    },
    "name" : "string",
    "type" : 1,
    "deviceType" : 0,
    "businessType" : 0,
    "created" : "string",
    "reportTime" : "string",
    "status" : 0,
    "statusName" : "string"
  }
}

5.9.3. 按时间查询检查检验单

GET /api/v2/open-agency/examination/all/query-by-date
参数
类型 名称 说明 类型 默认值

Query

dateFieldType
可选

查询日期类型: 1,创建时间; 2,最后修改时间; 3,检验/检查时间 4,审核时间 5,报告时间

integer (int32)

1

Query

endTime
可选

结束时间（格式yyyy-MM-dd HH:mm:ss）

string

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

Query

startTime
可选

开始时间（格式yyyy-MM-dd HH:mm:ss）

string

Query

type
可选

1：检验；2：检查

integer (int32)
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«检查检验摘要信息»»
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",
        "idCardType" : "身份证"
      },
      "status" : 0,
      "statusName" : "待检"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.9.4. 按单号查询检查检验单

GET /api/v2/open-agency/examination/query-by-patient-order-no
参数
类型 名称 说明 类型 默认值

Query

patientOrderNo
必填

单号

string

Query

type
可选

类型 0:就诊号 1:体检单号

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«查询检查检验数据响应»
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",
        "idCardType" : "身份证"
      },
      "status" : 0,
      "statusName" : "待检"
    } ]
  }
}

5.9.5. 查询检查检验单详情

GET /api/v2/open-agency/examination/examination-sheet-detail/{id}
参数
类型 名称 说明 类型

Path

id
必填

检查检验单id

string
响应
HTTP Code 说明 类型

200

OK

R«检查检验单详情信息»
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
      },
      "idCardType" : "身份证"
    },
    "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",
      "orderNoNum" : 1,
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "revisitStatus" : 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. 按单号查询检查检验单(条形码)

GET /api/v2/open-agency/examination/by-order-no/{orderNo}/{type}
参数
类型 名称 说明 类型

Path

orderNo
必填

订单号

string

Path

type
必填

类型 1:检验 2:检查

integer (int32)
响应
HTTP Code 说明 类型

200

OK

R«检查检验单详情信息»
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
      },
      "idCardType" : "身份证"
    },
    "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",
      "orderNoNum" : 1,
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "revisitStatus" : 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/by-order-no/{orderNo}/{type}
参数
类型 名称 说明 类型

Body

-
必填

-

检验单修改信息

Path

orderNo
必填

订单号

string

Path

type
必填

类型 1:检验 2:检查

integer (int32)
响应
HTTP Code 说明 类型

200

OK

R«检查检验单详情信息»
消耗

  • 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
      },
      "idCardType" : "身份证"
    },
    "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",
      "orderNoNum" : 1,
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "revisitStatus" : 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. 保存检查检验单数据

PUT /api/v2/open-agency/examination/examination-sheet-detail/{id}
参数
类型 名称 说明 类型

Body

-
必填

-

检验单修改信息

Path

id
必填

检查检验单id

string
响应
HTTP Code 说明 类型

200

OK

R«检查检验单详情信息»
消耗

  • 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
      },
      "idCardType" : "身份证"
    },
    "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",
      "orderNoNum" : 1,
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "revisitStatus" : 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.9. 创建检查检验单

POST /api/v2/open-agency/examination
参数
类型 名称 说明 类型

Body

-
必填

-

创建检查检验单请求
响应
HTTP Code 说明 类型

200

OK

R«创建检查检验单响应»
消耗

  • 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",
        "idCardType" : "身份证"
      },
      "status" : 0,
      "statusName" : "待检"
    } ]
  }
}

5.9.10. 作废检查检验单

PUT /api/v2/open-agency/examination/refund/{id}
参数
类型 名称 说明 类型

Path

id
必填

检查检验单id

string
响应
HTTP Code 说明 类型

200

OK

R«操作响应结果»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/examination/refund/string
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.9.11. 获取检查检验设备列表

GET /api/v2/open-agency/examination/devices/{type}
参数
类型 名称 说明 类型

Path

type
必填

类型 1:检验 2:检查

integer (int32)
响应
HTTP Code 说明 类型

200

OK

R«检验检查设备列表响应»
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,
        "isClinical" : 1,
        "mainMedicalName" : "儿科",
        "mainMedicalCode" : "50",
        "secondMedicalName" : "小儿呼吸",
        "secondMedicalCode" : "5001",
        "customId" : "5001"
      }
    } ]
  }
}

5.9.12. 按申请单号查询检查检验单

GET /api/v2/open-agency/examination/query-by-exam-apply-no/{examApplySheetNo}
参数
类型 名称 说明 类型

Path

examApplySheetNo
必填

examApplySheetNo

string

Query

type
可选

1：检验；2：检查

integer (int32)
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«检查检验摘要信息»»
HTTP请求示例
请求 path
/api/v2/open-agency/examination/query-by-exam-apply-no/string
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",
        "idCardType" : "身份证"
      },
      "status" : 0,
      "statusName" : "待检"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

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)

20

Query

offset
可选

分页起始下标 默认0

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«收费明细-单据信息»»
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)

20

Query

offset
可选

分页起始下标 默认0

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«收费明细-分类信息»»
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)

0

Query

limit
可选

每页显示条数，最大不能超过 100 默认20

integer (int32)

20

Query

offset
可选

分页起始下标 默认0

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«收费明细-明细信息»»
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)

20

Query

offset
可选

分页起始下标 默认0

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«执行业绩-明细»»
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)

20

Query

offset
必填

分页起始下标

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«开卡充值业绩明细视图»»
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)

20

Query

offset
必填

分页起始下标

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«会员充值业绩明细视图»»
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)

20

Query

offset
必填

分页起始下标

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«事件推送详情»»
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

R«地区信息»
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,2025年5月24号新入驻的客户，不再使用此接口，请使用5.14.1进行文件上传

参数
类型 名称 说明 类型

Header

cis-app-id
必填

cis-app-id

string
响应
HTTP Code 说明 类型

200

OK

R«OSS开放Token»
HTTP请求示例
请求 path
/api/v2/open-agency/property/oss/token
请求 header
"string"
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

R«操作响应结果»
消耗

  • 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

R«查询执行单列表响应»
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",
        "idCardType" : "身份证"
      },
      "abstractInfo" : "string",
      "created" : "2022-04-06 15:12:53",
      "isClosed" : 0
    } ]
  }
}

5.13.2. 执行单详情

GET /api/v2/open-agency/execute/{id}
参数
类型 名称 说明 类型

Path

id
必填

执行单ID

string
响应
HTTP Code 说明 类型

200

OK

R«执行单详情»
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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "string"
        } ],
        "id" : "string",
        "name" : "阿莫西林",
        "shebao" : {
          "nationalCode" : "T001700643",
          "insuranceTypes" : [ {
            "insuranceType" : "391",
            "reimbursementRatio" : 0.1
          } ]
        },
        "disableSell" : 0,
        "typeId" : 1,
        "dismounting" : 0,
        "typeName" : "药品",
        "customTypeId" : "213",
        "isSell" : 1,
        "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"
        },
        "remark" : "abc",
        "dosageFormType" : 0,
        "dosageFormTypeName" : "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,
          "dismounting" : 0,
          "typeName" : "药品",
          "customTypeId" : "213",
          "isSell" : 1,
          "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"
          },
          "remark" : "abc",
          "dosageFormType" : 0,
          "dosageFormTypeName" : "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" : [ "..." ],
          "extraInfo" : "string"
        } ],
        "extraInfo" : "string"
      } ],
      "extraInfo" : "string"
    } ],
    "status" : 1,
    "chargeStatus" : 0,
    "created" : "2022-04-06 15:12:53",
    "sellerId" : "ffffffff000000003484c3816487c002",
    "sellerName" : "张三",
    "doctorId" : "ffffffff000000003484c3816487c002",
    "doctorName" : "李四",
    "diagnosis" : "慢性鼻窦炎，颞下间隙感染",
    "isClosed" : 0
  }
}

5.13.3. 执行

POST /api/v2/open-agency/execute/{id}/do
参数
类型 名称 说明 类型

Body

-
必填

-

执行单执行请求参数

Path

id
必填

执行单ID

string
响应
HTTP Code 说明 类型

200

OK

R«操作响应结果»
消耗

  • 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

R«查询执行单执行记录响应参数»
HTTP请求示例
请求 path
/api/v2/open-agency/execute/ffffffff000000003484c3816487c002/record
HTTP响应示例
响应 200
{
  "data" : {
    "executeRecords" : [ {
      "id" : "ffffffff000000003484c3816487c002",
      "executeClinicId" : "ffffffff000000003484c3816487c002",
      "executeClinicName" : "中医诊所高新店",
      "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

R«操作响应结果»
消耗

  • 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)

10

Query

offset
可选

分页偏移，默认为 0

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«患者执行单信息»»
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

R«文件上传响应»
消耗

  • multipart/form-data

HTTP请求示例
请求 path
/api/v2/open-agency/file/upload
请求 body
{ }
HTTP响应示例
响应 200
{
  "data" : {
    "isSuccess" : 0,
    "message" : "string",
    "filePath" : "string",
    "fileId" : 0,
    "temp" : true
  }
}

5.14.2. 文件下载

GET /api/v2/open-agency/file/download/{id}
说明

调用方需支持重定向,只支持2025年7月1日后上传的文件下载，接口使用示例：curl –location –request GET 'http://localhost:8050/api/v2/open-agency/file/download/3818492943753494528' \ –header 'sign: 601E5C427EAAEEF7FA1DBB5E9D994424' \ –header 'ts: 1747806228' \ –header 'appId: 2430575937595654144' \ –header 'authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI2YTg2OWMyMmFiZWU0ZmZiYWVmM2U1MjdiYmI3MGFlYiIsImFwcElkIjoiMjQzMDU3NTkzNzU5NTY1NDE0NCIsImlhdCI6MTc0NzgwNTc2NiwiZXhwIjoxNzQ3ODEyOTY2fQ.4y-lXCYW6B14OCAXMVEI555wJLA39E3FruHcZdwUQ5k' \ –form 'file=@"/Users/Documents/test.xlsx"'

参数
类型 名称 说明 类型

Path

id
必填

文件Id,从5.14.1上传接口的fileId获取

integer (int64)
响应
HTTP Code 说明 类型

200

OK

无内容

302

重定向到文件下载地址

无内容

500

服务器内部错误

无内容
HTTP请求示例
请求 path
/api/v2/open-agency/file/download/0

5.15. 体检接口

5.15.1. 创建体检单

POST /api/v2/open-agency/pe-orders
参数
类型 名称 说明 类型

Body

req
必填

req

创建体检单请求
响应
HTTP Code 说明 类型

200

OK

R«创建体检单响应»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/pe-orders
请求 body
{
  "patientId" : "string",
  "businessTime" : "string",
  "reportGetWay" : 0,
  "address" : {
    "addressProvinceId" : "510000",
    "addressProvinceName" : "四川",
    "addressCityId" : "510100",
    "addressCityName" : "成都市",
    "addressDistrictId" : "510109",
    "addressDistrictName" : "高新区",
    "addressDetail" : "交子大道180号"
  },
  "forms" : [ {
    "type" : 0,
    "salesEmployeeId" : "string",
    "salesDepartmentId" : "string",
    "items" : [ {
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "productShortId" : "1907765200",
      "salesEmployeeId" : "string",
      "salesDepartmentId" : "string",
      "expectedUnitPrice" : 0.0
    } ]
  } ],
  "expectedTotalPrice" : 1000.0,
  "operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758",
      "idCardType" : "身份证"
    },
    "patientOrderId" : "string",
    "name" : "string",
    "no" : "string",
    "orderNo" : "string",
    "type" : 0,
    "businessTime" : "string",
    "orderCreated" : "string",
    "reportGetWay" : 0,
    "status" : 0,
    "totalFee" : 0.0,
    "chargeStatus" : 0,
    "sheetSubmitted" : "string",
    "reportApproved" : "string",
    "reportReleased" : "string",
    "sourceType" : 0,
    "patientImageUrl" : "string",
    "address" : {
      "addressProvinceId" : "510000",
      "addressProvinceName" : "四川",
      "addressCityId" : "510100",
      "addressCityName" : "成都市",
      "addressDistrictId" : "510109",
      "addressDistrictName" : "高新区",
      "addressDetail" : "交子大道180号"
    },
    "forms" : [ {
      "id" : 0,
      "type" : 0,
      "salesEmployee" : {
        "id" : "string",
        "name" : "string"
      },
      "salesDepartment" : {
        "id" : "string",
        "name" : "string",
        "departmentAddress" : "string"
      },
      "items" : [ {
        "id" : 0,
        "productId" : "string",
        "productType" : 0,
        "productSubType" : 0,
        "productName" : "string",
        "status" : 0,
        "sourceUnitPrice" : 0.0,
        "unitPrice" : 0.0,
        "salesEmployee" : {
          "id" : "string",
          "name" : "string"
        },
        "salesDepartment" : {
          "id" : "string",
          "name" : "string",
          "departmentAddress" : "string"
        },
        "scheduleTime" : "string",
        "remark" : "string",
        "children" : [ {
          "id" : 0,
          "productId" : "string",
          "productType" : 0,
          "productSubType" : 0,
          "productName" : "string",
          "status" : 0,
          "sourceUnitPrice" : 0.0,
          "unitPrice" : 0.0,
          "salesEmployee" : {
            "id" : "string",
            "name" : "string"
          },
          "salesDepartment" : {
            "id" : "string",
            "name" : "string",
            "departmentAddress" : "string"
          },
          "scheduleTime" : "string",
          "remark" : "string",
          "children" : [ "..." ]
        } ]
      } ],
      "chargeStatus" : 0,
      "totalFee" : 0.0
    } ],
    "salesEmployee" : {
      "id" : "string",
      "name" : "string"
    },
    "salesDepartment" : {
      "id" : "string",
      "name" : "string",
      "departmentAddress" : "string"
    },
    "chargeSheet" : {
      "id" : "string",
      "totalFee" : 0.0
    }
  }
}

5.15.2. 查看体检订单详情

GET /api/v2/open-agency/pe-orders/{id}
参数
类型 名称 说明 类型

Path

id
必填

体检订单id

string
响应
HTTP Code 说明 类型

200

OK

R«创建体检单响应»
HTTP请求示例
请求 path
/api/v2/open-agency/pe-orders/000000fc446f4dbd989857e305b00d6d
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758",
      "idCardType" : "身份证"
    },
    "patientOrderId" : "string",
    "name" : "string",
    "no" : "string",
    "orderNo" : "string",
    "type" : 0,
    "businessTime" : "string",
    "orderCreated" : "string",
    "reportGetWay" : 0,
    "status" : 0,
    "totalFee" : 0.0,
    "chargeStatus" : 0,
    "sheetSubmitted" : "string",
    "reportApproved" : "string",
    "reportReleased" : "string",
    "sourceType" : 0,
    "patientImageUrl" : "string",
    "address" : {
      "addressProvinceId" : "510000",
      "addressProvinceName" : "四川",
      "addressCityId" : "510100",
      "addressCityName" : "成都市",
      "addressDistrictId" : "510109",
      "addressDistrictName" : "高新区",
      "addressDetail" : "交子大道180号"
    },
    "forms" : [ {
      "id" : 0,
      "type" : 0,
      "salesEmployee" : {
        "id" : "string",
        "name" : "string"
      },
      "salesDepartment" : {
        "id" : "string",
        "name" : "string",
        "departmentAddress" : "string"
      },
      "items" : [ {
        "id" : 0,
        "productId" : "string",
        "productType" : 0,
        "productSubType" : 0,
        "productName" : "string",
        "status" : 0,
        "sourceUnitPrice" : 0.0,
        "unitPrice" : 0.0,
        "salesEmployee" : {
          "id" : "string",
          "name" : "string"
        },
        "salesDepartment" : {
          "id" : "string",
          "name" : "string",
          "departmentAddress" : "string"
        },
        "scheduleTime" : "string",
        "remark" : "string",
        "children" : [ {
          "id" : 0,
          "productId" : "string",
          "productType" : 0,
          "productSubType" : 0,
          "productName" : "string",
          "status" : 0,
          "sourceUnitPrice" : 0.0,
          "unitPrice" : 0.0,
          "salesEmployee" : {
            "id" : "string",
            "name" : "string"
          },
          "salesDepartment" : {
            "id" : "string",
            "name" : "string",
            "departmentAddress" : "string"
          },
          "scheduleTime" : "string",
          "remark" : "string",
          "children" : [ "..." ]
        } ]
      } ],
      "chargeStatus" : 0,
      "totalFee" : 0.0
    } ],
    "salesEmployee" : {
      "id" : "string",
      "name" : "string"
    },
    "salesDepartment" : {
      "id" : "string",
      "name" : "string",
      "departmentAddress" : "string"
    },
    "chargeSheet" : {
      "id" : "string",
      "totalFee" : 0.0
    }
  }
}

5.16. 体检支付接口

5.16.1. 支付

POST /api/v2/open-agency/pe-charge/{id}/pay
参数
类型 名称 说明 类型

Path

id
必填

id

string

Body

req
必填

req

支付请求
响应
HTTP Code 说明 类型

200

OK

R«支付响应»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/pe-charge/string/pay
请求 body
{
  "payMode" : 1,
  "amount" : 1000.0,
  "operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "patientOrderId" : "string",
    "chargeStatus" : 0,
    "errorMessage" : "string"
  }
}

5.17. 门诊叫号接口

5.17.1. 叫号列表

GET /api/v2/open-agency/outpatient/calling
参数
类型 名称 说明 类型

Query

departmentId
必填

departmentId

string

Query

doctorId
必填

doctorId

string
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«叫号列表响应»
HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/calling?departmentId=string&doctorId=string
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "doctorId" : "string",
      "departmentId" : "string",
      "currentPatient" : {
        "id" : "string",
        "timeOfDay" : "string",
        "registrationCategory" : 0,
        "orderNo" : 0,
        "status" : 0,
        "subStatus" : 0,
        "isAdjusted" : 0,
        "patientId" : "string",
        "patientName" : "string",
        "reserveStart" : "10:00",
        "reserveEnd" : "12:00",
        "signInTime" : "2022-04-06 15:12:53",
        "isPassed" : 0,
        "isAdditional" : 0,
        "latePunishCount" : 1,
        "leftLatePunishCount" : 1,
        "callingOrderNo" : 1
      },
      "waitingPatients" : [ {
        "id" : "string",
        "timeOfDay" : "string",
        "registrationCategory" : 0,
        "orderNo" : 0,
        "status" : 0,
        "subStatus" : 0,
        "isAdjusted" : 0,
        "patientId" : "string",
        "patientName" : "string",
        "reserveStart" : "10:00",
        "reserveEnd" : "12:00",
        "signInTime" : "2022-04-06 15:12:53",
        "isPassed" : 0,
        "isAdditional" : 0,
        "latePunishCount" : 1,
        "leftLatePunishCount" : 1,
        "callingOrderNo" : 1
      } ],
      "diagnosedPatients" : [ {
        "id" : "string",
        "timeOfDay" : "string",
        "registrationCategory" : 0,
        "orderNo" : 0,
        "status" : 0,
        "subStatus" : 0,
        "isAdjusted" : 0,
        "patientId" : "string",
        "patientName" : "string",
        "reserveStart" : "10:00",
        "reserveEnd" : "12:00",
        "signInTime" : "2022-04-06 15:12:53",
        "isPassed" : 0,
        "isAdditional" : 0,
        "latePunishCount" : 1,
        "leftLatePunishCount" : 1,
        "callingOrderNo" : 1
      } ]
    }
  }
}

5.17.2. 呼叫

PUT /api/v2/open-agency/outpatient/calling/call/{id}
参数
类型 名称 说明 类型 默认值

Path

id
必填

id

string

Query

operatorId
可选

operatorId

string

"00000000000000000000000000000000"
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«OpenCallingCallPatientRsp»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/calling/call/string
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "id" : "string"
    }
  }
}

5.17.3. 重新呼叫

PUT /api/v2/open-agency/outpatient/calling/recall/{id}
参数
类型 名称 说明 类型 默认值

Path

id
必填

id

string

Query

operatorId
可选

operatorId

string

"00000000000000000000000000000000"
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«OpenCallingCallPatientRsp»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/calling/recall/string
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "id" : "string"
    }
  }
}

5.17.4. 过号

PUT /api/v2/open-agency/outpatient/calling/pass/{id}
参数
类型 名称 说明 类型 默认值

Path

id
必填

id

string

Query

operatorId
可选

operatorId

string

"00000000000000000000000000000000"
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«OpenCallingCallPatientRsp»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/calling/pass/string
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "id" : "string"
    }
  }
}

5.17.5. 完诊

PUT /api/v2/open-agency/outpatient/calling/diagnosed/{id}
参数
类型 名称 说明 类型 默认值

Path

id
必填

id

string

Query

operatorId
可选

operatorId

string

"00000000000000000000000000000000"
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«OpenCallingCallPatientRsp»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/calling/diagnosed/string
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "id" : "string"
    }
  }
}

5.17.6. 调序

POST /api/v2/open-agency/outpatient/calling/reorder
参数
类型 名称 说明 类型

Body

req
必填

req

排序请求
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«OpenCallingReorderPatientRsp»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/calling/reorder
请求 body
{
  "doctorId" : "string",
  "departmentId" : "string",
  "patients" : [ {
    "id" : "string",
    "isAdjusted" : 0,
    "tag" : 0
  } ],
  "operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "doctorId" : "string",
      "departmentId" : "string",
      "consultingRoomId" : "string"
    }
  }
}

5.17.7. 重新排队

PUT /api/v2/open-agency/outpatient/calling/reorder/{id}
参数
类型 名称 说明 类型 默认值

Path

id
必填

id

string

Query

operatorId
可选

operatorId

string

"00000000000000000000000000000000"
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«OpenCallingReorderPatientRsp»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/calling/reorder/string
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "doctorId" : "string",
      "departmentId" : "string",
      "consultingRoomId" : "string"
    }
  }
}

5.18. 医院病区接口

5.18.1. 获取病区列表

GET /api/v2/open-agency/clinics/his/wards
参数
类型 名称 说明 类型 默认值

Query

limit
可选

limit

integer (int32)

10

Query

offset
可选

offset

integer (int32)

0
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«病区列表响应»
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/his/wards
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "rows" : [ {
        "id" : "ffffffff0000000006dddfe002e22000",
        "name" : "内科病区",
        "location" : "三楼一区",
        "wardRoomCount" : 0,
        "wardBedCount" : 0,
        "employeeCount" : 0,
        "status" : 0,
        "departments" : [ {
          "id" : "string",
          "name" : "string"
        } ]
      } ],
      "total" : 0,
      "offset" : 0,
      "limit" : 0,
      "keyword" : "string"
    }
  }
}

5.18.2. 根据病区获取病房列表

GET /api/v2/open-agency/clinics/his/wards/{wardAreaId}/rooms
参数
类型 名称 说明 类型

Path

wardAreaId
必填

wardAreaId

string
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«病房列表响应»
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/his/wards/string/rooms
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "rows" : [ {
        "id" : "string",
        "name" : "string",
        "totalBedsCount" : 0,
        "accommodationType" : 0,
        "remark" : "string"
      } ],
      "total" : 20
    }
  }
}

5.18.3. 根据病区获取病床列表

GET /api/v2/open-agency/clinics/his/wards/{wardAreaId}/beds
参数
类型 名称 说明 类型

Path

wardAreaId
必填

wardAreaId

string
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«病床列表响应»
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/his/wards/string/beds
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "rows" : [ {
        "id" : "string",
        "chainId" : "string",
        "clinicId" : "string",
        "wardAreaId" : "string",
        "wardRoomId" : "string",
        "bedNo" : "string",
        "type" : 0,
        "reserveReason" : 0,
        "reserveBeginTime" : "string",
        "reserveEndTime" : "string",
        "reserveRemark" : "string",
        "curPatientOrderId" : "string",
        "curPatientId" : "string",
        "enableStatus" : 0,
        "useStatus" : 0,
        "remark" : "string",
        "isDeleted" : 0
      } ],
      "total" : 50
    }
  }
}

5.18.4. 根据病区获取病床患者信息

GET /api/v2/open-agency/clinics/his/wards/{wardAreaId}/beds/patient
参数
类型 名称 说明 类型

Path

wardAreaId
必填

wardAreaId

string
响应
HTTP Code 说明 类型

200

OK

AbcServiceResponse«OpenWardPatientHospitalRsp»
HTTP请求示例
请求 path
/api/v2/open-agency/clinics/his/wards/string/beds/patient
HTTP响应示例
响应 200
{
  "statusCode" : "string",
  "statusCodeValue" : 0,
  "body" : {
    "error" : {
      "code" : 0,
      "message" : "string",
      "detail" : "object",
      "requestId" : "string"
    },
    "data" : {
      "rows" : [ {
        "id" : "string",
        "patientHospital" : {
          "id" : "string",
          "patient" : {
            "id" : "000000fc446f4dbd989857e305b00d6s",
            "name" : "张三",
            "mobile" : "18080000000",
            "sex" : "男",
            "birthday" : "1970-08-14",
            "age" : {
              "year" : 60,
              "month" : 2,
              "day" : 1
            },
            "idCard" : "630101200010075758",
            "idCardType" : "身份证"
          },
          "no" : "string",
          "status" : 0,
          "inpatientTimeRequest" : "string",
          "departmentId" : "string",
          "departmentName" : "string",
          "inDepartmentId" : "string",
          "inDepartmentName" : "string",
          "outDepartmentId" : "string",
          "outDepartmentName" : "string",
          "wardId" : "string",
          "wardName" : "string",
          "bedId" : "string",
          "bedNo" : "string",
          "adviceDeposit" : 0.0,
          "feeTypeName" : "string",
          "inpatientWay" : 0,
          "inpatientSource" : 0,
          "inpatientCondition" : 0,
          "outpatientDoctorId" : "string",
          "outpatientDoctorName" : "string",
          "preDiagnosisInfos" : [ {
            "value" : {
              "name" : "急性上呼吸道感染"
            }
          } ],
          "dischargeDiagnosisInfos" : [ {
            "toothNos" : [ 0 ],
            "value" : [ {
              "code" : "string",
              "name" : "string",
              "diseaseType" : "string",
              "hint" : "string"
            } ]
          } ],
          "primaryDiagnosisInfos" : [ {
            "toothNos" : [ 0 ],
            "value" : [ {
              "code" : "string",
              "name" : "string",
              "diseaseType" : "string",
              "hint" : "string"
            } ]
          } ],
          "doctorId" : "string",
          "doctorName" : "string",
          "nurseId" : "string",
          "nurseName" : "string",
          "inpatientTime" : "string",
          "dischargeTime" : "string",
          "dischargeReason" : "string",
          "inpatientDays" : 0,
          "times" : 0,
          "timesOfYear" : 0,
          "inpatientYear" : "string",
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ]
        },
        "chainId" : "string",
        "clinicId" : "string",
        "wardAreaId" : "string",
        "wardRoomId" : "string",
        "bedNo" : "string",
        "type" : 0,
        "reserveReason" : 0,
        "reserveBeginTime" : "string",
        "reserveEndTime" : "string",
        "reserveRemark" : "string",
        "curPatientOrderId" : "string",
        "curPatientId" : "string",
        "enableStatus" : 0,
        "useStatus" : 0,
        "remark" : "string",
        "isDeleted" : 0
      } ]
    }
  }
}

5.19. 社保接口

5.19.1. 第三方结算信息上报

POST /api/v2/open-agency/shebao/settle/thirdpart/upload
参数
类型 名称 说明 类型

Body

reqBody
必填

三方结算数据上传请求体Json

三方结算数据上传请求体
响应
HTTP Code 说明 类型

200

OK

R«操作响应结果»
消耗

  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/shebao/settle/thirdpart/upload
请求 body
{
  "thirdPartPaymentResultList" : [ {
    "sfsc" : "0",
    "sourceType" : 21,
    "sourceTypeDetail" : {
      "id" : "string",
      "displayName" : "string"
    },
    "setlId" : "32052507201636202450066275****",
    "mdtrtId" : "3205000000084292****",
    "psnNo" : "3205990000000000001234****",
    "psnName" : "张**",
    "psnCertType" : "01",
    "certno" : "320502199411******",
    "gend" : "1",
    "naty" : "01",
    "brdy" : "1994-11-30",
    "age" : 30.0,
    "insutype" : "310",
    "psnType" : "1101",
    "cvlservFlag" : "0",
    "flxempeFlag" : "0",
    "nwbFlag" : "0",
    "insuOptins" : "320506",
    "empName" : "某某医疗集团有限公司",
    "payLoc" : "2",
    "fixmedinsCode" : "H3205060****",
    "fixmedinsName" : "某某市中医医院",
    "hospLv" : "11",
    "fixmedinsPoolarea" : "320599",
    "lmtpricHospLv" : "9",
    "dedcHospLv" : "9",
    "begndate" : "2025-07-20",
    "enddate" : "2025-07-20",
    "setlTime" : "2025-07-20 16:36:18",
    "mdtrtCertType" : "01",
    "medType" : "11",
    "clrType" : "11",
    "clrWay" : "1",
    "clrOptins" : "320***",
    "medfeeSumamt" : 166.0,
    "fulamtOwnpayAmt" : 0.0,
    "overlmtSelfpay" : 0.0,
    "preselfpayAmt" : 0.0,
    "inscpScpAmt" : 166.0,
    "actPayDedc" : 0.0,
    "hifpPay" : 0.0,
    "poolPropSelfpay" : 0.0,
    "cvlservPay" : 0.0,
    "hifesPay" : 0.0,
    "hifmiPay" : 0.0,
    "hifobPay" : 0.0,
    "hifdmPay" : 0.0,
    "mafPay" : 0.0,
    "prefFundPay" : 0.0,
    "othPay" : 0.0,
    "fundPaySumamt" : 0.0,
    "psnPay" : 166.0,
    "acctPay" : 0.0,
    "cashPayamt" : 166.0,
    "balc" : 0.0,
    "acctMulaidPay" : 0.0,
    "medinsSetlId" : "32052507201636202450066275****",
    "refdSetlFlag" : "0",
    "year" : "2025",
    "diseCodg" : "M54.505",
    "diseName" : "腰肌劳损",
    "invono" : "string",
    "opterId" : "380314755738704****",
    "opterName" : "李**",
    "optTime" : "2025-07-20 16:36:18",
    "extendSetlDetail" : { },
    "wltpayAmt" : 0.0,
    "thirdPartPaymentResultItems" : [ {
      "name" : "中医刮痧",
      "feedetlSn" : "3507eb6cea0b****",
      "psnNo" : "3205990000000000001234****",
      "chrgBchno" : "3507eb6e43******",
      "diseCodg" : "M54.505",
      "rxno" : "3507eb6cea0b****",
      "rxCircFlag" : "0",
      "feeOcurTime" : "2025-07-20 16:36:02",
      "medListCodg" : "014100000******",
      "medinsListCodg" : "中医刮痧",
      "detItemFeeSumamt" : 88.0,
      "cnt" : 1.0,
      "pric" : 88.0,
      "costPrice" : 88.0,
      "unit" : "次",
      "sinDosDscr" : "1.0",
      "usedFrquDscr" : "string",
      "prdDays" : 1.0,
      "medcWayDscr" : "string",
      "bilgDeptCodg" : "A03",
      "bilgDeptName" : "内科",
      "bilgDrCodg" : "D320508008900",
      "bilgDrName" : "王**",
      "acordDeptCodg" : "A03",
      "acordDeptName" : "内科",
      "ordersDrCode" : "D320508008900",
      "ordersDrName" : "王**",
      "hospApprFlag" : "1",
      "tcmdrugUsedWay" : "string",
      "etipFlag" : "0",
      "etipHospCode" : "string",
      "dscgTkdrugFlag" : "0",
      "matnFeeFlag" : "0",
      "pricUplmtAmt" : 114.0,
      "selfpayProp" : 0.0,
      "fulamtOwnpayAmt" : 0.0,
      "overlmtAmt" : 0.0,
      "preselfpayAmt" : 0.0,
      "inscpScpAmt" : 88.0,
      "chrgitmLv" : "01",
      "medChrgitmType" : "02",
      "basMednFlag" : "0",
      "hiNegoDrugFlag" : "0",
      "chldMedcFlag" : "0",
      "listSpItemFlag" : "string",
      "lmtUsedFlag" : "0",
      "drtReimFlag" : "0",
      "memo" : "string",
      "extend" : { },
      "doseCount" : 1.0
    } ],
    "substitutes" : [ {
      "fundPayType" : "310100",
      "inscpScpAmt" : 0.0,
      "crtPaybLmtAmt" : 0.0,
      "fundPayamt" : 166.0,
      "fundPayTypeName" : "string",
      "setlProcInfo" : "string"
    } ]
  } ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.20. 发票接口

5.20.1. 按日期范围按门店查询发票信息

GET /api/v2/open-agency/invoice/page
参数
类型 名称 说明 类型

Query

supplierId
必填

供应商id

integer (int32)

Query

endDate
可选

结束时间(格式yyyy-MM-dd)

string (date)

Query

limit
可选

每页显示条数

integer (int32)

Query

offset
可选

分页起始下标

integer (int32)

Query

startDate
可选

开始时间(格式yyyy-MM-dd)

string (date)
响应
HTTP Code 说明 类型

200

OK

R«分页查询结果«发票信息»»
HTTP请求示例
请求 path
/api/v2/open-agency/invoice/page?supplierId=10000
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "sheetId" : "string",
      "recordId" : "string",
      "type" : 0,
      "businessId" : "string",
      "businessScene" : "string",
      "buyerName" : "string",
      "buyerTaxNum" : "string",
      "buyerPhone" : "string",
      "saleTaxNum" : "string",
      "salePhone" : "string",
      "saleAddress" : "string",
      "totalAmount" : 0.0,
      "invoiceCode" : "string",
      "invoiceNumber" : "string",
      "invoiceUrl" : "string",
      "invoiceTime" : "string",
      "checker" : "string",
      "payee" : "string",
      "clerk" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.20.2. 查询发票详情

GET /api/v2/open-agency/invoice/{recordId}
参数
类型 名称 说明 类型

Path

recordId
必填

发票ID

string
响应
HTTP Code 说明 类型

200

OK

R«OpenInvoiceDetailView»
HTTP请求示例
请求 path
/api/v2/open-agency/invoice/000000fc446f4dbd989857e305b00d6s
HTTP响应示例
响应 200
{
  "data" : {
    "busNo" : "string",
    "sheetId" : "string",
    "itemList" : [ {
      "itemId" : "string",
      "itemName" : "string",
      "feeTypeId" : 0,
      "itemSpec" : "string",
      "itemNum" : 0.0,
      "itemUnit" : "string",
      "itemPrice" : 0.0,
      "itemTotalAmt" : 0.0
    } ],
    "recordId" : "string",
    "summaryList" : [ {
      "summaryName" : "string",
      "summaryCode" : "string",
      "summaryCount" : 0.0,
      "summaryAmount" : 0.0
    } ],
    "type" : 0,
    "businessId" : "string",
    "businessScene" : "string",
    "buyerName" : "string",
    "buyerTaxNum" : "string",
    "buyerPhone" : "string",
    "saleTaxNum" : "string",
    "salePhone" : "string",
    "saleAddress" : "string",
    "totalAmount" : 0.0,
    "invoiceCode" : "string",
    "invoiceNumber" : "string",
    "invoiceUrl" : "string",
    "invoiceTime" : "string",
    "checker" : "string",
    "payee" : "string",
    "clerk" : "string"
  }
}

6. 错误码定义

错误码 说明

13903

会员手机号不能为空

13909

患者不存在

7. 模型定义

7.1. AbcListPage«商品批次库存信息»

名称 说明 类型

rows
可选

样例 : [ "商品批次库存信息" ]

< 商品批次库存信息 > array

total
可选

样例 : 0

integer (int32)

offset
可选

样例 : 0

integer (int32)

limit
可选

样例 : 0

integer (int32)

keyword
可选

样例 : "string"

string

7.2. AbcServiceError

名称 说明 类型

code
可选

样例 : 0

integer (int32)

message
可选

样例 : "string"

string

detail
可选

样例 : "object"

object

requestId
可选

样例 : "string"

string

7.3. AbcServiceResponseBody«OpenCallingCallPatientRsp»

名称 说明 类型

error
可选

样例 : AbcServiceError

AbcServiceError

data
可选

样例 : OpenCallingCallPatientRsp

OpenCallingCallPatientRsp

7.4. AbcServiceResponseBody«OpenCallingReorderPatientRsp»

名称 说明 类型

error
可选

样例 : AbcServiceError

AbcServiceError

data
可选

样例 : OpenCallingReorderPatientRsp

OpenCallingReorderPatientRsp

7.5. AbcServiceResponseBody«OpenWardPatientHospitalRsp»

名称 说明 类型

error
可选

样例 : AbcServiceError

AbcServiceError

data
可选

样例 : OpenWardPatientHospitalRsp

OpenWardPatientHospitalRsp

7.6. AbcServiceResponseBody«叫号列表响应»

名称 说明 类型

error
可选

样例 : AbcServiceError

AbcServiceError

data
可选

样例 : 叫号列表响应

叫号列表响应

7.7. AbcServiceResponseBody«病区列表响应»

名称 说明 类型

error
可选

样例 : AbcServiceError

AbcServiceError

data
可选

样例 : 病区列表响应

病区列表响应

7.8. AbcServiceResponseBody«病床列表响应»

名称 说明 类型

error
可选

样例 : AbcServiceError

AbcServiceError

data
可选

样例 : 病床列表响应

病床列表响应

7.9. AbcServiceResponseBody«病房列表响应»

名称 说明 类型

error
可选

样例 : AbcServiceError

AbcServiceError

data
可选

样例 : 病房列表响应

病房列表响应

7.10. AbcServiceResponse«OpenCallingCallPatientRsp»

名称 说明 类型

statusCode
可选

样例 : "string"

enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES)

statusCodeValue
可选

样例 : 0

integer (int32)

body
可选

样例 : AbcServiceResponseBody«OpenCallingCallPatientRsp»

AbcServiceResponseBody«OpenCallingCallPatientRsp»

7.11. AbcServiceResponse«OpenCallingReorderPatientRsp»

名称 说明 类型

statusCode
可选

样例 : "string"

enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES)

statusCodeValue
可选

样例 : 0

integer (int32)

body
可选

样例 : AbcServiceResponseBody«OpenCallingReorderPatientRsp»

AbcServiceResponseBody«OpenCallingReorderPatientRsp»

7.12. AbcServiceResponse«OpenWardPatientHospitalRsp»

名称 说明 类型

statusCode
可选

样例 : "string"

enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES)

statusCodeValue
可选

样例 : 0

integer (int32)

body
可选

样例 : AbcServiceResponseBody«OpenWardPatientHospitalRsp»

AbcServiceResponseBody«OpenWardPatientHospitalRsp»

7.13. AbcServiceResponse«叫号列表响应»

名称 说明 类型

statusCode
可选

样例 : "string"

enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES)

statusCodeValue
可选

样例 : 0

integer (int32)

body
可选

样例 : AbcServiceResponseBody«叫号列表响应»

AbcServiceResponseBody«叫号列表响应»

7.14. AbcServiceResponse«病区列表响应»

名称 说明 类型

statusCode
可选

样例 : "string"

enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES)

statusCodeValue
可选

样例 : 0

integer (int32)

body
可选

样例 : AbcServiceResponseBody«病区列表响应»

AbcServiceResponseBody«病区列表响应»

7.15. AbcServiceResponse«病床列表响应»

名称 说明 类型

statusCode
可选

样例 : "string"

enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES)

statusCodeValue
可选

样例 : 0

integer (int32)

body
可选

样例 : AbcServiceResponseBody«病床列表响应»

AbcServiceResponseBody«病床列表响应»

7.16. AbcServiceResponse«病房列表响应»

名称 说明 类型

statusCode
可选

样例 : "string"

enum (ACCEPTED, ALREADY_REPORTED, BAD_GATEWAY, BAD_REQUEST, BANDWIDTH_LIMIT_EXCEEDED, CHECKPOINT, CONFLICT, CONTINUE, CREATED, DESTINATION_LOCKED, EXPECTATION_FAILED, FAILED_DEPENDENCY, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, IM_USED, INSUFFICIENT_SPACE_ON_RESOURCE, INSUFFICIENT_STORAGE, INTERNAL_SERVER_ERROR, I_AM_A_TEAPOT, LENGTH_REQUIRED, LOCKED, LOOP_DETECTED, METHOD_FAILURE, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MOVED_TEMPORARILY, MULTIPLE_CHOICES, MULTI_STATUS, NETWORK_AUTHENTICATION_REQUIRED, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_EXTENDED, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, NO_CONTENT, OK, PARTIAL_CONTENT, PAYLOAD_TOO_LARGE, PAYMENT_REQUIRED, PERMANENT_REDIRECT, PRECONDITION_FAILED, PRECONDITION_REQUIRED, PROCESSING, PROXY_AUTHENTICATION_REQUIRED, REQUESTED_RANGE_NOT_SATISFIABLE, REQUEST_ENTITY_TOO_LARGE, REQUEST_HEADER_FIELDS_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, TOO_EARLY, TOO_MANY_REQUESTS, UNAUTHORIZED, UNAVAILABLE_FOR_LEGAL_REASONS, UNPROCESSABLE_ENTITY, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, URI_TOO_LONG, USE_PROXY, VARIANT_ALSO_NEGOTIATES)

statusCodeValue
可选

样例 : 0

integer (int32)

body
可选

样例 : AbcServiceResponseBody«病房列表响应»

AbcServiceResponseBody«病房列表响应»

7.17. ClinicEmployeeDepartmentReq

名称 说明 类型

showInWeClinic
可选

样例 : 0

integer (int32)

businessScope
可选

样例 : 0

integer (int32)

departmentIds
可选

样例 : [ "string" ]

< string > array

employeeIds
可选

样例 : [ "string" ]

< string > array

moduleIds
可选

样例 : [ 0 ]

< integer (int32) > array

roleIds
可选

样例 : [ 0 ]

< integer (int32) > array

7.18. DepartmentBase

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

departmentAddress
可选

样例 : "string"

string

7.19. DiagnosisInfo

名称 说明 类型

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

diseaseType
可选

样例 : "string"

string

hint
可选

样例 : "string"

string

7.20. DiagnosisRpcInfo

名称 说明 类型

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

7.21. ExtendDiagnosisInfo

名称 说明 类型

toothNos
可选

样例 : [ 0 ]

< integer (int32) > array

value
可选

样例 : [ "DiagnosisInfo" ]

< DiagnosisInfo > array

7.22. InvoiceItem

名称 说明 类型

itemId
可选

门诊收费(收费项目id)
样例 : "string"

string

itemName
可选

项目名称
样例 : "string"

string

feeTypeId
可选

费用分类
样例 : 0

integer (int64)

itemSpec
可选

规格
样例 : "string"

string

itemNum
可选

数量
样例 : 0.0

number

itemUnit
可选

单位
样例 : "string"

string

itemPrice
可选

单价
样例 : 0.0

number

itemTotalAmt
可选

总金额
样例 : 0.0

number

7.23. InvoiceSummary

名称 说明 类型

summaryName
可选

汇总名称
样例 : "string"

string

summaryCode
可选

汇总编码
样例 : "string"

string

summaryCount
可选

汇总数量
样例 : 0.0

number

summaryAmount
可选

汇总金额
样例 : 0.0

number

7.24. JsonNode

类型 : object

7.25. OSS开放Token

名称 说明 类型

endpoint
可选

endpoint
样例 : "string"

string

bucket
可选

bucket
样例 : "string"

string

fileDir
可选

文件目录
样例 : "string"

string

securityToken
可选

安全令牌
样例 : "string"

string

accessKeySecret
可选

临时访问密钥
样例 : "string"

string

accessKeyId
可选

临时访问密钥ID
样例 : "string"

string

expiration
可选

过期时间
样例 : "2022-11-09 12:00:00"

string

7.26. OpenCallingCallPatientRsp

名称 说明 类型

id
可选

单条叫号id
样例 : "string"

string

7.27. OpenCallingReorderPatientRsp

名称 说明 类型

doctorId
可选

医生id
样例 : "string"

string

departmentId
可选

科室id
样例 : "string"

string

consultingRoomId
可选

诊室id
样例 : "string"

string

7.28. OpenChargePayModeView

名称 说明 类型

payModes
可选

支付方式列表
样例 : [ "OpenPayModeItem" ]

< OpenPayModeItem > array

7.29. OpenClinicEmployeeDepartmentRsp

名称 说明 类型

employeeList
可选

样例 : [ "门店人员详细信息" ]

< 门店人员详细信息 > array

7.30. OpenInvoiceDetailView

发票详情

名称 说明 类型

busNo
可选

门诊号/住院号
样例 : "string"

string

sheetId
可选

发票sheetId
样例 : "string"

string

itemList
可选

明细信息
样例 : [ "InvoiceItem" ]

< InvoiceItem > array

recordId
可选

发票recordId
样例 : "string"

string

summaryList
可选

汇总信息
样例 : [ "InvoiceSummary" ]

< InvoiceSummary > array

type
可选

发票类型
样例 : 0

integer (int32)

businessId
可选

业务id
样例 : "string"

string

businessScene
可选

场景
样例 : "string"

string

buyerName
可选

购方名称
样例 : "string"

string

buyerTaxNum
可选

购方税号
样例 : "string"

string

buyerPhone
可选

购方电话
样例 : "string"

string

saleTaxNum
可选

销方税号
样例 : "string"

string

salePhone
可选

销方电话
样例 : "string"

string

saleAddress
可选

销方地址
样例 : "string"

string

totalAmount
可选

发票开票金额
样例 : 0.0

number

invoiceCode
可选

发票代码
样例 : "string"

string

invoiceNumber
可选

发票号码
样例 : "string"

string

invoiceUrl
可选

发票访问地址
样例 : "string"

string

invoiceTime
可选

开票时间
样例 : "string"

string

checker
可选

复核人
样例 : "string"

string

payee
可选

收款人
样例 : "string"

string

clerk
可选

开票员
样例 : "string"

string

7.31. OpenPatientOrderHospitalTagView

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

7.32. OpenPatientOrderHospitalView

名称 说明 类型

id
可选

样例 : "string"

string

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

no
可选

住院号
样例 : "string"

string

status
可选

住院状态 0:待登记 10:已登记 20:住院中 30:待转科 40:转科中 60:待出院 70:已出院-未结算 80:已出院-已结算 90:已关闭 100:出院召回
样例 : 0

integer (int32)

inpatientTimeRequest
可选

申请入院时间
样例 : "string"

string (date-time)

departmentId
可选

科室
样例 : "string"

string

departmentName
可选

科室名字
样例 : "string"

string

inDepartmentId
可选

入院科室
样例 : "string"

string

inDepartmentName
可选

入院科室
样例 : "string"

string

outDepartmentId
可选

出院科室
样例 : "string"

string

outDepartmentName
可选

出院科室
样例 : "string"

string

wardId
可选

病区
样例 : "string"

string

wardName
可选

病区名字
样例 : "string"

string

bedId
可选

床位
样例 : "string"

string

bedNo
可选

床位号
样例 : "string"

string

adviceDeposit
可选

建议押金
样例 : 0.0

number

feeTypeName
可选

费别 自费、根据国家医保来
样例 : "string"

string

inpatientWay
可选

入院方式 0:未知 1:步行 2:扶助 3:轮椅 4:平车
样例 : 0

integer (int32)

inpatientSource
可选

入院来源-途径 0:未知 1:急诊 2:门诊 3:其他医疗机构转入 4:其他
样例 : 0

integer (int32)

inpatientCondition
可选

入院病情 0:未知 1:病危 2:病重 3:普通病情
样例 : 0

integer (int32)

outpatientDoctorId
可选

门诊医生
样例 : "string"

string

outpatientDoctorName
可选

门诊医生姓名
样例 : "string"

string

preDiagnosisInfos
可选

入院诊断信息
样例 : [ { "value" : { "name" : "急性上呼吸道感染" } } ]

< ExtendDiagnosisInfo > array

dischargeDiagnosisInfos
可选

出院诊断信息
样例 : [ "ExtendDiagnosisInfo" ]

< ExtendDiagnosisInfo > array

primaryDiagnosisInfos
可选

主诊断信息
样例 : [ "ExtendDiagnosisInfo" ]

< ExtendDiagnosisInfo > array

doctorId
可选

住院医生
样例 : "string"

string

doctorName
可选

住院医生姓名
样例 : "string"

string

nurseId
可选

住院护士id
样例 : "string"

string

nurseName
可选

住院护士姓名
样例 : "string"

string

inpatientTime
可选

入院时间
样例 : "string"

string (date-time)

dischargeTime
可选

出院时间
样例 : "string"

string (date-time)

dischargeReason
可选

出院原因
样例 : "string"

string

inpatientDays
可选

在院天数
样例 : 0

integer (int32)

times
可选

入院次数
样例 : 0

integer (int32)

timesOfYear
可选

年度入院次数
样例 : 0

integer (int32)

inpatientYear
可选

住院次数的年份
样例 : "string"

string

tags
可选

标签信息
样例 : [ "OpenPatientOrderHospitalTagView" ]

< OpenPatientOrderHospitalTagView > array

7.33. OpenPayModeItem

名称 说明 类型

id
可选

支付方式id
样例 : "string"

string

name
可选

支付方式名称
样例 : "string"

string

7.34. OpenPeChargeSheetView

名称 说明 类型

id
可选

收费单id
样例 : "string"

string

totalFee
可选

收费单金额
样例 : 0.0

number

7.35. OpenPeFormItemReq

名称 说明 类型

productId
可选

商品ID，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "483ac61f811640f5849a3d3aabceea58"

string

productShortId
可选

商品编码，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "1907765200"

string

salesEmployeeId
可选

销售员工 个人增项可指定
样例 : "string"

string

salesDepartmentId
可选

销售科室id 个人增项可指定
样例 : "string"

string

expectedUnitPrice
可选

期望价格
样例 : 0.0

number

7.36. OpenPeFormItemView

名称 说明 类型

id
可选

单项id
样例 : 0

integer (int64)

productId
可选

商品id
样例 : "string"

string

productType
可选

商品类型
样例 : 0

integer (int32)

productSubType
可选

商品子类型
样例 : 0

integer (int32)

productName
可选

商品名称
样例 : "string"

string

status
可选

项目状态 0:待检 10:已检 11:报告已审核 20:弃检 30:退项 40:延期
样例 : 0

integer (int32)

sourceUnitPrice
可选

原始单价
样例 : 0.0

number

unitPrice
可选

单价
样例 : 0.0

number

salesEmployee
可选

销售员信息
样例 : 员工信息

员工信息

salesDepartment
可选

销售科室信息
样例 : DepartmentBase

DepartmentBase

scheduleTime
可选

延期时间 yyyy-MM-dd
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

children
可选

套餐子项
样例 : [ "OpenPeFormItemView" ]

< OpenPeFormItemView > array

7.37. OpenPeFormReq

名称 说明 类型

type
可选

form类型 0:体检套餐 10:个人增项 20:团检套餐
样例 : 0

integer (int32)

salesEmployeeId
可选

销售员工
样例 : "string"

string

salesDepartmentId
可选

销售科室id
样例 : "string"

string

items
可选

单项列表
样例 : [ "OpenPeFormItemReq" ]

< OpenPeFormItemReq > array

7.38. OpenPeFormView

名称 说明 类型

id
可选

样例 : 0

integer (int64)

type
可选

form类型 0:体检套餐 10:个人增项 20:团检套餐
样例 : 0

integer (int32)

salesEmployee
可选

销售员工
样例 : 员工信息

员工信息

salesDepartment
可选

销售科室
样例 : DepartmentBase

DepartmentBase

items
可选

项目列表
样例 : [ "OpenPeFormItemView" ]

< OpenPeFormItemView > array

chargeStatus
可选

收费状态
样例 : 0

integer (int32)

totalFee
可选

总金额
样例 : 0.0

number

7.39. OpenPrescriptionAcupoint

名称 说明 类型

name
可选

名称
样例 : "string"

string

position
可选

位置
样例 : "左｜右｜双｜单｜-"

string

acupointType
可选

类型： 0 未知 1 穴位 2 部位
样例 : 0

integer (int32)

7.40. OpenWardPatientHospitalRsp

名称 说明 类型

rows
可选

样例 : [ "住院患者信息" ]

< 住院患者信息 > array

7.41. PatientItem

名称 说明 类型

id
可选

单条叫号id
样例 : "string"

string

isAdjusted
可选

是否调整排序
样例 : 0

integer (int32)

tag
可选

标签 0-正常 1-急诊 2-老人 3-幼儿 4-军人 5-VIP
样例 : 0

integer (int32)

7.42. R«AbcListPage«商品批次库存信息»»

名称 说明 类型

data
可选

数据
样例 : AbcListPage«商品批次库存信息»

AbcListPage«商品批次库存信息»

7.43. R«OSS开放Token»

名称 说明 类型

data
可选

数据
样例 : OSS开放Token

OSS开放Token

7.44. R«OpenChargePayModeView»

名称 说明 类型

data
可选

数据
样例 : OpenChargePayModeView

OpenChargePayModeView

7.45. R«OpenClinicEmployeeDepartmentRsp»

名称 说明 类型

data
可选

数据
样例 : OpenClinicEmployeeDepartmentRsp

OpenClinicEmployeeDepartmentRsp

7.46. R«OpenInvoiceDetailView»

名称 说明 类型

data
可选

数据
样例 : OpenInvoiceDetailView

OpenInvoiceDetailView

7.47. R«事件推送详情»

名称 说明 类型

data
可选

数据
样例 : 事件推送详情

事件推送详情

7.48. R«会员卡支付响应»

名称 说明 类型

data
可选

数据
样例 : 会员卡支付响应

会员卡支付响应

7.49. R«会员卡退费响应»

名称 说明 类型

data
可选

数据
样例 : 会员卡退费响应

会员卡退费响应

7.50. R«供应商信息»

名称 说明 类型

data
可选

数据
样例 : 供应商信息

供应商信息

7.51. R«供应商档案信息返回体»

名称 说明 类型

data
可选

数据
样例 : 供应商档案信息返回体

供应商档案信息返回体

7.52. R«入库单详情»

名称 说明 类型

data
可选

数据
样例 : 入库单详情

入库单详情

7.53. R«出库单详情»

名称 说明 类型

data
可选

数据
样例 : 出库单详情

出库单详情

7.54. R«分页查询结果«事件推送详情»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«事件推送详情»

分页查询结果«事件推送详情»

7.55. R«分页查询结果«会员充值业绩明细视图»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«会员充值业绩明细视图»

分页查询结果«会员充值业绩明细视图»

7.56. R«分页查询结果«医生信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«医生信息»

分页查询结果«医生信息»

7.57. R«分页查询结果«发票信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«发票信息»

分页查询结果«发票信息»

7.58. R«分页查询结果«发药单摘要信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«发药单摘要信息»

分页查询结果«发药单摘要信息»

7.59. R«分页查询结果«商品信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«商品信息»

分页查询结果«商品信息»

7.60. R«分页查询结果«库存调拨单列表视图»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«库存调拨单列表视图»

分页查询结果«库存调拨单列表视图»

7.61. R«分页查询结果«开卡充值业绩明细视图»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«开卡充值业绩明细视图»

分页查询结果«开卡充值业绩明细视图»

7.62. R«分页查询结果«患者发药单信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«患者发药单信息»

分页查询结果«患者发药单信息»

7.63. R«分页查询结果«患者执行单信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«患者执行单信息»

分页查询结果«患者执行单信息»

7.64. R«分页查询结果«患者摘要信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«患者摘要信息»

分页查询结果«患者摘要信息»

7.65. R«分页查询结果«患者收费单摘要信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«患者收费单摘要信息»

分页查询结果«患者收费单摘要信息»

7.66. R«分页查询结果«患者附件»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«患者附件»

分页查询结果«患者附件»

7.67. R«分页查询结果«患者预约摘要信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«患者预约摘要信息»

分页查询结果«患者预约摘要信息»

7.68. R«分页查询结果«执行业绩-明细»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«执行业绩-明细»

分页查询结果«执行业绩-明细»

7.69. R«分页查询结果«挂号单基础信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«挂号单基础信息»

分页查询结果«挂号单基础信息»

7.70. R«分页查询结果«收费明细-分类信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«收费明细-分类信息»

分页查询结果«收费明细-分类信息»

7.71. R«分页查询结果«收费明细-单据信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«收费明细-单据信息»

分页查询结果«收费明细-单据信息»

7.72. R«分页查询结果«收费明细-明细信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«收费明细-明细信息»

分页查询结果«收费明细-明细信息»

7.73. R«分页查询结果«检查检验单摘要信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«检查检验单摘要信息»

分页查询结果«检查检验单摘要信息»

7.74. R«分页查询结果«检查检验摘要信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«检查检验摘要信息»

分页查询结果«检查检验摘要信息»

7.75. R«分页查询结果«检查检验项目信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«检查检验项目信息»

分页查询结果«检查检验项目信息»

7.76. R«分页查询结果«门诊单摘要信息»»

名称 说明 类型

data
可选

数据
样例 : 分页查询结果«门诊单摘要信息»

分页查询结果«门诊单摘要信息»

7.77. R«创建体检单响应»

名称 说明 类型

data
可选

数据
样例 : 创建体检单响应

创建体检单响应

7.78. R«创建挂号单响应结果»

名称 说明 类型

data
可选

数据
样例 : 创建挂号单响应结果

创建挂号单响应结果

7.79. R«创建检查检验单响应»

名称 说明 类型

data
可选

数据
样例 : 创建检查检验单响应

创建检查检验单响应

7.80. R«创建零售收费单响应参数»

名称 说明 类型

data
可选

数据
样例 : 创建零售收费单响应参数

创建零售收费单响应参数

7.81. R«医生信息详情»

名称 说明 类型

data
可选

数据
样例 : 医生信息详情

医生信息详情

7.82. R«医生号源日期列表响应»

名称 说明 类型

data
可选

数据
样例 : 医生号源日期列表响应

医生号源日期列表响应

7.83. R«医生排班号源详情响应结果»

名称 说明 类型

data
可选

数据
样例 : 医生排班号源详情响应结果

医生排班号源详情响应结果

7.84. R«发药单详情»

名称 说明 类型

data
可选

数据
样例 : 发药单详情

发药单详情

7.85. R«取消挂号响应»

名称 说明 类型

data
可选

数据
样例 : 取消挂号响应

取消挂号响应

7.86. R«商品分类信息响应»

名称 说明 类型

data
可选

数据
样例 : 商品分类信息响应

商品分类信息响应

7.87. R«商品明细信息»

名称 说明 类型

data
可选

数据
样例 : 商品明细信息

商品明细信息

7.88. R«商品详情»

名称 说明 类型

data
可选

数据
样例 : 商品详情

商品详情

7.89. R«地区信息»

名称 说明 类型

data
可选

数据
样例 : 地区信息

地区信息

7.90. R«就诊单号查询发药单响应»

名称 说明 类型

data
可选

数据
样例 : 就诊单号查询发药单响应

就诊单号查询发药单响应

7.91. R«库存入库单列表»

名称 说明 类型

data
可选

数据
样例 : 库存入库单列表

库存入库单列表

7.92. R«库存出库单列表»

名称 说明 类型

data
可选

数据
样例 : 库存出库单列表

库存出库单列表

7.93. R«库存盘点单列表»

名称 说明 类型

data
可选

数据
样例 : 库存盘点单列表

库存盘点单列表

7.94. R«库存结算单信息返回体»

名称 说明 类型

data
可选

数据
样例 : 库存结算单信息返回体

库存结算单信息返回体

7.95. R«库存结算单详情»

名称 说明 类型

data
可选

数据
样例 : 库存结算单详情

库存结算单详情

7.96. R«库存调拨单详情»

名称 说明 类型

data
可选

数据
样例 : 库存调拨单详情

库存调拨单详情

7.97. R«患者列表响应»

名称 说明 类型

data
可选

数据
样例 : 患者列表响应

患者列表响应

7.98. R«患者摘要信息»

名称 说明 类型

data
可选

数据
样例 : 患者摘要信息

患者摘要信息

7.99. R«患者详细信息»

名称 说明 类型

data
可选

数据
样例 : 患者详细信息

患者详细信息

7.100. R«执行单详情»

名称 说明 类型

data
可选

数据
样例 : 执行单详情

执行单详情

7.101. R«挂号详细信息»

名称 说明 类型

data
可选

数据
样例 : 挂号详细信息

挂号详细信息

7.102. R«操作响应结果»

名称 说明 类型

data
可选

数据
样例 : 操作响应结果

操作响应结果

7.103. R«支付响应»

名称 说明 类型

data
可选

数据
样例 : 支付响应

支付响应

7.104. R«收货单详情»

名称 说明 类型

data
可选

数据
样例 : 收货单详情

收货单详情

7.105. R«收费单列表»

名称 说明 类型

data
可选

数据
样例 : 收费单列表

收费单列表

7.106. R«收费单摘要信息列表»

名称 说明 类型

data
可选

数据
样例 : 收费单摘要信息列表

收费单摘要信息列表

7.107. R«收费单收费结果»

名称 说明 类型

data
可选

数据
样例 : 收费单收费结果

收费单收费结果

7.108. R«收费单详细信息»

名称 说明 类型

data
可选

数据
样例 : 收费单详细信息

收费单详细信息

7.109. R«收费单退费响应»

名称 说明 类型

data
可选

数据
样例 : 收费单退费响应

收费单退费响应

7.110. R«文件上传响应»

名称 说明 类型

data
可选

数据
样例 : 文件上传响应

文件上传响应

7.111. R«查询医生可预约项目响应»

名称 说明 类型

data
可选

数据
样例 : 查询医生可预约项目响应

查询医生可预约项目响应

7.112. R«查询商品库存响应参数»

名称 说明 类型

data
可选

数据
样例 : 查询商品库存响应参数

查询商品库存响应参数

7.113. R«查询商品批次响应»

名称 说明 类型

data
可选

数据
样例 : 查询商品批次响应

查询商品批次响应

7.114. R«查询就诊来源类型响应»

名称 说明 类型

data
可选

数据
样例 : 查询就诊来源类型响应

查询就诊来源类型响应

7.115. R«查询患者会员类型响应»

名称 说明 类型

data
可选

数据
样例 : 查询患者会员类型响应

查询患者会员类型响应

7.116. R«查询患者家庭成员响应»

名称 说明 类型

data
可选

数据
样例 : 查询患者家庭成员响应

查询患者家庭成员响应

7.117. R«查询执行单列表响应»

名称 说明 类型

data
可选

数据
样例 : 查询执行单列表响应

查询执行单列表响应

7.118. R«查询执行单执行记录响应参数»

名称 说明 类型

data
可选

数据
样例 : 查询执行单执行记录响应参数

查询执行单执行记录响应参数

7.119. R«查询检查检验数据响应»

名称 说明 类型

data
可选

数据
样例 : 查询检查检验数据响应

查询检查检验数据响应

7.120. R«查询预约备注模板响应»

名称 说明 类型

data
可选

数据
样例 : 查询预约备注模板响应

查询预约备注模板响应

7.121. R«检查检验单摘要信息»

名称 说明 类型

data
可选

数据
样例 : 检查检验单摘要信息

检查检验单摘要信息

7.122. R«检查检验单详情信息»

名称 说明 类型

data
可选

数据
样例 : 检查检验单详情信息

检查检验单详情信息

7.123. R«检查检验数据摘要信息»

名称 说明 类型

data
可选

数据
样例 : 检查检验数据摘要信息

检查检验数据摘要信息

7.124. R«检验检查设备列表响应»

名称 说明 类型

data
可选

数据
样例 : 检验检查设备列表响应

检验检查设备列表响应

7.125. R«添加患者附件响应»

名称 说明 类型

data
可选

数据
样例 : 添加患者附件响应

添加患者附件响应

7.126. R«盘点单详情»

名称 说明 类型

data
可选

数据
样例 : 盘点单详情

盘点单详情

7.127. R«科室列表返回体»

名称 说明 类型

data
可选

数据
样例 : 科室列表返回体

科室列表返回体

7.128. R«科室详细信息（含科室人员列表）»

名称 说明 类型

data
可选

数据
样例 : 科室详细信息（含科室人员列表）

科室详细信息（含科室人员列表）

7.129. R«要货单详情»

名称 说明 类型

data
可选

数据
样例 : 要货单详情

要货单详情

7.130. R«进销存明细返回体»

名称 说明 类型

data
可选

数据
样例 : 进销存明细返回体

进销存明细返回体

7.131. R«连锁商品自定义分类响应»

名称 说明 类型

data
可选

数据
样例 : 连锁商品自定义分类响应

连锁商品自定义分类响应

7.132. R«通过药品编码查询商品信息响应»

名称 说明 类型

data
可选

数据
样例 : 通过药品编码查询商品信息响应

通过药品编码查询商品信息响应

7.133. R«采购单列表»

名称 说明 类型

data
可选

数据
样例 : 采购单列表

采购单列表

7.134. R«采购单详情»

名称 说明 类型

data
可选

数据
样例 : 采购单详情

采购单详情

7.135. R«门店人员列表返回体»

名称 说明 类型

data
可选

数据
样例 : 门店人员列表返回体

门店人员列表返回体

7.136. R«门店人员详细信息»

名称 说明 类型

data
可选

数据
样例 : 门店人员详细信息

门店人员详细信息

7.137. R«门店信息»

名称 说明 类型

data
可选

数据
样例 : 门店信息

门店信息

7.138. R«门店医生排班状态响应»

名称 说明 类型

data
可选

数据
样例 : 门店医生排班状态响应

门店医生排班状态响应

7.139. R«门诊单详细信息»

名称 说明 类型

data
可选

数据
样例 : 门诊单详细信息

门诊单详细信息

7.140. R«项目指定日期号源信息响应»

名称 说明 类型

data
可选

数据
样例 : 项目指定日期号源信息响应

项目指定日期号源信息响应

7.141. R«预约项目每日号源状态响应»

名称 说明 类型

data
可选

数据
样例 : 预约项目每日号源状态响应

预约项目每日号源状态响应

7.142. SourceTypeDetail

名称 说明 类型

id
可选

唯一标识 最大长度16个字符
样例 : "string"

string

displayName
必填

展示名 最大长度32个字符
样例 : "string"

string

7.143. 三方erp系统商品信息

名称 说明 类型

erpProductId
可选

erp商品id，erp信息[erpProductData]有值时必填
样例 : "SPZ00015757"

string

name
可选

商品名称
样例 : "盐酸贝尼地平片"

string

manufacturer
可选

生产厂家
样例 : "四川中庸药业有限公司"

string

medicineNmpn
可选

批准文号
样例 : "国药准字Z20043621"

string

displaySpec
可选

规格
样例 : "2ml*10支/盒"

string

7.144. 三方结算数据上传请求体

名称 说明 类型

thirdPartPaymentResultList
必填

结算数据集合,单次调用最多上传100条
样例 : [ "结算数据 其中相关字段具体参考医疗保障信息平台基线接口文档的对应字典表" ]

< 结算数据 其中相关字段具体参考医疗保障信息平台基线接口文档的对应字典表 > array

7.145. 中药处方信息

名称 说明 类型

id
可选

处方ID
样例 : "string"

string

prescriptionFormItems
可选

处方单项
样例 : [ "中药处方单项信息" ]

< 中药处方单项信息 > array

type
可选

处方类型 1:西药 2:输液 3:中药
样例 : 1

integer (int32)

specification
可选

类型（饮片、颗粒）
样例 : "string"

string

doseCount
可选

剂数
样例 : 0

integer (int32)

dailyDosage
可选

每日剂量
样例 : "string"

string

usage
可选

用法
样例 : "string"

string

freq
可选

用药频次
样例 : "string"

string

requirement
可选

服用要求
样例 : "string"

string

usageLevel
可选

单次服用用量
样例 : "string"

string

7.146. 中药处方加工信息

名称 说明 类型

usageType
可选

加工类型 1:煎药 2:制膏 3:打粉 4:制丸 5:颗粒 6:茶包 7:胶囊
样例 : 0

integer (int32)

usageSubType
可选

加工子类型 usageType 为 1 时 1:手工煎药 2:机器煎药（普通） 3:机器煎药（浓缩） usageType 为 2 时 1:儿童膏方 2:成人膏方 usageType 为 3 时 1:粗粉 2:细粉 3:超细粉 usageType 为 4 时 1:水丸 2:蜜丸 3:水蜜丸 4:浓缩丸 其他情况传 0
样例 : 0

integer (int32)

unitCount
可选

每剂加工的袋数，加工类型为 1 时有效
样例 : 1.0

number

totalCount
可选

总加工袋数，加工类型为 1 时有效
样例 : 2.0

number

price
可选

加工费
样例 : 0.0

number

remark
可选

备注
样例 : "string"

string

7.147. 中药处方单项信息

名称 说明 类型

id
可选

处方单项ID
样例 : "string"

string

verifySignatures
可选

样例 : [ "处方签名Res" ]

< 处方签名Res > array

prescriptionFormId
可选

处方单ID
样例 : "string"

string

productId
可选

药品id
样例 : "string"

string

type
可选

1:药品 2:物资
样例 : 1

integer (int32)

subType
可选

type = 1:药品（subType = 1:西药 subType = 2:中药 subType = 3:中成药）type = 2:物资（subType = 1:医用材料 subType = 2:后勤材料 subType = 3:固定资产）
样例 : 1

integer (int32)

name
可选

药品商用名
样例 : "string"

string

specification
可选

药品规格
样例 : "string"

string

manufacturer
可选

生产厂家
样例 : "string"

string

usage
可选

用法
样例 : "string"

string

ivgtt
可选

输液滴速
样例 : 0.0

number

ivgttUnit
可选

输液滴塑单位
样例 : "string"

string

freq
可选

用药频次
样例 : "string"

string

dosage
可选

单次剂量
样例 : "string"

string

dosageUnit
可选

剂量单位
样例 : "string"

string

days
可选

用药天数
样例 : 0

integer (int32)

specialRequirement
可选

特殊要求
样例 : "string"

string

isDismounting
可选

是否使用拆零
样例 : 0

integer (int32)

unitCount
可选

数量
样例 : 0.0

number

unit
可选

单位
样例 : "string"

string

unitPrice
可选

单位价格
样例 : 0.0

number

groupId
可选

分组编号
样例 : 0

integer (int32)

isAst
可选

是否需要皮试 0:不需要皮试 1:需要皮试
样例 : 0

integer (int32)

astResult
可选

皮试结果
样例 : 皮试结果

皮试结果

productInfo
可选

药品信息
样例 : 商品详情

商品详情

7.148. 事件推送详情

名称 说明 类型

id
可选

ID
样例 : "2730297344132816890"

string

appId
可选

应用ID
样例 : "1928374655"

string

appCallBackUrl
可选

推送地址
样例 : "https://xxx.com/xx/xx"

string

callBackBody
可选

当时推送的数据内容
样例 : 事件推送请求

事件推送请求

failReason
可选

推送失败原因
样例 : "404 Not Found:"

string

status
可选

事件推送状态：0:未推送 1:推送成功 2:推送失败
样例 : 2

integer (int32)

created
可选

推送时间
样例 : "2022-04-06 15:12:53"

string (date-time)

7.149. 事件推送请求

名称 说明 类型

clinicId
可选

机构ID
样例 : "string"

string

eventModule
可选

事件模块: 参考事件订阅
样例 : 1

integer (int32)

eventType
可选

事件类型：参考事件订阅
样例 : 101

integer (int32)

eventName
可选

事件名称
样例 : "收费完成"

string

eventData
可选

事件数据：结构由事件决定，参考事件订阅的结构体
样例 : JsonNode

JsonNode

7.150. 交易记录商品明细

名称 说明 类型

id
可选

唯一标识ID
样例 : "ffffffff00000000265ff80811ab200x"

string

transactionId
可选

交易流水ID
样例 : "ffffffff00000000265ff80811ab2004"

string

chargeType
可选

收费类型：0部分收费；1收费完成；-1退费
样例 : 1

integer (int32)

productId
可选

商品id
样例 : "00000000000000000000000000000001"

string

productName
可选

商品名称
样例 : "白术"

string

productType
可选

商品类型
样例 : 5

integer (int32)

productSubType
可选

商品子类型
样例 : 0

integer (int32)

composeType
可选

套餐类型：0不是套餐；1套餐母项；2套餐子项
样例 : 0

integer (int32)

productUnit
可选

商品单位
样例 : "string"

string

productUnitCount
可选

商品数量
样例 : 1.0

number

doseCount
可选

商品剂量
样例 : 1.0

number

totalPrice
可选

商品总价
样例 : 0.0

number

discountPrice
可选

商品折扣价格
样例 : 0.0

number

created
可选

创建时间
样例 : "2022-04-06 15:12:53"

string (date-time)

sceneType
可选

场景类型：0:普通收退费，1:欠收，2:欠退
样例 : 0

integer (int32)

composeChildren
可选

子项列表（当前项目为套餐或多对码情况下才有）最多可能会存在三级结构
样例 : [ "交易记录商品明细" ]

< 交易记录商品明细 > array

7.151. 会员信息

名称 说明 类型

id
可选

会员卡ID
样例 : "ffffffff000000001dce673007782004"

string

principal
可选

本金
样例 : 2866.6

number

present
可选

赠金
样例 : 368.0

number

created
可选

开卡日期
样例 : "2018-08-14 13:08:05"

string (date-time)

memberTypeInfo
可选

会员卡类型
样例 : 会员类型信息

会员类型信息

7.152. 会员充值业绩明细视图

名称 说明 类型

id
必填

流水id
样例 : "string"

string

clinicId
可选

门店id
样例 : "string"

string

clinicName
可选

门店名称
样例 : "string"

string

sellerId
可选

销售员id
样例 : "string"

string

sellerName
可选

销售员名称
样例 : "string"

string

chargeTime
可选

充值时间
样例 : "string"

string

chargePrincipal
可选

充值本金
样例 : 0.0

number

chargePresent
可选

充值赠金
样例 : 0.0

number

patientId
可选

患者id
样例 : "string"

string

patientName
可选

患者名称
样例 : "string"

string

patientMobile
可选

患者手机号
样例 : "string"

string

chargerId
可选

收费员id
样例 : "string"

string

chargerName
可选

收费员名称
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

7.153. 会员卡支付响应

名称 说明 类型

transactionId
必填

会员卡交易流水ID
样例 : "ffffffff0000000034c1e2173d268002"

string

principalBalance
必填

本金余额
样例 : 200.0

number

presentBalance
必填

赠金余额
样例 : 100.0

number

principal
必填

此次扣除本金
样例 : 100.0

number

present
必填

此次扣除赠金
样例 : 50.0

number

businessId
必填

业务ID
样例 : "3808805404481667072"

string

7.154. 会员卡支付请求参数

名称 说明 类型

transactionPatientId
必填

使用会员卡患者ID
样例 : "ffffffff0000000034c1e2173d268002"

string

amount
必填

支付金额
最小值 : 0
样例 : 100.0

number

businessId
必填

业务ID
样例 : "3808805404481667072"

string

password
可选

会员卡密码
样例 : "123456"

string

operatorId
可选

操作人ID，系统中的员工ID
样例 : "00000000000000000000000000000000"

string

7.155. 会员卡退款请求参数

会员卡退款请求参数

名称 说明 类型

amount
必填

退款金额
最小值 : 0
样例 : 100.0

number

transactionIds
必填

支付交易ID列表
样例 : [ "string" ]

< string > array

businessId
必填

业务ID
样例 : "3808805404481667072"

string

operatorId
可选

操作人ID，系统中的员工ID
样例 : "00000000000000000000000000000000"

string

7.156. 会员卡退费响应

名称 说明 类型

transactionId
必填

会员卡交易流水ID
样例 : "ffffffff0000000034c1e2173d268002"

string

principalBalance
必填

本金余额
样例 : 200.0

number

presentBalance
必填

赠金余额
样例 : 100.0

number

principal
必填

此次扣除本金
样例 : 100.0

number

present
必填

此次扣除赠金
样例 : 50.0

number

businessId
必填

业务ID
样例 : "3808805404481667072"

string

7.157. 会员类型信息

名称 说明 类型

id
必填

会员类型ID
样例 : "9dc6f28121a7d9ba9fa6af00b406b314"

string

name
必填

会员类型名字
样例 : "普通卡"

string

7.158. 住址

名称 说明 类型

addressProvinceId
可选

省编码
样例 : "510000"

string

addressProvinceName
可选

省名称
样例 : "四川"

string

addressCityId
可选

市编码
样例 : "510100"

string

addressCityName
可选

市名称
样例 : "成都市"

string

addressDistrictId
可选

区编码
样例 : "510109"

string

addressDistrictName
可选

区名称
样例 : "高新区"

string

addressDetail
可选

详细地址
样例 : "交子大道180号"

string

7.159. 住院患者信息

名称 说明 类型

id
可选

床位id
样例 : "string"

string

patientHospital
可选

样例 : OpenPatientOrderHospitalView

OpenPatientOrderHospitalView

chainId
可选

连锁ID
样例 : "string"

string

clinicId
可选

门店ID
样例 : "string"

string

wardAreaId
可选

病区id
样例 : "string"

string

wardRoomId
可选

病房id
样例 : "string"

string

bedNo
可选

床号
样例 : "string"

string

type
可选

类型:0诊疗床位10护理床位20养老床位
样例 : 0

integer (int32)

reserveReason
可选

留用原因：10患者包床20设备故障30临时停用90其他
样例 : 0

integer (int32)

reserveBeginTime
可选

预留开始时间
样例 : "string"

string (date-time)

reserveEndTime
可选

预留结束时间
样例 : "string"

string (date-time)

reserveRemark
可选

预留备注
样例 : "string"

string

curPatientOrderId
可选

住院单id
样例 : "string"

string

curPatientId
可选

使用人：患者id
样例 : "string"

string

enableStatus
可选

0停用1启用
样例 : 0

integer (int32)

useStatus
可选

0空闲10留用20已使用
样例 : 0

integer (int32)

remark
可选

床备注
样例 : "string"

string

isDeleted
可选

0未删除1已删除
样例 : 0

integer (int32)

7.160. 供应商信息

名称 说明 类型

id
可选

供应商ID
样例 : "string"

string

name
可选

供应商名称
样例 : "string"

string

status
可选

供应商状态 0:禁用 1:启用
样例 : 0

integer (int32)

licenseId
可选

供应商许可证号
样例 : "string"

string

contact
可选

供应商联系人
样例 : "string"

string

mobile
可选

供应商联系方式
样例 : "string"

string

mark
可选

供应商备注
样例 : "string"

string

7.161. 供应商档案信息返回体

名称 说明 类型

supplierInfoList
可选

供应商列表
样例 : [ "供应商信息" ]

< 供应商信息 > array

7.162. 修改供应商请求参数

名称 说明 类型

name
必填

供应商名称
样例 : "string"

string

status
必填

供应商状态 0:禁用 1:启用
最小值 : 0
最大值 : 9223372036854775807
样例 : 1

integer (int32)

licenseId
可选

供应商许可证号
样例 : "string"

string

contact
可选

供应商联系人
样例 : "string"

string

mobile
可选

供应商联系方式
样例 : "string"

string

mark
可选

供应商备注
样例 : "string"

string

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.163. 修改加工状态请求参数

名称 说明 类型

externalTrace
可选

外部跟踪信息列表
样例 : [ "外部跟踪信息" ]

< 外部跟踪信息 > array

dispensingSheetId
可选

发药单ID
样例 : "string"

string

dispensingFormId
可选

发药处方ID
样例 : "string"

string

processGeneralStatus
可选

加工通用状态 0:初始状态 100:审方中 200:调配中 300:浸泡中 400:加工中 500:包装中 600:待快递 900:提取中 1000:浓缩中 1100:收膏中 1200:粉碎中 1300:制丸中 9999:已取消
样例 : 0

integer (int32)

7.164. 修改商品请求参数

名称 说明 类型

type
必填

商品类型 1:药品 2:物资 7:商品
样例 : 1

integer (int32)

subType
必填

商品子类型 当 type 为 1 时 1:西药 2:中药 3:中成药 当 type 为 2 时 1:医疗器械 2:后勤材料 3:固定资产 当 type 为 7 时 1:自制成品 2:保健药品 3:保健食品 4:其他商品
样例 : 1

integer (int32)

medicineCadn
可选

商品通用名
样例 : "阿莫西林"

string

name
可选

商品名, type为 1 ,subtype为 1 3 时可有值
样例 : "阿莫西林"

string

shortId
可选

商品编码,系统生成或自定义
样例 : "string"

string

cMSpec
可选

中药规格, type为 1,subtype为 2 时有值,值为[中药饮片|中药颗粒]
样例 : "中药饮片"

string

dismounting
可选

拆零标识 0:不可拆零 1:可拆零, type 为 1，subType为 2 时值为 1
样例 : 0

integer (int32)

extendSpec
可选

规格,type为 1，subType为 2可有值
样例 : "净制 0.5kg"

string

materialSpec
可选

规格,type为 2 7可有值
样例 : "弹力型 70mm*18mm"

string

manufacturer
可选

生产厂家
样例 : "北京同仁堂制药有限公司"

string

medicineNmpn
可选

批准文号
样例 : "国药准字Z41020748"

string

barCode
可选

条形码
样例 : "6920705211119"

string

pieceNum
可选

最小包装数量, type为 1，subType为 3 时值为 1
样例 : 0

integer (int32)

pieceUnit
可选

最小包装单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

componentContentUnit
可选

容量单位, tpe为 1,subType为 1，3时可有值
样例 : "string"

string

componentContentNum
可选

容量数量, tpe为 1,subType为 1，3时可有值
样例 : 0.0

number

medicineDosageNum
可选

成分含量数量, tpe为 1,subType为 1，3时可有值
样例 : 0.0

number

medicineDosageUnit
可选

成分含量单位, tpe为 1,subType为 1，3时可有值
样例 : "string"

string

piecePrice
可选

拆零价格
样例 : 1.0

number

packagePrice
可选

零售价格
样例 : 10.0

number

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.165. 修改快递信息请求参数

名称 说明 类型

externalTrace
可选

外部跟踪信息列表
样例 : [ "外部跟踪信息" ]

< 外部跟踪信息 > array

dispensingSheetId
可选

发药单id
样例 : "string"

string

deliveryStatus
可选

快递状态; 700:已发货/运输中;800:已签收
样例 : 700

integer (int32)

deliveryOrderNo
可选

快递单号; 状态为700时需要传快递单号;
样例 : "string"

string

7.166. 修改患者标签请求参数

名称 说明 类型

addTagIds
可选

新增患者标签列表
样例 : [ "string" ]

< string > array

deleteTagIds
可选

删除的患者标签列表
样例 : [ "string" ]

< string > array

operatorId
可选

操作人ID
样例 : "string"

string

7.167. 修改患者请求体

名称 说明 类型

name
可选

姓名
样例 : "string"

string

mobile
可选

手机号
样例 : "string"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

生日
样例 : "2010-01-15"

string

sourceId
可选

患者来源分类ID
样例 : "医生推荐分类id, 导医推荐分类id, 顾客推荐分类id"

string

sourceFromId
可选

患者来源分类下某个具体来源id。比如：当就诊来源分类为【医生推荐】时，根据api【5.2.2. 获取医生分页列表信息】获取到医生，此时字段取值为医生id；当就诊来源分类为【导医推荐】时, 根据api【5.1.3. 获取门店成员列表】获取到成员，此时字段取值为成员id；当就诊来源分类为【顾客推荐】时, 根据api【5.4.3. 获取患者列表】获取到患者，此时字段取值为患者id；
样例 : "string"

string

idCard
可选

身份证
样例 : "string"

string

pastHistory
可选

既往史
样例 : "string"

string

address
可选

家庭住址
样例 : 住址

住址

sn
可选

档案号
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

profession
可选

职业
样例 : "string"

string

company
可选

公司单位
样例 : "string"

string

marital
可选

婚姻状态
样例 : "string"

string

weight
可选

体重
样例 : "string"

string

7.168. 修改或设置收费单快递信息请求体参数

名称 说明 类型

addressProvinceId
必填

省编码
样例 : "510000"

string

addressProvinceName
可选

省名称
样例 : "四川"

string

addressCityId
必填

市编码
样例 : "510100"

string

addressCityName
可选

市名称
样例 : "成都市"

string

addressDistrictId
必填

区编码
样例 : "510109"

string

addressDistrictName
可选

区名称
样例 : "高新区"

string

addressDetail
必填

详细地址
样例 : "交子大道180号"

string

deliveryName
必填

收件人名称
样例 : "张三"

string

deliveryMobile
必填

收件人手机号
样例 : "18012312312"

string

deliveryCompanyName
必填

快递公司名称，需要预先在系统中配置好
样例 : "顺丰快递"

string

deliveryFee
可选

快递费，寄付时不传自动计算出费用
样例 : 12.0

number

deliveryOrderNo
可选

快递单号
样例 : "string"

string

deliveryPayType
必填

快递费支付方式 0:到付 1:寄付
最小值 : 0
最大值 : 9223372036854775807
样例 : 0

integer (int32)

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.169. 修改预诊信息请求参数

名称 说明 类型

chiefComplaint
可选

主述/现病史
样例 : "咽痛，干咳，咳痰"

string

presentHistory
可选

现病史
样例 : "无"

string

pastHistory
可选

既往史
样例 : "既往体健，既往有高血压"

string

familyHistory
可选

家族史
样例 : "无"

string

allergicHistory
可选

过敏史
样例 : "青霉素过敏"

string

obstetricalHistory
可选

妇科月经婚育史
样例 : "月经初潮13岁，月经规则，末次月经2023-06-15，末次月经量中等，末次月经痛经轻度，末次月经有血块，末次月经…​"

string

epidemiologicalHistory
可选

流行病学史
样例 : "无"

string

chineseExamination
可选

望闻切诊
样例 : "无"

string

auxiliaryExamination
可选

辅助检查
样例 : "无"

string

diagnosis
可选

诊断
样例 : "急性上呼吸道感染"

string

syndrome
可选

辩证
样例 : "风热感冒"

string

doctorAdvice
可选

处置
样例 : "口服感冒清热颗粒"

string

operatorId
可选

操作人ID，默认 32 个0
样例 : "00000000000000000000000000000000"

string

7.170. 修正入库单事件

名称 说明 类型

fixedInOrderItemList
可选

修正入库明细
样例 : [ "修正入库单明细视图" ]

< 修正入库单明细视图 > array

id
必填

修正入库单ID
样例 : 0

integer (int64)

orderNo
必填

修正入库单单号
样例 : "GRXZ20220526000001"

string

status
必填

修正入库单状态 0:待审核 1:待确认 2:已完成 9:已拒绝 31:撤回
样例 : 0

integer (int32)

organId
可选

出/入库门店ID
样例 : "1001"

string

organName
可选

出/入库门店名称
样例 : "高新大源店"

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
必填

品种数量
样例 : 5

integer (int32)

operator
可选

操作人（入库人）
样例 : "string"

string

supplier
可选

供应商
样例 : "string"

string

effectiveDate
必填

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
必填

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

药房详情

originalOrder
可选

被修正的入库单信息
样例 : 被修正的入库单信息

被修正的入库单信息

7.171. 修正入库单审核请求

名称 说明 类型

pass
必填

是否通过 0:拒绝 1:通过，默认值 1
最小值 : 0
最大值 : 9223372036854775807
样例 : 1

integer (int32)

comment
可选

审核评论或备注
样例 : "确认通过"

string

7.172. 修正入库单明细视图

修正入库单明细视图

名称 说明 类型

id
必填

条目ID
样例 : 0

integer (int64)

outDetailId
可选

外部明细ID
样例 : "123123"

string

originalItemId
必填

来源条目ID
样例 : 0

integer (int64)

originalOutDetailId
可选

来源外部明细ID
样例 : "123123"

string

productId
必填

商品编码
样例 : "string"

string

productShortId
可选

商品short编码
样例 : "string"

string

productName
可选

商品名称
样例 : "string"

string

specification
可选

规格
样例 : "string"

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

originalPackageCount
可选

入库包装数量
样例 : 2.0

number

originalPieceCount
可选

入库制剂数量
样例 : 10.0

number

originalAmount
可选

金额
样例 : 6033.23

number

changePackageCount
可选

修正入库包装数量（为正则说明实收大于应收，为负则说明实收小于应收）
样例 : 2.0

number

changePieceCount
可选

修正入库制剂数量（为正则说明实收大于应收，为负则说明实收小于应收）
样例 : 10.0

number

changeAmount
可选

修正金额（可正可负）
样例 : 633.23

number

originalBatchNo
可选

样例 : "string"

string

batchNo
可选

生产批号
样例 : "20220526000001"

string

created
必填

创建时间
样例 : "2022-05-10 12:22:56"

string (date-time)

7.173. 入库单事件

名称 说明 类型

id
可选

出/入库单ID
样例 : 0

integer (int64)

inOrderItemList
可选

入库单条目列表
样例 : [ "入库单条目" ]

< 入库单条目 > array

inOrderId
可选

退货的入库单ID
样例 : 0

integer (int64)

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

入库单状态 0:待审核 1:待确认 2:已完成 9:已拒绝 31:撤回
样例 : 0

integer (int32)

organName
可选

门店
样例 : "高新大源店"

string

organId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

operator
可选

操作人（入库人）
样例 : "string"

string

operatorId
可选

操作人ID
样例 : "string"

string

supplier
可选

供应商
样例 : "string"

string

supplierId
可选

供应商ID
样例 : "string"

string

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

药房详情

type
可选

类型 0:采购入库 10:退货出库
样例 : 0

integer (int32)

7.174. 入库单条目

名称 说明 类型

id
必填

条目ID
样例 : 123456

integer (int64)

inId
可选

退的入库项ID
样例 : 3123456

integer (int64)

originalItemId
可选

原始条目ID
样例 : 123456

integer (int64)

productId
必填

商品编码
样例 : "ffffffff0000000034966c3a883ec000"

string

productShortId
可选

商品short编码
样例 : "1000001"

string

productName
可选

商品名称
样例 : "阿莫西林"

string

specification
可选

规格
样例 : "string"

string

expiryDate
可选

有效期
样例 : "2022-05-10"

string

productionDate
可选

生产日期
样例 : "2024-05-10"

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

packageCostPrice
可选

包装成本单价
样例 : 12.5

number

packageCount
可选

入库包装数量
样例 : 2.0

number

pieceCount
可选

入库制剂数量
样例 : 10.0

number

amount
可选

金额
样例 : 6033.23

number

totalCost
可选

变化的成本金额
样例 : 6033.23

number

batchId
可选

批次号
样例 : 100026529

integer (int64)

batchNo
可选

生产批号
样例 : "20220526000001"

string

outDetailId
可选

外部明细ID
样例 : "12312"

string

stockInOutDetailId
可选

入库外部明细ID（退货出库、退货申请有值）
样例 : "12312"

string

created
必填

创建时间
样例 : "2022-05-10 12:22:56"

string (date-time)

lastModified
必填

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

traceableCodeList
可选

追溯码列表
样例 : [ "追溯码视图信息" ]

< 追溯码视图信息 > array

7.175. 入库单详情

名称 说明 类型

comment
可选

备注
样例 : 评论

评论

id
可选

出/入库单ID
样例 : 0

integer (int64)

inOrderItemList
可选

入库单条目列表
样例 : [ "入库单条目" ]

< 入库单条目 > array

inOrderId
可选

退货的入库单ID
样例 : 0

integer (int64)

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

入库单状态 0:待审核 1:待确认 2:已完成 9:已拒绝 31:撤回
样例 : 0

integer (int32)

organName
可选

门店
样例 : "高新大源店"

string

organId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

operator
可选

操作人（入库人）
样例 : "string"

string

operatorId
可选

操作人ID
样例 : "string"

string

supplier
可选

供应商
样例 : "string"

string

supplierId
可选

供应商ID
样例 : "string"

string

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

药房详情

type
可选

类型 0:采购入库 10:退货出库
样例 : 0

integer (int32)

7.176. 入库明细

名称 说明 类型

goodsId
可选

商品ID，商品ID和商品短ID必须要填一个
样例 : "ffffffff000000000000000000000001"

string

goodsShortId
可选

商品短ID，商品ID和商品短ID必须要填一个
样例 : "12345"

string

unit
必填

入库单位，不能超过 10 个字符
样例 : "瓶"

string

unitCount
必填

单位数量，正值
最小值(不包括) : 0
样例 : 0.0

number

unitCostPrice
必填

单位成本价
最小值 : 0
样例 : 0.0

number

totalCostPrice
可选

总成本价
最小值 : 0
样例 : 0.0

number

batchNo
可选

批次号
样例 : "string"

string

expireDate
可选

有效期 yyyy-MM-dd
样例 : "string"

string (date)

productionDate
可选

生产日期 yyyy-MM-dd
样例 : "string"

string (date)

outDetailId
可选

外部明细ID
样例 : "string"

string

traceableCodeList
可选

追溯码列表
样例 : [ "追溯码信息" ]

< 追溯码信息 > array

7.177. 出入库单信息

名称 说明 类型

id
可选

出/入库单ID
样例 : 0

integer (int64)

inOrderId
可选

退货的入库单ID
样例 : 0

integer (int64)

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

入库单状态 0:待审核 1:待确认 2:已完成 9:已拒绝 31:撤回
样例 : 0

integer (int32)

organName
可选

门店
样例 : "高新大源店"

string

organId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

operator
可选

操作人（入库人）
样例 : "string"

string

operatorId
可选

操作人ID
样例 : "string"

string

supplier
可选

供应商
样例 : "string"

string

supplierId
可选

供应商ID
样例 : "string"

string

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

药房详情

type
可选

类型 0:采购入库 10:退货出库
样例 : 0

integer (int32)

7.178. 出库单事件

名称 说明 类型

id
可选

出库单id
样例 : 0

integer (int64)

outOrderItemList
可选

出库单条目列表
样例 : [ "出库单条目" ]

< 出库单条目 > array

orderNo
可选

出库单号
样例 : "CK20220526000001"

string

status
可选

出库单状态 0:待确认 1:待审核 2:已完成 9:已拒绝 31:撤回
样例 : 0

integer (int32)

organName
可选

门店
样例 : "高新大源店"

string

type
可选

出库单类型 1:科室出库 2:报损出库 3:退货出库
样例 : 0

integer (int32)

kindCount
可选

品种数量
样例 : 5

integer (int32)

count
可选

数量
样例 : 12.0

number

amount
可选

含税金额
样例 : 6033.23

number

receiver
可选

领取人
样例 : "string"

string

operator
可选

操作人(出库人)
样例 : "string"

string

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

inOrderId
可选

关联的入库单id
样例 : "1928374567678"

string

pharmacy
可选

出库药房
样例 : 药房详情

药房详情

7.179. 出库单条目

名称 说明 类型

id
可选

条目ID
样例 : 0

integer (int64)

productId
可选

商品编码
样例 : "string"

string

productShortId
可选

商品short编码
样例 : "string"

string

productName
可选

商品名称
样例 : "string"

string

specification
可选

规格
样例 : "string"

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

packageCount
可选

出库包装数量
样例 : 0.0

number

pieceCount
可选

出库制剂数量
样例 : 0.0

number

packageCostPrice
可选

包装成本单价
样例 : 0.0

number

stockInId
可选

退货出库所退的入库条目id
样例 : 0

integer (int64)

amount
可选

出库包装成本价
样例 : 0.0

number

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

stockOutBatches
可选

门店发生的批次进销存信息
样例 : [ "单据进销存批次信息" ]

< 单据进销存批次信息 > array

7.180. 出库单详情

名称 说明 类型

comment
可选

备注
样例 : 评论

评论

id
可选

出库单id
样例 : 0

integer (int64)

outOrderItemList
可选

出库单条目列表
样例 : [ "出库单条目" ]

< 出库单条目 > array

orderNo
可选

出库单号
样例 : "CK20220526000001"

string

status
可选

出库单状态 0:待确认 1:待审核 2:已完成 9:已拒绝 31:撤回
样例 : 0

integer (int32)

organName
可选

门店
样例 : "高新大源店"

string

type
可选

出库单类型 1:科室出库 2:报损出库 3:退货出库
样例 : 0

integer (int32)

kindCount
可选

品种数量
样例 : 5

integer (int32)

count
可选

数量
样例 : 12.0

number

amount
可选

含税金额
样例 : 6033.23

number

receiver
可选

领取人
样例 : "string"

string

operator
可选

操作人(出库人)
样例 : "string"

string

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

inOrderId
可选

关联的入库单id
样例 : "1928374567678"

string

pharmacy
可选

出库药房
样例 : 药房详情

药房详情

7.181. 出库明细

名称 说明 类型

goodsId
可选

商品ID
样例 : "ffffffff000000000000000000000001"

string

goodsShortId
可选

商品短ID
样例 : "12345"

string

pieceCount
必填

小单位数量
最小值 : 0
样例 : 0.0

number

packageCount
必填

最小值 : 0
样例 : 0.0

number

batchNo
可选

批次号
样例 : "string"

string

batchId
可选

批次ID
样例 : 0

integer (int64)

7.182. 出库申请单审核请求

名称 说明 类型

pass
必填

是否通过 0:拒绝 1:通过，默认值 1
最小值 : 0
最大值 : 9223372036854775807
样例 : 1

integer (int32)

comment
可选

审核评论或备注
样例 : "确认通过"

string

7.183. 分页查询结果«事件推送详情»

名称 说明 类型

rows
可选

数据集
样例 : [ "事件推送详情" ]

< 事件推送详情 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.184. 分页查询结果«会员充值业绩明细视图»

名称 说明 类型

rows
可选

数据集
样例 : [ "会员充值业绩明细视图" ]

< 会员充值业绩明细视图 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.185. 分页查询结果«医生信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "医生信息" ]

< 医生信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.186. 分页查询结果«发票信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "发票信息" ]

< 发票信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.187. 分页查询结果«发药单摘要信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "发药单摘要信息" ]

< 发药单摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.188. 分页查询结果«商品信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "商品信息" ]

< 商品信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.189. 分页查询结果«库存调拨单列表视图»

名称 说明 类型

rows
可选

数据集
样例 : [ "库存调拨单列表视图" ]

< 库存调拨单列表视图 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.190. 分页查询结果«开卡充值业绩明细视图»

名称 说明 类型

rows
可选

数据集
样例 : [ "开卡充值业绩明细视图" ]

< 开卡充值业绩明细视图 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.191. 分页查询结果«患者发药单信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "患者发药单信息" ]

< 患者发药单信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.192. 分页查询结果«患者执行单信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "患者执行单信息" ]

< 患者执行单信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.193. 分页查询结果«患者摘要信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "患者摘要信息" ]

< 患者摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.194. 分页查询结果«患者收费单摘要信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "患者收费单摘要信息" ]

< 患者收费单摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.195. 分页查询结果«患者附件»

名称 说明 类型

rows
可选

数据集
样例 : [ "患者附件" ]

< 患者附件 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.196. 分页查询结果«患者预约摘要信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "患者预约摘要信息" ]

< 患者预约摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.197. 分页查询结果«执行业绩-明细»

名称 说明 类型

rows
可选

数据集
样例 : [ "执行业绩-明细" ]

< 执行业绩-明细 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.198. 分页查询结果«挂号单基础信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "挂号单基础信息" ]

< 挂号单基础信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.199. 分页查询结果«收费明细-分类信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "收费明细-分类信息" ]

< 收费明细-分类信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.200. 分页查询结果«收费明细-单据信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "收费明细-单据信息" ]

< 收费明细-单据信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.201. 分页查询结果«收费明细-明细信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "收费明细-明细信息" ]

< 收费明细-明细信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.202. 分页查询结果«检查检验单摘要信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "检查检验单摘要信息" ]

< 检查检验单摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.203. 分页查询结果«检查检验摘要信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "检查检验摘要信息" ]

< 检查检验摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.204. 分页查询结果«检查检验项目信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "检查检验项目信息" ]

< 检查检验项目信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.205. 分页查询结果«门诊单摘要信息»

名称 说明 类型

rows
可选

数据集
样例 : [ "门诊单摘要信息" ]

< 门诊单摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

7.206. 创建中药处方请求参数

名称 说明 类型

id
可选

处方id 为空表示新增，不为空表示更新
样例 : "0"

string

pharmacyNo
可选

药房号，默认 0:本地药房
样例 : 0

integer (int32)

isTotalPriceChanged
必填

是否议价 0:不议价 1:议价，默认值为 0
样例 : 1

integer (int32)

specification
必填

类型 中药饮片/中药颗粒
样例 : "中药饮片"

string

doseCount
必填

剂数
样例 : 3

integer (int32)

expectedTotalPrice
可选

期望处方总价（议价时使用）
样例 : 10.0

number

prescriptionFormItems
可选

样例 : [ "处方药品请求基类" ]

< 处方药品请求基类 > array

usage
必填

用法 [煎服,冲服,制膏]
样例 : "煎服"

string

dailyDosage
可选

每日剂量
样例 : "1日1剂"

string

freq
可选

用药频次
样例 : "1日6次"

string

usageLevel
可选

单次服用用量
样例 : "每次60ml"

string

usageDays
可选

服用天数描述，usage 为制膏时有效
样例 : "约服35天"

string

requirement
可选

服用要求或备注
样例 : "饭前服用"

string

processInfo
可选

加工信息
样例 : 中药处方加工信息

中药处方加工信息

7.207. 创建体检单响应

名称 说明 类型

id
可选

订单id
样例 : "string"

string

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

patientOrderId
可选

体检就诊单id
样例 : "string"

string

name
可选

订单名称
样例 : "string"

string

no
可选

体检单号
样例 : "string"

string

orderNo
可选

订单编号
样例 : "string"

string

type
可选

订单类型 0 个检 10 团检
样例 : 0

integer (int32)

businessTime
可选

体检时间 yyyy-MM-dd
样例 : "string"

string

orderCreated
可选

下单时间
样例 : "string"

string (date-time)

reportGetWay
可选

取报告方式
样例 : 0

integer (int32)

status
可选

订单状态 10:待预约 20:已预约-待登记 30:已登记-体检中 40:已体检-待交表 50:已交表 60:待总评 70:待审核 80:待发布 90:已发布
样例 : 0

integer (int32)

totalFee
可选

订单金额
样例 : 0.0

number

chargeStatus
可选

订单收费状态 0:未收费 10:部分收费 20:已收费
样例 : 0

integer (int32)

sheetSubmitted
可选

已检时间-交表时间
样例 : "string"

string (date-time)

reportApproved
可选

总评时间-审核通过
样例 : "string"

string (date-time)

reportReleased
可选

发布时间
样例 : "string"

string (date-time)

sourceType
可选

订单来源 0:PC 100:OPEN_API
样例 : 0

integer (int32)

patientImageUrl
可选

体检单头像照片
样例 : "string"

string

address
可选

客户地址
样例 : 住址

住址

forms
可选

患者照片url
样例 : [ "OpenPeFormView" ]

< OpenPeFormView > array

salesEmployee
可选

销售员工
样例 : 员工信息

员工信息

salesDepartment
可选

销售科室信息
样例 : DepartmentBase

DepartmentBase

chargeSheet
可选

体检收费订单
样例 : OpenPeChargeSheetView

OpenPeChargeSheetView

7.208. 创建体检单请求

名称 说明 类型

patientId
必填

患者ID
样例 : "string"

string

businessTime
可选

体检时间
样例 : "string"

string (date-time)

reportGetWay
可选

取报告方式 0:到店自取 1:快递 2:电子报告
最小值 : 0
样例 : 0

integer (int32)

address
可选

邮寄地址
样例 : 住址

住址

forms
可选

体检项目
样例 : [ "OpenPeFormReq" ]

< OpenPeFormReq > array

expectedTotalPrice
可选

订单金额（小数点前最多为12位，小数点后最多4位）,为空默认使用商品系统价格
样例 : 1000.0

number

operatorId
可选

操作人ID
样例 : "00000000000000000000000000000000"

string

7.209. 创建供应商请求参数

名称 说明 类型

name
必填

供应商名称
样例 : "string"

string

status
必填

供应商状态 0:禁用 1:启用
最小值 : 0
最大值 : 9223372036854775807
样例 : 1

integer (int32)

licenseId
可选

供应商许可证号
样例 : "string"

string

contact
可选

供应商联系人
样例 : "string"

string

mobile
可选

供应商联系方式
样例 : "string"

string

mark
可选

供应商备注
样例 : "string"

string

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.210. 创建入库单请求

名称 说明 类型

supplierId
必填

供应商Id
样例 : "string"

string

outOrderNo
可选

随货单号
样例 : "20241112001"

string

pharmacyNo
可选

药房号，默认0号药房
样例 : 0

integer (int32)

toClinicId
可选

入库门店ID，仅总部支持给其他子店入库，其他场景为当前门店ID
样例 : "ffffffff000000000000000000000001"

string

comment
可选

单据备注，不能超过 500 个字符
样例 : "备注"

string

inOrderItemList
必填

入库明细
样例 : [ "入库明细" ]

< 入库明细 > array

7.211. 创建出库单请求

名称 说明 类型

inOrderId
可选

入库单ID，如果没有传会通过 batchNo 随机获取
样例 : 0

integer (int64)

pharmacyNo
可选

药房号，默认0号药房
样例 : 0

integer (int32)

toClinicId
可选

出库门店ID，仅总部支持给其他子店入库，其他场景为当前门店ID
样例 : "ffffffff000000000000000000000001"

string

comment
可选

单据备注，不能超过 500 个字符
样例 : "备注"

string

outOrderItemList
必填

出库明细
样例 : [ "出库明细" ]

< 出库明细 > array

7.212. 创建商品请求参数

名称 说明 类型

type
必填

商品类型 1:药品 2:物资 7:商品
样例 : 1

integer (int32)

subType
必填

商品子类型 当 type 为 1 时 1:西药 2:中药 3:中成药 当 type 为 2 时 1:医疗器械 2:后勤材料 3:固定资产 当 type 为 7 时 1:自制成品 2:保健药品 3:保健食品 4:其他商品
样例 : 1

integer (int32)

medicineCadn
可选

商品通用名
样例 : "阿莫西林"

string

name
可选

商品名, type为 1 ,subtype为 1 3 时可有值
样例 : "阿莫西林"

string

shortId
可选

商品编码,系统生成或自定义
样例 : "string"

string

cMSpec
可选

中药规格, type为 1,subtype为 2 时有值,值为[中药饮片|中药颗粒]
样例 : "中药饮片"

string

dismounting
可选

拆零标识 0:不可拆零 1:可拆零, type 为 1，subType为 2 时值为 1
样例 : 0

integer (int32)

extendSpec
可选

规格,type为 1，subType为 2可有值
样例 : "净制 0.5kg"

string

materialSpec
可选

规格,type为 2 7可有值
样例 : "弹力型 70mm*18mm"

string

manufacturer
可选

生产厂家
样例 : "北京同仁堂制药有限公司"

string

medicineNmpn
可选

批准文号
样例 : "国药准字Z41020748"

string

barCode
可选

条形码
样例 : "6920705211119"

string

pieceNum
可选

最小包装数量, type为 1，subType为 3 时值为 1
样例 : 0

integer (int32)

pieceUnit
可选

最小包装单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

componentContentUnit
可选

容量单位, tpe为 1,subType为 1，3时可有值
样例 : "string"

string

componentContentNum
可选

容量数量, tpe为 1,subType为 1，3时可有值
样例 : 0.0

number

medicineDosageNum
可选

成分含量数量, tpe为 1,subType为 1，3时可有值
样例 : 0.0

number

medicineDosageUnit
可选

成分含量单位, tpe为 1,subType为 1，3时可有值
样例 : "string"

string

piecePrice
可选

拆零价格
样例 : 1.0

number

packagePrice
可选

零售价格
样例 : 10.0

number

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.213. 创建外治处方药品请求

名称 说明 类型

acupoints
可选

穴位列表
样例 : [ "OpenPrescriptionAcupoint" ]

< OpenPrescriptionAcupoint > array

id
可选

处方单项id 为空表示新增，不为空表示更新
样例 : "483ac61f811640f5849a3d3aabceea58"

string

dosage
可选

计数
样例 : "12"

string

productId
可选

商品ID，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "483ac61f811640f5849a3d3aabceea58"

string

dosageUnit
可选

计数单位
样例 : "次"

string

productShortId
可选

商品编码，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "1907765200"

string

freq
可选

频率
样例 : "1日1次"

string

unitCount
必填

单位数量
样例 : 2.0

number

expectedUnitPrice
可选

期望单价（议价时使用）
样例 : 5.0

number

specialRequirement
可选

备注说明
样例 : "贴敷30分钟"

string

expectedTotalPrice
可选

期望总价格（议价时使用）
样例 : 5.0

number

unitCountType
可选

开单计数方式 0 穴位计数 1 手动计数
样例 : 0

integer (int32)

unit
可选

开单计数单位
样例 : "部位"

string

useDismounting
可选

是否拆零销售 0:不拆零 1:拆零（需要药品物资支持拆零出售），默认为 0
样例 : 0

integer (int32)

7.214. 创建患者请求体

名称 说明 类型

name
必填

姓名
样例 : "string"

string

mobile
可选

手机号
样例 : "string"

string

sex
必填

性别[男,女]
样例 : "男"

string

birthday
必填

生日
样例 : "2010-01-15"

string

sourceId
可选

患者来源分类id
样例 : "医生推荐分类id, 导医推荐分类id, 顾客推荐分类id"

string

sourceFromId
可选

患者来源分类下某个具体来源id。比如：当就诊来源分类为【医生推荐】时，根据api【5.2.2. 获取医生分页列表信息】获取到医生，此时字段取值为医生id；当就诊来源分类为【导医推荐】时, 根据api【5.1.3. 获取门店成员列表】获取到成员，此时字段取值为成员id；当就诊来源分类为【顾客推荐】时, 根据api【5.4.3. 获取患者列表】获取到患者，此时字段取值为患者id；
样例 : "string"

string

idCard
可选

身份证
样例 : "string"

string

pastHistory
可选

既往史
样例 : "string"

string

address
可选

家庭住址
样例 : 住址

住址

sn
可选

档案号
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

profession
可选

职业
样例 : "string"

string

company
可选

公司单位
样例 : "string"

string

marital
可选

婚姻状态
样例 : "string"

string

weight
可选

体重
样例 : "string"

string

7.215. 创建挂号单响应结果

名称 说明 类型

registrationSheetId
必填

挂号单ID
样例 : "string"

string

chargeSheetId
可选

收费单ID
样例 : "ffffffff00000000220e67a8116d8000"

string

patientOrderId
必填

就诊单ID
样例 : "string"

string

7.216. 创建收货单明细请求

名称 说明 类型

purchaseOrderItemId
可选

abc采购单据明细id
样例 : 100002498

integer (int64)

claimOrderItemId
可选

abc要货单据明细id
样例 : 100002498

integer (int64)

productId
可选

abc商品id
样例 : "0021650c11444ed9ad05e07f3ccc5c1f"

string

shortId
可选

abc商品编码
样例 : "2481526"

string

batchNo
可选

生产批号
样例 : "202311008"

string

expiryDate
可选

有效日期
样例 : "2025-12-10"

string

productionDate
可选

生产日期
样例 : "2021-01-20"

string

totalPrice
必填

总价
样例 : 10.0

number

packageCostPrice
必填

成本价
样例 : 5.0

number

receiveCount
必填

收货数量
样例 : 2.0

number

unit
必填

收货单位
样例 : "盒"

string

erpProductData
可选

三方erp系统商品信息
样例 : 三方erp系统商品信息

三方erp系统商品信息

7.217. 创建收货单请求

名称 说明 类型

erpOrderNo
可选

erp订单编号
样例 : "XHCX00000182466"

string

erpOrderId
可选

erp订单id
样例 : "CX00000182466"

string

purchaseOrderId
可选

abc采购单id
样例 : "100001697"

string

claimOrderId
可选

abc要货单id
样例 : "100001697"

string

supplierId
必填

abc供应商id
样例 : "ffffffff00000000349179dde6fd0000"

string

receiveOrganId
必填

收货机构
样例 : "ffffffff0000000013186d180b520000"

string

list
可选

收货单明细
样例 : [ "创建收货单明细请求" ]

< 创建收货单明细请求 > array

sourceType
可选

收货单来源 100=采购收货单 120=配货收货单
样例 : 100

integer (int32)

7.218. 创建检查检验单响应

名称 说明 类型

examinationSheets
必填

检查检验摘要信息列表
样例 : [ "检查检验摘要信息" ]

< 检查检验摘要信息 > array

7.219. 创建检查检验单请求

名称 说明 类型

patientId
必填

患者ID
样例 : "string"

string

productSubType
必填

商品子类型 1:检验 2:检查
最小值 : 0
最大值 : 9223372036854775807
样例 : 0

integer (int32)

examinationFormItems
必填

检查检验项列表
样例 : [ "创建检查检验项请求" ]

< 创建检查检验项请求 > array

doctorId
可选

开单医生ID
样例 : "string"

string

doctorDepartmentId
可选

开单医生科室ID
样例 : "string"

string

operatorId
可选

操作人ID，默认为 '00000000000000000000000000000000'
样例 : "00000000000000000000000000000000"

string

7.220. 创建检查检验项请求

名称 说明 类型

productId
必填

商品ID
样例 : "string"

string

name
必填

检查检验项名称
样例 : "string"

string

unitCount
必填

单位数量
样例 : 0.0

number

7.221. 创建治疗项目请求

名称 说明 类型

id
可选

治疗单处方单项ID 为空表示新增，不为空表示更新
样例 : "0"

string

pharmacyNo
必填

药房号，默认 0:本地药房
样例 : 0

integer (int32)

productId
可选

商品ID，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "483ac61f811640f5849a3d3aabceea58"

string

productShortId
可选

商品编码，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "1907765200"

string

freq
可选

频率
样例 : "每日2次"

string

dailyDosage
可选

每日次数 或者 每次12部位
样例 : 3

integer (int32)

days
可选

诊疗项目天数
样例 : 1

integer (int32)

unitCount
可选

单位数量
样例 : 2.0

number

unit
可选

单位
样例 : "次"

string

remark
可选

备注
样例 : "穴位经渠；"

string

expectedUnitPrice
可选

期望单价（议价时使用）
样例 : 5.0

number

expectedTotalPrice
可选

期望总价格（议价时使用）
样例 : 5.0

number

useDismounting
可选

是否拆零销售 0:不拆零 1:拆零（需要药品物资支持拆零出售），默认为 0
样例 : 0

integer (int32)

toothNos
可选

牙位 口腔使用
样例 : [ 12, 23 ]

< integer (int32) > array

7.222. 创建病历请求

名称 说明 类型

id
可选

病历id 为空表示新增，不为空表示更新
样例 : "0"

string

chiefComplaint
必填

主述/现病史
样例 : "咽痛，干咳，咳痰"

string

pastHistory
可选

既往史
样例 : "既往体健，既往有高血压"

string

allergicHistory
可选

过敏史
样例 : "鸡蛋过敏，青霉素过敏"

string

familyHistory
可选

家族史
样例 : "string"

string

presentHistory
可选

现病史
样例 : "string"

string

physicalExamination
可选

体格检查
样例 : "string"

string

diagnosis
必填

诊断
样例 : "急性上呼吸道感染"

string

doctorAdvice
可选

医嘱
样例 : "string"

string

syndrome
可选

辨症
样例 : "string"

string

therapy
可选

治法
样例 : "string"

string

chineseExamination
可选

望闻切诊
样例 : "string"

string

obstetricalHistory
可选

妇科月经婚育史
样例 : "string"

string

7.223. 创建西药处方药品请求

名称 说明 类型

ast
可选

皮试标识 1:皮试 2:续用 3:免试
样例 : 1

integer (int32)

id
可选

处方单项id 为空表示新增，不为空表示更新
样例 : "483ac61f811640f5849a3d3aabceea58"

string

productId
可选

商品ID，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "483ac61f811640f5849a3d3aabceea58"

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次
样例 : "qd"

string

productShortId
可选

商品编码，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "1907765200"

string

dosage
可选

单次剂量
样例 : 3.0

number

unitCount
必填

单位数量
样例 : 2.0

number

dosageUnit
可选

单次单位
样例 : "片"

string

expectedUnitPrice
可选

期望单价（议价时使用）
样例 : 5.0

number

days
可选

用药天数
样例 : 5.0

number

expectedTotalPrice
可选

期望总价格（议价时使用）
样例 : 5.0

number

specialRequirement
可选

特殊用法
样例 : "首次加倍"

string

useDismounting
可选

是否拆零销售 0:不拆零 1:拆零（需要药品物资支持拆零出售），默认为 0
样例 : 0

integer (int32)

pharmacyNo
必填

药房号，默认 0:本地药房
样例 : 0

integer (int32)

7.224. 创建输注处方药品请求

名称 说明 类型

ast
可选

皮试标识 1:皮试 2:续用 3:免试
样例 : 1

integer (int32)

id
可选

处方单项id 为空表示新增，不为空表示更新
样例 : "483ac61f811640f5849a3d3aabceea58"

string

dosage
可选

单次剂量
样例 : 3.0

number

productId
可选

商品ID，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "483ac61f811640f5849a3d3aabceea58"

string

dosageUnit
可选

单次单位
样例 : "片"

string

productShortId
可选

商品编码，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "1907765200"

string

specialRequirement
可选

特殊用法
样例 : "首次加倍"

string

unitCount
必填

单位数量
样例 : 2.0

number

expectedUnitPrice
可选

期望单价（议价时使用）
样例 : 5.0

number

pharmacyNo
必填

药房号，默认 0:本地药房
样例 : 0

integer (int32)

expectedTotalPrice
可选

期望总价格（议价时使用）
样例 : 5.0

number

useDismounting
可选

是否拆零销售 0:不拆零 1:拆零（需要药品物资支持拆零出售），默认为 0
样例 : 0

integer (int32)

7.225. 创建零售收费单响应参数

名称 说明 类型

id
必填

收费单ID
样例 : "ffffffff0000000035094935b30b8000"

string

patientOrderId
必填

就诊单ID
样例 : "ffffffff0000000035094935ade28000"

string

status
必填

收费单状态 0:待收 1:部分收 2:已收 3:部分退费 4:已退费
样例 : 0

integer (int32)

needPay
必填

应收金额
样例 : 100.0

number

7.226. 创建零售收费单请求参数

名称 说明 类型

chargeForms
必填

收费处方列表
样例 : [ "收费处方请求参数" ]

< 收费处方请求参数 > array

patientId
可选

患者ID
样例 : "ffffffff0000000034de380221984001"

string

sellerId
可选

开单人ID
样例 : "ffffffff000000001b6cf51810e0e000"

string

sellerDepartmentId
可选

开单人部门ID，sellerId有值时，sellerDepartmentId必填
样例 : "38e4085cb61ef7ac520cbd6e7508ead2"

string

doctorId
可选

医生ID，有值时医生科室ID、诊断不能为空
样例 : "ffffffff0000000022174678012e2000"

string

doctorDepartmentId
可选

医生科室ID
样例 : "38e4085cb61ef7ac520cbd6e7508ead2"

string

diagnosis
可选

诊断
样例 : "急性上呼吸道感染"

string

prescriptionUrls
可选

处方图片URL列表。通过接口【5.14.1】上传
样例 : [ "string" ]

< string > array

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.227. 删除商品响应

名称 说明 类型

id
可选

商品ID
样例 : "string"

string

7.228. 医生信息

开方医生

名称 说明 类型

id
可选

ID：唯一标识
样例 : "string"

string

mobile
可选

手机号码
样例 : "18088888888"

string

name
可选

姓名
样例 : "张三"

string

sex
可选

性别
样例 : "男"

string

headImgUrl
可选

头像
样例 : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg"

string

introduction
可选

医生简介
样例 : "毕业于陆军军医大学临床医学七年制"

string

practiceImgUrl
可选

头像
样例 : "string"

string

doctorPageUrl
可选

医生微诊所页面
样例 : "string"

string

doctorTags
可选

医生标签
样例 : "省级名中医、市级名中医"

< string > array

7.229. 医生信息详情

名称 说明 类型

departments
可选

医生科室列表
样例 : [ "科室摘要信息" ]

< 科室摘要信息 > array

id
可选

ID：唯一标识
样例 : "string"

string

mobile
可选

手机号码
样例 : "18088888888"

string

name
可选

姓名
样例 : "张三"

string

sex
可选

性别
样例 : "男"

string

headImgUrl
可选

头像
样例 : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg"

string

introduction
可选

医生简介
样例 : "毕业于陆军军医大学临床医学七年制"

string

practiceImgUrl
可选

头像
样例 : "string"

string

doctorPageUrl
可选

医生微诊所页面
样例 : "string"

string

doctorTags
可选

医生标签
样例 : "省级名中医、市级名中医"

< string > array

7.230. 医生号源日期列表响应

名称 说明 类型

reserveSections
可选

预约日期列表
样例 : [ "医生预约排班信息" ]

< 医生预约排班信息 > array

7.231. 医生排班号源详情响应结果

名称 说明 类型

doctorId
可选

医生ID
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

workingDate
可选

工作日期
样例 : "string"

string

dayOfWeek
可选

周几
样例 : "string"

string

restCountToday
可选

当天余号
样例 : 0

integer (int32)

canReserve
可选

是否可预约 0:否 1:是
样例 : 0

integer (int32)

scheduleIntervals
可选

预约时段列表
样例 : [ "预约时段" ]

< 预约时段 > array

7.232. 医生科室排班预约信息

名称 说明 类型

id
必填

科室id
样例 : "ffffffff0000000022174678012e2000"

string

name
可选

科室名称
样例 : "儿科"

string

restCount
可选

余号
样例 : 9

integer (int32)

totalCount
可选

总数量
样例 : 10

integer (int32)

status
可选

排班状态 0:有号 1:约满 2:无号（排班班次拆分后的总预约单元格为空，如：班次时长不满足最小服务时长等） 3:未放号 4:完诊（最晚排班结束时间已过） 5:无排班 6:停诊
样例 : 0

integer (int32)

fee
可选

挂号费初诊费用
样例 : 20.0

number

revisitedFee
可选

挂号费复诊费用
样例 : 30.0

number

registerStartTime
可选

预约开始时间 HH:mm（开放平台的预约挂号接口没有这个限制）
样例 : "09:30"

string

registrationCategoryDayShifts
可选

挂号种类号源详情信息列表
样例 : [ "挂号种类号源信息" ]

< 挂号种类号源信息 > array

7.233. 医生预约排班信息

名称 说明 类型

date
可选

预约日期 yyyy-MM-dd
样例 : "2024-04-23"

string

departments
可选

科室列表
样例 : [ "医生科室排班预约信息" ]

< 医生科室排班预约信息 > array

7.234. 单据进销存批次信息

单据进销存批次信息

名称 说明 类型

stockId
可选

调拨GoodsStock的Id,如果没指定批次，这个字段为空
样例 : 12312

integer (int64)

stockInOutDetailId
可选

stockIn 外部明细ID
样例 : "12312"

string

batchId
可选

批次号
样例 : 12312

integer (int64)

supplier
可选

供应商
样例 : 库存商品供应商

库存商品供应商

batchNo
可选

调拨批号
样例 : "555555"

string

productionDate
可选

生产日期
样例 : "2023-01-11"

string

expiryDate
可选

有效期
样例 : "2023-01-11"

string

packageCount
可选

整包装库存变化量，正数代表增加库存，负数代表扣库
样例 : 1.0

number

pieceCount
可选

入库制剂数量，正数代表增加库存，负数代表扣库
样例 : 1.0

number

packageCostPrice
可选

包装成本单价
样例 : 1.0

number

pieceNum
必填

制剂数量
样例 : 10

integer (int32)

costPrice
可选

变更总成本
样例 : 1.0

number

packagePrice
可选

大包装零售价
样例 : 1.0

number

7.235. 发票信息

名称 说明 类型

sheetId
可选

发票sheetId
样例 : "string"

string

recordId
可选

发票recordId
样例 : "string"

string

type
可选

发票类型
样例 : 0

integer (int32)

businessId
可选

业务id
样例 : "string"

string

businessScene
可选

场景
样例 : "string"

string

buyerName
可选

购方名称
样例 : "string"

string

buyerTaxNum
可选

购方税号
样例 : "string"

string

buyerPhone
可选

购方电话
样例 : "string"

string

saleTaxNum
可选

销方税号
样例 : "string"

string

salePhone
可选

销方电话
样例 : "string"

string

saleAddress
可选

销方地址
样例 : "string"

string

totalAmount
可选

发票开票金额
样例 : 0.0

number

invoiceCode
可选

发票代码
样例 : "string"

string

invoiceNumber
可选

发票号码
样例 : "string"

string

invoiceUrl
可选

发票访问地址
样例 : "string"

string

invoiceTime
可选

开票时间
样例 : "string"

string

checker
可选

复核人
样例 : "string"

string

payee
可选

收款人
样例 : "string"

string

clerk
可选

开票员
样例 : "string"

string

7.236. 发药单-处方信息

名称 说明 类型

id
可选

唯一标识
样例 : "ffffffff00000000264a75300d759999"

string

dispseneFormType
可选

发药单类型 4:中西药处方 5:输注处方 6:中药处方 7:门诊单新加的项目收费 8:门诊单新加的商品收费 9:材料 10:赠品 11:套餐
样例 : 0

integer (int32)

numberOfHerbs
可选

中药处方中药味数
样例 : 0

integer (int32)

usageInfo
可选

门诊处方的用法用量 医嘱等信息
样例 : 处方-药品使用信息

处方-药品使用信息

totalPrice
可选

总金额
样例 : 30.23

number

vendorId
可选

供应商ID
样例 : "ffffffff0000000034e6cae04206c09c"

string

vendorName
可选

供应商名字
样例 : "供应商A"

string

dispensingFormItems
可选

药品发药列表
样例 : [ "发药处方的药品发药信息" ]

< 发药处方的药品发药信息 > array

compoundInfo
可选

调配信息
样例 : 处方调配信息

处方调配信息

auditInfo
可选

审核信息
样例 : 处方审核信息

处方审核信息

7.237. 发药单事件

名称 说明 类型

clinicId
可选

门店ID
样例 : "ffffffff000000002620d6280d751234"

string

id
可选

唯一标识
样例 : "ffffffff000000002620d6280d751234"

string

sourceSheetId
可选

来源订单ID：门诊发药单-收费单ID
样例 : "ffffffff000000002620d6280d751234"

string

doctorId
可选

医生ID
样例 : "ffffffff0000000022e9e9580179a123"

string

patientOrderId
可选

本次发药单所属的就诊单ID
样例 : "ffffffff0000000022e9e9580179a123"

string

patientOrderNo
可选

本次发药单所属的就诊单的就诊号
样例 : "诊号：00003447"

string

diagnosedDate
可选

就诊诊断时间
样例 : "2022-07-14 12:00:00"

string (date-time)

medicalRecord
可选

病例诊断信息
样例 : 病历信息

病历信息

patientInfo
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

deliveryInfo
可选

快递信息
样例 : 快递信息

快递信息

deliveredStatus
必填

快递状态 0:不需要快递 1:未发快递 2:已发快递
样例 : 0

integer (int32)

deliveryType
可选

快递类型 0:不需要快递 1:需要快递
样例 : 0

integer (int32)

status
可选

发药单状态 0:未发药 1:已发药 2:已退药
样例 : 0

integer (int32)

statusName
可选

发药状态名称
样例 : "未发药"

string

dispensedBy
可选

发药人ID
样例 : "ffffffff000000002622cbd801e7777"

string

dispensedByName
可选

发药人名称
样例 : "张三"

string

dispensedTime
可选

发药时间
样例 : "2022-07-14 12:00:00"

string (date-time)

created
可选

发药单创建时间
样例 : "2022-07-14 12:00:00"

string (date-time)

pharmacy
可选

药房信息
样例 : 药房详情

药房详情

netIncomeFee
可选

总金额
样例 : 43.75

number

doctor
可选

医生信息
样例 : 员工信息

员工信息

department
可选

科室
样例 : 科室摘要信息

科室摘要信息

isShebaoPay
可选

是否社保支付 0:不是 1:是
样例 : 0

integer (int32)

dispensingForms
可选

发药单包含的处方列表
样例 : [ "发药单-处方信息" ]

< 发药单-处方信息 > array

7.238. 发药单摘要信息

名称 说明 类型

id
必填

发药单ID
样例 : "string"

string

patientOrderId
必填

本次发药单所属的就诊单ID
样例 : "string"

string

patientOrderNo
必填

就诊单号
样例 : "000001"

string

chargeSheetId
必填

关联收费单ID
样例 : "string"

string

pharmacyNo
必填

药房号
样例 : 0

integer (int32)

pharmacyType
必填

药房类型：0:实体药房 1:空中药房 2:虚拟药房
样例 : 0

integer (int32)

status
必填

发药单状态 0:待发 1:已发 2:已退 3:关闭 4:取消
样例 : 0

integer (int32)

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

7.239. 发药单明细请求

名称 说明 类型

id
必填

发药单明细ID
样例 : "ffffffff00000000350895c78a404003"

string

unitCount
必填

每剂发药数量，整数
样例 : 12.0

number

7.240. 发药单详情

名称 说明 类型

clinicId
可选

门店ID
样例 : "ffffffff000000002620d6280d751234"

string

id
可选

唯一标识
样例 : "ffffffff000000002620d6280d751234"

string

sourceSheetId
可选

来源订单ID：门诊发药单-收费单ID
样例 : "ffffffff000000002620d6280d751234"

string

doctorId
可选

医生ID
样例 : "ffffffff0000000022e9e9580179a123"

string

patientOrderId
可选

本次发药单所属的就诊单ID
样例 : "ffffffff0000000022e9e9580179a123"

string

patientOrderNo
可选

本次发药单所属的就诊单的就诊号
样例 : "诊号：00003447"

string

diagnosedDate
可选

就诊诊断时间
样例 : "2022-07-14 12:00:00"

string (date-time)

medicalRecord
可选

病例诊断信息
样例 : 病历信息

病历信息

patientInfo
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

deliveryInfo
可选

快递信息
样例 : 快递信息

快递信息

deliveredStatus
必填

快递状态 0:不需要快递 1:未发快递 2:已发快递
样例 : 0

integer (int32)

deliveryType
可选

快递类型 0:不需要快递 1:需要快递
样例 : 0

integer (int32)

status
可选

发药单状态 0:未发药 1:已发药 2:已退药
样例 : 0

integer (int32)

statusName
可选

发药状态名称
样例 : "未发药"

string

dispensedBy
可选

发药人ID
样例 : "ffffffff000000002622cbd801e7777"

string

dispensedByName
可选

发药人名称
样例 : "张三"

string

dispensedTime
可选

发药时间
样例 : "2022-07-14 12:00:00"

string (date-time)

created
可选

发药单创建时间
样例 : "2022-07-14 12:00:00"

string (date-time)

pharmacy
可选

药房信息
样例 : 药房详情

药房详情

netIncomeFee
可选

总金额
样例 : 43.75

number

doctor
可选

医生信息
样例 : 员工信息

员工信息

department
可选

科室
样例 : 科室摘要信息

科室摘要信息

isShebaoPay
可选

是否社保支付 0:不是 1:是
样例 : 0

integer (int32)

dispensingForms
可选

发药单包含的处方列表
样例 : [ "发药单-处方信息" ]

< 发药单-处方信息 > array

7.241. 发药商品供应商

名称 说明 类型

id
可选

供应商Id
样例 : "ffffffff0000000034e6cae04206c09c"

string

name
可选

供应商的名字
样例 : "药品供应商"

string

7.242. 发药处方的药品发药信息

名称 说明 类型

id
可选

唯一标识
样例 : "ffffffff00000000264a75300d757777"

string

sourceFormItemId
可选

来源项目ID：门诊发药单-收费项ID
样例 : "ffffffff00000000264a75300d757778"

string

status
可选

发药状态 0:未发药 1:已发药 2:已退药
样例 : 1

integer (int32)

productId
可选

发药商品ID
样例 : "02bb5357a5df05b65d028f8868472222"

string

productName
可选

发药药品的名称
样例 : "罗红霉素胶囊"

string

unit
可选

发药单位
样例 : "12g/剂*3剂 的g"

string

unitCount
可选

每剂发药数量
样例 : "12g/剂*3剂 的12"

number

doseCount
可选

剂数
样例 : "12g/剂*3剂 的3 (同发药处方上的剂数相同)"

number

totalCount
可选

药物总重量
样例 : "12g/剂*3剂 的36=12*3 (totalCount = unitCount * doseCount)"

number

usageInfo
可选

药品的特别用法
样例 : 处方-药品使用信息

处方-药品使用信息

productInfo
可选

药品信息
样例 : 商品详情

商品详情

totalPrice
可选

总金额
样例 : 10.3

number

dispensingBatches
可选

发药批次
样例 : [ "发药批次信息" ]

< 发药批次信息 > array

composeChildren
可选

套餐子项，只有当前发药项是套餐母项的时候才会有子项
样例 : [ "发药处方的药品发药抽象信息" ]

< 发药处方的药品发药抽象信息 > array

traceableCodeList
可选

追溯码列表
样例 : [ "追溯码视图信息" ]

< 追溯码视图信息 > array

7.243. 发药处方的药品发药抽象信息

名称 说明 类型

id
可选

唯一标识
样例 : "ffffffff00000000264a75300d757777"

string

sourceFormItemId
可选

来源项目ID：门诊发药单-收费项ID
样例 : "ffffffff00000000264a75300d757778"

string

status
可选

发药状态 0:未发药 1:已发药 2:已退药
样例 : 1

integer (int32)

productId
可选

发药商品ID
样例 : "02bb5357a5df05b65d028f8868472222"

string

productName
可选

发药药品的名称
样例 : "罗红霉素胶囊"

string

unit
可选

发药单位
样例 : "12g/剂*3剂 的g"

string

unitCount
可选

每剂发药数量
样例 : "12g/剂*3剂 的12"

number

doseCount
可选

剂数
样例 : "12g/剂*3剂 的3 (同发药处方上的剂数相同)"

number

totalCount
可选

药物总重量
样例 : "12g/剂*3剂 的36=12*3 (totalCount = unitCount * doseCount)"

number

usageInfo
可选

药品的特别用法
样例 : 处方-药品使用信息

处方-药品使用信息

productInfo
可选

药品信息
样例 : 商品详情

商品详情

totalPrice
可选

总金额
样例 : 10.3

number

dispensingBatches
可选

发药批次
样例 : [ "发药批次信息" ]

< 发药批次信息 > array

composeChildren
可选

套餐子项，只有当前发药项是套餐母项的时候才会有子项
样例 : [ "发药处方的药品发药抽象信息" ]

< 发药处方的药品发药抽象信息 > array

traceableCodeList
可选

追溯码列表
样例 : [ "追溯码视图信息" ]

< 追溯码视图信息 > array

7.244. 发药批次信息

名称 说明 类型

stockLogId
必填

进销存明细ID
样例 : "123456"

string

action
可选

动作：发药;退药
样例 : "发药"

string

stockId
可选

GoodsStock的Id,如果没指定批次，这个字段为空
样例 : 123456

integer (int64)

supplier
可选

库存商品供应商信息
样例 : 发药商品供应商

发药商品供应商

batchId
可选

批次号
样例 : 3123455

integer (int64)

batchNo
可选

生产批号
样例 : "Z123"

string

productionDate
可选

生产日期
样例 : "2023-01-01"

string

expiryDate
可选

有效期
样例 : "2026-01-01"

string

packageCount
可选

整包装库存变化量，发药时为负值，退药时为正值
样例 : -10.0

number

piecePrice
可选

小包装销售单价
样例 : 1.0

number

packagePrice
可选

大包装销售单价
样例 : 10.0

number

pieceCount
可选

制剂数量，发药是为负值，退药时为正值
样例 : -10.0

number

packageCostPrice
可选

包装成本单价
样例 : 10.0

number

costPrice
可选

成本价变化量
样例 : -10.0

number

salePrice
可选

变更实收
样例 : 10.0

number

stockInOutDetailId
可选

入库外部明细ID
样例 : "Z123"

string

created
必填

创建时间
样例 : "2023-01-01 00:00:00"

string (date-time)

7.245. 取消快递费请求参数

名称 说明 类型

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.246. 取消挂号响应

名称 说明 类型

isSuccess
可选

是否成功
样例 : 0

integer (int32)

tips
可选

退号提示
样例 : "string"

string

7.247. 叫号列表响应

名称 说明 类型

doctorId
可选

医生id
样例 : "string"

string

departmentId
可选

科室id
样例 : "string"

string

currentPatient
可选

当前就诊患者
样例 : 叫号患者信息

叫号患者信息

waitingPatients
可选

等待就诊患者列表
样例 : [ "叫号患者信息" ]

< 叫号患者信息 > array

diagnosedPatients
可选

已诊患者列表
样例 : [ "叫号患者信息" ]

< 叫号患者信息 > array

7.248. 叫号患者信息

名称 说明 类型

id
可选

单条叫号id
样例 : "string"

string

timeOfDay
可选

上午/下午/晚上
样例 : "string"

string

registrationCategory
可选

挂号种类；0：普通门诊；1：专家门诊；2：便民门诊；
样例 : 0

integer (int32)

orderNo
可选

号数
样例 : 0

integer (int32)

status
可选

叫号状态 0：普通候诊 1: 上屏候诊 2：正在候诊 3: 已完诊
样例 : 0

integer (int32)

subStatus
可选

叫号子状态 0：正常 1：迟到 2：过号 3: 回诊
样例 : 0

integer (int32)

isAdjusted
可选

是否调序 0: 否 1：是
样例 : 0

integer (int32)

patientId
可选

患者id
样例 : "string"

string

patientName
可选

患者姓名
样例 : "string"

string

reserveStart
可选

预计就诊时间-开始
样例 : "10:00"

string

reserveEnd
可选

预计就诊时间-结束
样例 : "12:00"

string

signInTime
可选

签到时间
样例 : "2022-04-06 15:12:53"

string

isPassed
可选

是否曾过号 0:否 1:是
样例 : 0

integer (int32)

isAdditional
可选

是否是加号 0:否 1:是
样例 : 0

integer (int32)

latePunishCount
可选

迟到-当前等待人数
样例 : 1

integer (int32)

leftLatePunishCount
可选

迟到-剩余等待人数
样例 : 1

integer (int32)

callingOrderNo
可选

叫号顺序
样例 : 1

integer (int32)

7.249. 同步erp库存明细请求

名称 说明 类型

productShortId
可选

商品编码
样例 : "000001"

string

productId
可选

商品id
样例 : "001e3d44f92946d28feabfd750a43c51"

string

erpPackageCount
必填

第三方库存
样例 : 10.0

number

erpPackageUnit
可选

第三方库存单位
样例 : "盒"

string

erpPackagePrice
可选

第三方库存售价
样例 : 0.0

number

erpPackageCostPrice
可选

第三方库存成本
样例 : 0.0

number

erpProductId
必填

erp商品id，需与abc绑定的商品
样例 : "SPZ00015757"

string

erpBatchId
必填

erp批次id
样例 : "00015757"

string

erpBatchNo
可选

生产批号
样例 : "202311008"

string

erpExpiryDate
可选

有效日期
样例 : "2025-12-10"

string

erpProductionDate
可选

生产日期
样例 : "2021-01-20"

string

7.250. 同步第三方库存请求

名称 说明 类型

supplierId
必填

供应商id，需对接过erp的供应商
样例 : "ffffffff0000000034fe0a2cd8564000"

string

list
可选

第三方库存明细列表
样例 : [ "同步erp库存明细请求" ]

< 同步erp库存明细请求 > array

7.251. 告警信息

名称 说明 类型

title
可选

标题
样例 : "处理发药事件失败"

string

content
可选

内容
样例 : "内容"

string

7.252. 员工信息

名称 说明 类型

id
可选

员工ID
样例 : "string"

string

name
可选

员工名字
样例 : "string"

string

7.253. 商品SPU信息

名称 说明 类型

id
可选

商品 SPU ID
样例 : "string"

string

name
可选

SPU 名称
样例 : "string"

string

brandName
可选

品牌名称
样例 : "string"

string

material
可选

材质
样例 : "string"

string

7.254. 商品SPU规格属性

名称 说明 类型

color
可选

颜色（仅镜架商品 typeId 为 65 有该字段）
样例 : "string"

string

spec
可选

规格（仅太阳镜商品 typeId 为 69 有该字段）
样例 : "string"

string

7.255. 商品信息

名称 说明 类型

id
可选

商品编码
样例 : "string"

string

shortId
可选

商品短编码
样例 : "string"

string

name
可选

商品名称
样例 : "string"

string

specification
可选

规格型号
样例 : "string"

string

typeId
可选

分类id
样例 : 0

integer (int32)

typeName
可选

商品类型
样例 : "string"

string

combineType
可选

是否是组合类型 0:非组合类型 1:组合类型
样例 : 0

integer (int32)

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

status
可选

商品状态 1:正常 99:删除
样例 : 1

integer (int32)

disableSell
可选

禁售销售 0:正常 1:禁止销售
样例 : 0

integer (int32)

7.256. 商品分类信息

名称 说明 类型

id
可选

分类ID
样例 : 0

integer (int32)

type
可选

一级分类
样例 : 0

integer (int32)

subType
可选

二级分类
样例 : 0

integer (int32)

category
可选

三级分类
样例 : "string"

string

isLeaf
可选

是否叶子结点 0非叶子结点 1 叶子结点
样例 : 0

integer (int32)

name
可选

分类名称
样例 : "string"

string

children
可选

children节点
样例 : [ "商品分类信息" ]

< 商品分类信息 > array

7.257. 商品分类信息响应

名称 说明 类型

typeTree
可选

商品分类信息列表
样例 : [ "商品分类信息" ]

< 商品分类信息 > array

7.258. 商品库存信息

名称 说明 类型

productId
必填

商品ID
样例 : "ffffffff000000000ef10788097b000c"

string

productShortId
必填

商品编码
样例 : "75724341"

string

stockPieceCount
必填

小包装可售库存数量: 总库存 - 禁售库存 - 锁定库存
样例 : 20.0

number

stockPackageCount
必填

大包装可售库存数量：总库存 - 禁售库存 - 锁定库存
样例 : 10.0

number

pharmacyStocks
必填

各药房库存列表
样例 : [ "药房库存信息" ]

< 药房库存信息 > array

7.259. 商品库存调拨单事件

名称 说明 类型

id
可选

调拨单ID
样例 : 0

integer (int64)

amount
可选

调拨总金额（含税)
样例 : 0.0

number

count
可选

所有调拨商品转成大包装的数量的累加
样例 : 0.0

number

kindCount
可选

种类数量（调拨单里面有几种类型的药）
样例 : 0

integer (int32)

orderNo
可选

可读的调拨库单号
样例 : "string"

string

transType
可选

调拨单类型0:门店间调拨1:药房间调拨
样例 : 0

integer (int32)

transCostPriceType
可选

调拨价格类型（0:同价调拨(调出方改入库成本加，会影响到掉入方的成本)1:异价调拨）
样例 : 0

integer (int32)

createdUser
可选

创建人
样例 : 员工信息

员工信息

created
可选

出库单创建时间
样例 : "string"

string (date-time)

reviewDate
可选

总部审核时间
样例 : "string"

string (date-time)

reviewUser
可选

审核人
样例 : 员工信息

员工信息

inConfirmDate
可选

调拨单调入确认时间
样例 : "string"

string (date-time)

inConfirmUser
可选

调拨单调入放确认人
样例 : 员工信息

员工信息

toOrgan
可选

调入的门店
样例 : 门店摘要信息

门店摘要信息

inPharmacy
可选

调入的药房
样例 : 药房详情

药房详情

fromOrgan
可选

调来的门店
样例 : 门店摘要信息

门店摘要信息

outPharmacy
可选

调出的药房
样例 : 药房详情

药房详情

lastModified
可选

最近一次修改时间
样例 : "string"

string (date-time)

lastModifiedUser
可选

最近一次修改人
样例 : 员工信息

员工信息

status
必填

调拨单状态 0:待出库房确认 5:待总部审核 9:拒绝 10:待入库方确认 20:调拨完成 31:撤回
样例 : 1

integer (int32)

items
可选

调拨项列表
样例 : [ "商品库存调拨项" ]

< 商品库存调拨项 > array

7.260. 商品库存调拨项

名称 说明 类型

applicationPackageCount
可选

申请调拨的大包数量
样例 : 0.0

number

applicationPieceCount
可选

申请调拨的小包数量
样例 : 0.0

number

packageCount
可选

实际调拨的大包数量
样例 : 0.0

number

pieceCount
可选

实际调拨的小包数量
样例 : 0.0

number

goods
可选

goods快照信息
样例 : 商品条目信息

商品条目信息

outTotalCostPrice
可选

总成本
样例 : 0.0

number

outPackageCostPrice
可选

调拨成本价
样例 : 0.0

number

bathes
可选

调拨批次（调出方指定了调拨批次时有效）
样例 : [ "调拨批次" ]

< 调拨批次 > array

transInBatches
可选

调入门店的批次信息
样例 : [ "单据进销存批次信息" ]

< 单据进销存批次信息 > array

lastModified
可选

上次修改时间
样例 : "string"

string (date-time)

7.261. 商品批次信息

名称 说明 类型

batchId
必填

批次号
样例 : 123123

integer (int64)

stockInOutDetailId
可选

stockIn 外部明细ID
样例 : "123123"

string

batchNo
必填

批号
样例 : "100012157"

string

productionDate
可选

生产日期 yyyy-MM-dd
样例 : "2024-09-10"

string

expiryDate
可选

效期 yyyy-MM-dd
样例 : "2024-09-10"

string

stockPieceCount
必填

小包装可售库存数量: 总库存 - 禁售库存 - 锁定库存
样例 : 20.0

number

stockPackageCount
必填

大包装可售库存数量：总库存 - 禁售库存 - 锁定库存
样例 : 10.0

number

packageCostPrice
可选

大包装成本价
样例 : 10.0

number

inDate
可选

入库时间 yyyy-MM-dd HH:mm:ss
样例 : "2024-09-10 18:33:00"

string (date-time)

7.262. 商品批次库存信息

名称 说明 类型

goodsId
必填

商品ID
样例 : "ffffffff000000003473c049d7ab4004"

string

goodsShortId
可选

商品编码
样例 : "Z12312312"

string

batchId
必填

批次ID
样例 : 123123

integer (int64)

pieceNum
可选

制剂数量
样例 : 8

integer (int32)

pharmacyType
必填

药房类型
样例 : 0

integer (int32)

pharmacyNo
必填

药房号
样例 : 0

integer (int32)

expiryDate
可选

效期
样例 : "2025-01-17"

string

productionDate
可选

生产日期
样例 : "2025-01-17"

string

inDate
可选

入库日期 yyyy-MM-dd HH:mm:ss
样例 : "2025-01-17 02:36:00"

string (date-time)

batchNo
可选

批号
样例 : "100012157"

string

packageCostPrice
可选

大包装成本单价
样例 : 10.0

number

leftCost
可选

剩余成本
样例 : 10.0

number

pieceCount
必填

小包装数量
样例 : 10.0

number

packageCount
必填

大包装数量
样例 : 20.0

number

status
必填

批次状态
样例 : 0

integer (int32)

stockInOutDetailId
可选

外部入库明细ID
样例 : "string"

string

7.263. 商品批次汇总信息

名称 说明 类型

productId
必填

商品ID
样例 : "ffffffff000000000ef10788097b000c"

string

pieceNum
必填

制剂数量
样例 : 5.0

number

batches
可选

批次列表
样例 : [ "商品批次信息" ]

< 商品批次信息 > array

7.264. 商品明细信息

名称 说明 类型

cmspec
可选

样例 : "string"

string

id
可选

商品ID
样例 : "string"

string

medicineCadn
可选

商品通用名
样例 : "阿莫西林"

string

name
可选

商品名
样例 : "阿莫西林"

string

type
可选

商品类型 1:药品 2:物资 7:商品
样例 : 1

integer (int32)

subType
可选

商品子类型 当 type 为 1 时 1:西药 2:中药 3:中成药 当 type 为 2 时 1:医疗器械 2:后勤材料 3:固定资产 当 type 为 7 时 1:自制成品 2:保健药品 3:保健食品 4:其他商品
样例 : 1

integer (int32)

typeId
可选

系统分类ID
样例 : 1

integer (int32)

typeName
可选

系统分类名称
样例 : "药品"

string

customTypeId
可选

自定义分类ID
样例 : "213"

string

customTypeName
可选

自定义分类名称
样例 : "抗生素"

string

manufacturer
可选

生产厂家
样例 : "拜耳"

string

medicineNmpn
可选

国药准字
样例 : "H20000001"

string

barCode
可选

条形码
样例 : "string"

string

extendSpec
可选

规格,type为 1，subType为 2可有值
样例 : "净制 0.5kg"

string

materialSpec
可选

规格,type为 2 7可有值
样例 : "弹力型 70mm*18mm"

string

pieceUnit
可选

制剂单位
样例 : "支"

string

pieceNum
可选

制剂数量（10支/盒中的10）
样例 : 10.0

number

piecePrice
可选

制剂单价
样例 : 10.5

number

packageUnit
可选

包装单位
样例 : "盒"

string

packagePrice
可选

包装单价
样例 : 105.0

number

shortId
可选

药品编码
样例 : "K1001"

string

displaySpec
可选

规格: 组装好的格式
样例 : "1ml:0.5mg*10支/盒"

string

displayName
可选

名称：组织名称
样例 : "醋酸泼尼松片(华意)"

string

status
可选

商品状态 1:正常 99:删除
样例 : 1

integer (int32)

7.265. 商品条目信息

商品条目信息

名称 说明 类型

id
可选

商品ID
样例 : "string"

string

name
可选

商品名称
样例 : "阿莫西林"

string

typeId
可选

系统分类ID
样例 : 1

integer (int32)

typeName
可选

系统分类名称
样例 : "药品"

string

customTypeId
可选

自定义分类ID
样例 : "213"

string

customTypeName
可选

自定义分类名称
样例 : "抗生素"

string

manufacturer
可选

生产厂家
样例 : "拜耳"

string

medicineNmpn
可选

国药准字
样例 : "H20000001"

string

barCode
可选

条形码
样例 : "string"

string

pieceUnit
可选

制剂单位
样例 : "支"

string

pieceNum
可选

制剂数量（10支/盒中的10）
样例 : 10.0

number

piecePrice
可选

制剂单价
样例 : 10.5

number

packageUnit
可选

包装单位
样例 : "盒"

string

packagePrice
可选

包装单价
样例 : 105.0

number

shortId
可选

药品编码
样例 : "K1001"

string

specification
可选

规格: 组装好的格式
样例 : "1ml:0.5mg*10支/盒"

string

otcType
可选

OTC药物 1处方药 2:甲类非处方 4:乙类非处方
样例 : 1

integer (int32)

status
可选

商品状态 1:正常 99:删除
样例 : 1

integer (int32)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

goodsSpu
可选

商品SPU信息（目前仅眼镜商品有值）
样例 : 商品SPU信息

商品SPU信息

goodsSpec
可选

商品SPU规格属性（目前仅眼镜商品有值）
样例 : 商品SPU规格属性

商品SPU规格属性

remark
可选

商品备注
样例 : "abc"

string

dosageFormType
可选

样例 : 0

integer (int32)

dosageFormTypeName
可选

样例 : "string"

string

7.266. 商品社保信息

名称 说明 类型

nationalCode
可选

社保国家码
样例 : "T001700643"

string

insuranceTypes
可选

险种信息列表
样例 : [ "商品社保险种信息" ]

< 商品社保险种信息 > array

7.267. 商品社保险种信息

名称 说明 类型

insuranceType
可选

险种，和每个地区的医保相关
样例 : "391"

string

reimbursementRatio
可选

报销比例（范围为0到1）
样例 : 0.1

number

7.268. 商品详情

名称 说明 类型

children
可选

商品子项
样例 : [ "商品详情" ]

< 商品详情 > array

id
可选

商品ID
样例 : "string"

string

name
可选

商品名称
样例 : "阿莫西林"

string

shebao
可选

社保信息
样例 : 商品社保信息

商品社保信息

disableSell
可选

禁售销售 0:正常 1:禁止销售
样例 : 0

integer (int32)

typeId
可选

系统分类ID
样例 : 1

integer (int32)

dismounting
可选

是否拆零 0:不可拆零 1:可拆零
样例 : 0

integer (int32)

typeName
可选

系统分类名称
样例 : "药品"

string

customTypeId
可选

自定义分类ID
样例 : "213"

string

isSell
可选

是否可对外销售 0:不可销售 1:可销售
样例 : 1

integer (int32)

customTypeName
可选

自定义分类名称
样例 : "抗生素"

string

manufacturer
可选

生产厂家
样例 : "拜耳"

string

medicineNmpn
可选

国药准字
样例 : "H20000001"

string

barCode
可选

条形码
样例 : "string"

string

pieceUnit
可选

制剂单位
样例 : "支"

string

pieceNum
可选

制剂数量（10支/盒中的10）
样例 : 10.0

number

piecePrice
可选

制剂单价
样例 : 10.5

number

packageUnit
可选

包装单位
样例 : "盒"

string

packagePrice
可选

包装单价
样例 : 105.0

number

shortId
可选

药品编码
样例 : "K1001"

string

specification
可选

规格: 组装好的格式
样例 : "1ml:0.5mg*10支/盒"

string

otcType
可选

OTC药物 1处方药 2:甲类非处方 4:乙类非处方
样例 : 1

integer (int32)

status
可选

商品状态 1:正常 99:删除
样例 : 1

integer (int32)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

goodsSpu
可选

商品SPU信息（目前仅眼镜商品有值）
样例 : 商品SPU信息

商品SPU信息

goodsSpec
可选

商品SPU规格属性（目前仅眼镜商品有值）
样例 : 商品SPU规格属性

商品SPU规格属性

remark
可选

商品备注
样例 : "abc"

string

dosageFormType
可选

样例 : 0

integer (int32)

dosageFormTypeName
可选

样例 : "string"

string

7.269. 商品采购单审核请求

名称 说明 类型

pass
必填

是否通过 0:拒绝 1:通过，默认值 1
样例 : 1

integer (int32)

comment
可选

审核评论或备注
样例 : "药品数量超过限制"

string

7.270. 地区信息

名称 说明 类型

id
可选

地区ID
样例 : "510000"

string

name
可选

地区名称
样例 : "四川"

string

children
可选

下级区域列表
样例 : [ "地区信息" ]

< 地区信息 > array

7.271. 基金分项

名称 说明 类型

fundPayType
必填

基金支付类型
样例 : "310100"

string

inscpScpAmt
必填

符合政策范围金额
样例 : 0.0

number

crtPaybLmtAmt
必填

本次可支付限额金额
样例 : 0.0

number

fundPayamt
必填

基金支付金额
样例 : 166.0

number

fundPayTypeName
可选

基金支付类型名称
样例 : "string"

string

setlProcInfo
可选

结算过程信息
样例 : "string"

string

7.272. 处方-药品使用信息

名称 说明 类型

usage
可选

处方用法（煎服,冲服,制膏,制丸,外用,贴敷,打粉,泡饮,泡酒,泡浴,泡脚,擦拭）
样例 : "煎服"

string

freq
可选

每日次数
样例 : "1日3次"

string

medicineRequirement
可选

处方药品特殊煎煮方式（先煎，先煎半小时，先煎一小时，后下，包煎，另煎，先炒，烊化，冲服，捣碎，另包）
样例 : "先煎"

string

doseCount
可选

处方剂量
样例 : 3

integer (int32)

dailyDosage
可选

每日使用剂数
样例 : "1日3剂"

string

requirement
可选

处方备注
样例 : "饭前服用"

string

usageLevel
可选

每次用量
样例 : "每次150ml"

string

processUsage
可选

加工制法（煎药，手工煎药，机器煎药（普通），制膏，儿童膏方，成人膏方，打粉，粗粉，细粉，超细粉，制丸，水丸，蜜丸，水蜜丸，浓缩丸，机器煎药（浓缩），颗粒，茶包，胶囊）
样例 : "机器煎药（普通）"

string

processRemark
可选

加工备注
样例 : "加工备注信息"

string

usageDays
可选

服用天数描述
样例 : "约服30天"

string

processBagUnitCount
可选

每剂加工数量，一剂煎X袋，共煎Y袋的X。
样例 : 3.0

number

totalProcessCount
可选

总加工数量，一剂煎X袋，共煎Y袋的Y。
样例 : 9.0

number

isDecoction
可选

是否代煎 0-自煎 1-代煎
样例 : 0

integer (int32)

7.273. 处方使用信息

名称 说明 类型

usage
可选

处方用法（煎服,冲服,制膏,制丸,外用,贴敷,打粉,泡饮,泡酒,泡浴,泡脚,擦拭）
样例 : "煎服"

string

freq
可选

每日次数
样例 : "1日3次"

string

doseCount
可选

处方剂量
最小值 : 1
最大值 : 999
样例 : 3

integer (int32)

dailyDosage
可选

每日使用剂数
样例 : "1日3剂"

string

requirement
可选

处方备注
样例 : "饭前服用"

string

usageLevel
可选

每次用量
样例 : "每次150ml"

string

7.274. 处方信息

名称 说明 类型

id
可选

处方ID
样例 : "string"

string

prescriptionFormItems
可选

处方单项
样例 : [ "处方单项信息" ]

< 处方单项信息 > array

type
可选

处方类型 1:西药 2:输液 3:中药
样例 : 1

integer (int32)

specification
可选

类型（饮片、颗粒）
样例 : "string"

string

doseCount
可选

剂数
样例 : 0

integer (int32)

dailyDosage
可选

每日剂量
样例 : "string"

string

usage
可选

用法
样例 : "string"

string

freq
可选

用药频次
样例 : "string"

string

requirement
可选

服用要求
样例 : "string"

string

usageLevel
可选

单次服用用量
样例 : "string"

string

7.275. 处方信息请求

名称 说明 类型

id
必填

发药单处方ID
样例 : "ffffffff00000000350895c78a404002"

string

doseCount
必填

剂数，非中药默认为1，中药可大于1。为整数
样例 : 1.0

number

dispensingFormItems
必填

发药单明细列表
样例 : [ "发药单明细请求" ]

< 发药单明细请求 > array

7.276. 处方单项信息

名称 说明 类型

id
可选

处方单项ID
样例 : "string"

string

prescriptionFormId
可选

处方单ID
样例 : "string"

string

productId
可选

药品id
样例 : "string"

string

type
可选

1:药品 2:物资
样例 : 1

integer (int32)

subType
可选

type = 1:药品（subType = 1:西药 subType = 2:中药 subType = 3:中成药）type = 2:物资（subType = 1:医用材料 subType = 2:后勤材料 subType = 3:固定资产）
样例 : 1

integer (int32)

name
可选

药品商用名
样例 : "string"

string

specification
可选

药品规格
样例 : "string"

string

manufacturer
可选

生产厂家
样例 : "string"

string

usage
可选

用法
样例 : "string"

string

ivgtt
可选

输液滴速
样例 : 0.0

number

ivgttUnit
可选

输液滴塑单位
样例 : "string"

string

freq
可选

用药频次
样例 : "string"

string

dosage
可选

单次剂量
样例 : "string"

string

dosageUnit
可选

剂量单位
样例 : "string"

string

days
可选

用药天数
样例 : 0

integer (int32)

specialRequirement
可选

特殊要求
样例 : "string"

string

isDismounting
可选

是否使用拆零
样例 : 0

integer (int32)

unitCount
可选

数量
样例 : 0.0

number

unit
可选

单位
样例 : "string"

string

unitPrice
可选

单位价格
样例 : 0.0

number

groupId
可选

分组编号
样例 : 0

integer (int32)

isAst
可选

是否需要皮试 0:不需要皮试 1:需要皮试
样例 : 0

integer (int32)

astResult
可选

皮试结果
样例 : 皮试结果

皮试结果

productInfo
可选

药品信息
样例 : 商品详情

商品详情

7.277. 处方基类

名称 说明 类型

id
可选

处方id 为空表示新增，不为空表示更新
样例 : "0"

string

isTotalPriceChanged
必填

是否议价 0:不议价 1:议价，默认值为 0
样例 : 1

integer (int32)

expectedTotalPrice
可选

期望处方总价（议价时使用）
样例 : 10.0

number

prescriptionFormItems
可选

样例 : [ "创建西药处方药品请求" ]

< 创建西药处方药品请求 > array

7.278. 处方审核信息

处方审核信息

名称 说明 类型

auditBy
可选

审核人ID
样例 : "ffffffff00000000264a75300d757777"

string

auditByName
可选

审核人名称
样例 : "张三"

string

auditByHandSign
可选

审核人手签
样例 : "http://www.baidu.com"

string

auditTime
可选

审核时间
样例 : "2025-01-09 17:20:00"

string (date-time)

7.279. 处方签名Req

名称 说明 类型

productShortId
可选

商品编码，与有存在用药风险的商品的商品编码（商品编码和商品ID二选一，商品ID优先）
样例 : "1907765200"

string

productId
可选

商品ID，与有存在用药风险的商品的商品ID（商品编码和商品ID二选一，商品ID优先）
样例 : "483ac61f811640f5849a3d3aabceea58"

string

productName
可选

商品名称，与有存在用药风险的商品的商品名称
样例 : "三七"

string

status
可选

签名状态 1=已签
样例 : 1

integer (int32)

7.280. 处方签名Res

名称 说明 类型

productId
可选

商品ID，与有存在用药风险的商品的商品ID（商品编码和商品ID二选一，商品ID优先）
样例 : "483ac61f811640f5849a3d3aabceea58"

string

productName
可选

商品名称，与有存在用药风险的商品的商品名称
样例 : "三七"

string

status
可选

签名状态 1=已签
样例 : 1

integer (int32)

7.281. 处方药品请求基类

名称 说明 类型

id
可选

处方单项id 为空表示新增，不为空表示更新
样例 : "483ac61f811640f5849a3d3aabceea58"

string

specialRequirement
可选

特殊要求 [先煎,后下,冲服]
样例 : "先煎"

string

productId
可选

商品ID，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "483ac61f811640f5849a3d3aabceea58"

string

productShortId
可选

商品编码，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "1907765200"

string

verifySignatures
可选

处方签名
样例 : [ "处方签名Req" ]

< 处方签名Req > array

unitCount
必填

单位数量
样例 : 2.0

number

expectedUnitPrice
可选

期望单价（议价时使用）
样例 : 5.0

number

expectedTotalPrice
可选

期望总价格（议价时使用）
样例 : 5.0

number

useDismounting
可选

是否拆零销售 0:不拆零 1:拆零（需要药品物资支持拆零出售），默认为 0
样例 : 0

integer (int32)

7.282. 处方调配信息

处方调配信息

名称 说明 类型

compoundBy
可选

调配人ID
样例 : "ffffffff00000000264a75300d757777"

string

compoundByName
可选

调配人名称
样例 : "张三"

string

compoundByHandSign
可选

调配人手签
样例 : "http://www.baidu.com"

string

compoundTime
可选

调配时间 yyyy-MM-dd HH:mm:ss
样例 : "2025-01-09 17:20:00"

string (date-time)

7.283. 外治处方请求

名称 说明 类型

id
可选

处方id 为空表示新增，不为空表示更新
样例 : "0"

string

usageType
必填

用法类型 0:贴敷 1:针刺 2:艾灸 3:拔罐 4:刮痧 5:推拿
样例 : 1

integer (int32)

isTotalPriceChanged
必填

是否议价 0:不议价 1:议价，默认值为 0
样例 : 1

integer (int32)

usageSubType
必填

用法子类型 贴敷: 0-成品贴 1-现配贴 针刺：0-毫针 1-电针 2-皮肤针 3-梅花针 4-头针 5-耳针
样例 : 1

integer (int32)

expectedTotalPrice
可选

期望处方总价（议价时使用）
样例 : 10.0

number

prescriptionFormItems
可选

样例 : [ "创建外治处方药品请求" ]

< 创建外治处方药品请求 > array

7.284. 外部跟踪信息

名称 说明 类型

content
可选

信息内容
样例 : "string"

string

time
可选

时间
样例 : "yyyy-MM-dd HH:mm:ss"

string

7.285. 就诊单号查询发药单响应

名称 说明 类型

dispensingSheets
可选

发药单列表
样例 : [ "发药单详情" ]

< 发药单详情 > array

7.286. 就诊来源类型

名称 说明 类型

id
必填

类型ID
样例 : "string"

string

name
必填

类型名称或关联ID名称（当关联类型为单个员工时为员工名称；当关联类型为单个患者时为患者名称；当关联类型为员工角色时为角色名称，其他情况就是类型名称）
样例 : "张三"

string

relatedType
必填

关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色
样例 : 3

integer (int32)

relatedId
可选

关联ID，由 relatedType 确定关联的是什么ID，关联单个患者时，是患者ID；关联单个医生时，是医生ID；关联的是医生角色时，是角色ID；其他情况为空
样例 : "ffffffff00000000094c2a500293c000"

string

children
可选

就诊来源子类（和 relatedType 有关，只有在关联类型为 0 的时候才可能有值）
样例 : [ "就诊来源类型" ]

< 就诊来源类型 > array

7.287. 库存入库单列表

名称 说明 类型

stockInOrderList
可选

库存入库单列表
样例 : [ "出入库单信息" ]

< 出入库单信息 > array

7.288. 库存出库单列表

名称 说明 类型

stockOutOrderList
可选

库存出库单列表
样例 : [ "库存出库单摘要信息" ]

< 库存出库单摘要信息 > array

7.289. 库存出库单摘要信息

名称 说明 类型

id
可选

出库单id
样例 : 0

integer (int64)

orderNo
可选

出库单号
样例 : "CK20220526000001"

string

status
可选

出库单状态 0:待确认 1:待审核 2:已完成 9:已拒绝 31:撤回
样例 : 0

integer (int32)

organName
可选

门店
样例 : "高新大源店"

string

type
可选

出库单类型 1:科室出库 2:报损出库 3:退货出库
样例 : 0

integer (int32)

kindCount
可选

品种数量
样例 : 5

integer (int32)

count
可选

数量
样例 : 12.0

number

amount
可选

含税金额
样例 : 6033.23

number

receiver
可选

领取人
样例 : "string"

string

operator
可选

操作人(出库人)
样例 : "string"

string

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

inOrderId
可选

关联的入库单id
样例 : "1928374567678"

string

pharmacy
可选

出库药房
样例 : 药房详情

药房详情

7.290. 库存变更事件

名称 说明 类型

goodsStocks
必填

商品库存列表
样例 : [ "商品库存信息" ]

< 商品库存信息 > array

7.291. 库存商品供应商

名称 说明 类型

id
可选

供应商Id
样例 : "string"

string

name
可选

供应商的名字
样例 : "string"

string

7.292. 库存盘点单列表

名称 说明 类型

checkOrderList
可选

库存盘点单列表
样例 : [ "库存盘点单摘要信息" ]

< 库存盘点单摘要信息 > array

7.293. 库存盘点单摘要信息

名称 说明 类型

id
可选

盘点单ID
样例 : 0

integer (int64)

orderNo
可选

盘点单号
样例 : "PD20220526000001"

string

status
可选

盘点单状态 0:未知初始状态 10:新建待审批 20:审批被拒绝 30:完成(审批通过) 40:撤回
样例 : 0

integer (int32)

organId
可选

门店ID
样例 : "ffffffff0000000019b354880922800a"

string

organName
可选

门店
样例 : "高新大源店"

string

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

totalCostPriceChange
可选

盈亏金额（进价）
样例 : 0.0

number

totalPriceChange
可选

盈亏金额（售价）
样例 : 0.0

number

operator
可选

操作人（入库人）
样例 : "string"

string

operatorId
可选

操作人ID
样例 : "123456"

string

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

7.294. 库存结算单信息

名称 说明 类型

id
可选

结算单ID
样例 : 0

integer (int64)

createdUser
可选

结算单创建人
样例 : "string"

string

createDate
可选

创建时间
样例 : "2022-04-07 15:12:53"

string (date-time)

supplierName
可选

供应商名称
样例 : "string"

string

status
可选

结算单状态 -1:未结算 0:审批中 1:通过审批 6:审批被拒绝 9:撤回申请
样例 : -1

integer (int32)

includeTaxPrice
可选

含税金额
样例 : 0.0

number

excludeTaxPrice
可选

不含税金额
样例 : 0.0

number

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

7.295. 库存结算单信息返回体

名称 说明 类型

settlementOrderList
可选

库存结算单列表
样例 : [ "库存结算单信息" ]

< 库存结算单信息 > array

7.296. 库存结算单详情

名称 说明 类型

id
可选

结算单ID
样例 : 0

integer (int64)

itemsList
可选

结算单条目列表
样例 : [ "结算单条目列表" ]

< 结算单条目列表 > array

createdUser
可选

结算单创建人
样例 : "string"

string

invoicesList
可选

结算单发票列表
样例 : [ "结算单发票列表" ]

< 结算单发票列表 > array

createDate
可选

创建时间
样例 : "2022-04-07 15:12:53"

string (date-time)

inOutList
可选

结算单入库单出库单列表
样例 : [ "结算单入库单出库单列表" ]

< 结算单入库单出库单列表 > array

supplierName
可选

供应商名称
样例 : "string"

string

status
可选

结算单状态 -1:未结算 0:审批中 1:通过审批 6:审批被拒绝 9:撤回申请
样例 : -1

integer (int32)

includeTaxPrice
可选

含税金额
样例 : 0.0

number

excludeTaxPrice
可选

不含税金额
样例 : 0.0

number

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

7.297. 库存调拨单列表视图

名称 说明 类型

id
可选

调拨单ID
样例 : 0

integer (int64)

amount
可选

调拨总金额（含税)
样例 : 0.0

number

count
可选

所有调拨商品转成大包装的数量的累加
样例 : 0.0

number

kindCount
可选

种类数量（调拨单里面有几种类型的药）
样例 : 0

integer (int32)

orderNo
可选

可读的调拨库单号
样例 : "string"

string

transType
可选

调拨单类型0:门店间调拨1:药房间调拨
样例 : 0

integer (int32)

transCostPriceType
可选

调拨价格类型（0:同价调拨(调出方改入库成本加，会影响到掉入方的成本)1:异价调拨）
样例 : 0

integer (int32)

createdUser
可选

创建人
样例 : 员工信息

员工信息

created
可选

出库单创建时间
样例 : "string"

string (date-time)

reviewDate
可选

总部审核时间
样例 : "string"

string (date-time)

reviewUser
可选

审核人
样例 : 员工信息

员工信息

inConfirmDate
可选

调拨单调入确认时间
样例 : "string"

string (date-time)

inConfirmUser
可选

调拨单调入放确认人
样例 : 员工信息

员工信息

toOrgan
可选

调入的门店
样例 : 门店摘要信息

门店摘要信息

inPharmacy
可选

调入的药房
样例 : 药房详情

药房详情

fromOrgan
可选

调来的门店
样例 : 门店摘要信息

门店摘要信息

outPharmacy
可选

调出的药房
样例 : 药房详情

药房详情

lastModified
可选

最近一次修改时间
样例 : "string"

string (date-time)

lastModifiedUser
可选

最近一次修改人
样例 : 员工信息

员工信息

status
必填

调拨单状态 0:待出库方确认 5:待总部审核 9:拒绝 10:待入库方确认 20:调拨完成 31:撤回
样例 : 1

integer (int32)

7.298. 库存调拨单详情

名称 说明 类型

id
可选

调拨单ID
样例 : 0

integer (int64)

amount
可选

调拨总金额（含税)
样例 : 0.0

number

count
可选

所有调拨商品转成大包装的数量的累加
样例 : 0.0

number

kindCount
可选

种类数量（调拨单里面有几种类型的药）
样例 : 0

integer (int32)

orderNo
可选

可读的调拨库单号
样例 : "string"

string

transType
可选

调拨单类型0:门店间调拨1:药房间调拨
样例 : 0

integer (int32)

transCostPriceType
可选

调拨价格类型（0:同价调拨(调出方改入库成本加，会影响到掉入方的成本)1:异价调拨）
样例 : 0

integer (int32)

createdUser
可选

创建人
样例 : 员工信息

员工信息

created
可选

出库单创建时间
样例 : "string"

string (date-time)

reviewDate
可选

总部审核时间
样例 : "string"

string (date-time)

reviewUser
可选

审核人
样例 : 员工信息

员工信息

inConfirmDate
可选

调拨单调入确认时间
样例 : "string"

string (date-time)

inConfirmUser
可选

调拨单调入放确认人
样例 : 员工信息

员工信息

toOrgan
可选

调入的门店
样例 : 门店摘要信息

门店摘要信息

inPharmacy
可选

调入的药房
样例 : 药房详情

药房详情

fromOrgan
可选

调来的门店
样例 : 门店摘要信息

门店摘要信息

outPharmacy
可选

调出的药房
样例 : 药房详情

药房详情

lastModified
可选

最近一次修改时间
样例 : "string"

string (date-time)

lastModifiedUser
可选

最近一次修改人
样例 : 员工信息

员工信息

status
必填

调拨单状态 0:待出库房确认 5:待总部审核 9:拒绝 10:待入库方确认 20:调拨完成 31:撤回
样例 : 1

integer (int32)

items
可选

调拨项列表
样例 : [ "商品库存调拨项" ]

< 商品库存调拨项 > array

7.299. 库存采购单信息

名称 说明 类型

id
可选

采购单ID
样例 : 0

integer (int64)

orderNo
可选

采购单号
样例 : "CG2024110600001"

string

status
可选

采购单状态,0:待审核 1:审核通过 9:审核驳回 31:撤回 药店特有，60:待收货 62:待验收 64:待入库 66:已入库
样例 : 0

integer (int32)

orderType
可选

采购类型，0：线下集采，10：ABC商城采购
样例 : 0

integer (int32)

purchaseOrganName
可选

采购门店名称
样例 : "string"

string

purchaseOrganId
可选

采购门店ID
样例 : "string"

string

applyEmployeeId
可选

申请人ID
样例 : "string"

string

applyEmployeeName
可选

申请人
样例 : "string"

string

purchaseOrderDate
可选

采购日期
样例 : "2024-11-06 16:51:03"

string (date-time)

created
可选

创建时间
样例 : "2024-11-06 16:51:03"

string (date-time)

7.300. 开卡充值业绩明细视图

名称 说明 类型

id
可选

id
样例 : "3810522672384016386"

string

clinicId
必填

门店id
样例 : "ffffffff00000000105f9cf8062ec000"

string

rechargeTime
可选

操作时间 yyyy-MM-dd HH:mm:ss
样例 : "2025-01-06 10:00:00"

string

patientId
可选

患者id
样例 : "ffffffff00000000105f9cf8062ec000"

string

patientMobile
可选

患者手机号
样例 : "18888888888"

string

cardId
可选

卡id
样例 : "ffffffff00000000105f9cf8062ec000"

string

cardName
可选

卡名称
样例 : "充送卡"

string

operationType
可选

操作类型：1-开卡 2-销卡 4-充值 5-退储蓄金
样例 : 1

integer (int32)

actualAmount
可选

实收金额
样例 : 100.0

number (double)

rechargePrincipal
可选

充值本金
样例 : 100.0

number (double)

rechargePresent
可选

充值赠金
样例 : 20.0

number (double)

principalBalance
可选

剩余本金
样例 : 100.0

number (double)

presentBalance
可选

剩余赠金
样例 : 20.0

number (double)

sellerId
可选

销售员ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

sellerName
可选

销售员
样例 : "张三"

string

createdByName
可选

操作人
样例 : "张三"

string

createdBy
可选

操作人id
样例 : "ffffffff00000000105f9cf8062ec000"

string

originPrice
可选

原价金额
样例 : 100.0

number (double)

7.301. 当前时段可用的号源

名称 说明 类型

restCount
可选

当前号源剩余号数；0：当前号源不可用
样例 : 0

integer (int32)

timeOfDay
可选

号源对应 上午/下午/晚上
样例 : "string"

string

orderNo
可选

号数
样例 : 0

integer (int32)

type
可选

预留号类型 0:非预留号 1:PC预留 2:会员预留号
样例 : 2

integer (int32)

start
可选

号源开始时间 HH:mm
样例 : "string"

string

end
可选

号源结束时间 HH:mm
样例 : "string"

string

available
可选

当前号源是否可用
样例 : 0

integer (int32)

7.302. 快递信息

名称 说明 类型

addressProvinceName
可选

省
样例 : "四川省"

string

addressCityName
可选

市
样例 : "成都市"

string

addressDistrictName
可选

区
样例 : "高新区"

string

addressDetail
可选

详细信息
样例 : "四川省成都市高新区xxx街道xxx"

string

deliveryName
可选

收件人姓名
样例 : "张三"

string

deliveryMobile
可选

收件人手机号
样例 : "18088888888"

string

deliveryCompany
可选

快递公司
样例 : 快递公司

快递公司

deliveryOrderNo
可选

快递单号
样例 : "20827634879930368"

string

deliveryPayType
必填

快递费用支付方式 0:到付 1:寄付
样例 : 1

integer (int32)

deliveryFee
可选

快递费用
样例 : 10.0

number

7.303. 快递公司

名称 说明 类型

id
可选

快递公司ID
样例 : "127203805890060288"

string

name
可选

快递公司名称
样例 : "string"

string

7.304. 快递物流轨迹节点信息

名称 说明 类型

context
可选

节点内容
样例 : "string"

string

ftime
可选

节点时间
样例 : "string"

string

7.305. 患者列表响应

名称 说明 类型

rows
可选

患者列表
样例 : [ "患者摘要信息" ]

< 患者摘要信息 > array

7.306. 患者发药单信息

名称 说明 类型

id
可选

发药单ID
样例 : "string"

string

patientOrderId
可选

本次发药单所属的就诊单ID
样例 : "string"

string

chargeSheetId
可选

关联收费单ID
样例 : "string"

string

pharmacyNo
可选

药房号
样例 : 0

integer (int32)

pharmacyType
可选

药房类型：0:实体药房 1:空中药房 2:虚拟药房
样例 : 0

integer (int32)

status
可选

发药单状态 0:待发 1:已发 2:已退 3:关闭 4:取消
样例 : 0

integer (int32)

created
可选

发药单创建时间
样例 : "2024-05-30 08:13:00"

string (date-time)

sellerId
可选

开单人ID
样例 : "ffffffff000000002620d6280d751234"

string

sellerName
可选

开单人姓名
样例 : "张三"

string

7.307. 患者合并事件信息

名称 说明 类型

sourcePatientIds
可选

参与合并的患者ID列表（目前只会有两个）
样例 : [ "string" ]

< string > array

mergedPatient
可选

合并后的患者信息
样例 : 患者更新事件信息

患者更新事件信息

7.308. 患者家庭成员信息

名称 说明 类型

familyRole
可选

家庭角色 0:不是家庭成员 1:家长 2:家庭成员
样例 : 0

integer (int32)

id
必填

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

name
必填

姓名
样例 : "张三"

string

relation
可选

关系
样例 : "儿子"

string

mobile
可选

手机号
样例 : "18080000000"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

age
可选

患者年龄大小
样例 : 患者年龄

患者年龄

idCard
可选

证件号
样例 : "630101200010075758"

string

idCardType
可选

证件类型
样例 : "身份证"

string

7.309. 患者年龄

名称 说明 类型

year
可选

岁
样例 : 60

integer (int32)

month
可选

月
样例 : 2

integer (int32)

day
可选

天
样例 : 1

integer (int32)

7.310. 患者微信信息

名称 说明 类型

chainMpOpenId
可选

连锁公众号openId
样例 : "202394712938192"

string

chainWeappOpenId
可选

连锁小程序openId
样例 : "202394712938192"

string

7.311. 患者执行单信息

名称 说明 类型

id
必填

执行单ID
样例 : "ffffffff0000000034be47d786e44000"

string

status
必填

执行状态 1:待执行 2:已执行 3:已取消（已退费）
样例 : 1

integer (int32)

created
必填

创建时间
样例 : "2022-04-06 15:12:53"

string (date-time)

items
可选

执行项列表
样例 : [ "患者执行项信息" ]

< 患者执行项信息 > array

sellerId
可选

开单人ID
样例 : "ffffffff0000000034be47d786e44000"

string

sellerName
可选

开单人姓名
样例 : "张三"

string

7.312. 患者执行项信息

名称 说明 类型

id
必填

执行项ID
样例 : "ffffffff0000000034be47d5e6e44002"

string

productId
必填

商品ID
样例 : "ffffffff000000003499787109ea4003"

string

productName
可选

商品名称
样例 : "推拿"

string

chargeStatus
可选

执行项收费状态 0:未收费 1:已收费 2:已退费
样例 : 1

integer (int32)

totalCount
可选

总次数（已退费的情况下为 null）
样例 : 10.0

number

executedUnitCount
可选

已执行数量（已退费的情况下为null）
样例 : 2.0

number

7.313. 患者摘要信息

名称 说明 类型

id
必填

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

name
必填

姓名
样例 : "张三"

string

mobile
可选

手机号
样例 : "18080000000"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

age
可选

患者年龄大小
样例 : 患者年龄

患者年龄

idCard
可选

证件号
样例 : "630101200010075758"

string

idCardType
可选

证件类型
样例 : "身份证"

string

7.314. 患者收费单摘要信息

名称 说明 类型

id
可选

收费单ID
样例 : "ffffffff00000000348e4da767258000"

string

patientOrderId
可选

就诊单ID
样例 : "ffffffff0000000034c1d861a2eb8000"

string

doctorId
可选

医生ID
样例 : "ffffffff0000000034c1ed8a86f00003"

string

doctorName
可选

医生名称
样例 : "王五"

string

status
可选

收费单状态 0:未付费 1:部分付费 2:已付费 3:部分退费 4:已退费
样例 : 0

integer (int32)

receivableFee
可选

应收金额
样例 : 20.0

number

sellerId
可选

开单人ID
样例 : "ffffffff00000000287b8f500fa68000"

string

sellerName
可选

开单人名称
样例 : "李四"

string

chargerId
可选

收费员ID
样例 : "ffffffff00000000348e4e60e7290000"

string

chargerName
可选

收费员名称
样例 : "张三"

string

type
可选

收费单类型 0:未知 1:挂号 2:门诊 3:零售 5:会员充值 6:执行站开单 7:在线问诊
样例 : 1

integer (int32)

created
可选

创建时间
样例 : "2022-04-06 15:12:53"

string (date-time)

7.315. 患者更新事件信息

名称 说明 类型

id
可选

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

name
可选

姓名
样例 : "张三"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

mobile
可选

手机号
样例 : "18080000000"

string

sex
可选

性别
样例 : "男"

string

idCard
可选

身份证号
样例 : "string"

string

address
可选

住址
样例 : 住址

住址

sn
可选

档案号
样例 : "031756"

string

profession
可选

职业
样例 : "教师"

string

company
可选

公司
样例 : "ABC"

string

patientSource
可选

来源
样例 : 患者来源

患者来源

remark
可选

备注信息
样例 : "string"

string

7.316. 患者来源

名称 说明 类型

parentId
可选

来源类型上级ID
样例 : "string"

string

parentName
可选

来源类型上级名称
样例 : "string"

string

id
必填

来源类型ID
样例 : "string"

string

name
必填

就诊推荐
样例 : "就诊推荐"

string

sourceFrom
可选

就诊推荐人ID，当关联类型为所有员工、员工角色时为员工ID；当关联类型为所有患者时为患者ID；
样例 : "推荐人ID"

string

sourceFromName
可选

推荐人名称，当关联类型为所有员工、员工角色时为员工名称；当关联类型为所有患者时为患者名称；
样例 : "张三"

string

relatedType
必填

关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色
样例 : 3

integer (int32)

relatedId
可选

关联ID，由 relatedType 确定关联的是什么ID，关联单个患者时是患者ID；关联单个医生时是医生ID；关联的是医生角色时是角色ID；
样例 : "ffffffff00000000094c2a500293c000"

string

relateName
可选

就诊关联来源关联名称，和 relatedId 有关
样例 : "string"

string

7.317. 患者标签

名称 说明 类型

id
可选

标签ID
样例 : "as123"

string

name
可选

标签名称
样例 : "糖尿病"

string

7.318. 患者详细信息

名称 说明 类型

createdClinicId
可选

患者创建门店ID
样例 : "000000fc446f4dbd989857e305b00d6s"

string

id
必填

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

createdClinicName
可选

患者创建门店名称
样例 : "张三"

string

name
必填

姓名
样例 : "张三"

string

created
可选

创建日期
样例 : "2018-08-14 13:08:05"

string (date-time)

mobile
可选

手机号
样例 : "18080000000"

string

patientSource
可选

来源
样例 : 患者来源

患者来源

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

sn
可选

档案号
样例 : "031756"

string

age
可选

患者年龄大小
样例 : 患者年龄

患者年龄

idCard
可选

身份证号
样例 : "string"

string

profession
可选

职业
样例 : "教师"

string

company
可选

公司
样例 : "ABC"

string

idCardType
可选

证件类型
样例 : "身份证"

string

remark
可选

备注
样例 : "string"

string

address
可选

住址
样例 : 住址

住址

shebaoCardInfo
可选

社保信息
样例 : 社保信息

社保信息

tags
可选

标签信息
样例 : [ "患者标签" ]

< 患者标签 > array

memberInfo
可选

会员卡信息
样例 : 会员信息

会员信息

weChatInfo
可选

微信公众号/小程序信息
样例 : 患者微信信息

患者微信信息

7.319. 患者附件

名称 说明 类型

id
必填

附件ID
样例 : "123123121"

string

url
必填

附件路径
样例 : "https://test.com/aaa.xlsx"

string

fileName
必填

文件名称
样例 : "aaa.xlsx"

string

displayName
可选

展示名称
样例 : "体检报告"

string

created
必填

上传时间 yyyy-MM-dd HH:mm:ss
样例 : "2024-08-15 19:18:50"

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:其他
样例 : 1

integer (int32)

7.320. 患者附件信息

名称 说明 类型

url
必填

附件路径，长度不能超过512个字符，通过接口 【5.12.2 获取 OSS Token】上传到阿里云得到
样例 : "https://test.com/aaa.png"

string

fileName
必填

文件名称，长度不能超过50个字符
样例 : "xxxx.png"

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:其他
样例 : 1

integer (int32)

7.321. 患者预约摘要信息

名称 说明 类型

id
必填

挂号单ID
样例 : "string"

string

patientOrderId
必填

就诊单ID
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

医生名称
样例 : "张三"

string

reserveDate
可选

预约就诊日期
样例 : "2019-04-04"

string

reserveStart
可选

预约开始时间
样例 : "10:10"

string

reserveEnd
可选

预约开始时间
样例 : "10:30"

string

type
必填

类型 0：pc预约/挂号；2：门诊快速接诊挂号Direct；3：微诊所预约/挂号；4：open api 预约；5：在线咨询预约
样例 : 0

integer (int32)

status
可选

状态 10：待支付；12：已预约（理疗预约）；20：待签到；21：已签到（理疗预约）；30：待诊；40：已诊；90：已退号；92：已取消
样例 : 10

integer (int32)

payStatus
可选

支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费
样例 : 0

integer (int32)

consultingRoomId
可选

诊室ID
样例 : "string"

string

consultingRoomName
可选

诊室名称
样例 : "string"

string

registrationProducts
可选

预约项目
样例 : [ "预约项目摘要信息" ]

< 预约项目摘要信息 > array

created
可选

创建时间
样例 : "2022-06-23 18:45:00"

string (date-time)

7.322. 执行业绩-明细

名称 说明 类型

id
必填

执行明细ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

patientId
可选

患者ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

patientName
可选

患者名称
样例 : "张三"

string

patientMobile
可选

患者手机号
样例 : "18888888888"

string

executeClinicId
必填

执行门店ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

executeClinicName
可选

执行门店名称
样例 : "北京朝阳医院"

string

executorIds
可选

执行人ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

executorNames
可选

执行人名称
样例 : "张三"

string

status
必填

状态 0:有效 1:撤销
样例 : 0

integer (int32)

executeDate
必填

执行时间 yyyy-MM-dd HH:mm:ss
样例 : "2022-03-28 10:00:00"

string

productId
必填

执行项目ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

productShortId
可选

执行项目编码
样例 : "0001"

string

productName
可选

执行项目名称
样例 : "注射"

string

productType
可选

商品类型
样例 : 1

integer (int32)

productSubType
可选

商品子类型
样例 : 20

integer (int32)

executeCount
可选

执行次数
样例 : 1.0

number

totalPrice
可选

原价
样例 : 20.0

number

amount
可选

实收金额
样例 : 18.0

number

comment
可选

备注
样例 : "执行备注"

string

recordEffectInfo
可选

执行记录
样例 : "【方法】头针;【部位】[穴位]云门；;【反应】麻，酸;【病因】气血亏虚，阴虚内热;【结果】好转;"

string

sheetCreateClinicId
可选

开单门店ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

sheetCreateClinicName
可选

开单门店名称
样例 : "北京朝阳医院"

string

sheetCreatedBy
可选

开单人
样例 : "张三"

string

sheetCreatedByName
可选

开单人名称
样例 : "张三"

string

sheetCreateDepartmentId
可选

开单科室ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

sheetCreateDepartmentName
可选

开单科室名称
样例 : "张三"

string

sheetCreated
可选

开单时间 yyyy-MM-dd HH:mm:ss
样例 : "2022-03-28 10:00:00"

string

createdBy
可选

登记人ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

createdByName
可选

登记人名称
样例 : "张三"

string

chargeFormItemId
可选

收费项ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

chargeSheetId
可选

收费单ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

7.323. 执行事件消息

执行事件消息

名称 说明 类型

id
必填

执行记录ID
样例 : "ffffffff000000003484c3816487c002"

string

executeSheetId
必填

执行单ID
样例 : "ffffffff000000003484c3816487c002"

string

patientOrderId
必填

就诊单ID
样例 : "ffffffff000000003484c3816487c002"

string

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

executors
可选

执行人ID
样例 : [ "员工信息" ]

< 员工信息 > array

items
可选

执行项目列表
样例 : [ "执行记录执行项目信息" ]

< 执行记录执行项目信息 > array

operator
可选

操作人
样例 : 员工信息

员工信息

executeTime
可选

执行时间
样例 : "2022-04-06 15:12:53"

string (date-time)

7.324. 执行单执行请求参数

执行单执行请求参数

名称 说明 类型

items
必填

执行项列表
样例 : [ "治疗项目执行请求" ]

< 治疗项目执行请求 > array

executorIds
必填

执行人列表
样例 : [ "string" ]

< string > array

operatorId
可选

操作人ID，如果不指定则取第一个执行人ID
样例 : "string"

string

comment
可选

备注
样例 : "string"

string

7.325. 执行单摘要信息

执行单摘要信息

名称 说明 类型

id
必填

执行单ID
样例 : "ffffffff000000003484c3816487c002"

string

patientOrderId
必填

就诊单ID
样例 : "ffffffff000000003484c3816487c002"

string

status
必填

执行状态 0:没有可执行项 1:待执行 2:已执行 3:已取消（已退费）
样例 : 1

integer (int32)

patient
必填

患者信息
样例 : 患者摘要信息

患者摘要信息

abstractInfo
可选

执行内容摘要信息
样例 : "string"

string

created
必填

创建时间
样例 : "2022-04-06 15:12:53"

string (date-time)

isClosed
可选

是否关闭 0:未关闭 1:已关闭
样例 : 0

integer (int32)

7.326. 执行单详情

执行单详情

名称 说明 类型

id
必填

执行单ID
样例 : "ffffffff000000003484c3816487c002"

string

patientOrderId
必填

就诊单ID
样例 : "ffffffff000000003484c3816487c002"

string

items
必填

执行项列表
样例 : [ "执行项" ]

< 执行项 > array

status
必填

执行状态 0:没有可执行项 1:待执行 2:已执行 3:已取消（已退费）
样例 : 1

integer (int32)

chargeStatus
必填

收费单状态 0:未收费 1:部分收费 2:收费完成 3:部分退费 4:退费完成
样例 : 0

integer (int32)

created
必填

创建时间
样例 : "2022-04-06 15:12:53"

string (date-time)

sellerId
可选

开单人ID
样例 : "ffffffff000000003484c3816487c002"

string

sellerName
可选

开单人姓名
样例 : "张三"

string

doctorId
可选

医生ID
样例 : "ffffffff000000003484c3816487c002"

string

doctorName
可选

医生名称
样例 : "李四"

string

diagnosis
可选

诊断
样例 : "慢性鼻窦炎，颞下间隙感染"

string

isClosed
可选

是否关闭 0:未关闭 1:已关闭
样例 : 0

integer (int32)

7.327. 执行记录

执行记录

名称 说明 类型

id
必填

执行记录ID
样例 : "ffffffff000000003484c3816487c002"

string

executeClinicId
必填

执行门店ID
样例 : "ffffffff000000003484c3816487c002"

string

executeClinicName
必填

执行门店名称
样例 : "中医诊所高新店"

string

status
必填

执行状态 0:已执行 1:已取消
样例 : 0

integer (int32)

executors
可选

执行人ID
样例 : [ "员工信息" ]

< 员工信息 > array

items
可选

执行项目列表
样例 : [ "执行记录执行项目信息" ]

< 执行记录执行项目信息 > array

executeTime
可选

执行时间
样例 : "2022-04-06 15:12:53"

string (date-time)

operator
可选

操作人
样例 : 员工信息

员工信息

7.328. 执行记录执行项目信息

执行记录执行项目信息

名称 说明 类型

id
可选

执行项执行记录ID
样例 : 0

integer (int64)

executeItemId
必填

执行项目ID
样例 : "ffffffff000000003484c3816487c002"

string

executeItemProductId
必填

执行项商品ID
样例 : "ffffffff000000003484c3816487c002"

string

executeItemProductName
必填

执行项商品名称
样例 : "雾化吸入"

string

executeCount
必填

执行次数
样例 : 2

integer (int32)

7.329. 执行项

名称 说明 类型

id
可选

ID:唯一标识
样例 : "0002b62eaf9c461f85ff3fedc4583a79"

string

needExecutive
必填

是否可以执行 0:不可以执行 1:可以执行
样例 : 1

integer (int32)

chargeFormId
可选

收费项FormId
样例 : "0002b62eaf9c461f85ff3fedc4583a80"

string

executedUnitCount
必填

已执行数量
样例 : 2.0

number

executeStatus
可选

执行状态 1:待执行 2:已执行 3:已取消（已退费）
样例 : 1

integer (int32)

productId
可选

收费商品ID
样例 : "e8aa6074f8c44dfe9f49e076e30265a9"

string

productName
可选

收费商品名称
样例 : "注射用青霉素钠"

string

status
可选

收费项状态 0-未收费 1-已收费 2-已退费 3-未选择/已取消 4-套餐子项已退（只出现在套餐母项本身）
样例 : 0

integer (int32)

unit
可选

单位
样例 : "支"

string

receivedFee
可选

实收，总金额，收费完成后有值
样例 : 40.0

number

unitPrice
可选

实收单价，收费完成后有值
样例 : 10.0

number

displayUnitPrice
可选

显示单价（待收费时是不使用任何优惠时的应收，部分收费或已收费时是优惠抵扣后的应收）
样例 : 10.0

number

displayTotalPrice
可选

显示总价（待收费时是不使用任何优惠时的总应收，部分收费或已收费时是优惠抵扣后的总应收）
样例 : 40.0

number

unitCount
可选

单位数量
样例 : 4.0

number

doseCount
可选

剂数
样例 : 1.0

number

totalCount
可选

总数量：totalCount = unitCount * doseCount
样例 : 4.0

number

productType
可选

商品一级分类: 参考api 5.3.5. 获取商品分类
样例 : 1

integer (int32)

productSubType
可选

商品二级分类: 参考api 5.3.5. 获取商品分类
样例 : 3

integer (int32)

sourceItemType
可选

收费项来源类型 0:普通 1:自备
样例 : 0

integer (int32)

productInfo
可选

商品信息
样例 : 商品详情

商品详情

composeChildren
可选

套餐项目列表
样例 : [ "收费项目明细" ]

< 收费项目明细 > array

extraInfo
可选

外部信息，如外部id
样例 : "string"

string

7.330. 挂号事件

名称 说明 类型

patientOrderId
可选

就诊单ID
样例 : "string"

string

visitSourceParentId
可选

就诊来源分类上级ID
样例 : "string"

string

registrationSheetId
可选

挂号单ID
样例 : "string"

string

visitSourceParentName
可选

就诊来源分类上级名称
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

visitSourceId
可选

就诊来源分类ID
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

visitSourceName
可选

就诊来源分类名称
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

visitSourceFromId
可选

就诊来源分类下具体来源ID，当关联类型为所有员工、员工角色时为员工ID；当关联类型为所有患者时为患者ID；
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

visitSourceFromName
可选

就诊来源分类下具体来源名称，当关联类型为所有员工、员工角色时为员工名称；当关联类型为所有患者时为患者名称；
样例 : "string"

string

doctorName
可选

医生名称
样例 : "string"

string

visitSourceRelatedType
可选

就诊来源关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色
样例 : 0

integer (int32)

orderNoNum
可选

号数
样例 : 1

integer (int32)

visitSourceRelatedId
可选

就诊来源关联ID，由 relatedType 确定关联的是什么ID，关联单个患者时是患者ID；关联单个医生时是医生ID；关联的是医生角色时是角色ID；
样例 : "string"

string

orderNo
可选

号数
样例 : "上午 01号"

string

visitSourceRelateName
可选

就诊关联来源关联名称，和 visitSourceRelateId 有关
样例 : "string"

string

reserveDate
可选

预约就诊日期
样例 : "2019-04-04"

string

visitSourceRemark
可选

就诊备注
样例 : "string"

string

reserveTime
可选

预约具体的时间
样例 : "10:10～10:30"

string

isReserved
可选

是否是预约号 1:是 0:否
样例 : 1

integer (int32)

revisitStatus
可选

初复诊状态 1:初诊 2:复诊
样例 : 1

integer (int32)

status
可选

状态 10：待支付；12：已预约（理疗预约）；20：待签到；21：已签到（理疗预约）；30：待诊；40：已诊；90：已退号；92：已取消
样例 : 10

integer (int32)

signIn
可选

签到状态 0:无需签到 1:待签到 2:已签到
样例 : 0

integer (int32)

consultingRoomId
可选

诊室id
样例 : "string"

string

consultingRoomName
可选

诊室名称
样例 : "string"

string

type
可选

预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号
样例 : 0

integer (int32)

payStatus
可选

支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费
样例 : 0

integer (int32)

code
可选

取号码
样例 : 0

integer (int32)

registrationType
可选

预约类型 0:门诊预约 1:理疗预约 10:检查预约
样例 : 0

integer (int32)

created
可选

创建时间
样例 : "2022-06-23 18:45:00"

string (date-time)

7.331. 挂号单基础信息

名称 说明 类型

patientOrderId
可选

就诊单ID
样例 : "string"

string

registrationSheetId
可选

挂号单ID
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

医生名称
样例 : "string"

string

orderNoNum
可选

号数
样例 : 1

integer (int32)

orderNo
可选

号数
样例 : "上午 01号"

string

reserveDate
可选

预约就诊日期
样例 : "2019-04-04"

string

reserveTime
可选

预约具体的时间
样例 : "10:10～10:30"

string

isReserved
可选

是否是预约号 1:是 0:否
样例 : 1

integer (int32)

revisitStatus
可选

初复诊状态 1:初诊 2:复诊
样例 : 1

integer (int32)

status
可选

状态 10：待支付；12：已预约（理疗预约）；20：待签到；21：已签到（理疗预约）；30：待诊；40：已诊；90：已退号；92：已取消
样例 : 10

integer (int32)

signIn
可选

签到状态 0:无需签到 1:待签到 2:已签到
样例 : 0

integer (int32)

consultingRoomId
可选

诊室id
样例 : "string"

string

consultingRoomName
可选

诊室名称
样例 : "string"

string

type
可选

预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号
样例 : 0

integer (int32)

payStatus
可选

支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费
样例 : 0

integer (int32)

code
可选

取号码
样例 : 0

integer (int32)

registrationType
可选

预约类型 0:门诊预约 1:理疗预约 10:检查预约
样例 : 0

integer (int32)

created
可选

创建时间
样例 : "2022-06-23 18:45:00"

string (date-time)

7.332. 挂号种类号源信息

名称 说明 类型

departmentId
可选

科室id
样例 : "ffffffff0000000017e9b87008386000"

string

registrationCategory
可选

挂号种类；0：普通门诊；1：专家门诊；2：便民门诊；
样例 : 0

integer (int32)

restCount
可选

剩余号源数量
样例 : 5

integer (int32)

totalCount
可选

总号源数量
样例 : 10

integer (int32)

status
可选

状态
样例 : 0

integer (int32)

dayShifts
可选

按时段展示，上午/下午/晚上 或者 自定义时段
样例 : [ "时间段信息" ]

< 时间段信息 > array

7.333. 挂号详细信息

名称 说明 类型

clinicName
可选

门店名称
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

registrationSheetId
可选

挂号单ID
样例 : "string"

string

visitSourceParentId
可选

就诊来源分类上级ID
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

visitSourceParentName
可选

就诊来源分类上级名称
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

visitSourceId
可选

就诊来源分类ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

visitSourceName
可选

就诊来源分类名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

visitSourceFromId
可选

就诊来源分类下具体来源ID，当关联类型为所有员工、员工角色时为员工ID；当关联类型为所有患者时为患者ID；
样例 : "string"

string

doctorName
可选

医生名称
样例 : "string"

string

visitSourceFromName
可选

就诊来源分类下具体来源名称，当关联类型为所有员工、员工角色时为员工名称；当关联类型为所有患者时为患者名称；
样例 : "string"

string

orderNoNum
可选

号数
样例 : 1

integer (int32)

visitSourceRelatedType
可选

就诊来源关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色
样例 : 0

integer (int32)

orderNo
可选

号数
样例 : "上午 01号"

string

visitSourceRelatedId
可选

就诊来源关联ID，由 relatedType 确定关联的是什么ID，关联单个患者时是患者ID；关联单个医生时是医生ID；关联的是医生角色时是角色ID；
样例 : "string"

string

reserveDate
可选

预约就诊日期
样例 : "2019-04-04"

string

visitSourceRelateName
可选

就诊关联来源关联名称，和 visitSourceRelateId 有关
样例 : "string"

string

reserveTime
可选

预约具体的时间
样例 : "10:10～10:30"

string

visitSourceRemark
可选

就诊备注
样例 : "string"

string

isReserved
可选

是否是预约号 1:是 0:否
样例 : 1

integer (int32)

registrationProducts
可选

预约项目列表
样例 : [ "预约项目摘要信息" ]

< 预约项目摘要信息 > array

revisitStatus
可选

初复诊状态 1:初诊 2:复诊
样例 : 1

integer (int32)

status
可选

状态 10：待支付；12：已预约（理疗预约）；20：待签到；21：已签到（理疗预约）；30：待诊；40：已诊；90：已退号；92：已取消
样例 : 10

integer (int32)

signIn
可选

签到状态 0:无需签到 1:待签到 2:已签到
样例 : 0

integer (int32)

consultingRoomId
可选

诊室id
样例 : "string"

string

consultingRoomName
可选

诊室名称
样例 : "string"

string

type
可选

预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号
样例 : 0

integer (int32)

payStatus
可选

支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费
样例 : 0

integer (int32)

code
可选

取号码
样例 : 0

integer (int32)

registrationType
可选

预约类型 0:门诊预约 1:理疗预约 10:检查预约
样例 : 0

integer (int32)

created
可选

创建时间
样例 : "2022-06-23 18:45:00"

string (date-time)

7.334. 排序请求

名称 说明 类型

doctorId
可选

医生id
样例 : "string"

string

departmentId
可选

科室id
样例 : "string"

string

patients
可选

患者列表
样例 : [ "PatientItem" ]

< PatientItem > array

operatorId
可选

操作人ID
样例 : "00000000000000000000000000000000"

string

7.335. 推送内容

名称 说明 类型

eventModule
可选

事件模块
样例 : 0

integer (int32)

id
可选

事件id
样例 : "string"

string

clinicId
可选

机构ID
样例 : "string"

string

eventType
可选

事件类型
样例 : 0

integer (int32)

eventName
可选

事件名称
样例 : "string"

string

eventData
可选

事件数据
样例 : "object"

object

callbackCount
可选

回调次数，第一次请求时 1，失败后第一次重试时为 2
样例 : 0

integer (int32)

7.336. 推送内容«JsonNode»

名称 说明 类型

eventModule
可选

事件模块
样例 : 0

integer (int32)

id
可选

事件id
样例 : "string"

string

clinicId
可选

机构ID
样例 : "string"

string

eventType
可选

事件类型
样例 : 0

integer (int32)

eventName
可选

事件名称
样例 : "string"

string

eventData
可选

事件数据
样例 : JsonNode

JsonNode

callbackCount
可选

回调次数，第一次请求时 1，失败后第一次重试时为 2
样例 : 0

integer (int32)

7.337. 撤销执行请求参数

撤销执行请求参数

名称 说明 类型

operatorId
可选

操作人ID
样例 : "string"

string

7.338. 操作响应结果

名称 说明 类型

code
可选

返回码
样例 : 200

integer (int32)

message
可选

返回提示
样例 : "提示信息"

string

7.339. 支付响应

名称 说明 类型

id
可选

体检收费单id
样例 : "string"

string

patientOrderId
可选

体检就诊单id
样例 : "string"

string

chargeStatus
可选

支付状态 10:待支付 20:支付成功 30:支付成功业务处理失败 40:支付失败
样例 : 0

integer (int32)

errorMessage
可选

错误信息
样例 : "string"

string

7.340. 支付请求

名称 说明 类型

payMode
必填

1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项
样例 : 1

integer (int32)

amount
必填

支付金额（小数点前最多为12位，小数点后最多4位）
样例 : 1000.0

number

operatorId
可选

操作人ID
样例 : "00000000000000000000000000000000"

string

7.341. 收货单明细

名称 说明 类型

id
必填

条目ID
样例 : 123456

integer (int64)

productId
必填

商品编码
样例 : "ffffffff0000000034966c3a883ec000"

string

productShortId
可选

商品short编码
样例 : "1000001"

string

productName
可选

商品名称
样例 : "阿莫西林"

string

expiryDate
可选

有效期
样例 : "2022-05-10"

string

productionDate
可选

生产日期
样例 : "2024-05-10"

string

batchNo
可选

生产批号
样例 : "20220526000001"

string

totalPrice
必填

总价
样例 : 10.0

number

packageCostPrice
必填

成本价
样例 : 5.0

number

receiveCount
必填

收货数量
样例 : 2.0

number

unit
必填

收货单位
样例 : "盒"

string

7.342. 收货单详情

名称 说明 类型

id
可选

收货单id
样例 : 3796368496350265344

integer (int64)

receiveOrderItemList
可选

收货单明细列表
样例 : [ "收货单明细" ]

< 收货单明细 > array

orderNo
可选

收货单单号
样例 : "SH2024013000001"

string

status
可选

收货单状态 10:待收货 20:已收货
样例 : 10

integer (int32)

kindCount
可选

收货品种数量
样例 : 5

integer (int32)

sum
可选

收货金额
样例 : 100.0

number

outOrderNo
可选

外部单号
样例 : "035040"

string

receiveDate
可选

收货时间
样例 : "string"

string (date-time)

receiveOrganId
可选

收货机构id
样例 : "ffffffff0000000034d6d4adbec04000"

string

receiveOrganName
可选

收货机构
样例 : "abc"

string

receiveEmployeeId
可选

收货人id
样例 : "6e45706922a74966ab51e4ed1e604641"

string

receiveEmployeeName
可选

收货人
样例 : "张三"

string

supplier
可选

供应商
样例 : "测试供应商"

string

supplierId
可选

供应商ID
样例 : "ffffffff0000000034af4ae82d69c000"

string

7.343. 收费单事件详细信息

名称 说明 类型

id
必填

收费单唯一标识
样例 : "ffffffff00000000220e67a8116d8000"

string

status
可选

收费单状态 0:未收费 1:部分收费 2:收费完成 3:部分退费 4:退费完成
样例 : 0

integer (int32)

type
可选

收费单类型 1:挂号 2:门诊 3:零售收费 5:会员卡充值\退费 6:执行站开单 7:咨询单 8:自主续方 9:家庭医生签约 10:营销卡开卡\销卡 11:营销卡项充值\退费
样例 : 1

integer (int32)

created
可选

创建时间
样例 : "2022-04-06 15:12:53"

string (date-time)

receivableFee
可选

应收金额
样例 : 0.01

number

receivedFee
可选

实收金额
样例 : 0.0

number

refundFee
可选

退费金额
样例 : 0.01

number

discountFee
必填

优惠金额（负值）
样例 : -10.0

number

refundTime
可选

退费时间
样例 : "2022-04-07 15:12:53"

string (date-time)

charger
可选

收费员
样例 : 收费员

收费员

deliveryInfo
可选

收货信息
样例 : 快递信息

快递信息

doctor
可选

开方医生
样例 : 医生信息

医生信息

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

medicalRecord
可选

病历信息
样例 : 病历信息

病历信息

chargeFormItems
可选

收费项目明细
样例 : [ "收费项目明细" ]

< 收费项目明细 > array

chargeTransactions
可选

收费记录：一张收费单可以分多次收费
样例 : [ "收退费交易记录" ]

< 收退费交易记录 > array

chargeTransactionPaidRecords
可选

收费记录：一张收费单可以有多个收费项 只对收费记录进行合并
样例 : [ "收费项详细信息" ]

< 收费项详细信息 > array

sellerId
可选

销售员id
样例 : "ffffff000000xxxxx"

string

sellerName
可选

销售员名字
样例 : "张三"

string

registrationSheetId
可选

挂号单ID，注意：零售收费、在线咨询等与挂号不相关的途径产生的收退费事件，该字段返回的值为空
样例 : "ffffffff0000000025b0df48001ae013"

string

patientOrderId
可选

就诊单ID
样例 : "ffffffff00000000220e67a8116d8000"

string

isDraft
可选

是否是草稿 0:不是草稿 1:是草稿
样例 : 0

integer (int32)

isClosed
可选

是否关闭 0:未关闭 1:已关闭
样例 : 0

integer (int32)

chargedTime
可选

收费完成时间
样例 : "2022-04-06 15:12:53"

string (date-time)

fromSource
可选

来源 0:正常收费单 1:openApi创建的零售收费单
样例 : 1

integer (int32)

7.344. 收费单列表

名称 说明 类型

chargeSheets
可选

收费单列表
样例 : [ "收费单详细信息" ]

< 收费单详细信息 > array

7.345. 收费单摘要信息

名称 说明 类型

id
可选

收费单ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

created
可选

收费单创建时间，而不是在收费台展示的时间，在任何可能会产生收费单场景都会预先创建收费单（例如与挂号预约时）
样例 : "string"

string (date-time)

doctorName
可选

医生名称
样例 : "string"

string

isDraft
可选

是否是草稿 0:不是草稿 1:是草稿
样例 : 0

integer (int32)

status
可选

收费单状态 0:未付费 1:部分付费 2:已付费 3:部分退费 4:已退费
样例 : 0

integer (int32)

owedStatus
可选

欠费状态 0:无欠费 10:欠费中
样例 : 0

integer (int32)

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

type
可选

收费单类型 0:未知 1:挂号 2:门诊 3:零售 5:会员充值 7:在线问诊
样例 : 1

integer (int32)

isClosed
可选

是否关闭 0:未关闭 1:已关闭
样例 : 0

integer (int32)

7.346. 收费单摘要信息列表

名称 说明 类型

chargeSheets
可选

收费单列表
样例 : [ "收费单摘要信息" ]

< 收费单摘要信息 > array

7.347. 收费单支付请求

名称 说明 类型

payMode
必填

支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项
最小值 : 1
样例 : 1

integer (int32)

amount
必填

当次支付金额（小数点前最多为12位，小数点后最多4位）
样例 : 100.0

number

needPayFee
可选

收费单剩余需要支付的金额（小数点前最多为12位，小数点后最多4位），部分收费场景该字段必填
样例 : 1000.0

number

expectedOddFee
可选

期望凑整抹零金额（不能小于-1，不能大于1），就算没有开启凑整抹零的开关依然生效！！！，如果是部分收费，只有第一次收费的时候这个值有效。
样例 : 0.52

number

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

comment
可选

备注信息（长度最大为 200 个字符）
样例 : "来自互联网医院"

string

7.348. 收费单收费结果

名称 说明 类型

id
必填

收费单ID
样例 : "string"

string

patientOrderId
必填

就诊单ID
样例 : "string"

string

status
必填

收费单状态 0:未收费 1:部分收费 2:已收费 3:部分退费 4:已退费
样例 : 2

integer (int32)

statusName
必填

状态名称
样例 : "已收费"

string

needPay
必填

收费单总共支付的金额
样例 : 100.0

number

receivedFee
必填

收费单已经收费单的金额
样例 : 100.0

number

7.349. 收费单详细信息

名称 说明 类型

id
必填

收费单唯一标识
样例 : "ffffffff00000000220e67a8116d8000"

string

status
可选

收费单状态 0:未收费 1:部分收费 2:收费完成 3:部分退费 4:退费完成
样例 : 0

integer (int32)

type
可选

收费单类型 1:挂号 2:门诊 3:零售收费 5:会员卡充值\退费 6:执行站开单 7:咨询单 8:自主续方 9:家庭医生签约 10:营销卡开卡\销卡 11:营销卡项充值\退费
样例 : 1

integer (int32)

created
可选

创建时间
样例 : "2022-04-06 15:12:53"

string (date-time)

receivableFee
可选

应收金额
样例 : 0.01

number

receivedFee
可选

实收金额
样例 : 0.0

number

refundFee
可选

退费金额
样例 : 0.01

number

discountFee
必填

优惠金额（负值）
样例 : -10.0

number

refundTime
可选

退费时间
样例 : "2022-04-07 15:12:53"

string (date-time)

charger
可选

收费员
样例 : 收费员

收费员

deliveryInfo
可选

收货信息
样例 : 快递信息

快递信息

doctor
可选

开方医生
样例 : 医生信息

医生信息

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

medicalRecord
可选

病历信息
样例 : 病历信息

病历信息

chargeFormItems
可选

收费项目明细
样例 : [ "收费项目明细" ]

< 收费项目明细 > array

chargeTransactions
可选

收费记录：一张收费单可以分多次收费
样例 : [ "收退费交易记录" ]

< 收退费交易记录 > array

chargeTransactionPaidRecords
可选

收费记录：一张收费单可以有多个收费项 只对收费记录进行合并
样例 : [ "收费项详细信息" ]

< 收费项详细信息 > array

sellerId
可选

销售员id
样例 : "ffffff000000xxxxx"

string

sellerName
可选

销售员名字
样例 : "张三"

string

registrationSheetId
可选

挂号单ID，注意：零售收费、在线咨询等与挂号不相关的途径产生的收退费事件，该字段返回的值为空
样例 : "ffffffff0000000025b0df48001ae013"

string

patientOrderId
可选

就诊单ID
样例 : "ffffffff00000000220e67a8116d8000"

string

isDraft
可选

是否是草稿 0:不是草稿 1:是草稿
样例 : 0

integer (int32)

isClosed
可选

是否关闭 0:未关闭 1:已关闭
样例 : 0

integer (int32)

chargedTime
可选

收费完成时间
样例 : "2022-04-06 15:12:53"

string (date-time)

fromSource
可选

来源 0:正常收费单 1:openApi创建的零售收费单
样例 : 1

integer (int32)

7.350. 收费单退费响应

名称 说明 类型

id
必填

收费单ID
样例 : "string"

string

status
必填

收费单状态 0:未收费 1:部分收费 2:已收费 3:部分退费 4:已退费
样例 : 2

integer (int32)

statusName
必填

状态名称
样例 : "已收费"

string

refundFee
必填

本次已退金额
样例 : 10.0

number

refundedFee
必填

累积已退金额
样例 : 20.0

number

7.351. 收费单退费请求

名称 说明 类型

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

needRefundFee
可选

收费项需要退费金额（如果不传默认为收费单的实收金额），最大值为 chargeForms 中商品实收金额总和
样例 : 0.0

number

refundFee
可选

本次退费金额（如果不传默认为收费单的实收金额），最大值为 [needRefundFee] + 欠退金额
样例 : 0.0

number

payMode
可选

支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项（如果不传则默认为任意一次收费交易的支付方式）
最小值 : 1
样例 : 1

integer (int32)

chargeForms
可选

收费form列表，如果需要部分退的场景才传该值
样例 : [ "退费form请求" ]

< 退费form请求 > array

7.352. 收费员

名称 说明 类型

id
可选

ID：唯一标识
样例 : "string"

string

name
可选

姓名
样例 : "张三"

string

7.353. 收费处方请求参数

名称 说明 类型

doseCount
必填

剂数，非中药默认为1，中药可大于1。为整数
样例 : 1.0

number

pharmacyNo
必填

药房号，默认 0:本地药房
最小值 : 0
样例 : 0

integer (int32)

chargeFormItems
可选

收费明细列表，明细必须是同一类型的药品, 只支持库存商品
样例 : [ "收费明细请求参数" ]

< 收费明细请求参数 > array

usageInfo
可选

处方使用信息
样例 : 处方使用信息

处方使用信息

7.354. 收费明细-分类信息

名称 说明 类型

clinicName
可选

门店
样例 : "大源店"

string

feeType
可选

费用分类
样例 : "string"

string

clinicId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

departmentName
可选

科室
样例 : "内科"

string

departmentId
可选

科室ID
样例 : "ffffffff00000000264a75300d752999"

string

employeeName
可选

开单人
样例 : "张三"

string

employeeId
可选

开单人ID
样例 : "ffffffff00000000264a75300d752999"

string

chargeName
可选

收费员
样例 : "李四"

string

chargeId
可选

收费员ID
样例 : "ffffffff00000000264a75300d752999"

string

totalPrice
可选

原价
样例 : 20.0

number

adjustmentPrice
可选

整单议价金额
样例 : 0.0

number

discountPrice
可选

优惠金额
样例 : -9.0

number

deductPrice
可选

服务折扣金额
样例 : 0.0

number

amount
可选

实收金额
样例 : 11.0

number

created
可选

收费时间
样例 : "2022-04-28 15:41:27"

string

sourceType
可选

来源
样例 : "门诊"

string

action
可选

类型 收费、退费、欠费、销欠费
样例 : "收费"

string

patientId
可选

患者ID
样例 : "ffffffff0000000034d22e0ce272c000"

string

patientName
可选

患者姓名
样例 : "张三"

string

no
可选

患者就诊号
样例 : 100

integer (int32)

payMode
可选

支付方式名称
样例 : "支付宝"

string

payModeId
必填

支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项
样例 : 1

integer (int32)

paySubModeId
可选

支付子类型
样例 : 0

integer (int32)

comment
可选

备注
样例 : "-"

string

memberPatientId
可选

会员患者ID
样例 : "fffffffff00000000349018418ff74000"

string

memberPatientName
可选

会员患者姓名
样例 : "张三"

string

memberPatientMobile
可选

会员患者手机号
样例 : "18012312312"

string

7.355. 收费明细-单据信息

名称 说明 类型

clinicName
可选

门店
样例 : "大源店"

string

transactionId
必填

交易流水ID
样例 : "ffffffff0000000034cebe945dc04002"

string

clinicId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

patientOrderId
可选

就诊单ID
样例 : "ffffffff0000000034cebe945dc04002"

string

departmentName
可选

科室
样例 : "内科"

string

receivableFee
可选

应收
样例 : 0.0

number

chargeSheetId
必填

收费单ID
样例 : "ffffffff00000000264a75300d752999"

string

departmentId
可选

科室ID
样例 : "ffffffff00000000264a75300d752999"

string

employeeName
可选

开单人
样例 : "张三"

string

thirdPartyPayTransactionId
可选

三方支付交易流水号
样例 : "3811634313497509894"

string

employeeId
可选

开单人ID
样例 : "ffffffff00000000264a75300d752999"

string

visitSource
可选

推荐来源
样例 : 患者来源

患者来源

chargeName
可选

收费员
样例 : "李四"

string

chargeId
可选

收费员ID
样例 : "ffffffff00000000264a75300d752999"

string

totalPrice
可选

原价
样例 : 20.0

number

adjustmentPrice
可选

整单议价金额
样例 : 0.0

number

discountPrice
可选

优惠金额
样例 : -9.0

number

deductPrice
可选

服务折扣金额
样例 : 0.0

number

amount
可选

实收金额
样例 : 11.0

number

created
可选

收费时间
样例 : "2022-04-28 15:41:27"

string

sourceType
可选

来源
样例 : "门诊"

string

action
可选

类型 收费、退费、欠费、销欠费
样例 : "收费"

string

patientId
可选

患者ID
样例 : "ffffffff0000000034d22e0ce272c000"

string

patientName
可选

患者姓名
样例 : "张三"

string

no
可选

患者就诊号
样例 : 100

integer (int32)

payMode
可选

支付方式名称
样例 : "支付宝"

string

payModeId
必填

支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项
样例 : 1

integer (int32)

paySubModeId
可选

支付子类型
样例 : 0

integer (int32)

comment
可选

备注
样例 : "-"

string

memberPatientId
可选

会员患者ID
样例 : "fffffffff00000000349018418ff74000"

string

memberPatientName
可选

会员患者姓名
样例 : "张三"

string

memberPatientMobile
可选

会员患者手机号
样例 : "18012312312"

string

7.356. 收费明细-明细信息

名称 说明 类型

clinicName
可选

门店
样例 : "大源店"

string

patientMobile
可选

患者手机号
样例 : "13800000000"

string

clinicId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

id
必填

收费明细ID
样例 : "ffffffff0000000034e501b0275a4074"

string

departmentName
可选

科室
样例 : "内科"

string

name
可选

收费项名称
样例 : "血清胰岛素、"

string

departmentId
可选

科室ID
样例 : "ffffffff00000000264a75300d752999"

string

productId
必填

商品ID
样例 : "ffffffff0000000034e501b0275a4074"

string

employeeName
可选

开单人
样例 : "张三"

string

productShortId
可选

商品编码
样例 : "1000001"

string

count
可选

数量
样例 : 1.0

number

employeeId
可选

开单人ID
样例 : "ffffffff00000000264a75300d752999"

string

chargeName
可选

收费员
样例 : "李四"

string

price
可选

单价
样例 : 5.0

number

chargeId
可选

收费员ID
样例 : "ffffffff00000000264a75300d752999"

string

feeType1
可选

收费项一级分类名称
样例 : "治疗"

string

feeType2
可选

收费项二级分类名称
样例 : "-"

string

totalPrice
可选

原价
样例 : 20.0

number

adjustmentPrice
可选

整单议价金额
样例 : 0.0

number

productType
可选

商品类型
样例 : 1

integer (int32)

discountPrice
可选

优惠金额
样例 : -9.0

number

productSubType
可选

商品子类型
样例 : 20

integer (int32)

deductPrice
可选

服务折扣金额
样例 : 0.0

number

productCustomType
可选

用户自定义商品类型
样例 : 1000

integer (int32)

amount
可选

实收金额
样例 : 11.0

number

batchId
可选

批次号（批次维度有值）
样例 : 1000324

integer (int64)

batchNo
可选

批号（批次维度有值）
样例 : "1234"

string

created
可选

收费时间
样例 : "2022-04-28 15:41:27"

string

expiryDate
可选

效期（批次维度有值）
样例 : "2022-03-28"

string

sourceType
可选

来源
样例 : "门诊"

string

action
可选

类型 收费、退费、欠费、销欠费
样例 : "收费"

string

productionDate
可选

生产日期（批次维度有值）
样例 : "2022-03-28"

string

chargeSheetId
必填

收费单ID
样例 : "ffffffff0000000034e501b0275a4074"

string

patientId
可选

患者ID
样例 : "ffffffff0000000034d22e0ce272c000"

string

chargeFormItemId
必填

收费项ID
样例 : "ffffffff0000000034e501b0275a4074"

string

patientName
可选

患者姓名
样例 : "张三"

string

chargeTransactionId
必填

收费交易ID
样例 : "ffffffff0000000034e501b0275a4074"

string

no
可选

患者就诊号
样例 : 100

integer (int32)

itemAdjustmentAmount
可选

项目议价金额
样例 : 5.0

number

payMode
可选

支付方式名称
样例 : "支付宝"

string

payModeId
必填

支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项
样例 : 1

integer (int32)

paySubModeId
可选

支付子类型
样例 : 0

integer (int32)

comment
可选

备注
样例 : "-"

string

memberPatientId
可选

会员患者ID
样例 : "fffffffff00000000349018418ff74000"

string

memberPatientName
可选

会员患者姓名
样例 : "张三"

string

memberPatientMobile
可选

会员患者手机号
样例 : "18012312312"

string

7.357. 收费明细请求参数

名称 说明 类型

productId
可选

商品ID，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "483ac61f811640f5849a3d3aabceea58"

string

productShortId
可选

商品编码，商品ID和商品编码任选一个，如果传了商品编码，则以商品编码为准，并且单次请求中的所有商品都只能用商品编码
样例 : "1907765200"

string

unitCount
必填

单位数量，整数
样例 : 2.0

number

expectedUnitPrice
可选

期望单价（议价时使用）
样例 : 5.0

number

expectedTotalPrice
可选

期望总价格（议价时使用）
样例 : 5.0

number

useDismounting
必填

是否拆零销售 0:不拆零 1:拆零 中药时为1；非中药时，商品允许拆零可为1，否则为0
最小值 : 0
最大值 : 9223372036854775807
样例 : 1

integer (int32)

specialRequirement
可选

中药时煎法，非中药时备注
样例 : "煎法(先煎、后下、包煎、另煎、先炒、烊化、冲服、捣碎、吞服、煎汤代水、兑入、打粉、另包)"

string

extraInfo
可选

外部信息，如外部id
样例 : "string"

string

7.358. 收费项目明细

名称 说明 类型

id
可选

ID:唯一标识
样例 : "0002b62eaf9c461f85ff3fedc4583a79"

string

chargeFormId
可选

收费项FormId
样例 : "0002b62eaf9c461f85ff3fedc4583a80"

string

productId
可选

收费商品ID
样例 : "e8aa6074f8c44dfe9f49e076e30265a9"

string

productName
可选

收费商品名称
样例 : "注射用青霉素钠"

string

status
可选

收费项状态 0-未收费 1-已收费 2-已退费 3-未选择/已取消 4-套餐子项已退（只出现在套餐母项本身）
样例 : 0

integer (int32)

unit
可选

单位
样例 : "支"

string

receivedFee
可选

实收，总金额，收费完成后有值
样例 : 40.0

number

unitPrice
可选

实收单价，收费完成后有值
样例 : 10.0

number

displayUnitPrice
可选

显示单价（待收费时是不使用任何优惠时的应收，部分收费或已收费时是优惠抵扣后的应收）
样例 : 10.0

number

displayTotalPrice
可选

显示总价（待收费时是不使用任何优惠时的总应收，部分收费或已收费时是优惠抵扣后的总应收）
样例 : 40.0

number

unitCount
可选

单位数量
样例 : 4.0

number

doseCount
可选

剂数
样例 : 1.0

number

totalCount
可选

总数量：totalCount = unitCount * doseCount
样例 : 4.0

number

productType
可选

商品一级分类: 参考api 5.3.5. 获取商品分类
样例 : 1

integer (int32)

productSubType
可选

商品二级分类: 参考api 5.3.5. 获取商品分类
样例 : 3

integer (int32)

sourceItemType
可选

收费项来源类型 0:普通 1:自备
样例 : 0

integer (int32)

productInfo
可选

商品信息
样例 : 商品详情

商品详情

composeChildren
可选

套餐项目列表
样例 : [ "收费项目明细" ]

< 收费项目明细 > array

extraInfo
可选

外部信息，如外部id
样例 : "string"

string

7.359. 收费项详细信息

名称 说明 类型

productId
可选

商品id
样例 : "00000000000000000000000000000001"

string

productName
可选

商品名称
样例 : "白术"

string

productType
可选

商品类型
样例 : 5

integer (int32)

productSubType
可选

商品子类型
样例 : 0

integer (int32)

composeType
可选

套餐类型：0不是套餐；1套餐母项；2套餐子项
样例 : 0

integer (int32)

productUnit
可选

商品单位
样例 : "string"

string

productUnitCount
可选

商品数量
样例 : 1.0

number

doseCount
可选

商品剂量
样例 : 1.0

number

totalPrice
可选

商品总价
样例 : 0.0

number

discountPrice
可选

商品折扣价格
样例 : 0.0

number

records
可选

收费记录详情 只包含收费记录
样例 : 0

< 交易记录商品明细 > array

7.360. 收费项退费请求

名称 说明 类型

id
必填

收费项ID
样例 : "00000000000000000000000000000000"

string

unitCount
必填

退费单位数量
样例 : 1.0

number

doseCount
必填

退费剂数
样例 : 1.0

number

7.361. 收退费交易记录

名称 说明 类型

id
可选

ID:唯一表示
样例 : "ffffffff00000000220e67a8116d8001"

string

payMode
必填

支付方式
样例 : 1

integer (int32)

paySubMode
必填

支付子方式
样例 : 1

integer (int32)

payModeName
可选

支付方式
样例 : "ABC支付"

string

payModeDisplayName
可选

用于展示的支付方式
样例 : "ABC支付-微信"

string

amount
可选

金额
样例 : 0.0

number

created
可选

创建时间
样例 : "2022-04-06 15:12:53"

string (date-time)

isRefunded
可选

是否已退费 0:否 1:是
样例 : 0

integer (int32)

thirdTransactionId
可选

第三方交易ID
样例 : "123456789"

string

thirdPartyPayInfo
可选

第三方交易信息
样例 : 第三方支付信息

第三方支付信息

chargeTransactionRecords
可选

交易记录商品明细列表
样例 : [ "交易记录商品明细" ]

< 交易记录商品明细 > array

7.362. 文件上传响应

名称 说明 类型

isSuccess
可选

是否成功:0否，1是
样例 : 0

integer (int32)

message
可选

信息:失败的时候有值
样例 : "string"

string

filePath
可选

文件路径
样例 : "string"

string

fileId
可选

文件Id，使用5.14.2下载,请传入此值
样例 : 0

integer (int64)

temp
可选

是否临时路径，指filePath是否为临时地址,临时地址有效时间为24小时
样例 : true

boolean

7.363. 新增或修改患者会员请求

名称 说明 类型

memberTypeId
必填

会员类型ID
样例 : "ffffffff0000000034b7a61b5a37c000"

string

sourceId
可选

患者来源ID
样例 : "ffffffff0000000034b7a61b5a37c000"

string

sourceFromId
可选

患者具体来源ID
样例 : "ffffffff0000000034b7a61b5a37c000"

string

remark
可选

备注信息（不能超过200个字符）
长度 : 0 - 200
样例 : "老客户"

string

7.364. 新增挂号请求参数

名称 说明 类型

source
可选

OpenApi的来源,默认4 OpenApi
样例 : 4

integer (int32)

reserveMustPay
可选

是否必须支付.默认0(0:非必需支付 1:必须支付)
样例 : 0

integer (int32)

patientId
必填

患者ID
样例 : "string"

string

departmentId
可选

科室ID，门诊预约时必传
样例 : "string"

string

doctorId
必填

医生ID
样例 : "string"

string

orderNo
可选

号数，门诊预约必填
样例 : 0

integer (int32)

reserveDate
必填

预约日期 yyyy-MM-dd
样例 : "string"

string

reserveStart
必填

预约号源开始时间, HH:mm
样例 : "string"

string

reserveEnd
必填

预约号源结束时间, HH:mm
样例 : "string"

string

sourceId
可选

就诊来源分类ID
样例 : "医生推荐分类ID, 导医推荐分类ID, 顾客推荐分类ID"

string

sourceFromId
可选

就诊来源分类下某个具体来源ID。比如：当就诊来源分类为【医生推荐】时，根据api【5.2.2. 获取医生分页列表信息】获取到医生，此时字段取值为医生ID；当就诊来源分类为【导医推荐】时, 根据api【5.1.3. 获取门店成员列表】获取到成员，此时字段取值为成员ID；当就诊来源分类为【顾客推荐】时, 根据api【5.4.3. 获取患者列表】获取到患者，此时字段取值为患者ID；
样例 : "string"

string

sourceRemark
可选

就诊备注
样例 : "string"

string

registrationType
可选

预约类型 0:门诊预约 1:理疗预约，默认为门诊预约
样例 : 0

integer (int32)

registrationProductIds
可选

预约项目列表，仅在理疗预约时有效
样例 : [ 0 ]

< integer (int64) > array

7.365. 时间段信息

名称 说明 类型

shifts
可选

时间单元格列表
样例 : [ "预约号单元格信息" ]

< 预约号单元格信息 > array

restCount
可选

余号
样例 : 5

integer (int32)

totalCount
可选

总号
样例 : 10

integer (int32)

status
可选

排班状态 0:有号 1:约满 2:无号（排班班次拆分后的总预约单元格为空，如：班次时长不满足最小服务时长等） 3:未放号 4:完诊（最晚排班结束时间已过） 5:无排班
样例 : 0

integer (int32)

start
可选

开始时间 HH:mm
样例 : "09:00"

string

end
可选

结束时间 HH:mm
样例 : "10:00"

string

timeOfDay
可选

start对应的时段；上午/下午/晚上
样例 : "上午"

string

7.366. 更新快递物流状态请求体

名称 说明 类型

deliveryTraceData
可选

物流轨迹列表
样例 : [ "快递物流轨迹节点信息" ]

< 快递物流轨迹节点信息 > array

7.367. 查询医生可预约项目响应

名称 说明 类型

registrationProducts
可选

可预约项目列表
样例 : [ "预约项目信息" ]

< 预约项目信息 > array

7.368. 查询商品库存响应参数

名称 说明 类型

goodsStocks
必填

商品库存列表
样例 : [ "商品库存信息" ]

< 商品库存信息 > array

7.369. 查询商品批次响应

名称 说明 类型

products
可选

商品列表
样例 : [ "商品批次汇总信息" ]

< 商品批次汇总信息 > array

7.370. 查询就诊来源类型响应

名称 说明 类型

list
可选

就诊来源类型集合
样例 : [ "就诊来源类型" ]

< 就诊来源类型 > array

7.371. 查询患者会员类型响应

名称 说明 类型

memberTypes
必填

会员类型列表
样例 : [ "会员类型信息" ]

< 会员类型信息 > array

7.372. 查询患者家庭成员响应

名称 说明 类型

patientId
可选

查询患者的ID
样例 : "string"

string

familyRole
可选

查询患者的家庭角色 0:不是家庭成员 1:家长 2:家庭成员
样例 : 0

integer (int32)

familyPatients
可选

家庭成员列表（包含查询患者）
样例 : [ "患者家庭成员信息" ]

< 患者家庭成员信息 > array

7.373. 查询执行单列表响应

名称 说明 类型

executeSheets
可选

执行单摘要信息列表
样例 : [ "执行单摘要信息" ]

< 执行单摘要信息 > array

7.374. 查询执行单执行记录响应参数

名称 说明 类型

executeRecords
必填

执行历史列表
样例 : [ "执行记录" ]

< 执行记录 > array

7.375. 查询检查检验数据响应

名称 说明 类型

rows
可选

检查检验列表
样例 : [ "检查检验数据摘要信息" ]

< 检查检验数据摘要信息 > array

7.376. 查询预约备注模板响应

名称 说明 类型

rows
可选

预约备注模板列表
样例 : [ "预约备注模板" ]

< 预约备注模板 > array

7.377. 根据收费单查询进销存明细

名称 说明 类型

patientOrderId
可选

就诊单ID
样例 : "string"

string

chargeSheetId
可选

收费单ID
样例 : "string"

string

7.378. 检查人

名称 说明 类型

id
可选

检查人ID
样例 : "string"

string

name
可选

检查人姓名
样例 : "string"

string

date
可选

检查时间
样例 : "string"

string

7.379. 检查检验单摘要信息

名称 说明 类型

id
可选

检查检验ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

name
可选

项目名称
样例 : "string"

string

type
可选

类型 1:检验 2:检查
样例 : 1

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
样例 : 0

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

created
可选

创建时间
样例 : "string"

string (date-time)

reportTime
可选

报告出具时间
样例 : "string"

string (date-time)

status
可选

状态 0:等检状态 1:已检状态 2:已退款状态 3:待审核状态
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "string"

string

7.380. 检查检验单设备信息

名称 说明 类型

deviceId
可选

设备id
样例 : 0

integer (int64)

deviceShortId
可选

设备编号
样例 : "string"

string

deviceModelId
可选

设备型号id
样例 : 0

integer (int64)

name
可选

设备名字
样例 : "string"

string

model
可选

设备型号
样例 : "string"

string

deviceUuid
可选

设备唯一识别码
样例 : "string"

string

manufacture
可选

设备生产商
样例 : "string"

string

iconUrl
可选

设备图标链接
样例 : "string"

string

buyUrl
可选

设备购买链接
样例 : "string"

string

installUrl
可选

设备安装链接
样例 : "string"

string

remarks
可选

设备备注信息
样例 : "string"

string

type
可选

设备分类 1:检验 2:检查
样例 : 0

integer (int32)

extendSpec
可选

设备扩展分类 检验：无意义 检查：10-RIS检查 20-眼科检查
样例 : "string"

string

deviceType
可选

设备类型
样例 : 0

integer (int32)

usageType
可选

设备用途类型 检验：0 未知类型 1 血液分析 2 生化分析 3尿液分析 4免疫分析 5 微生物分析
样例 : 0

integer (int32)

salePrice
可选

售价
样例 : 0.0

number

deviceNamePy
可选

设备名称拼音
样例 : "string"

string

deviceStatus
可选

设备状态 0 初始化 10启用 20停用 99删除
样例 : 0

integer (int32)

deviceRoomId
可选

设备机房id
样例 : 0

integer (int64)

deviceRoomName
可选

设备机房名称
样例 : "string"

string

department
可选

设备科室
样例 : 科室摘要信息

科室摘要信息

7.381. 检查检验单详情信息

名称 说明 类型

id
可选

检查检验单ID
样例 : "string"

string

outpatientFormItemId
可选

门诊单子项ID
样例 : "string"

string

patientOrderId
可选

门诊单ID
样例 : "string"

string

patientOrderNumber
可选

门诊号/住院号/体检号
样例 : "string"

string

patient
可选

患者信息
样例 : 检查检验患者摘要信息

检查检验患者摘要信息

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

医生名称
样例 : "string"

string

doctorDepartmentId
可选

医生科室ID
样例 : "string"

string

doctorDepartmentName
可选

医生科室名称
样例 : "string"

string

sellerId
可选

开单人id
样例 : "string"

string

sellerName
可选

开单人名称
样例 : "string"

string

sellerDepartmentId
可选

开单人科室id
样例 : "string"

string

sellerDepartmentName
可选

开单人科室名称
样例 : "string"

string

productId
可选

检验项目ID，在开启了合并模式的情况下为空
样例 : "string"

string

products
必填

检验项目列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "检验项目摘要信息" ]

< 检验项目摘要信息 > array

productIds
必填

检验项目ID列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "string" ]

< string > array

composeParentProductId
可选

套餐商品ID
样例 : "string"

string

composeParentName
可选

套餐名称
样例 : "string"

string

name
可选

检验项名称
样例 : "string"

string

orderNo
可选

检验单号(条形码) yyyyMMdd000X
样例 : "202302140038"

string

status
可选

状态 0:等检状态 1:已检状态 2:已退款状态 3:设备回传 4:待审核状态
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "string"

string

sampleType
可选

样本类型
样例 : "string"

string

samplerId
可选

采集人id
样例 : "string"

string

samplerName
可选

采集人名称
样例 : "string"

string

sampleTime
可选

采集时间
样例 : "string"

string (date-time)

collectorId
可选

核收人id
样例 : "string"

string

collectorName
可选

核收人名称
样例 : "string"

string

collectTime
可选

核收时间
样例 : "string"

string (date-time)

results
可选

检查检验结果
样例 : [ "检查检验结果" ]

< 检查检验结果 > array

eyeResults
可选

眼科检查结果
样例 : [ "眼科检查结果" ]

< 眼科检查结果 > array

reports
可选

检查检验报告
样例 : [ "检查检验报告" ]

< 检查检验报告 > array

attachments
可选

附件
样例 : [ "附件" ]

< 附件 > array

remark
可选

检验结果备注
样例 : "string"

string

testerId
可选

检验人ID
样例 : "string"

string

testerName
可选

检验人名称
样例 : "string"

string

testTime
可选

检验时间
样例 : "string"

string (date-time)

checkerId
可选

审核人ID
样例 : "string"

string

checkerName
可选

审核人名称
样例 : "string"

string

checkTime
可选

审核时间
样例 : "string"

string (date-time)

reportTime
可选

报告时间
样例 : "string"

string (date-time)

created
可选

创建时间
样例 : "string"

string (date-time)

type
可选

类型 1:检验 2:检查
样例 : 1

integer (int32)

subType
可选

子类型 检验：无意义；检查： 10-RIS检查 20-眼科检查
样例 : 20

integer (int32)

diagnosis
可选

诊断
样例 : "急性上呼吸道感染"

string

reportUrl
可选

报告url
样例 : "string"

string

examinationApplySheetNo
可选

检查申请单号
样例 : "string"

string

bedNo
可选

床位号
样例 : "string"

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
样例 : 0

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

relationPatientOrderId
可选

关联的门诊单id(眼科检查特有)
样例 : "string"

string

registrationFormItem
可选

关联的挂号单(眼科检查特有)
样例 : 挂号单基础信息

挂号单基础信息

7.382. 检查检验患者摘要信息

名称 说明 类型

id
必填

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

sn
可选

患者SN号，同一连锁下SN号唯一
样例 : "100"

string

idCard
可选

患者身份证号
样例 : "string"

string

name
必填

姓名
样例 : "张三"

string

mobile
可选

手机号
样例 : "18080000000"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

age
可选

患者年龄大小
样例 : 患者年龄

患者年龄

idCardType
可选

证件类型
样例 : "身份证"

string

7.383. 检查检验报告

名称 说明 类型

id
可选

检查/检验报告id
样例 : "string"

string

imageFiles
可选

检查图像
样例 : [ "附件" ]

< 附件 > array

videoDescription
可选

影像描述
样例 : "string"

string

suggestion
可选

建议
样例 : "string"

string

inspectionSite
可选

检查部位
样例 : "string"

string

deviceModelDesc
可选

设备型号描述
样例 : "string"

string

diagnosisFlag
可选

诊断标志 0-阴性 10-阳性
样例 : 0

integer (int32)

recordDoctorId
可选

记录医生id
样例 : "string"

string

consultationDoctorId
可选

会诊医生id
样例 : "string"

string

recordDoctorName
可选

记录医生名字
样例 : "string"

string

consultationDoctorName
可选

会诊医生名字
样例 : "string"

string

diagnosisEntryItems
可选

诊断建议
样例 : [ "检查诊断信息" ]

< 检查诊断信息 > array

7.384. 检查检验报告修改请求

名称 说明 类型

id
可选

检查/检验报告id
样例 : "string"

string

imageFiles
可选

检查图像
样例 : [ "附件" ]

< 附件 > array

videoDescription
可选

影像描述
样例 : "string"

string

suggestion
可选

建议
样例 : "string"

string

diagnosisFlag
可选

诊断标志 0-阴性 10-阳性
样例 : 0

integer (int32)

recordDoctorId
可选

记录医生id
样例 : "string"

string

consultationDoctorId
可选

会诊医生id
样例 : "string"

string

inspectionSite
可选

检查部位
样例 : "string"

string

deviceModelDesc
可选

设备型号描述
样例 : "string"

string

isDeleted
可选

是否删除(删除时需要显式的指定) 0-否 1-是
样例 : 0

integer (int32)

diagnosisEntryItems
可选

诊断建议
样例 : [ "检查诊断信息" ]

< 检查诊断信息 > array

7.385. 检查检验摘要信息

名称 说明 类型

id
可选

检验单ID
样例 : "string"

string

orderNo
可选

订单号(新条码)
样例 : "string"

string

productId
可选

检验项目ID，在开启了合并模式的情况下为空
样例 : "string"

string

products
必填

检验项目列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "检验项目摘要信息" ]

< 检验项目摘要信息 > array

productIds
必填

检验项目ID列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "string" ]

< string > array

name
可选

检查项目名称
样例 : "string"

string

type
可选

类型 1:检验 2:检查
样例 : 1

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
样例 : 0

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

sampleType
可选

样本类型
样例 : "string"

string

patientOrderNo
可选

就诊单号
样例 : "string"

string

patientOrderType
可选

就诊单类型
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

送检医生
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string

patientInfo
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

status
可选

状态
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "待检"

string

7.386. 检查检验数据摘要信息

名称 说明 类型

diagnosis
可选

诊断
样例 : "string"

string

id
可选

检验单ID
样例 : "string"

string

orderNo
可选

订单号(新条码)
样例 : "string"

string

productId
可选

检验项目ID，在开启了合并模式的情况下为空
样例 : "string"

string

products
必填

检验项目列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "检验项目摘要信息" ]

< 检验项目摘要信息 > array

productIds
必填

检验项目ID列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "string" ]

< string > array

name
可选

检查项目名称
样例 : "string"

string

type
可选

类型 1:检验 2:检查
样例 : 1

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
样例 : 0

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

sampleType
可选

样本类型
样例 : "string"

string

patientOrderNo
可选

就诊单号
样例 : "string"

string

patientOrderType
可选

就诊单类型
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

送检医生
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string

patientInfo
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

status
可选

状态
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "待检"

string

7.387. 检查检验结果

名称 说明 类型

id
可选

指标项id
样例 : "string"

string

type
可选

指标项类型 1 数值型 2 文字型 3 阴阳型
样例 : 1

integer (int32)

name
可选

指标项名称
样例 : "string"

string

enName
可选

指标项编码
样例 : "string"

string

unit
可选

单位
样例 : "string"

string

itemCode
可选

检查子项 code
样例 : "string"

string

ref
可选

指标项参考范围 json字符串
样例 : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}"

string

productId
可选

检验项目id
样例 : "string"

string

resultDisplayScale
可选

指标项检查结果页面展示小数位数
样例 : 0

integer (int32)

value
可选

检查检验结果值 String|List<Attachment>|List<ExaminationDiagnosisItem>，根据valueType对应不同的value：valueType为STRING时，value为字符串；valueType为IMAGE，value为url字符串；valueType为ATTACHMENTS时，value为附件列表类型，附件结构详情见6.134
样例 : JsonNode

JsonNode

valueType
可选

值类型 STRING、IMAGE、ATTACHMENTS 默认STRING
样例 : "STRING"

string

abnormalFlag
可选

异常标志 “H”- 结果高于参考范围上限； “L” – 结果低于参考范围下限； “HH”-危机值高； “LL”-危机值低； “A” 阴阳型异常； “TA” 文字型异常； “N” 正常
样例 : "N"

string

abnormalText
可选

异常描述 abnormalFlag为TA时有效
样例 : "string"

string

7.388. 检查检验退费摘要

名称 说明 类型

id
可选

指标项ID
样例 : "string"

string

chargeSheetId
可选

收费单ID
样例 : "string"

string

chargeFormItemId
可选

收费单子项ID
样例 : "string"

string

outpatientFormItemId
可选

门诊单子项ID
样例 : "string"

string

patientOrderId
可选

门诊单ID
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

productId
可选

检验项目ID，在开启了合并模式的情况下为空
样例 : "string"

string

products
必填

检验项目列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "检验项目摘要信息" ]

< 检验项目摘要信息 > array

productIds
必填

检验项目ID列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "string" ]

< string > array

composeParentProductId
可选

套餐商品ID
样例 : "string"

string

composeParentName
可选

套餐名称
样例 : "string"

string

name
可选

检验项名称
样例 : "string"

string

orderNo
可选

检查单号
样例 : "string"

string

remark
可选

检验结果备注
样例 : "string"

string

testerId
可选

检验人ID
样例 : "string"

string

checkerId
可选

审核人ID
样例 : "string"

string

count
可选

检查报告次数
样例 : 0

integer (int32)

createdBy
可选

创建人
样例 : "string"

string

created
可选

创建时间
样例 : "string"

string (date-time)

type
可选

类型 1 检验 2 检查
样例 : 0

integer (int32)

subType
可选

子类型 检验：无意义；检查： 10-RIS检查 20-眼科检查
样例 : 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
样例 : 0

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

7.389. 检查检验项目信息

名称 说明 类型

id
可选

主键ID
样例 : "string"

string

shortId
可选

检查检验项目shortId
样例 : "string"

string

name
可选

项目名称
样例 : "string"

string

code
可选

项目代码
样例 : "string"

string

7.390. 检查诊断信息

名称 说明 类型

id
可选

诊断id
样例 : 0

integer (int64)

name
可选

诊断名称
样例 : "string"

string

abnormalFlag
可选

异常关注 0-正常 10-异常
样例 : 0

integer (int32)

7.391. 检验单修改信息

名称 说明 类型

attachments
可选

附件
样例 : [ "附件" ]

< 附件 > array

reports
可选

检查报告
样例 : [ "检查检验报告修改请求" ]

< 检查检验报告修改请求 > array

results
可选

检查结果
样例 : [ "检查检验结果" ]

< 检查检验结果 > array

eyeResults
可选

眼科检查结果
样例 : [ "眼科检查结果" ]

< 眼科检查结果 > array

deviceModelId
可选

设备型号id
样例 : 0

integer (int64)

deviceId
可选

设备id
样例 : 0

integer (int64)

subType
可选

检验单子类型 检验：无意义；检查： 10-RIS检查 20-眼科检查
样例 : 0

integer (int32)

remark
可选

备注
样例 : "string"

string

testerId
可选

检验人id，检验人ID和名称必须填一个
样例 : "string"

string

testerName
可选

检验人名称
样例 : "string"

string

checkerId
可选

审核人id，审核人ID和名称必须填一个
样例 : "string"

string

checkerName
可选

审核人名称
样例 : "string"

string

sampleType
可选

样本类型
样例 : "string"

string

testTime
必填

检验时间 yyyy-MM-dd HH:mm
样例 : "2022-11-14 14:00"

string

checkTime
可选

审核时间 yyyy-MM-dd HH:mm
样例 : "2022-11-14 14:00"

string

reportTime
可选

报告时间 yyyy-MM-dd HH:mm
样例 : "2022-11-14 14:00"

string

status
必填

状态 0:待检 1:已检(已审核) 2:已退 3:设备回传数据(检验待查看、检查待写报告) 4:待审核
样例 : 0

integer (int32)

relationPatientOrderId
可选

门诊单id
样例 : "string"

string

7.392. 检验检查设备列表响应

名称 说明 类型

devices
可选

样例 : [ "检查检验单设备信息" ]

< 检查检验单设备信息 > array

7.393. 检验项目摘要信息

名称 说明 类型

productId
可选

检验项目ID
样例 : "string"

string

productName
可选

检验项目名称
样例 : "string"

string

examinationSheetId
可选

检查检验单id
样例 : "string"

string

7.394. 治疗单信息

名称 说明 类型

id
可选

治疗单ID
样例 : "string"

string

type
可选

来源类型 2:检查检验 3:治疗理疗 8:商品 9:耗材 11:套餐 21:其他
样例 : 2

integer (int32)

productFormItems
可选

治疗单子项
样例 : [ "治疗单子项信息" ]

< 治疗单子项信息 > array

7.395. 治疗单处方

名称 说明 类型

id
可选

治疗单处方ID 为空表示新增，不为空表示更新
样例 : "0"

string

sourceFromType
必填

来源类型 2:检查检验 3:治疗理疗 8:商品 9:耗材 11:套餐 21:其他
样例 : 2

integer (int32)

productFormItems
必填

项目列表
样例 : [ "创建治疗项目请求" ]

< 创建治疗项目请求 > array

7.396. 治疗单子项信息

名称 说明 类型

id
可选

治疗单子项ID
样例 : "string"

string

productFormId
可选

治疗单ID
样例 : "string"

string

productId
可选

治疗项ID
样例 : "string"

string

name
可选

治疗项名称
样例 : "string"

string

unitCount
可选

单位次数
样例 : 0.0

number

unit
可选

单位
样例 : "string"

string

unitPrice
可选

单位价格
样例 : 0.0

number

isDismounting
可选

是否拆零 0:未拆零 1:拆零
样例 : 0

integer (int32)

type
可选

类型 1:药品 2:物资 3:检查 4:治疗 5:挂号(保)
样例 : 1

integer (int32)

subType
可选

子类型
样例 : 0

integer (int32)

days
可选

诊疗项目天数
样例 : 0

integer (int32)

dailyDosage
可选

每天次数
样例 : 0

integer (int32)

freq
可选

频率
样例 : "每日2次"

string

remark
可选

备注
样例 : "小心使用"

string

toothNos
可选

牙位 口腔使用
样例 : [ 12, 23 ]

< integer (int32) > array

7.397. 治疗项目执行请求

治疗项目执行请求

名称 说明 类型

id
必填

治疗项目ID
样例 : "ffffffff000000003484c3816487c002"

string

executeCount
必填

执行次数
最小值 : 0
样例 : 1

integer (int32)

7.398. 添加患者附件响应

名称 说明 类型

attachments
可选

附件列表
样例 : [ "患者附件" ]

< 患者附件 > array

7.399. 添加患者附件请求

名称 说明 类型

attachments
必填

附件列表
样例 : [ "患者附件信息" ]

< 患者附件信息 > array

7.400. 病区列表响应

名称 说明 类型

rows
可选

样例 : [ "病区基本信息" ]

< 病区基本信息 > array

total
可选

样例 : 0

integer (int32)

offset
可选

样例 : 0

integer (int32)

limit
可选

样例 : 0

integer (int32)

keyword
可选

样例 : "string"

string

7.401. 病区基本信息

名称 说明 类型

id
可选

病区ID
样例 : "ffffffff0000000006dddfe002e22000"

string

name
可选

病区名称
样例 : "内科病区"

string

location
可选

病区位置
样例 : "三楼一区"

string

wardRoomCount
可选

病房总数
样例 : 0

integer (int32)

wardBedCount
可选

病床总数
样例 : 0

integer (int32)

employeeCount
可选

成员总数
样例 : 0

integer (int32)

status
可选

病区状态 0:正常 90: 停用
样例 : 0

integer (int32)

departments
可选

关联科室
样例 : [ "科室信息" ]

< 科室信息 > array

7.402. 病历信息

名称 说明 类型

id
可选

病历ID
样例 : "string"

string

outpatientSheetId
可选

门诊单ID
样例 : "ffffffff00000000094c2a500293c000"

string

chiefComplaint
可选

主述/现病史
样例 : "咽痛，干咳，咳痰"

string

pastHistory
可选

既往史
样例 : "既往体健，既往有高血压"

string

familyHistory
可选

家族史
样例 : "string"

string

presentHistory
可选

现病史
样例 : "string"

string

physicalExamination
可选

体格检查
样例 : "string"

string

diagnosisInfos
可选

诊断信息
样例 : "JX.001.001,急性上呼吸道感染"

< DiagnosisRpcInfo > array

diagnosis
可选

诊断
样例 : "急性上呼吸道感染"

string

doctorAdvice
可选

医嘱
样例 : "string"

string

syndrome
可选

辨症
样例 : "string"

string

therapy
可选

治法
样例 : "string"

string

chineseExamination
可选

望闻切诊
样例 : "string"

string

wearGlassesHistory
可选

戴镜史
样例 : "近视"

string

epidemiologicalHistory
可选

流行病学史
样例 : "无"

string

obstetricalHistory
可选

妇科月经婚育史
样例 : "string"

string

eyeExamination
可选

眼科检查
样例 : 眼科检查

眼科检查

allergicHistory
可选

过敏史
样例 : "青霉素过敏"

string

auxiliaryExamination
可选

辅助检查
样例 : "无"

string

attachments
可选

附件列表
样例 : [ "附件" ]

< 附件 > array

7.403. 病床信息

名称 说明 类型

id
可选

床位id
样例 : "string"

string

chainId
可选

连锁ID
样例 : "string"

string

clinicId
可选

门店ID
样例 : "string"

string

wardAreaId
可选

病区id
样例 : "string"

string

wardRoomId
可选

病房id
样例 : "string"

string

bedNo
可选

床号
样例 : "string"

string

type
可选

类型:0诊疗床位10护理床位20养老床位
样例 : 0

integer (int32)

reserveReason
可选

留用原因：10患者包床20设备故障30临时停用90其他
样例 : 0

integer (int32)

reserveBeginTime
可选

预留开始时间
样例 : "string"

string (date-time)

reserveEndTime
可选

预留结束时间
样例 : "string"

string (date-time)

reserveRemark
可选

预留备注
样例 : "string"

string

curPatientOrderId
可选

住院单id
样例 : "string"

string

curPatientId
可选

使用人：患者id
样例 : "string"

string

enableStatus
可选

0停用1启用
样例 : 0

integer (int32)

useStatus
可选

0空闲10留用20已使用
样例 : 0

integer (int32)

remark
可选

床备注
样例 : "string"

string

isDeleted
可选

0未删除1已删除
样例 : 0

integer (int32)

7.404. 病床列表响应

名称 说明 类型

rows
可选

病床列表
样例 : [ "病床信息" ]

< 病床信息 > array

total
可选

总数
样例 : 50

integer (int32)

7.405. 病房列表响应

名称 说明 类型

rows
可选

病房列表
样例 : [ "病房基本信息" ]

< 病房基本信息 > array

total
可选

总数
样例 : 20

integer (int32)

7.406. 病房基本信息

名称 说明 类型

id
可选

病房id
样例 : "string"

string

name
可选

病房名称
样例 : "string"

string

totalBedsCount
可选

床位总数/病房床数
样例 : 0

integer (int32)

accommodationType
可选

入住方式：0:不允许混住 10:允许混住 20:男性病房 30:女性病房 40:不支持分配入住
样例 : 0

integer (int32)

remark
可选

备注
样例 : "string"

string

7.407. 皮试结果

名称 说明 类型

result
可选

结果
样例 : "阴性"

string

description
可选

描述
样例 : "执行人：王萍，执行时间：2022-04-13"

string

7.408. 盘点单事件

名称 说明 类型

checkOrderItemList
可选

盘点条目列表
样例 : [ "盘点条目" ]

< 盘点条目 > array

id
可选

盘点单ID
样例 : 0

integer (int64)

orderNo
可选

盘点单号
样例 : "PD20220526000001"

string

status
可选

盘点单状态 0:未知初始状态 10:新建待审批 20:审批被拒绝 30:完成(审批通过) 40:撤回
样例 : 0

integer (int32)

organId
可选

门店ID
样例 : "ffffffff0000000019b354880922800a"

string

organName
可选

门店
样例 : "高新大源店"

string

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

totalCostPriceChange
可选

盈亏金额（进价）
样例 : 0.0

number

totalPriceChange
可选

盈亏金额（售价）
样例 : 0.0

number

operator
可选

操作人（入库人）
样例 : "string"

string

operatorId
可选

操作人ID
样例 : "123456"

string

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

7.409. 盘点单详情

名称 说明 类型

checkOrderItemList
可选

盘点条目列表
样例 : [ "盘点条目" ]

< 盘点条目 > array

comment
可选

备注
样例 : 评论

评论

id
可选

盘点单ID
样例 : 0

integer (int64)

orderNo
可选

盘点单号
样例 : "PD20220526000001"

string

status
可选

盘点单状态 0:未知初始状态 10:新建待审批 20:审批被拒绝 30:完成(审批通过) 40:撤回
样例 : 0

integer (int32)

organId
可选

门店ID
样例 : "ffffffff0000000019b354880922800a"

string

organName
可选

门店
样例 : "高新大源店"

string

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

totalCostPriceChange
可选

盈亏金额（进价）
样例 : 0.0

number

totalPriceChange
可选

盈亏金额（售价）
样例 : 0.0

number

operator
可选

操作人（入库人）
样例 : "string"

string

operatorId
可选

操作人ID
样例 : "123456"

string

effectiveDate
可选

生效时间
样例 : "2022-04-07 15:12:53"

string (date-time)

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

7.410. 盘点条目

名称 说明 类型

id
可选

条目ID
样例 : 0

integer (int64)

productId
可选

商品编码
样例 : "string"

string

productShortId
可选

商品short编码
样例 : "string"

string

productName
可选

商品名称
样例 : "string"

string

specification
可选

规格
样例 : "string"

string

expiryDate
可选

有效期
样例 : "string"

string

productionDate
可选

生产日期
样例 : "yyyy-mm-dd"

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

stockId
可选

盘点批次ID
样例 : "string"

string

packageCostPrice
可选

包装成本单价
样例 : 0.0

number

beforePieceCount
可选

盘点前包装数量
样例 : 0.0

number

beforePackageCount
可选

盘点前制剂数量
样例 : 0.0

number

afterPieceCount
可选

盘点后包装数量
样例 : 0.0

number

afterPackageCount
可选

盘点后制剂数量
样例 : 0.0

number

changePieceCount
可选

盘点变更包装数量
样例 : 0.0

number

changePackageCount
可选

盘点变更制剂数量
样例 : 0.0

number

amount
可选

盘点变更总金额
样例 : 0.0

number

lastModified
可选

最后修改时间
样例 : "2022-05-13 12:22:56"

string (date-time)

checkBatches
可选

盘点发生的批次进销存信息
样例 : [ "单据进销存批次信息" ]

< 单据进销存批次信息 > array

7.411. 眼科检查

名称 说明 类型

items
可选

眼科检查项
样例 : [ "眼科检查项" ]

< 眼科检查项 > array

7.412. 眼科检查三级标题信息

名称 说明 类型

name
可选

标题名称
样例 : "string"

string

children
可选

眼科检查眼位信息
样例 : [ "眼科检查眼位信息" ]

< 眼科检查眼位信息 > array

7.413. 眼科检查二级标题信息

名称 说明 类型

name
可选

标题名称
样例 : "string"

string

children
可选

三级标题信息
样例 : [ "眼科检查三级标题信息" ]

< 眼科检查三级标题信息 > array

7.414. 眼科检查指标信息

名称 说明 类型

items
可选

指标项
样例 : [ "眼科检查指标项信息" ]

< 眼科检查指标项信息 > array

7.415. 眼科检查指标约束

名称 说明 类型

message
可选

消息
样例 : "string"

string

required
可选

是否必传
样例 : true

boolean

precision
可选

精度
样例 : 0

integer (int32)

scale
可选

小数位
样例 : 0

integer (int32)

min
可选

最小值
样例 : 0

integer (int32)

max
可选

最大值
样例 : 0

integer (int32)

size
可选

大小
样例 : 0

integer (int32)

unit
可选

单位
样例 : "string"

string

validateType
可选

验证类型
样例 : 0

integer (int32)

7.416. 眼科检查指标项信息

名称 说明 类型

id
可选

主键id
样例 : "string"

string

productId
可选

商品id
样例 : "string"

string

type
可选

指标项类型 1 数值型 2 文字型 3 阴阳型
样例 : 0

integer (int32)

name
可选

指标项名称
样例 : "string"

string

enName
可选

指标项名称编码
样例 : "string"

string

unit
可选

单位
样例 : "string"

string

ref
可选

指标项参考范围 json字符串
样例 : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}"

string

resultDisplayScale
可选

指标项检查结果页面展示小数位数
样例 : 0

integer (int32)

inspectType
可选

指标眼位类型 0 左眼 1 右眼 2 双眼
样例 : 0

integer (int32)

componentType
可选

指标组件类型
样例 : 0

integer (int32)

options
可选

指标项选项列表
样例 : [ "string" ]

< string > array

constraints
可选

指标项约束
样例 : [ "眼科检查指标约束" ]

< 眼科检查指标约束 > array

value
可选

检查结果值
样例 : "string"

string

sort
可选

排序编号
样例 : 0

integer (int32)

groupId
可选

分组id
样例 : 0

integer (int32)

displayName
可选

指标项展示名称
样例 : "string"

string

7.417. 眼科检查眼位信息

名称 说明 类型

inspectType
可选

眼位类型 1 单眼 2 双眼
样例 : 0

integer (int32)

children
可选

眼位信息
样例 : [ "眼科检查指标信息" ]

< 眼科检查指标信息 > array

7.418. 眼科检查结果

名称 说明 类型

productId
可选

眼科检查项目ID
样例 : "string"

string

name
可选

眼科检查项目名称
样例 : "string"

string

children
可选

眼科检查二级指标
样例 : [ "眼科检查二级标题信息" ]

< 眼科检查二级标题信息 > array

checker
可选

检查人
样例 : 检查人

检查人

7.419. 眼科检查项

名称 说明 类型

key
可选

眼科部位-key
样例 : "string"

string

name
可选

眼科部位-名称
样例 : "string"

string

rightEyeValue
可选

左眼
样例 : "string"

string

leftEyeValue
可选

右眼
样例 : "string"

string

7.420. 社保信息

名称 说明 类型

cardNo
可选

医保卡号
样例 : "shebaoCardInfo"

string

7.421. 科室人员信息

名称 说明 类型

employeeId
可选

员工ID
样例 : "10a861eb5b4d43b59721301073112029"

string

name
可选

员工姓名
样例 : "张三"

string

mobile
可选

手机号
样例 : "18088888888"

string

7.422. 科室信息

名称 说明 类型

id
可选

科室ID
样例 : "string"

string

name
可选

科室名称
样例 : "string"

string

7.423. 科室列表返回体

名称 说明 类型

departmentList
可选

科室摘要信息列表
样例 : [ "科室摘要信息" ]

< 科室摘要信息 > array

7.424. 科室摘要信息

名称 说明 类型

id
可选

科室ID
样例 : "ffffffff0000000006dddfe002e22000"

string

name
可选

科室名称
样例 : "儿保科室"

string

type
可选

科室是否接受预约
样例 : 1

integer (int32)

isClinical
可选

0:职能科室 1:门诊科室 2:儿保科室
样例 : 1

integer (int32)

mainMedicalName
可选

一级科目
样例 : "儿科"

string

mainMedicalCode
可选

一级科目编码
样例 : "50"

string

secondMedicalName
可选

二级科目
样例 : "小儿呼吸"

string

secondMedicalCode
可选

二级科目编码
样例 : "5001"

string

customId
可选

科室编码
样例 : "5001"

string

7.425. 科室详细信息（含科室人员列表）

名称 说明 类型

employees
可选

科室人员列表
样例 : [ "科室人员信息" ]

< 科室人员信息 > array

id
可选

科室ID
样例 : "ffffffff0000000006dddfe002e22000"

string

principal
可选

负责人
样例 : "张三"

string

name
可选

科室名称
样例 : "儿保科室"

string

phone
可选

联系电话
样例 : "18088888888"

string

created
可选

创建时间
样例 : "2019-04-11 10:48:07"

string (date-time)

type
可选

科室是否接受预约
样例 : 1

integer (int32)

isClinical
可选

0:职能科室 1:门诊科室 2:儿保科室
样例 : 1

integer (int32)

mainMedicalName
可选

一级科目
样例 : "儿科"

string

mainMedicalCode
可选

一级科目编码
样例 : "50"

string

secondMedicalName
可选

二级科目
样例 : "小儿呼吸"

string

secondMedicalCode
可选

二级科目编码
样例 : "5001"

string

customId
可选

科室编码
样例 : "5001"

string

7.426. 第三方支付信息

名称 说明 类型

transactionId
可选

支付方流水号
样例 : "string"

string

thirdPartyTransactionId
可选

三方平台流水号
样例 : "string"

string

channelTransactionId
可选

渠道平台流水号 微信 支付宝等单号
样例 : "string"

string

7.427. 结算单入库单出库单列表

名称 说明 类型

id
可选

出入库单ID
样例 : 0

integer (int64)

includeTaxPrice
可选

出入库单含税金额
样例 : 0.0

number

excludeTaxPrice
可选

出入库单不含税金额
样例 : 0.0

number

totalPackageCount
可选

出入库单数量
样例 : 0.0

number

clinicId
可选

出入库单门店ID
样例 : "string"

string

clinicName
可选

出入库单门店名称
样例 : "string"

string

orderInOutDate
可选

出入库时间
样例 : "string"

string (date-time)

orderCreatedUserName
可选

单据创建人名字
样例 : "string"

string

type
可选

出入库单类型 0:入库 1:出库
样例 : 0

integer (int32)

7.428. 结算单发票列表

名称 说明 类型

id
可选

发票ID
样例 : 0

integer (int64)

invoicedDate
可选

发票日期
样例 : "string"

string

invoiceNo
可选

发票号
样例 : "string"

string

7.429. 结算单条目列表

名称 说明 类型

id
可选

结算单条目ID
样例 : 0

integer (int64)

name
可选

名称
样例 : "string"

string

specification
可选

规格型号
样例 : "string"

string

unit
可选

单位
样例 : "string"

string

totalPackageCount
可选

数量
样例 : 0

integer (int32)

includeTaxPrice
可选

含税金额
样例 : 0.0

number

excludeTaxPrice
可选

不含税金额
样例 : 0.0

number

7.430. 结算数据 其中相关字段具体参考医疗保障信息平台基线接口文档的对应字典表

名称 说明 类型

sfsc
必填

是否删除 1代表为删除 0为非删除
样例 : "0"

string

sourceType
必填

数据来源 2-三方数据 21-药柜
样例 : 21

integer (int32)

sourceTypeDetail
可选

数据来源详情，包含展示名(displayName)和标识(id)
样例 : SourceTypeDetail

SourceTypeDetail

setlId
必填

结算ID
样例 : "32052507201636202450066275**"

string

mdtrtId
必填

就诊ID
样例 : "3205000000084292**"

string

psnNo
必填

人员编号
样例 : "3205990000000000001234**"

string

psnName
必填

人员姓名
样例 : "张**"

string

psnCertType
必填

人员证件类型 01-居民身份证 02-军官证 90-社会保障卡等，具体参考医疗保障信息平台基线接口文档的相关字典
样例 : "01"

string

certno
必填

证件号码
样例 : "320502199411"

string

gend
可选

性别 0-未知 1-男 2-女，具体参考医疗保障信息平台基线接口文档的相关字典
样例 : "1"

string

naty
可选

民族 01-汉族 02-蒙古族 03-回族等，具体参考医疗保障信息平台基线接口文档的相关字典
样例 : "01"

string

brdy
可选

出生日期
样例 : "1994-11-30"

string (date)

age
必填

年龄
样例 : 30.0

number

insutype
必填

险种类型 310-职工基本医疗保险 320-公务员医疗补助 390-城乡居民基本医疗保险等，具体参考医疗保障信息平台基线接口文档的相关字典
样例 : "310"

string

psnType
必填

人员类别
样例 : "1101"

string

cvlservFlag
必填

公务员标志
样例 : "0"

string

flxempeFlag
可选

灵活就业标志
样例 : "0"

string

nwbFlag
可选

新生儿标志
样例 : "0"

string

insuOptins
可选

参保机构医保区划
样例 : "320506"

string

empName
可选

单位名称
样例 : "某某医疗集团有限公司"

string

payLoc
可选

支付地点类别
样例 : "2"

string

fixmedinsCode
可选

定点医药机构编号
样例 : "H3205060**"

string

fixmedinsName
可选

定点医药机构名称
样例 : "某某市中医医院"

string

hospLv
可选

医院等级
样例 : "11"

string

fixmedinsPoolarea
可选

定点归属机构
样例 : "320599"

string

lmtpricHospLv
可选

限价医院等级
样例 : "9"

string

dedcHospLv
可选

起付线医院等级
样例 : "9"

string

begndate
可选

开始日期 yyyy-MM-dd
样例 : "2025-07-20"

string (date)

enddate
可选

结束日期 yyyy-MM-dd
样例 : "2025-07-20"

string (date)

setlTime
必填

结算时间 yyyy-MM-dd HH:mm:ss
样例 : "2025-07-20 16:36:18"

string (date-time)

mdtrtCertType
可选

就诊凭证类型 01 医保电子凭证 02 居民身份证 03 社会保障卡
样例 : "01"

string

medType
必填

医疗类别 11-门诊 21-住院 41-药店购药等，具体参考医疗保障信息平台基线接口文档的相关字典
样例 : "11"

string

clrType
必填

清算类别 11-门诊 21-住院 41-药店购药 99-其他，具体参考医疗保障信息平台基线接口文档的相关字典
样例 : "11"

string

clrWay
可选

清算方式
样例 : "1"

string

clrOptins
必填

清算经办机构
样例 : "320***"

string

medfeeSumamt
必填

医疗费总额
样例 : 166.0

number

fulamtOwnpayAmt
必填

全自费金额
样例 : 0.0

number

overlmtSelfpay
必填

超限价自费费用
样例 : 0.0

number

preselfpayAmt
必填

先行自付金额
样例 : 0.0

number

inscpScpAmt
必填

符合政策范围金额
样例 : 166.0

number

actPayDedc
可选

实际支付起付线
样例 : 0.0

number

hifpPay
必填

基本医疗保险统筹基金支出
样例 : 0.0

number

poolPropSelfpay
必填

基本医疗保险统筹基金支付比例
样例 : 0.0

number

cvlservPay
必填

公务员医疗补助资金支出
样例 : 0.0

number

hifesPay
必填

企业补充医疗保险基金支出
样例 : 0.0

number

hifmiPay
必填

居民大病保险资金支出
样例 : 0.0

number

hifobPay
必填

职工大额医疗费用补助基金支出
样例 : 0.0

number

hifdmPay
可选

伤残基金
样例 : 0.0

number

mafPay
必填

医疗救助基金支出
样例 : 0.0

number

prefFundPay
可选

优抚对象基金支出
样例 : 0.0

number

othPay
必填

其他支出
样例 : 0.0

number

fundPaySumamt
必填

基金支付总额
样例 : 0.0

number

psnPay
必填

个人负担总金额
样例 : 166.0

number

acctPay
必填

个人账户支出
样例 : 0.0

number

cashPayamt
必填

个人现金支出
样例 : 166.0

number

balc
必填

余额
样例 : 0.0

number

acctMulaidPay
必填

个人账户共济支付金额
样例 : 0.0

number

medinsSetlId
必填

医药机构结算ID
样例 : "32052507201636202450066275**"

string

refdSetlFlag
可选

退费结算标志
样例 : "0"

string

year
可选

年度
样例 : "2025"

string

diseCodg
可选

病种编码
样例 : "M54.505"

string

diseName
可选

病种名称
样例 : "腰肌劳损"

string

invono
可选

发票号
样例 : "string"

string

opterId
可选

经办人ID
样例 : "380314755738704**"

string

opterName
可选

经办人姓名
样例 : "李**"

string

optTime
可选

经办时间 yyyy-MM-dd HH:mm:ss
样例 : "2025-07-20 16:36:18"

string (date-time)

extendSetlDetail
可选

结算时输出的扩展信息
样例 : JsonNode

JsonNode

wltpayAmt
可选

医保钱包支付
样例 : 0.0

number

thirdPartPaymentResultItems
必填

费用明细数据
样例 : [ "费用明细" ]

< 费用明细 > array

substitutes
可选

基金分项数据
样例 : [ "基金分项" ]

< 基金分项 > array

7.431. 职称信息

名称 说明 类型

type
可选

类别
样例 : "04|护理人员"

string

title
可选

名称
样例 : "13|主管护师"

string

7.432. 药房库存信息

名称 说明 类型

pharmacyNo
必填

样例 : 0

integer (int32)

pharmacyName
必填

药房名称
样例 : "本地药房"

string

stockPieceCount
必填

可售小包装库存
样例 : 20.0

number

stockPackageCount
必填

可售大包装库存
样例 : 10.0

number

7.433. 药房详情

名称 说明 类型

no
可选

药房号
样例 : 0

integer (int32)

7.434. 被修正的入库单信息

被修正的入库单信息

名称 说明 类型

id
可选

入库单ID
样例 : 0

integer (int64)

orderNo
可选

入库单号
样例 : "string"

string

outOrderNo
可选

入库随货单号
样例 : "string"

string

7.435. 要货单事件

名称 说明 类型

comment
可选

备注
样例 : 评论

评论

id
可选

要货单ID
样例 : 0

integer (int64)

claimOrderItemList
可选

要货单条目列表
样例 : [ "要货单条目" ]

< 要货单条目 > array

orderNo
可选

要货单号
样例 : "YH2025101000001"

string

status
可选

要货单状态 0:待审核 1:已审核 9:已驳回 10:已终止 31:已撤销
样例 : 0

integer (int32)

kindCount
可选

要货品种数
样例 : 2

integer (int32)

claimOrganName
可选

要门店名称
样例 : "string"

string

claimOrganId
可选

要货门店ID
样例 : "string"

string

applyEmployeeId
可选

要货人ID
样例 : "string"

string

applyEmployeeName
可选

要货人
样例 : "string"

string

claimOrderDate
可选

要货日期
样例 : "2024-11-06 16:51:03"

string (date-time)

created
可选

创建时间
样例 : "2024-11-06 16:51:03"

string (date-time)

7.436. 要货单条目

名称 说明 类型

id
可选

条目ID
样例 : 123123

integer (int64)

productId
可选

商品ID
样例 : "ffffffff000000003473c049d7ab4000"

string

productShortId
可选

商品编码
样例 : "000251"

string

productName
可选

商品名称
样例 : "阿莫西林胶囊"

string

pieceCount
可选

要货小包装数量
样例 : 0.0

number

packageCount
可选

要货大包装数量
样例 : 1.0

number

approvePieceCount
可选

批准要货小包装数量
样例 : 0.0

number

approvePackageCount
可选

批准要货大包装数量
样例 : 1.0

number

7.437. 要货单详情

名称 说明 类型

comment
可选

备注
样例 : 评论

评论

id
可选

要货单ID
样例 : 0

integer (int64)

claimOrderItemList
可选

要货单条目列表
样例 : [ "要货单条目" ]

< 要货单条目 > array

orderNo
可选

要货单号
样例 : "YH2025101000001"

string

status
可选

要货单状态 0:待审核 1:已审核 9:已驳回 10:已终止 31:已撤销
样例 : 0

integer (int32)

kindCount
可选

要货品种数
样例 : 2

integer (int32)

claimOrganName
可选

要门店名称
样例 : "string"

string

claimOrganId
可选

要货门店ID
样例 : "string"

string

applyEmployeeId
可选

要货人ID
样例 : "string"

string

applyEmployeeName
可选

要货人
样例 : "string"

string

claimOrderDate
可选

要货日期
样例 : "2024-11-06 16:51:03"

string (date-time)

created
可选

创建时间
样例 : "2024-11-06 16:51:03"

string (date-time)

7.438. 评论

名称 说明 类型

time
可选

评论时间
样例 : "string"

string (date-time)

content
可选

评论内容
样例 : "string"

string

employeeId
可选

评论人ID
样例 : "string"

string

employeeName
可选

评论人名称
样例 : "string"

string

7.439. 调拨批次

名称 说明 类型

stockId
可选

调拨库存ID（如果没指定批次，这个字段为空）
样例 : 0

integer (int64)

batchNo
可选

调拨批次号
样例 : "string"

string

expiryDate
可选

过期时间 yyyy-MM-dd
样例 : "string"

string

packageCount
可选

大包装数量
样例 : 0.0

number

pieceCount
可选

小包装数量
样例 : 0.0

number

outPackageCostPrice
可选

调拨成本价
样例 : 0.0

number

7.440. 费用明细

名称 说明 类型

name
可选

项目名称
样例 : "中医刮痧"

string

feedetlSn
可选

费用明细流水号
样例 : "3507eb6cea0b**"

string

psnNo
可选

人员编号
样例 : "3205990000000000001234**"

string

chrgBchno
可选

收费批次号
样例 : "3507eb6e43"

string

diseCodg
可选

病种编码
样例 : "M54.505"

string

rxno
可选

处方号
样例 : "3507eb6cea0b**"

string

rxCircFlag
可选

外购处方标志
样例 : "0"

string

feeOcurTime
可选

费用发生时间 yyyy-MM-dd HH:mm:ss
样例 : "2025-07-20 16:36:02"

string

medListCodg
可选

医疗目录编码
样例 : "014100000"

string

medinsListCodg
可选

医药机构目录编码
样例 : "中医刮痧"

string

detItemFeeSumamt
必填

明细项目费用总额
样例 : 88.0

number

cnt
必填

数量
样例 : 1.0

number

pric
必填

单价
样例 : 88.0

number

costPrice
可选

进价
样例 : 88.0

number

unit
可选

单位
样例 : "次"

string

sinDosDscr
可选

单次剂量描述
样例 : "1.0"

string

usedFrquDscr
可选

使用频次描述
样例 : "string"

string

prdDays
可选

周期天数
样例 : 1.0

number

medcWayDscr
可选

用药途径描述
样例 : "string"

string

bilgDeptCodg
可选

开单科室编码 A01-预防保健科 A03-内科 A20-急诊医学科等，具体参考医疗保障信息平台基线接口文档的相关字典
样例 : "A03"

string

bilgDeptName
可选

开单科室名称
样例 : "内科"

string

bilgDrCodg
可选

开单医生编码
样例 : "D320508008900"

string

bilgDrName
可选

开单医师姓名
样例 : "王**"

string

acordDeptCodg
可选

受单科室编码 A01-预防保健科 A03-内科 A20-急诊医学科等，具体参考医疗保障信息平台基线接口文档的相关字典
样例 : "A03"

string

acordDeptName
可选

受单科室名称
样例 : "内科"

string

ordersDrCode
可选

受单医生编码
样例 : "D320508008900"

string

ordersDrName
可选

受单医生姓名
样例 : "王**"

string

hospApprFlag
可选

医院审批标志
样例 : "1"

string

tcmdrugUsedWay
可选

中药使用方式
样例 : "string"

string

etipFlag
可选

外检标志
样例 : "0"

string

etipHospCode
可选

外检医院编码
样例 : "string"

string

dscgTkdrugFlag
可选

出院带药标志
样例 : "0"

string

matnFeeFlag
可选

生育费用标志
样例 : "0"

string

pricUplmtAmt
必填

定价上限金额
样例 : 114.0

number

selfpayProp
可选

自付比例
样例 : 0.0

number

fulamtOwnpayAmt
可选

全自费金额
样例 : 0.0

number

overlmtAmt
可选

超限价金额
样例 : 0.0

number

preselfpayAmt
可选

先行自付金额
样例 : 0.0

number

inscpScpAmt
可选

符合政策范围金额
样例 : 88.0

number

chrgitmLv
必填

收费项目等级
样例 : "01"

string

medChrgitmType
必填

医疗收费项目类别
样例 : "02"

string

basMednFlag
可选

基本药物标志
样例 : "0"

string

hiNegoDrugFlag
可选

医保谈判药品标志
样例 : "0"

string

chldMedcFlag
可选

儿童用药标志
样例 : "0"

string

listSpItemFlag
可选

目录特项标志
样例 : "string"

string

lmtUsedFlag
可选

限制使用标志
样例 : "0"

string

drtReimFlag
可选

直报标志
样例 : "0"

string

memo
可选

备注
样例 : "string"

string

extend
可选

各地扩展信息-非国标标准数据
样例 : JsonNode

JsonNode

doseCount
可选

帖数
样例 : 1.0

number

7.441. 输注处方请求

名称 说明 类型

id
可选

处方id 为空表示新增，不为空表示更新
样例 : "0"

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次
样例 : "qd"

string

isTotalPriceChanged
必填

是否议价 0:不议价 1:议价，默认值为 0
样例 : 1

integer (int32)

days
可选

天数
样例 : 5

integer (int32)

expectedTotalPrice
可选

期望处方总价（议价时使用）
样例 : 10.0

number

ivgtt
可选

输注速度
样例 : 50.0

number

prescriptionFormItems
可选

样例 : [ "创建输注处方药品请求" ]

< 创建输注处方药品请求 > array

ivgttUnit
可选

输注速度单位
样例 : "滴/分钟"

string

7.442. 进销存明细

名称 说明 类型

stockLogId
必填

进销存明细ID
样例 : "123456"

string

date
必填

进销存发生日期 yyyy-MM-dd HH:mm:ss
样例 : "2020-03-05 12:00:00"

string

productId
必填

商品ID
样例 : "ffffffff00000000347730f37eb54000"

string

productShortId
可选

商品编码
样例 : "H12334"

string

productName
可选

商品名称
样例 : "阿莫西林"

string

pieceCount
可选

制剂库存变化量
样例 : 10.0

number

packageCount
可选

整包装库存变化量
样例 : 1.0

number

action
必填

进销存类型：发药、退药、采购入库、退货出库…
样例 : "发药"

string

orderId
必填

单据ID
样例 : "123456"

string

orderItemId
必填

订单条目ID
样例 : "123456789"

string

patientOrderId
可选

就诊单ID，仅发药、退药时有值
样例 : "ffffffff00000000347ce07462de0001"

string

sourceOrderId
可选

来源单据ID 发药、退药：收费单ID
样例 : "ffffffff00000000347ce07462de0001"

string

sourceOrderItemId
可选

来源订单条目ID 发药、退药：收费项ID
样例 : "ffffffff00000000347ce07462de0001"

string

packageCostPrice
可选

大包装单位成本价
样例 : 10.0

number

batchId
必填

批次ID
样例 : 123456

integer (int64)

batchNo
可选

生产批号
样例 : "20200305"

string

productionDate
可选

生产日期
样例 : "2020-03-05"

string

expireDate
可选

效期
样例 : "2020-03-05"

string

inOrderId
可选

进销存关联的入库单ID
样例 : 123456

integer (int64)

inOrderItemId
可选

进销存关联的入库单条目ID
样例 : 12345678

integer (int64)

inOrderItemOutDetailId
可选

入库单明细外部明细ID
样例 : "X12345678"

string

costPrice
可选

成本价变化量
样例 : -10.0

number

salePrice
可选

变更实收
样例 : 10.0

number

pieceNum
可选

制剂数量
样例 : 7

integer (int32)

traceableCodeList
可选

追溯码列表
样例 : [ "追溯码视图信息" ]

< 追溯码视图信息 > array

7.443. 进销存明细返回体

名称 说明 类型

detailsList
可选

进销存明细列表
样例 : [ "进销存明细" ]

< 进销存明细 > array

total
可选

总数
样例 : 10

integer (int32)

7.444. 进销存：进销存明细

名称 说明 类型

date
可选

日期（格式yyyy-MM-dd）
样例 : "2020-03-05"

string (date)

orderIdList
可选

入库单、出库单、盘点单、发药单ID
样例 : [ "12334234", "456667" ]

< string > array

chargeSheetList
可选

收费单列表，仅 type 为 3 时有效，orderIdList 的优先级更高
样例 : [ "根据收费单查询进销存明细" ]

< 根据收费单查询进销存明细 > array

type
必填

进销存单据类型 1:出库 2:盘点 3:发退药 4:调拨
样例 : 1

integer (int32)

offset
可选

页偏移，如果按照日期拉取，则必填，默认值为0
最小值 : 0
样例 : 0

integer (int32)

limit
可选

每页大小，如果按照日期拉取，则必填，默认值为 10，最大值为 100
最小值 : 1
最大值 : 100
样例 : 10

integer (int32)

7.445. 连锁商品自定义分类

名称 说明 类型

id
可选

自定义分类ID
样例 : "43794"

string

typeId
可选

所属系统分类ID
样例 : 18

integer (int32)

name
可选

自定义分类名称
样例 : "物资"

string

7.446. 连锁商品自定义分类响应

名称 说明 类型

list
可选

连锁商品自定义分类列表
样例 : [ "连锁商品自定义分类" ]

< 连锁商品自定义分类 > array

7.447. 追溯码信息

名称 说明 类型

no
必填

追溯码
样例 : "86975041000000000000"

string

hisPieceCount
必填

追溯码分配小单位数量
样例 : 10.0

number

hisPackageCount
必填

追溯码分配大单位数量
样例 : 1.0

number

7.448. 追溯码视图信息

名称 说明 类型

no
可选

追溯码
样例 : "86975041000000000000"

string

type
必填

码的业务类型，0:正常的追溯码，10:无追溯码
样例 : 0

integer (int32)

hisPieceCount
可选

追溯码分配小单位数量（新版本追溯码采集才有）
样例 : 10.0

number

hisPackageCount
可选

追溯码分配大单位数量（新版本追溯码采集才有）
样例 : 1.0

number

count
可选

追溯码个数（老版本追溯码采集才有）
样例 : 1.0

number

7.449. 退药请求参数

名称 说明 类型

dispensingForms
必填

发药单处方列表
样例 : [ "处方信息请求" ]

< 处方信息请求 > array

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.450. 退费form请求

名称 说明 类型

id
必填

收费formId
样例 : "00000000000000000000000000000000"

string

chargeFormItems
可选

收费项列表
样例 : [ "收费项退费请求" ]

< 收费项退费请求 > array

7.451. 通过商品ID查询商品库存请求参数

名称 说明 类型

productIds
必填

商品ID列表
样例 : [ "string" ]

< string > array

7.452. 通过商品ID查询商品批次请求参数

名称 说明 类型

productIds
必填

商品ID列表，最大不能超过 10 个
样例 : [ "string" ]

< string > array

7.453. 通过药品编码查询商品信息响应

名称 说明 类型

products
可选

商品信息列表
样例 : [ "商品信息" ]

< 商品信息 > array

7.454. 通过药品编码查询药品信息请求

名称 说明 类型

productShortIds
可选

商品短ID
样例 : [ "string" ]

< string > array

7.455. 采购单事件

名称 说明 类型

comment
可选

备注
样例 : 评论

评论

id
可选

采购单ID
样例 : 0

integer (int64)

orderNo
可选

采购单号
样例 : "CG2024110600001"

string

purchaseOrderItemList
可选

采购单条目列表
样例 : [ "采购单条目" ]

< 采购单条目 > array

status
可选

采购单状态,0:待审核 1:审核通过 9:审核驳回 31:撤回 药店特有，60:待收货 62:待验收 64:待入库 66:已入库
样例 : 0

integer (int32)

supplierId
可选

供应商id，药店有值
样例 : "ffffffff0000000034af4ae82d69c000"

string

orderType
可选

采购类型，0：线下集采，10：ABC商城采购
样例 : 0

integer (int32)

supplier
可选

供应商，药店有值
样例 : "测试供应商"

string

purchaseOrganName
可选

采购门店名称
样例 : "string"

string

receiveOrganId
可选

收货机构id，药店有值
样例 : "ffffffff0000000034d6d4adbec04000"

string

purchaseOrganId
可选

采购门店ID
样例 : "string"

string

receiveOrganName
可选

收货机构，药店有值
样例 : "abc"

string

applyEmployeeId
可选

申请人ID
样例 : "string"

string

applyEmployeeName
可选

申请人
样例 : "string"

string

purchaseOrderDate
可选

采购日期
样例 : "2024-11-06 16:51:03"

string (date-time)

created
可选

创建时间
样例 : "2024-11-06 16:51:03"

string (date-time)

7.456. 采购单列表

名称 说明 类型

purchaseOrderList
可选

采购单列表
样例 : [ "库存采购单信息" ]

< 库存采购单信息 > array

7.457. 采购单条目

名称 说明 类型

id
可选

条目ID
样例 : 123123

integer (int64)

productId
可选

商品ID
样例 : "ffffffff000000003473c049d7ab4000"

string

productShortId
可选

商品编码
样例 : "000251"

string

productName
可选

商品名称
样例 : "阿莫西林胶囊"

string

pieceCount
可选

采购小包装数量
样例 : 0.0

number

packageCount
可选

采购大包装数量
样例 : "盒"

number

7.458. 采购单详情

名称 说明 类型

comment
可选

备注
样例 : 评论

评论

id
可选

采购单ID
样例 : 0

integer (int64)

orderNo
可选

采购单号
样例 : "CG2024110600001"

string

purchaseOrderItemList
可选

采购单条目列表
样例 : [ "采购单条目" ]

< 采购单条目 > array

status
可选

采购单状态,0:待审核 1:审核通过 9:审核驳回 31:撤回 药店特有，60:待收货 62:待验收 64:待入库 66:已入库
样例 : 0

integer (int32)

supplierId
可选

供应商id，药店有值
样例 : "ffffffff0000000034af4ae82d69c000"

string

orderType
可选

采购类型，0：线下集采，10：ABC商城采购
样例 : 0

integer (int32)

supplier
可选

供应商，药店有值
样例 : "测试供应商"

string

purchaseOrganName
可选

采购门店名称
样例 : "string"

string

receiveOrganId
可选

收货机构id，药店有值
样例 : "ffffffff0000000034d6d4adbec04000"

string

purchaseOrganId
可选

采购门店ID
样例 : "string"

string

receiveOrganName
可选

收货机构，药店有值
样例 : "abc"

string

applyEmployeeId
可选

申请人ID
样例 : "string"

string

applyEmployeeName
可选

申请人
样例 : "string"

string

purchaseOrderDate
可选

采购日期
样例 : "2024-11-06 16:51:03"

string (date-time)

created
可选

创建时间
样例 : "2024-11-06 16:51:03"

string (date-time)

7.459. 门店人员列表返回体

名称 说明 类型

employeeList
可选

门店人员信息列表
样例 : [ "门店人员详细信息" ]

< 门店人员详细信息 > array

7.460. 门店人员详细信息

名称 说明 类型

departmentList
可选

样例 : [ "科室摘要信息" ]

< 科室摘要信息 > array

id
可选

员工ID
样例 : "ffffffff0000000017ea20500df64000"

string

position
可选

职务
样例 : "string"

string

headImgUrl
可选

头像
样例 : "string"

string

name
可选

员工姓名
样例 : "张三"

string

mobile
可选

手机号
样例 : "13888888888"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1987-04-12"

string

role
可选

角色
样例 : "医生"

string

certNo
可选

样例 : "string"

string

nationalDoctorCode
可选

国家医生编码
样例 : "string"

string

practiceCertCode
可选

样例 : "string"

string

introduction
可选

介绍
样例 : "毕业于陆军军医大学临床医学七年制"

string

practiceInfos
可选

职称信息列表
样例 : [ "职称信息" ]

< 职称信息 > array

practiceImgUrl
可选

执业照
样例 : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/clinic-usage/fff730ccc5ee45d783d82a85b8a0e52d/license/dog_v2vHea4SK8gb.jpeg"

string

goodAt
可选

医生擅长
样例 : "擅长中医内科"

string

roles
可选

员工角色列表 0-管理员：1-医生 2-护士 3-检验师 4-理疗师 5-医助 6-其他 7-库管 8-采购 9-视光师 10-检查技师 11-咨询师 …
样例 : [ 1, 2, 3 ]

< integer (int32) > array

doctorTags
可选

医生标签
样例 : "省级名中医、市级名中医"

< string > array

7.461. 门店信息

名称 说明 类型

id
可选

门店ID
样例 : "fff730ccc5ee45d783d82a85b8a0e52d"

string

parentId
可选

连锁ID（总部ID）
样例 : "fff730ccc5ee45d783d82a85b8a0e520"

string

hisType
可选

门店类型 0:ABC诊所管家 1:口腔管家 2:眼科管家
样例 : 0

integer (int32)

name
可选

门店名称
样例 : "中医诊所高新店"

string

phone
可选

联系电话
样例 : "13888888888"

string

category
可选

门店类型
样例 : "中医诊所"

string

provinceName
可选

门店所处省份
样例 : "四川省"

string

cityName
可选

门店所处城市
样例 : "成都市"

string

districtName
可选

门店所处区域
样例 : "高新区"

string

addressDetail
可选

门店详细地址
样例 : "高新区100号"

string

7.462. 门店医生排班状态响应

名称 说明 类型

doctorShifts
可选

门店医生排班列表
样例 : [ "门店排班医生信息" ]

< 门店排班医生信息 > array

7.463. 门店排班医生信息

名称 说明 类型

showInWeClinic
可选

是否展示在微诊所 0:否 1:是，因为开放平台的接口返回的是所有排版的医生，如果接入方想要保持和微诊所一致的话，就能自己通过这个标识做过滤
样例 : 1

integer (int32)

doctor
可选

医生信息
样例 : 医生信息

医生信息

status
可选

排班状态 0:有号 1:约满 2:无号（排班班次拆分后的总预约单元格为空，如：班次时长不满足最小服务时长等） 3:未放号 4:完诊（最晚排班结束时间已过） 5:无排班 6:停诊
样例 : 0

integer (int32)

7.464. 门店摘要信息

名称 说明 类型

id
可选

机构ID
样例 : "string"

string

name
可选

机构名称
样例 : "string"

string

7.465. 门诊单信息

名称 说明 类型

id
可选

门诊单ID
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

registrationSheetId
可选

挂号单ID
样例 : "string"

string

departmentId
可选

就诊科室ID
样例 : "string"

string

departmentName
可选

就诊科室名称
样例 : "string"

string

doctorId
可选

就诊医生ID
样例 : "string"

string

doctorName
可选

就诊医生名字
样例 : "string"

string

created
可选

创建时间
样例 : "string"

string (date-time)

diagnosedDate
可选

首次完成诊断时间
样例 : "string"

string (date-time)

status
可选

状态 0:未诊 1:已诊
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "string"

string

medicalRecord
可选

病历记录信息
样例 : 病历信息

病历信息

prescriptionChineseForms
可选

中药处方
样例 : [ "处方信息" ]

< 处方信息 > array

prescriptionWesternForms
可选

西药处方
样例 : [ "处方信息" ]

< 处方信息 > array

prescriptionInfusionForms
可选

输注处方
样例 : [ "处方信息" ]

< 处方信息 > array

prescriptionExternalForms
可选

外治处方
样例 : [ "处方信息" ]

< 处方信息 > array

productForms
可选

治疗单处方
样例 : [ "治疗单信息" ]

< 治疗单信息 > array

7.466. 门诊单摘要信息

名称 说明 类型

id
可选

门诊单ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

created
可选

创建时间
样例 : "string"

string (date-time)

doctorId
可选

就诊医生ID
样例 : "string"

string

doctorName
可选

就诊医生名字
样例 : "string"

string

patientOrderNo
可选

诊号
样例 : "0000000001"

string

status
可选

状态 0:未诊 1:已诊
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "string"

string

7.467. 门诊单详细信息

名称 说明 类型

id
必填

门诊单ID
样例 : "string"

string

clinicId
必填

门店ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

patientOrderNo
可选

诊号
样例 : "00019691"

string

departmentId
可选

就诊科室ID
样例 : "string"

string

departmentName
可选

就诊科室名称
样例 : "string"

string

doctorId
可选

就诊医生ID
样例 : "string"

string

doctorName
可选

就诊医生名字
样例 : "string"

string

created
必填

创建时间
样例 : "string"

string (date-time)

diagnosedDate
可选

首次完成诊断时间
样例 : "string"

string (date-time)

status
必填

状态 0:未诊 1:已诊
样例 : 0

integer (int32)

statusName
必填

状态名称
样例 : "string"

string

revisitStatus
可选

初复诊标识 1:初诊 2:复诊
样例 : 1

integer (int32)

patient
可选

患者信息
样例 : 患者摘要信息

患者摘要信息

medicalRecord
可选

病历记录信息
样例 : 病历信息

病历信息

prescriptionChineseForms
可选

中药处方
样例 : [ "中药处方信息" ]

< 中药处方信息 > array

prescriptionWesternForms
可选

西药处方
样例 : [ "处方信息" ]

< 处方信息 > array

prescriptionInfusionForms
可选

输注处方
样例 : [ "处方信息" ]

< 处方信息 > array

prescriptionExternalForms
可选

外治处方
样例 : [ "处方信息" ]

< 处方信息 > array

productForms
可选

治疗单处方
样例 : [ "治疗单信息" ]

< 治疗单信息 > array

7.468. 门诊单请求参数

名称 说明 类型

departmentId
必填

医生科室ID
样例 : "string"

string

doctorId
必填

医生ID
样例 : "string"

string

patientId
必填

患者ID
样例 : "string"

string

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

medicalRecord
必填

病历
样例 : 创建病历请求

创建病历请求

prescriptionChineseForms
可选

中药处方列表
样例 : [ "创建中药处方请求参数" ]

< 创建中药处方请求参数 > array

prescriptionWesternForms
可选

西药处方列表
样例 : [ "处方基类" ]

< 处方基类 > array

prescriptionInfusionForms
可选

输注处方列表
样例 : [ "输注处方请求" ]

< 输注处方请求 > array

prescriptionExternalForms
可选

外治处方列表
样例 : [ "外治处方请求" ]

< 外治处方请求 > array

productForms
可选

治疗处方单列表
样例 : [ "治疗单处方" ]

< 治疗单处方 > array

revisitStatus
可选

初复诊状态 1:初诊 2:复诊
样例 : 1

integer (int32)

shebaoChargeType
可选

门诊费别 1:自费门诊 2:医保普通门诊 3:医保慢特病门诊
样例 : 1

integer (int32)

7.469. 附件

名称 说明 类型

url
必填

url
样例 : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg"

string

fileName
可选

文件名称
样例 : "NatGeo09.jpg"

string

fileSize
可选

文件大小
样例 : 4771201

integer (int32)

7.470. 项目指定日期号源信息响应

名称 说明 类型

registrationCategoryDaysShifts
可选

挂号种类号源信息
样例 : [ "项目预约种类号源信息" ]

< 项目预约种类号源信息 > array

7.471. 项目预约号源信息

名称 说明 类型

date
必填

日期（yyyy-MM-dd）
样例 : "2024-03-05"

string

status
必填

排班状态 0:有号 1:约满 2:无号（排班班次拆分后的总预约单元格为空，如：班次时长不满足最小服务时长等） 3:未放号 4:完诊（最晚排班结束时间已过） 5:无排班
样例 : 0

integer (int32)

7.472. 项目预约种类号源信息

名称 说明 类型

status
可选

排班状态 0:有号 1:约满 2:无号（排班班次拆分后的总预约单元格为空，如：班次时长不满足最小服务时长等） 3:未放号 4:完诊（最晚排班结束时间已过） 5:无排班
样例 : 0

integer (int32)

registrationCategory
可选

挂号种类；0：普通门诊；1：专家门诊；2：便民门诊；
样例 : 0

integer (int32)

dayShifts
可选

按时段展示，上午/下午/晚上 或者 自定义时段
样例 : [ "预约项目排班信息" ]

< 预约项目排班信息 > array

7.473. 预约号单元格信息

名称 说明 类型

orderNo
可选

号数，目前只针对精确预约、自定义时段预约有效
样例 : 5

integer (int32)

start
可选

开始时间 HH:mm
样例 : "09:00"

string

end
可选

结束时间 HH:mm
样例 : "09:20"

string

timeOfDay
可选

时段；上午/下午/晚上
样例 : "上午"

string

count
可选

剩余号数
样例 : 1

integer (int32)

totalCount
可选

总号数
样例 : 1

integer (int32)

7.474. 预约备注模板

名称 说明 类型

id
必填

主键ID
样例 : "string"

string

registrationType
必填

预约类型 0:门诊预约
样例 : 0

integer (int32)

content
可选

内容
样例 : "string"

string

sort
必填

顺序
样例 : 0

integer (int32)

disableModify
必填

是否禁止修改 0:不禁止 1:禁止
样例 : 0

integer (int32)

disableDelete
必填

是否禁止删除 0:不禁止 1:禁止
样例 : 0

integer (int32)

7.475. 预约时段

名称 说明 类型

timeOfDay
可选

上午/下午/晚上
样例 : "string"

string

start
可选

时段开始时间; HH:mm
样例 : "string"

string

end
可选

时段结束时间; HH:mm
样例 : "string"

string

list
可选

当前时段可用的号源集合
样例 : [ "当前时段可用的号源" ]

< 当前时段可用的号源 > array

7.476. 预约项目信息

名称 说明 类型

id
必填

预约项目ID
样例 : "ffffffff000000000000000000000001"

string

introduce
可选

介绍
样例 : "专业按摩，疏通筋骨"

string

name
必填

预约项目名称
样例 : "针灸"

string

price
可选

预约项目价格（仅仅用于展示，到店再支付项目费用）
样例 : 100.0

number

attachments
可选

附件介绍
样例 : [ "附件" ]

< 附件 > array

7.477. 预约项目排班信息

名称 说明 类型

start
可选

开始时间
样例 : "08:00"

string

end
可选

结束时间
样例 : "08:30"

string

timeOfDay
可选

上午/下午/晚上
样例 : "上午"

string

status
可选

排班状态 0:有号 1:约满 2:无号（排班班次拆分后的总预约单元格为空，如：班次时长不满足最小服务时长等） 3:未放号 4:完诊（最晚排班结束时间已过） 5:无排班
样例 : 0

integer (int32)

shiftDoctors
可选

排班医生列表
样例 : [ "预约项目排班医生信息" ]

< 预约项目排班医生信息 > array

7.478. 预约项目排班医生信息

名称 说明 类型

doctorId
可选

医生id
样例 : "ffffffff000000000000000000000001"

string

status
可选

排班状态 0:有号 1:约满 2:无号（排班班次拆分后的总预约单元格为空，如：班次时长不满足最小服务时长等） 3:未放号 4:完诊（最晚排班结束时间已过） 5:无排班
样例 : 0

integer (int32)

7.479. 预约项目摘要信息

名称 说明 类型

id
必填

预约项目ID
样例 : "ffffffff000000000000000000000001"

string

name
必填

预约项目名称
样例 : "针灸"

string

7.480. 预约项目每日号源状态响应

名称 说明 类型

reserveSectionStatusList
可选

微诊所预约项目每日号源状态列表
样例 : [ "项目预约号源信息" ]

< 项目预约号源信息 > array

8. 更新日志

8.1. 2025年05月20日

新增

  1. [文件] 5.14.2文件下载接口

修改

  1. [平台]5.12.1增加鉴权，接口只对老客户开放

  2. [文件]5.14.1文件存储从公桶迁移到私桶，增加fileId返回，可通过5.14.2进行文件下载。

8.2. 2024年09月30日

新增

  1. [患者] 查询会员类型列表

  2. [患者] 修改患者会员

8.3. 2024年08月30日

新增

  1. [发药] 发药单详情和发药单事件快递信息新增“快递费用支付方式”字段

  2. [患者] 新增患者附件上传、删除、查询接口

  3. [认证授权] 连锁总部支持获取 accessToken

8.4. 2024年06月30日

新增

  1. [收费] 5.7.7查询患者收费单列表接口

  2. [执行] 5.13.6查询患者执行单列表接口

  3. [预约] 5.5.8查询门店可预约项目列表接口

  4. [预约] 5.5.9查询项目每日号源

  5. [预约] 5.5.10查询项目指定日期排班信息

  6. [预约] 5.5.11查询患者预约列表

  7. [预约] 5.5.12查询门店指定日期医生号源状态

  8. [预约] 5.5.13查询门店指定医生号源日期列表

修改

  1. [医生] 5.2.1根据手机号获取医生信息：新增医生标签字段

  2. [医生] 5.2.2获取医生分页列表信息：新增医生标签字段

  3. [执行] 5.13.2执行单详情：新增开单人信息

  4. [门诊] 5.6.2获取门诊单详情：新增过敏史字段

  5. [收费] 5.7.3收费单付款：支持传收费备注

8.5. 2024年06月03日

修改

  1. 5.4.2查询患者表信息：支持按照患者档案号查询患者信息

  2. 5.9.1按患者查询检查检验单：由默认查询近3个月，调整为支持传递不超过3个月的时间范围，支持单独查询检查单或检验单，支持根据检查检验合并开关返回数据

  3. 5.9.2按创建时间查询检查检验单：由仅支持查一天，调整为支持传递不超过3天的时间范围，支持单独查询检查单或检验单，支持根据检查检验合并开关返回数据

  4. 5.9.4查询检查检验单详情、5.9.5按单号查询检查检验单(条形码)：检查结果`results`旧节点`诊断意见`将不再维护

  5. 5.9.6根据检验单号修改检验单信息、5.9.7保存检查检验单数据：检查结果`results`旧节点`诊断意见`将不再维护，支持按照设备更新数据

新增

  1. 5.9.10获取检查检验设备列表

8.6. 2024年05月29日

修改

  1. 5.6.1按患者查询门诊单：由默认查询近3个月，调整为支持传递不超过3个月的时间范围

8.7. 2024年04月29日

修改

  1. 5.7.4退费接口：支持部分退费

  2. 5.13.4查询执行单执行历史接口返回执行时间

  3. 801执行事件：新增执行时间字段

  4. 802执行取消事件：新增执行时间字段

8.8. 2024年03月07日

增加收费模块功能完善

修改

  1. 5.7.3收费接口：支持部分收费

  2. 5.7.5修改快递信息接口：支持收费完成后修改快递信息

8.9. 2024年01月22日

本次更新增加对患者合并事件的支持

新增

  1. 新增 403 患者合并事件

8.10. 2023年10月20日

本次更新增加对执行事件的支持

新增

  1. 新增 801 执行事件

  2. 新增 802 执行取消事件

  3. 新增 5.5.4 通过就诊单ID获取挂号详情接口

8.11. 2023年8月29日

本次更新增加对理疗预约的支持和执行接口支持

新增

  1. 新增 5.13 执行功能支持（不支持输注处方）

  2. 新增 5.5.6 查询医生可预约项目

  3. 支持理疗预约

  4. 新增 701 挂号单创建事件

  5. 新增 702 挂号单修改事件

8.12. 2023年8月7日

本次更新增加了门诊单的创建到收费单的收费和退款的支持

新增

  1. 新增 5.6.3 创建门诊单接口（仅支持中药处方和中西成药处方）

  2. 新增 5.7.3 收费单收费接口（仅支持全部收费）

  3. 新增 5.7.4 收费单退费接口（仅支持全部退费）

  4. 新增 5.7.5 设置或修改快递信息接口

  5. 新增 108 收费单创建事件

修复

  • 修复收费单详情没有返回患者年龄问题