1. 平台概述

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

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

2. 应用接入指南

2.1. 申请

第三方开发者向平台提出接入申请,提供要访问连锁(或单店)的信息,由平台分配应用Id AppId 和应用密钥 AppSecret,应用通过平台授权接口获取 AccessToken,即可访问权限内的相关接口及数据。如果需要修改应用密钥及权限,请联系平台管理员。

参数 类型 说明

AppId

string

第三方应用的唯一标识

AppSecret

string

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

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

企业微信群二维码

2.2. 授权

  1. AccessToken说明:

    • 应用通过分配的 AppIdAppSecret 向平台换取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

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

      311

      入库完成时,向第三方应用进行推送

      出库完成

      3

      321

      出库完成时,向第三方应用进行推送

      盘点完成

      3

      331

      盘点完成时,向第三方应用进行推送

      调拨完成

      3

      341

      调拨完成时,向第三方应用进行推送

      新增患者

      4

      401

      新增患者时,向第三方应用进行推送

      修改患者

      4

      402

      修改患者姓名、生日、手机号、性别、身份证、住址、档案号、职业、公司、来源时,向第三方应用进行推送

      患者合并

      4

      403

      患者合并时,向第三方应用推送合并来源及合并后的患者信息

      创建发药单

      5

      500

      收到新的发药单时,向第三方应用进行推送

      更新发药单

      5

      501

      修改发药单快递/加工/调配/审核等,向第三方应用进行推送

      删除发药单

      5

      502

      未发药情况下退费,会删除发药单,向第三方应用进行推送

      发药

      5

      503

      在一次发药动作完成时,向第三方应用进行推送

      退药

      5

      504

      在一次退药动作完成时,向第三方应用进行推送

      创建检查检验单

      6

      601

      在一次创建检查检验单完成时,向第三方应用进行推送

      检查检验退费

      6

      602

      在一次检查检验退费完成时,向第三方应用进行推送

      挂号单创建

      7

      701

      创建挂号单完成后,向第三方应用进行推送

      挂号单更新

      7

      702

      修改挂号单完成后,向第三方应用进行推送

      执行

      8

      801

      执行完成后,向第三方应用进行推送

      取消执行

      8

      802

      执行取消后,向第三方应用进行推送

    • 推送请求体结构示例

      {
        "eventModule": 1,
        "eventType": 102,
        "eventName": "收费单退费",
        "clinicId": "机构id",
        "eventData": {
          "id": "ffffffff0000000021cf6a50116aa003",
          "doctor": {
            "id": "6e45706922a74966ab51e4ed1e604641",
            "name": "刘喜"
          },
          "status": 2,
          "charger": {
            "id": "ffffffff000000000a9f19c805814000",
            "name": "李强"
          },
          "created": "2022-03-31 07:52:42",
          "patient": {
            "id": "ffffffff000000000a9f19c805814000",
            "age": {
              "year": 51,
              "month": 7,
              "day": 17
            },
            "sex": "女",
            "name": "韩梅梅",
            "idCard": "511681199505224089",
            "mobile": "19912122121",
            "birthday": "2020-08-26"
          },
          "receivableFee": 44.4,
          "receivedFee": 44.4,
          "refundFee": 0,
          "refundTime": "2022-03-31 07:52:42",
          "deliveryInfo": {
            "deliveryName": "张三",
            "addressDetail": "双桥小区",
            "deliveryMobile": "18888888888",
            "addressCityName": "成都市",
            "deliveryCompany": "顺丰",
            "deliveryOrderNo": "asdf1233",
            "addressDistrictName": "金牛区",
            "addressProvinceName": "四川省"
          },
          "chargeFormItems": [
            {
              "id": "ffffffff0000000021cf6a50116aa005",
              "unit": "个",
              "status": 1,
              "productId": "ffffffff0000000013f949480c52c000",
              "unitPrice": 22.2,
              "totalCount": 1,
              "productName": "三七",
              "receivedFee": 22.2
            }
          ],
          "chargeTransactions": [
            {
              "id": "ffffffff0000000021cf6b10116aa003",
              "amount": 44.4,
              "created": "2022-03-31 07:53:07",
              "isRefunded": 1,
              "payModeName": "美团"
            }
          ]
        }
      }

5. 接口列表

5.1. 基础信息接口

5.1.1. 获取科室列表

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

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/clinics/departments
HTTP响应示例
响应 200
{
  "data" : {
    "departmentList" : [ {
      "id" : "ffffffff0000000006dddfe002e22000",
      "name" : "儿保科室",
      "type" : 1,
      "mainMedicalName" : "儿科",
      "secondMedicalName" : "小儿呼吸"
    } ]
  }
}

5.1.2. 获取门店信息

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

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/clinics/info
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "fff730ccc5ee45d783d82a85b8a0e52d",
    "parentId" : "fff730ccc5ee45d783d82a85b8a0e520",
    "hisType" : 0,
    "name" : "中医诊所高新店",
    "phone" : "13888888888",
    "category" : "中医诊所",
    "provinceName" : "四川省",
    "cityName" : "成都市",
    "districtName" : "高新区",
    "addressDetail" : "高新区100号"
  }
}

5.1.3. 获取科室详情

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

Path

id
必填

科室id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/clinics/departments/6209a883af8e4178b6f8d5f436cd236d
HTTP响应示例
响应 200
{
  "data" : {
    "employees" : [ {
      "employeeId" : "10a861eb5b4d43b59721301073112029",
      "name" : "张三",
      "mobile" : "18088888888"
    } ],
    "id" : "ffffffff0000000006dddfe002e22000",
    "principal" : "张三",
    "name" : "儿保科室",
    "phone" : "18088888888",
    "created" : "2019-04-11 10:48:07",
    "type" : 1,
    "mainMedicalName" : "儿科",
    "secondMedicalName" : "小儿呼吸"
  }
}

5.1.4. 获取人员详情

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

Path

id
必填

人员id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/clinics/employees/07b47b860f9649febc9d907e2ec6f23f
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "ffffffff0000000017ea20500df64000",
    "position" : "string",
    "headImgUrl" : "string",
    "name" : "张三",
    "mobile" : "13888888888",
    "sex" : "男",
    "birthday" : "1987-04-12",
    "role" : "医生",
    "introduction" : "毕业于陆军军医大学临床医学七年制",
    "nationalDoctorCode" : "string",
    "practiceInfos" : [ {
      "type" : "04|护理人员",
      "title" : "13|主管护师"
    } ],
    "practiceImgUrl" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/clinic-usage/fff730ccc5ee45d783d82a85b8a0e52d/license/dog_v2vHea4SK8gb.jpeg",
    "goodAt" : "擅长中医内科",
    "roles" : [ 1, 2, 3 ],
    "doctorTags" : "省级名中医、市级名中医"
  }
}

5.1.5. 获取门店人员列表

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

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/clinics/employees
HTTP响应示例
响应 200
{
  "data" : {
    "employeeList" : [ {
      "id" : "ffffffff0000000017ea20500df64000",
      "position" : "string",
      "headImgUrl" : "string",
      "name" : "张三",
      "mobile" : "13888888888",
      "sex" : "男",
      "birthday" : "1987-04-12",
      "role" : "医生",
      "introduction" : "毕业于陆军军医大学临床医学七年制",
      "nationalDoctorCode" : "string",
      "practiceInfos" : [ {
        "type" : "04|护理人员",
        "title" : "13|主管护师"
      } ],
      "practiceImgUrl" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/clinic-usage/fff730ccc5ee45d783d82a85b8a0e52d/license/dog_v2vHea4SK8gb.jpeg",
      "goodAt" : "擅长中医内科",
      "roles" : [ 1, 2, 3 ],
      "doctorTags" : "省级名中医、市级名中医"
    } ]
  }
}

5.2. 医生接口

5.2.1. 根据手机号获取医生信息

GET /api/v2/open-agency/doctor/query-by-mobile
参数
类型 名称 说明 类型

Query

mobile
必填

手机号

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/doctor/query-by-mobile?mobile=18088888888
HTTP响应示例
响应 200
{
  "data" : {
    "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

HTTP请求示例
请求 path
/api/v2/open-agency/doctor/query-list
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "mobile" : "18088888888",
      "name" : "张三",
      "sex" : "男",
      "headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
      "introduction" : "毕业于陆军军医大学临床医学七年制",
      "practiceImgUrl" : "string",
      "doctorPageUrl" : "string",
      "doctorTags" : "省级名中医、市级名中医"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.3. 商品接口

5.3.1. 获取商品分类

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

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/types
HTTP响应示例
响应 200
{
  "data" : {
    "typeTree" : [ {
      "id" : 0,
      "type" : 0,
      "subType" : 0,
      "category" : "string",
      "isLeaf" : 0,
      "name" : "string",
      "children" : [ {
        "id" : 0,
        "type" : 0,
        "subType" : 0,
        "category" : "string",
        "isLeaf" : 0,
        "name" : "string",
        "children" : [ "..." ]
      } ]
    } ]
  }
}

5.3.2. 获取商品自定义分类列表

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

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/custom-types
HTTP响应示例
响应 200
{
  "data" : {
    "list" : [ {
      "id" : "43794",
      "typeId" : 18,
      "name" : "物资"
    } ]
  }
}

5.3.3. 获取商品列表

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

Query

type
必填

类型: 1,药品; 2,物资; 3,检查; 4,治疗; 5,挂号; 7,商品; 11,套餐; 19,其他

integer (int32)

Query

beginDate
可选

开始时间(格式yyyy-MM-dd)配合查询日期类型使用

string

Query

dateFieldType
可选

查询日期类型: 1,创建时间; 2,最后修改时间

integer (int32)

Query

endDate
可选

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

string

Query

includeDeleted
可选

是否包含已经删除的商品 0:不包含删除的商品 1:包含删除的商品 ,默认值为0

integer (int32)

0

Query

limit
可选

每页显示条数,最大值为 200

integer (int32)

20

Query

offset
可选

查询偏移量

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products?type=1
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "shortId" : "string",
      "name" : "string",
      "specification" : "string",
      "typeId" : 0,
      "typeName" : "string",
      "combineType" : 0,
      "pieceNum" : 5.0,
      "pieceUnit" : "片",
      "packageUnit" : "盒",
      "lastModified" : "2022-05-13 12:22:56",
      "status" : 1,
      "disableSell" : 0
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.3.4. 获取商品详情

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

Path

id
必填

商品id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/ffffffff0000000022195dc8114b8000
HTTP响应示例
响应 200
{
  "data" : {
    "children" : [ {
      "children" : [ "..." ],
      "id" : "string",
      "name" : "string",
      "shebao" : {
        "nationalCode" : "T001700643",
        "insuranceTypes" : [ {
          "insuranceType" : "391",
          "reimbursementRatio" : 0.1
        } ]
      },
      "typeId" : 0,
      "typeName" : "string",
      "customTypeId" : "string",
      "customTypeName" : "string",
      "manufacturer" : "string",
      "medicineNmpn" : "string",
      "barCode" : "string",
      "pieceUnit" : "string",
      "pieceNum" : 0.0,
      "piecePrice" : 0.0,
      "packageUnit" : "string",
      "packagePrice" : 0.0,
      "shortId" : "string",
      "specification" : "1ml:0.5mg*10支/盒",
      "status" : 1,
      "lastModified" : "2022-05-13 12:22:56",
      "goodsSpu" : {
        "id" : "string",
        "name" : "string",
        "brandName" : "string",
        "material" : "string"
      },
      "goodsSpec" : {
        "color" : "string",
        "spec" : "string"
      }
    } ],
    "id" : "string",
    "name" : "string",
    "shebao" : {
      "nationalCode" : "T001700643",
      "insuranceTypes" : [ {
        "insuranceType" : "391",
        "reimbursementRatio" : 0.1
      } ]
    },
    "typeId" : 0,
    "typeName" : "string",
    "customTypeId" : "string",
    "customTypeName" : "string",
    "manufacturer" : "string",
    "medicineNmpn" : "string",
    "barCode" : "string",
    "pieceUnit" : "string",
    "pieceNum" : 0.0,
    "piecePrice" : 0.0,
    "packageUnit" : "string",
    "packagePrice" : 0.0,
    "shortId" : "string",
    "specification" : "1ml:0.5mg*10支/盒",
    "status" : 1,
    "lastModified" : "2022-05-13 12:22:56",
    "goodsSpu" : {
      "id" : "string",
      "name" : "string",
      "brandName" : "string",
      "material" : "string"
    },
    "goodsSpec" : {
      "color" : "string",
      "spec" : "string"
    }
  }
}

5.3.5. 获取出库单列表

GET /api/v2/open-agency/products/out-order-list
参数
类型 名称 说明 类型

Query

beginDate
必填

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

string

Query

endDate
必填

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

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/out-order-list?beginDate=2022-04-14&endDate=2022-04-14
HTTP响应示例
响应 200
{
  "data" : {
    "stockOutOrderList" : [ {
      "id" : 0,
      "orderNo" : "CK20220526000001",
      "status" : 0,
      "organName" : "高新大源店",
      "type" : 0,
      "kindCount" : 5,
      "count" : 12.0,
      "amount" : 6033.23,
      "receiver" : "string",
      "operator" : "string",
      "effectiveDate" : "2022-04-07 15:12:53",
      "lastModified" : "2022-05-13 12:22:56",
      "inOrderId" : "1928374567678",
      "pharmacy" : {
        "no" : 0
      }
    } ]
  }
}

5.3.6. 获取出库单详情

GET /api/v2/open-agency/products/out-order-detail/{orderId}
参数
类型 名称 说明 类型

Path

orderId
必填

出库单id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/out-order-detail/100000767
HTTP响应示例
响应 200
{
  "data" : {
    "comment" : {
      "time" : "string",
      "content" : "string",
      "employeeId" : "string",
      "employeeName" : "string"
    },
    "id" : 0,
    "outOrderItemList" : [ {
      "id" : 0,
      "productId" : "string",
      "productShortId" : "string",
      "productName" : "string",
      "specification" : "string",
      "pieceNum" : 5.0,
      "pieceUnit" : "片",
      "packageUnit" : "盒",
      "packageCount" : 0.0,
      "pieceCount" : 0.0,
      "packageCostPrice" : 0.0,
      "stockInId" : 0,
      "amount" : 0.0,
      "lastModified" : "2022-05-13 12:22:56",
      "stockOutBatches" : [ {
        "stockId" : 0,
        "supplier" : {
          "id" : "string",
          "name" : "string"
        },
        "batchNo" : "string",
        "expiryDate" : "string",
        "packageCount" : 0.0,
        "pieceCount" : 0.0,
        "packageCostPrice" : 0.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

Query

endDate
必填

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

string

Query

type
可选

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

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/in-order-list?beginDate=2022-04-14&endDate=2022-04-14
HTTP响应示例
响应 200
{
  "data" : {
    "stockInOrderList" : [ {
      "id" : 0,
      "orderNo" : "RK20220526000001",
      "status" : 0,
      "organName" : "高新大源店",
      "amount" : 6033.23,
      "count" : 12.0,
      "kindCount" : 5,
      "operator" : "string",
      "supplier" : "string",
      "effectiveDate" : "2022-04-07 15:12:53",
      "lastModified" : "2022-05-13 12:22:56",
      "pharmacy" : {
        "no" : 0
      },
      "type" : 0
    } ]
  }
}

5.3.8. 获取入库单详情

GET /api/v2/open-agency/products/in-order-detail/{orderId}
参数
类型 名称 说明 类型

Path

orderId
必填

入库单id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/in-order-detail/100005416
HTTP响应示例
响应 200
{
  "data" : {
    "comment" : {
      "time" : "string",
      "content" : "string",
      "employeeId" : "string",
      "employeeName" : "string"
    },
    "id" : 0,
    "inOrderItemList" : [ {
      "id" : 0,
      "productId" : "string",
      "productShortId" : "string",
      "productName" : "string",
      "specification" : "string",
      "expiryDate" : "yyyy-mm-dd",
      "productionDate" : "yyyy-mm-dd",
      "pieceNum" : 5.0,
      "pieceUnit" : "片",
      "packageUnit" : "盒",
      "packageCostPrice" : 0.0,
      "packageCount" : 0.0,
      "pieceCount" : 0.0,
      "amount" : 0.0,
      "batchNo" : "string",
      "lastModified" : "2022-05-13 12:22:56"
    } ],
    "orderNo" : "RK20220526000001",
    "status" : 0,
    "organName" : "高新大源店",
    "amount" : 6033.23,
    "count" : 12.0,
    "kindCount" : 5,
    "operator" : "string",
    "supplier" : "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

Query

endDate
必填

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

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/check-order-list?beginDate=2022-04-14&endDate=2022-04-14
HTTP响应示例
响应 200
{
  "data" : {
    "checkOrderList" : [ {
      "id" : 0,
      "orderNo" : "PD20220526000001",
      "status" : 0,
      "organName" : "高新大源店",
      "count" : 12.0,
      "kindCount" : 5,
      "totalCostPriceChange" : 0.0,
      "totalPriceChange" : 0.0,
      "operator" : "string",
      "effectiveDate" : "2022-04-07 15:12:53",
      "lastModified" : "2022-05-13 12:22:56"
    } ]
  }
}

5.3.10. 获取盘点单详情

GET /api/v2/open-agency/products/check-order-detail/{orderId}
参数
类型 名称 说明 类型

Path

orderId
必填

盘点单id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/check-order-detail/1540
HTTP响应示例
响应 200
{
  "data" : {
    "checkOrderItemList" : [ {
      "id" : 0,
      "productId" : "string",
      "productShortId" : "string",
      "productName" : "string",
      "specification" : "string",
      "expiryDate" : "string",
      "productionDate" : "yyyy-mm-dd",
      "pieceNum" : 5.0,
      "pieceUnit" : "片",
      "packageUnit" : "盒",
      "stockId" : "string",
      "packageCostPrice" : 0.0,
      "beforePieceCount" : 0.0,
      "beforePackageCount" : 0.0,
      "afterPieceCount" : 0.0,
      "afterPackageCount" : 0.0,
      "changePieceCount" : 0.0,
      "changePackageCount" : 0.0,
      "amount" : 0.0,
      "lastModified" : "2022-05-13 12:22:56",
      "checkBatches" : [ {
        "stockId" : 0,
        "supplier" : {
          "id" : "string",
          "name" : "string"
        },
        "batchNo" : "string",
        "expiryDate" : "string",
        "packageCount" : 0.0,
        "pieceCount" : 0.0,
        "packageCostPrice" : 0.0
      } ]
    } ],
    "comment" : {
      "time" : "string",
      "content" : "string",
      "employeeId" : "string",
      "employeeName" : "string"
    },
    "id" : 0,
    "orderNo" : "PD20220526000001",
    "status" : 0,
    "organName" : "高新大源店",
    "count" : 12.0,
    "kindCount" : 5,
    "totalCostPriceChange" : 0.0,
    "totalPriceChange" : 0.0,
    "operator" : "string",
    "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

Query

dateFieldType
可选

查询日期类型: 1,创建时间; 2,最后修改时间; 3,入库时间; 4,出库时间; 5,结算盘点时间

integer (int32)

1

Query

endDate
可选

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

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/settlement-order-list
HTTP响应示例
响应 200
{
  "data" : {
    "settlementOrderList" : [ {
      "id" : 0,
      "createdUser" : "string",
      "createDate" : "2022-04-07 15:12:53",
      "supplierName" : "string",
      "status" : -1,
      "includeTaxPrice" : 0.0,
      "excludeTaxPrice" : 0.0,
      "effectiveDate" : "2022-04-07 15:12:53",
      "lastModified" : "2022-05-13 12:22:56"
    } ]
  }
}

5.3.12. 获取结算单详情

GET /api/v2/open-agency/products/settlement-order-detail/{orderId}
参数
类型 名称 说明 类型

Path

orderId
必填

结算单id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/settlement-order-detail/ffffffff0000000022195dc8114b8000
HTTP响应示例
响应 200
{
  "data" : {
    "id" : 0,
    "itemsList" : [ {
      "id" : 0,
      "name" : "string",
      "specification" : "string",
      "unit" : "string",
      "totalPackageCount" : 0,
      "includeTaxPrice" : 0.0,
      "excludeTaxPrice" : 0.0
    } ],
    "createdUser" : "string",
    "invoicesList" : [ {
      "id" : 0,
      "invoicedDate" : "string",
      "invoiceNo" : "string"
    } ],
    "createDate" : "2022-04-07 15:12:53",
    "inOutList" : [ {
      "id" : 0,
      "includeTaxPrice" : 0.0,
      "excludeTaxPrice" : 0.0,
      "totalPackageCount" : 0.0,
      "clinicId" : "string",
      "clinicName" : "string",
      "orderInOutDate" : "string",
      "orderCreatedUserName" : "string",
      "type" : 0
    } ],
    "supplierName" : "string",
    "status" : -1,
    "includeTaxPrice" : 0.0,
    "excludeTaxPrice" : 0.0,
    "effectiveDate" : "2022-04-07 15:12:53",
    "lastModified" : "2022-05-13 12:22:56"
  }
}

5.3.13. 获取供应商列表

GET /api/v2/open-agency/products/suppliers
响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/products/suppliers
HTTP响应示例
响应 200
{
  "data" : {
    "supplierInfoList" : [ {
      "id" : "string",
      "name" : "string"
    } ]
  }
}

5.3.14. 获取进销存明细

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

Body

-
必填

-

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/products/inout-stock-details
请求 body
{
  "date" : "2020-03-05",
  "orderIdList" : [ "string" ],
  "type" : 1
}
HTTP响应示例
响应 200
{
  "data" : {
    "detailsList" : [ {
      "date" : "string",
      "productId" : "string",
      "productShortId" : "string",
      "productName" : "string",
      "pieceCount" : 0.0,
      "packageCount" : 0.0,
      "action" : "string",
      "orderId" : "string",
      "orderItemId" : "string",
      "packageCostPrice" : 0.0,
      "batchNo" : "string",
      "inOrderId" : 0,
      "inOrderItemId" : 0,
      "costPrice" : 0.0
    } ]
  }
}

5.3.15. 查询商品库存

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

Body

-
必填

-

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/products/stock/query-by-id
请求 body
{
  "productIds" : [ "string" ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "goodsStocks" : [ {
      "productId" : "ffffffff000000000ef10788097b000c",
      "productShortId" : "75724341",
      "stockPieceCount" : 20.0,
      "stockPackageCount" : 10.0,
      "pharmacyStocks" : [ {
        "pharmacyNo" : 0,
        "pharmacyName" : "本地药房",
        "stockPieceCount" : 20.0,
        "stockPackageCount" : 10.0
      } ]
    } ]
  }
}

5.4. 患者接口

5.4.1. 获取患者分页列表

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

Query

date
必填

患者创建时间(格式yyyy-MM-dd)

string

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/patient/query-list?date=2020-03-05
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.4.2. 根据手机号和姓名或档案号获取患者分页列表信息

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

Query

mobile
可选

手机号

string

Query

name
可选

姓名

string

Query

sn
可选

档案号

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/patient/query
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    } ]
  }
}

5.4.3. 获取患者详情

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

Path

id
必填

患者id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/patient/000000fc446f4dbd989857e305b00d6d
HTTP响应示例
响应 200
{
  "data" : {
    "created" : "2018-08-14 13:08:05",
    "id" : "000000fc446f4dbd989857e305b00d6s",
    "name" : "张三",
    "patientSource" : {
      "parentId" : "string",
      "parentName" : "string",
      "id" : "string",
      "name" : "就诊推荐",
      "sourceFrom" : "推荐人ID",
      "sourceFromName" : "张三",
      "relatedType" : 3,
      "relatedId" : "ffffffff00000000094c2a500293c000",
      "relateName" : "string"
    },
    "mobile" : "18080000000",
    "sn" : "031756",
    "idCard" : "string",
    "sex" : "男",
    "birthday" : "1970-08-14",
    "profession" : "教师",
    "age" : {
      "year" : 60,
      "month" : 2,
      "day" : 1
    },
    "company" : "ABC",
    "remark" : "string",
    "address" : {
      "addressProvinceId" : "510000",
      "addressProvinceName" : "四川",
      "addressCityId" : "510100",
      "addressCityName" : "成都市",
      "addressDistrictId" : "510109",
      "addressDistrictName" : "高新区",
      "addressDetail" : "交子大道180号"
    },
    "shebaoCardInfo" : {
      "cardNo" : "shebaoCardInfo"
    },
    "tags" : [ {
      "id" : "as123",
      "name" : "糖尿病"
    } ],
    "memberInfo" : {
      "principal" : 2866.6,
      "present" : 368.0,
      "created" : "2018-08-14 13:08:05",
      "memberTypeInfo" : {
        "id" : "9dc6f28121a7d9ba9fa6af00b406b314",
        "name" : "普通卡"
      }
    }
  }
}

5.4.4. 查询来源分类列表

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

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/patient/source/types
HTTP响应示例
响应 200
{
  "data" : {
    "list" : [ {
      "id" : "string",
      "name" : "张三",
      "relatedType" : 3,
      "relatedId" : "ffffffff00000000094c2a500293c000",
      "children" : [ {
        "id" : "string",
        "name" : "张三",
        "relatedType" : 3,
        "relatedId" : "ffffffff00000000094c2a500293c000",
        "children" : [ "..." ]
      } ]
    } ]
  }
}

5.4.5. 创建患者

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

Body

-
必填

-

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/patient
请求 body
{
  "name" : "string",
  "mobile" : "string",
  "sex" : "string",
  "birthday" : "2010-01-15",
  "sourceId" : "医生推荐分类id, 导医推荐分类id, 顾客推荐分类id",
  "sourceFromId" : "string",
  "idCard" : "string",
  "pastHistory" : "string",
  "address" : {
    "addressProvinceId" : "510000",
    "addressProvinceName" : "四川",
    "addressCityId" : "510100",
    "addressCityName" : "成都市",
    "addressDistrictId" : "510109",
    "addressDistrictName" : "高新区",
    "addressDetail" : "交子大道180号"
  },
  "sn" : "string",
  "remark" : "string",
  "profession" : "string",
  "company" : "string",
  "marital" : "string",
  "weight" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "000000fc446f4dbd989857e305b00d6s",
    "name" : "张三",
    "mobile" : "18080000000",
    "sex" : "男",
    "birthday" : "1970-08-14",
    "age" : {
      "year" : 60,
      "month" : 2,
      "day" : 1
    },
    "idCard" : "630101200010075758"
  }
}

5.4.6. 修改患者

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

Body

-
必填

-

Path

id
必填

患者id

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/patient/1928374566xxx
请求 body
{
  "name" : "string",
  "mobile" : "string",
  "sex" : "string",
  "birthday" : "2010-01-15",
  "sourceId" : "医生推荐分类id, 导医推荐分类id, 顾客推荐分类id",
  "sourceFromId" : "string",
  "idCard" : "string",
  "pastHistory" : "string",
  "address" : {
    "addressProvinceId" : "510000",
    "addressProvinceName" : "四川",
    "addressCityId" : "510100",
    "addressCityName" : "成都市",
    "addressDistrictId" : "510109",
    "addressDistrictName" : "高新区",
    "addressDetail" : "交子大道180号"
  },
  "sn" : "string",
  "remark" : "string",
  "profession" : "string",
  "company" : "string",
  "marital" : "string",
  "weight" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "000000fc446f4dbd989857e305b00d6s",
    "name" : "张三",
    "mobile" : "18080000000",
    "sex" : "男",
    "birthday" : "1970-08-14",
    "age" : {
      "year" : 60,
      "month" : 2,
      "day" : 1
    },
    "idCard" : "630101200010075758"
  }
}

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

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

Path

patientId
必填

患者ID

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/patient/string/family-member
HTTP响应示例
响应 200
{
  "data" : {
    "patientId" : "string",
    "familyRole" : 0,
    "familyPatients" : [ {
      "familyRole" : 0,
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    } ]
  }
}

5.5. 挂号接口

5.5.1. 获取科室医生的号源详情

GET /api/v2/open-agency/registration/doctor/{doctorId}
参数
类型 名称 说明 类型 默认值

Path

doctorId
必填

医生id

string

Query

workingDate
必填

工作日期 yyyy-MM-dd

string

Query

departmentId
可选

科室id,门诊预约时必填

string

Query

registrationType
可选

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

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/doctor/ffffffff00000000220e67a8116d8000?workingDate=2022-05-05
HTTP响应示例
响应 200
{
  "data" : {
    "doctorId" : "string",
    "departmentId" : "string",
    "workingDate" : "string",
    "dayOfWeek" : "string",
    "restCountToday" : 0,
    "canReserve" : 0,
    "scheduleIntervals" : [ {
      "timeOfDay" : "string",
      "start" : "string",
      "end" : "string",
      "list" : [ {
        "restCount" : 0,
        "timeOfDay" : "string",
        "orderNo" : 0,
        "type" : 2,
        "start" : "string",
        "end" : "string",
        "available" : 0
      } ]
    } ]
  }
}

5.5.2. 创建挂号

POST /api/v2/open-agency/registration
说明

只有开启了预约升级的门店才能进行理疗预约

参数
类型 名称 说明 类型

Body

-
必填

-

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/registration
请求 body
{
  "patientId" : "string",
  "departmentId" : "string",
  "doctorId" : "string",
  "orderNo" : 0,
  "reserveDate" : "string",
  "reserveStart" : "string",
  "reserveEnd" : "string",
  "sourceId" : "医生推荐分类ID, 导医推荐分类ID, 顾客推荐分类ID",
  "sourceFromId" : "string",
  "sourceRemark" : "string",
  "registrationType" : 0,
  "registrationProductIds" : [ 0 ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "registrationSheetId" : "string",
    "patientOrderId" : "string"
  }
}

5.5.3. 获取挂号详情

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

Path

registrationsSheetId
必填

挂号单id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/ffffffff0000000006dddfe002e22000
HTTP响应示例
响应 200
{
  "data" : {
    "clinicName" : "string",
    "patientOrderId" : "string",
    "registrationSheetId" : "string",
    "visitSourceParentId" : "string",
    "patientId" : "string",
    "visitSourceParentName" : "string",
    "departmentId" : "string",
    "visitSourceId" : "string",
    "departmentName" : "string",
    "visitSourceName" : "string",
    "doctorId" : "string",
    "visitSourceFromId" : "string",
    "doctorName" : "string",
    "visitSourceFromName" : "string",
    "orderNo" : "上午 01号",
    "visitSourceRelatedType" : 0,
    "reserveDate" : "2019-04-04",
    "visitSourceRelatedId" : "string",
    "reserveTime" : "10:10~10:30",
    "visitSourceRelateName" : "string",
    "isReserved" : 1,
    "visitSourceRemark" : "string",
    "registrationProducts" : [ {
      "id" : "ffffffff000000000000000000000001",
      "name" : "针灸"
    } ],
    "status" : 10,
    "signIn" : 0,
    "consultingRoomId" : "string",
    "consultingRoomName" : "string",
    "type" : 0,
    "payStatus" : 0,
    "code" : 0,
    "registrationType" : 0,
    "created" : "2022-06-23 18:45:00"
  }
}

5.5.4. 通过就诊单ID获取挂号详情

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

Path

patientOrderId
必填

就诊单ID

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/by-patient-order-id/ffffffff0000000006dddfe002e22000
HTTP响应示例
响应 200
{
  "data" : {
    "clinicName" : "string",
    "patientOrderId" : "string",
    "registrationSheetId" : "string",
    "visitSourceParentId" : "string",
    "patientId" : "string",
    "visitSourceParentName" : "string",
    "departmentId" : "string",
    "visitSourceId" : "string",
    "departmentName" : "string",
    "visitSourceName" : "string",
    "doctorId" : "string",
    "visitSourceFromId" : "string",
    "doctorName" : "string",
    "visitSourceFromName" : "string",
    "orderNo" : "上午 01号",
    "visitSourceRelatedType" : 0,
    "reserveDate" : "2019-04-04",
    "visitSourceRelatedId" : "string",
    "reserveTime" : "10:10~10:30",
    "visitSourceRelateName" : "string",
    "isReserved" : 1,
    "visitSourceRemark" : "string",
    "registrationProducts" : [ {
      "id" : "ffffffff000000000000000000000001",
      "name" : "针灸"
    } ],
    "status" : 10,
    "signIn" : 0,
    "consultingRoomId" : "string",
    "consultingRoomName" : "string",
    "type" : 0,
    "payStatus" : 0,
    "code" : 0,
    "registrationType" : 0,
    "created" : "2022-06-23 18:45:00"
  }
}

5.5.5. 取消挂号

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

Path

registrationsSheetId
必填

挂号单id

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/registration/ffffffff0000000006dddfe002e22000/cancel
HTTP响应示例
响应 200
{
  "data" : {
    "isSuccess" : 0,
    "tips" : "string"
  }
}

5.5.6. 查询预约备注模板

GET /api/v2/open-agency/registration/remark-templates
响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/remark-templates
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "registrationType" : 0,
      "content" : "string",
      "sort" : 0,
      "disableModify" : 0,
      "disableDelete" : 0
    } ]
  }
}

5.5.7. 查询医生可预约项目列表

GET /api/v2/open-agency/registration/doctor/{doctorId}/product
说明

目前仅支持查询理疗预约项目

参数
类型 名称 说明 类型

Path

doctorId
必填

医生ID

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/doctor/string/product
HTTP响应示例
响应 200
{
  "data" : {
    "registrationProducts" : [ {
      "id" : "ffffffff000000000000000000000001",
      "introduce" : "专业按摩,疏通筋骨",
      "name" : "针灸",
      "price" : 100.0,
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    } ]
  }
}

5.5.8. 查询门店可预约项目列表

GET /api/v2/open-agency/registration/product
说明

目前仅支持查询理疗预约项目

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/product
HTTP响应示例
响应 200
{
  "data" : {
    "registrationProducts" : [ {
      "id" : "ffffffff000000000000000000000001",
      "introduce" : "专业按摩,疏通筋骨",
      "name" : "针灸",
      "price" : 100.0,
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    } ]
  }
}

5.5.9. 查询项目每日号源

GET /api/v2/open-agency/registration/product/{registrationProductId}/section-status
说明

目前仅支持查询理疗预约项目

参数
类型 名称 说明 类型

Path

registrationProductId
必填

预约项目ID

integer (int64)

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/product/0/section-status
HTTP响应示例
响应 200
{
  "data" : {
    "reserveSectionStatusList" : [ {
      "date" : "2024-03-05",
      "status" : 0
    } ]
  }
}

5.5.10. 查询项目指定日期排班信息

GET /api/v2/open-agency/registration/product/{registrationProductId}/days-shifts
说明

目前仅支持查询理疗预约项目

参数
类型 名称 说明 类型

Path

registrationProductId
必填

预约项目ID

integer (int64)

Query

reserveDate
必填

预约日期(yyyy-MM-dd)

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/product/0/days-shifts?reserveDate=2024-03-03
HTTP响应示例
响应 200
{
  "data" : {
    "registrationCategoryDaysShifts" : [ {
      "status" : 0,
      "registrationCategory" : 0,
      "dayShifts" : [ {
        "start" : "08:00",
        "end" : "08:30",
        "timeOfDay" : "上午",
        "status" : 0,
        "shiftDoctors" : [ {
          "doctorId" : "ffffffff000000000000000000000001",
          "status" : 0
        } ]
      } ]
    } ]
  }
}

5.5.11. 查询患者预约列表

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

Path

patientId
必填

患者ID

string

Query

beginDate
可选

开始日期,yyyy-MM-dd,为空则默认为三个月前

string (date)

Query

endDate
可选

结束日期,yyyy-MM-dd,为空则默认为今天

string (date)

Query

limit
可选

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

integer (int32)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

registrationType
可选

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

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/patient/string
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "张三",
      "reserveDate" : "2019-04-04",
      "reserveStart" : "10:10",
      "reserveEnd" : "10:30",
      "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

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

registrationType
可选

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

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/registration/doctor/string/shift
HTTP响应示例
响应 200
{
  "data" : {
    "reserveSections" : [ {
      "date" : "2024-04-23",
      "departments" : [ {
        "id" : "ffffffff0000000022174678012e2000",
        "name" : "儿科",
        "restCount" : 9,
        "totalCount" : 10,
        "status" : 0,
        "fee" : 20.0,
        "registerStartTime" : "09:30",
        "registrationCategoryDayShifts" : [ {
          "departmentId" : "ffffffff0000000017e9b87008386000",
          "registrationCategory" : 0,
          "restCount" : 5,
          "totalCount" : 10,
          "status" : 0,
          "dayShifts" : [ {
            "shifts" : [ {
              "orderNo" : 5,
              "start" : "09:00",
              "end" : "09:20",
              "timeOfDay" : "上午",
              "count" : 1,
              "totalCount" : 1
            } ],
            "restCount" : 5,
            "totalCount" : 10,
            "status" : 0,
            "start" : "09:00",
            "end" : "10:00",
            "timeOfDay" : "上午"
          } ]
        } ]
      } ]
    } ]
  }
}

5.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

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/query-by-patient/ffffffff000000001bc17db00f42e000
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "created" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "status" : 0,
      "statusName" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.6.2. 获取门诊单详情

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

Path

id
必填

门诊单ID

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/ffffffff00000000216fab8810cde000
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "patientOrderId" : "string",
    "patientOrderNo" : "00019691",
    "departmentId" : "string",
    "departmentName" : "string",
    "doctorId" : "string",
    "doctorName" : "string",
    "created" : "string",
    "diagnosedDate" : "string",
    "status" : 0,
    "statusName" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛,干咳,咳痰",
      "pastHistory" : "既往体健,既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "prescriptionChineseForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人:王萍,执行时间:2022-04-13"
        }
      } ]
    } ],
    "prescriptionWesternForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人:王萍,执行时间:2022-04-13"
        }
      } ]
    } ],
    "prescriptionInfusionForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人:王萍,执行时间:2022-04-13"
        }
      } ]
    } ],
    "prescriptionExternalForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人:王萍,执行时间:2022-04-13"
        }
      } ]
    } ],
    "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
      } ]
    } ]
  }
}

5.6.3. 创建门诊单

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

Body

req
必填

req

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient
请求 body
{
  "departmentId" : "string",
  "doctorId" : "string",
  "patientId" : "string",
  "operatorId" : "00000000000000000000000000000000",
  "medicalRecord" : {
    "chiefComplaint" : "咽痛,干咳,咳痰",
    "pastHistory" : "既往体健,既往有高血压",
    "familyHistory" : "string",
    "presentHistory" : "string",
    "physicalExamination" : "string",
    "diagnosis" : "急性上呼吸道感染",
    "doctorAdvice" : "string",
    "syndrome" : "string",
    "therapy" : "string",
    "chineseExamination" : "string",
    "obstetricalHistory" : "string"
  },
  "prescriptionChineseForms" : [ {
    "isTotalPriceChanged" : 1,
    "pharmacyNo" : 0,
    "expectedTotalPrice" : 10.0,
    "specification" : "中药饮片",
    "doseCount" : 3,
    "prescriptionFormItems" : [ {
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "specialRequirement" : "先煎",
      "productShortId" : "1907765200",
      "unitCount" : 2.0,
      "expectedUnitPrice" : 5.0,
      "expectedTotalPrice" : 5.0,
      "useDismounting" : 0
    } ],
    "usage" : "煎服",
    "dailyDosage" : "1日1剂",
    "freq" : "1日6次",
    "usageLevel" : "每次60ml",
    "usageDays" : "约服35天",
    "requirement" : "饭前服用",
    "processInfo" : {
      "usageType" : 0,
      "usageSubType" : 0,
      "unitCount" : 1.0,
      "totalCount" : 2.0,
      "price" : 0.0,
      "remark" : "string"
    }
  } ],
  "prescriptionWesternForms" : [ {
    "isTotalPriceChanged" : 1,
    "expectedTotalPrice" : 10.0,
    "prescriptionFormItems" : [ {
      "ast" : 1,
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "productShortId" : "1907765200",
      "usage" : "含服用",
      "freq" : "qd",
      "unitCount" : 2.0,
      "dosage" : 3.0,
      "expectedUnitPrice" : 5.0,
      "dosageUnit" : "片",
      "expectedTotalPrice" : 5.0,
      "days" : 5.0,
      "useDismounting" : 0,
      "specialRequirement" : "首次加倍",
      "pharmacyNo" : 0
    } ]
  } ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "patientOrderId" : "string",
    "patientOrderNo" : "00019691",
    "departmentId" : "string",
    "departmentName" : "string",
    "doctorId" : "string",
    "doctorName" : "string",
    "created" : "string",
    "diagnosedDate" : "string",
    "status" : 0,
    "statusName" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛,干咳,咳痰",
      "pastHistory" : "既往体健,既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "prescriptionChineseForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人:王萍,执行时间:2022-04-13"
        }
      } ]
    } ],
    "prescriptionWesternForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人:王萍,执行时间:2022-04-13"
        }
      } ]
    } ],
    "prescriptionInfusionForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人:王萍,执行时间:2022-04-13"
        }
      } ]
    } ],
    "prescriptionExternalForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人:王萍,执行时间:2022-04-13"
        }
      } ]
    } ],
    "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
      } ]
    } ]
  }
}

5.6.4. 按天查询门诊单

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

Query

date
必填

日期(格式yyyy-MM-dd)

string

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/outpatient/query-by-date?date=2022-01-03
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "created" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "status" : 0,
      "statusName" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.7. 收费接口

5.7.1. 查询指定日期的收费单

GET /api/v2/open-agency/charge/query-by-date
参数
类型 名称 说明 类型

Query

date
必填

日期 yyyy-MM-dd

string (date-time)

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/charge/query-by-date?date=2023-03-01
HTTP响应示例
响应 200
{
  "data" : {
    "chargeSheets" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "created" : "string",
      "doctorName" : "string",
      "isDraft" : 0,
      "status" : 0,
      "owedStatus" : 0,
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "type" : 1,
      "isClosed" : 0
    } ]
  }
}

5.7.2. 获取收费单明细

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

Path

id
必填

收费单ID

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/charge/query-detail/ffffffff00000000220e67a8116d8000
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "ffffffff00000000220e67a8116d8000",
    "status" : 0,
    "type" : 1,
    "created" : "2022-04-06 15:12:53",
    "receivableFee" : 0.01,
    "receivedFee" : 0.0,
    "refundFee" : 0.01,
    "discountFee" : -10.0,
    "refundTime" : "2022-04-07 15:12:53",
    "charger" : {
      "id" : "string",
      "name" : "张三"
    },
    "deliveryInfo" : {
      "addressProvinceName" : "四川省",
      "addressCityName" : "成都市",
      "addressDistrictName" : "高新区",
      "addressDetail" : "四川省成都市高新区xxx街道xxx",
      "deliveryName" : "张三",
      "deliveryMobile" : "18088888888",
      "deliveryCompany" : {
        "id" : "127203805890060288",
        "name" : "string"
      },
      "deliveryOrderNo" : "20827634879930368"
    },
    "doctor" : {
      "id" : "string",
      "mobile" : "18088888888",
      "name" : "张三",
      "sex" : "男",
      "headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
      "introduction" : "毕业于陆军军医大学临床医学七年制",
      "practiceImgUrl" : "string",
      "doctorPageUrl" : "string",
      "doctorTags" : "省级名中医、市级名中医"
    },
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛,干咳,咳痰",
      "pastHistory" : "既往体健,既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "chargeFormItems" : [ {
      "id" : "0002b62eaf9c461f85ff3fedc4583a79",
      "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
      "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
      "productName" : "注射用青霉素钠",
      "status" : 0,
      "unit" : "支",
      "receivedFee" : 40.0,
      "unitPrice" : 10.0,
      "displayUnitPrice" : 10.0,
      "displayTotalPrice" : 40.0,
      "unitCount" : 4.0,
      "doseCount" : 1.0,
      "totalCount" : 4.0,
      "productType" : 1,
      "productSubType" : 3,
      "sourceItemType" : 0
    } ],
    "chargeTransactions" : [ {
      "id" : "ffffffff00000000220e67a8116d8001",
      "payModeName" : "ABC支付",
      "payModeDisplayName" : "ABC支付-微信",
      "amount" : 0.0,
      "created" : "2022-04-06 15:12:53",
      "isRefunded" : 0,
      "chargeTransactionRecords" : [ {
        "id" : "ffffffff00000000265ff80811ab200x",
        "transactionId" : "ffffffff00000000265ff80811ab2004",
        "chargeType" : 1,
        "productId" : "00000000000000000000000000000001",
        "productName" : "白术",
        "productType" : 5,
        "productSubType" : 0,
        "composeType" : 0,
        "productUnit" : "string",
        "productUnitCount" : 1.0,
        "doseCount" : 1.0,
        "totalPrice" : 0.0,
        "discountPrice" : 0.0,
        "created" : "2022-04-06 15:12:53",
        "sceneType" : 0,
        "composeChildren" : [ {
          "id" : "ffffffff00000000265ff80811ab200x",
          "transactionId" : "ffffffff00000000265ff80811ab2004",
          "chargeType" : 1,
          "productId" : "00000000000000000000000000000001",
          "productName" : "白术",
          "productType" : 5,
          "productSubType" : 0,
          "composeType" : 0,
          "productUnit" : "string",
          "productUnitCount" : 1.0,
          "doseCount" : 1.0,
          "totalPrice" : 0.0,
          "discountPrice" : 0.0,
          "created" : "2022-04-06 15:12:53",
          "sceneType" : 0,
          "composeChildren" : [ "..." ]
        } ]
      } ]
    } ],
    "chargeTransactionPaidRecords" : [ {
      "productId" : "00000000000000000000000000000001",
      "productName" : "白术",
      "productType" : 5,
      "productSubType" : 0,
      "composeType" : 0,
      "productUnit" : "string",
      "productUnitCount" : 1.0,
      "doseCount" : 1.0,
      "totalPrice" : 0.0,
      "discountPrice" : 0.0,
      "records" : 0
    } ],
    "sellerId" : "ffffff000000xxxxx",
    "sellerName" : "张三",
    "registrationSheetId" : "ffffffff0000000025b0df48001ae013",
    "patientOrderId" : "ffffffff00000000220e67a8116d8000",
    "isDraft" : 0,
    "isClosed" : 0
  }
}

5.7.3. 收费单付款(支持部分收费)

PUT /api/v2/open-agency/charge/{chargeSheetId}/pay
说明

部分收费示例:例如一个收费单应收总金额为1000元。第一次部分收200元:needPayFee=1000,amount=200; 第二次部分收300元:needPayFee=800,amount=300; 第三次全收500元:needPayFee=500,amount=500;

参数
类型 名称 说明 类型

Body

-
必填

-

Path

chargeSheetId
必填

收费单ID

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/charge/string/pay
请求 body
{
  "payMode" : 1,
  "amount" : 100.0,
  "needPayFee" : 1000.0,
  "expectedOddFee" : 0.52,
  "operatorId" : "00000000000000000000000000000000",
  "comment" : "来自互联网医院"
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "patientOrderId" : "string",
    "status" : 2,
    "statusName" : "已收费",
    "needPay" : 100.0,
    "receivedFee" : 100.0
  }
}

5.7.4. 收费单退款(支持部分退)

PUT /api/v2/open-agency/charge/{chargeSheetId}/refund
说明

只退指定商品:chargeForms 中只传需要退的商品即可,然后 needRefundFee 和 refundFee 传指定商品的金额总和即可。 退到不同的支付方式:如果需要全退 100 块钱,但是要退到两个不同的支付方式,可以在第一次退费的时候传所有需要退费的商品到 chargeForms 中进行退费,然后传 needRefundFee=100, refundFee=50 退到支付方式A,这个时候所有的商品都已经退完了,但是“欠退50块钱”,第二次退费的时候,不传需要退费商品到 chargeForms 中(因为第一次已经把商品退完了),然后 needRefundFee=0 refundFee=50 退到支付方式B

参数
类型 名称 说明 类型

Body

-
必填

-

Path

chargeSheetId
必填

收费单ID

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/charge/string/refund
请求 body
{
  "operatorId" : "00000000000000000000000000000000",
  "needRefundFee" : 0.0,
  "refundFee" : 0.0,
  "payMode" : 1,
  "chargeForms" : [ {
    "id" : "00000000000000000000000000000000",
    "chargeFormItems" : [ {
      "id" : "00000000000000000000000000000000",
      "unitCount" : 1.0,
      "doseCount" : 1.0
    } ]
  } ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "status" : 2,
    "statusName" : "已收费",
    "refundFee" : 10.0,
    "refundedFee" : 20.0
  }
}

5.7.5. 设置或修改收费单快递信息

PUT /api/v2/open-agency/charge/{chargeSheetId}/delivery
说明

支持收费完成后修改快递信息

参数
类型 名称 说明 类型

Body

-
必填

-

Path

chargeSheetId
必填

收费单ID

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/charge/string/delivery
请求 body
{
  "addressProvinceId" : "510000",
  "addressProvinceName" : "四川",
  "addressCityId" : "510100",
  "addressCityName" : "成都市",
  "addressDistrictId" : "510109",
  "addressDistrictName" : "高新区",
  "addressDetail" : "交子大道180号",
  "deliveryName" : "张三",
  "deliveryMobile" : "18012312312",
  "deliveryCompanyName" : "顺丰快递",
  "deliveryFee" : 12.0,
  "deliveryOrderNo" : "string",
  "deliveryPayType" : 0,
  "operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "ffffffff00000000220e67a8116d8000",
    "status" : 0,
    "type" : 1,
    "created" : "2022-04-06 15:12:53",
    "receivableFee" : 0.01,
    "receivedFee" : 0.0,
    "refundFee" : 0.01,
    "discountFee" : -10.0,
    "refundTime" : "2022-04-07 15:12:53",
    "charger" : {
      "id" : "string",
      "name" : "张三"
    },
    "deliveryInfo" : {
      "addressProvinceName" : "四川省",
      "addressCityName" : "成都市",
      "addressDistrictName" : "高新区",
      "addressDetail" : "四川省成都市高新区xxx街道xxx",
      "deliveryName" : "张三",
      "deliveryMobile" : "18088888888",
      "deliveryCompany" : {
        "id" : "127203805890060288",
        "name" : "string"
      },
      "deliveryOrderNo" : "20827634879930368"
    },
    "doctor" : {
      "id" : "string",
      "mobile" : "18088888888",
      "name" : "张三",
      "sex" : "男",
      "headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
      "introduction" : "毕业于陆军军医大学临床医学七年制",
      "practiceImgUrl" : "string",
      "doctorPageUrl" : "string",
      "doctorTags" : "省级名中医、市级名中医"
    },
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛,干咳,咳痰",
      "pastHistory" : "既往体健,既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "chargeFormItems" : [ {
      "id" : "0002b62eaf9c461f85ff3fedc4583a79",
      "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
      "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
      "productName" : "注射用青霉素钠",
      "status" : 0,
      "unit" : "支",
      "receivedFee" : 40.0,
      "unitPrice" : 10.0,
      "displayUnitPrice" : 10.0,
      "displayTotalPrice" : 40.0,
      "unitCount" : 4.0,
      "doseCount" : 1.0,
      "totalCount" : 4.0,
      "productType" : 1,
      "productSubType" : 3,
      "sourceItemType" : 0
    } ],
    "chargeTransactions" : [ {
      "id" : "ffffffff00000000220e67a8116d8001",
      "payModeName" : "ABC支付",
      "payModeDisplayName" : "ABC支付-微信",
      "amount" : 0.0,
      "created" : "2022-04-06 15:12:53",
      "isRefunded" : 0,
      "chargeTransactionRecords" : [ {
        "id" : "ffffffff00000000265ff80811ab200x",
        "transactionId" : "ffffffff00000000265ff80811ab2004",
        "chargeType" : 1,
        "productId" : "00000000000000000000000000000001",
        "productName" : "白术",
        "productType" : 5,
        "productSubType" : 0,
        "composeType" : 0,
        "productUnit" : "string",
        "productUnitCount" : 1.0,
        "doseCount" : 1.0,
        "totalPrice" : 0.0,
        "discountPrice" : 0.0,
        "created" : "2022-04-06 15:12:53",
        "sceneType" : 0,
        "composeChildren" : [ {
          "id" : "ffffffff00000000265ff80811ab200x",
          "transactionId" : "ffffffff00000000265ff80811ab2004",
          "chargeType" : 1,
          "productId" : "00000000000000000000000000000001",
          "productName" : "白术",
          "productType" : 5,
          "productSubType" : 0,
          "composeType" : 0,
          "productUnit" : "string",
          "productUnitCount" : 1.0,
          "doseCount" : 1.0,
          "totalPrice" : 0.0,
          "discountPrice" : 0.0,
          "created" : "2022-04-06 15:12:53",
          "sceneType" : 0,
          "composeChildren" : [ "..." ]
        } ]
      } ]
    } ],
    "chargeTransactionPaidRecords" : [ {
      "productId" : "00000000000000000000000000000001",
      "productName" : "白术",
      "productType" : 5,
      "productSubType" : 0,
      "composeType" : 0,
      "productUnit" : "string",
      "productUnitCount" : 1.0,
      "doseCount" : 1.0,
      "totalPrice" : 0.0,
      "discountPrice" : 0.0,
      "records" : 0
    } ],
    "sellerId" : "ffffff000000xxxxx",
    "sellerName" : "张三",
    "registrationSheetId" : "ffffffff0000000025b0df48001ae013",
    "patientOrderId" : "ffffffff00000000220e67a8116d8000",
    "isDraft" : 0,
    "isClosed" : 0
  }
}

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

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

Path

就诊单ID
必填

patientOrderId

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/charge/by-patient-order-id/{patientOrderId}
HTTP响应示例
响应 200
{
  "data" : {
    "chargeSheets" : [ {
      "id" : "ffffffff00000000220e67a8116d8000",
      "status" : 0,
      "type" : 1,
      "created" : "2022-04-06 15:12:53",
      "receivableFee" : 0.01,
      "receivedFee" : 0.0,
      "refundFee" : 0.01,
      "discountFee" : -10.0,
      "refundTime" : "2022-04-07 15:12:53",
      "charger" : {
        "id" : "string",
        "name" : "张三"
      },
      "deliveryInfo" : {
        "addressProvinceName" : "四川省",
        "addressCityName" : "成都市",
        "addressDistrictName" : "高新区",
        "addressDetail" : "四川省成都市高新区xxx街道xxx",
        "deliveryName" : "张三",
        "deliveryMobile" : "18088888888",
        "deliveryCompany" : {
          "id" : "127203805890060288",
          "name" : "string"
        },
        "deliveryOrderNo" : "20827634879930368"
      },
      "doctor" : {
        "id" : "string",
        "mobile" : "18088888888",
        "name" : "张三",
        "sex" : "男",
        "headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
        "introduction" : "毕业于陆军军医大学临床医学七年制",
        "practiceImgUrl" : "string",
        "doctorPageUrl" : "string",
        "doctorTags" : "省级名中医、市级名中医"
      },
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "medicalRecord" : {
        "id" : "string",
        "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
        "chiefComplaint" : "咽痛,干咳,咳痰",
        "pastHistory" : "既往体健,既往有高血压",
        "familyHistory" : "string",
        "presentHistory" : "string",
        "physicalExamination" : "string",
        "diagnosis" : "急性上呼吸道感染",
        "doctorAdvice" : "string",
        "syndrome" : "string",
        "therapy" : "string",
        "chineseExamination" : "string",
        "obstetricalHistory" : "string",
        "eyeExamination" : {
          "items" : [ {
            "key" : "string",
            "name" : "string",
            "rightEyeValue" : "string",
            "leftEyeValue" : "string"
          } ]
        },
        "allergicHistory" : "青霉素过敏",
        "attachments" : [ {
          "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
          "fileName" : "NatGeo09.jpg",
          "fileSize" : 4771201
        } ]
      },
      "chargeFormItems" : [ {
        "id" : "0002b62eaf9c461f85ff3fedc4583a79",
        "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
        "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
        "productName" : "注射用青霉素钠",
        "status" : 0,
        "unit" : "支",
        "receivedFee" : 40.0,
        "unitPrice" : 10.0,
        "displayUnitPrice" : 10.0,
        "displayTotalPrice" : 40.0,
        "unitCount" : 4.0,
        "doseCount" : 1.0,
        "totalCount" : 4.0,
        "productType" : 1,
        "productSubType" : 3,
        "sourceItemType" : 0
      } ],
      "chargeTransactions" : [ {
        "id" : "ffffffff00000000220e67a8116d8001",
        "payModeName" : "ABC支付",
        "payModeDisplayName" : "ABC支付-微信",
        "amount" : 0.0,
        "created" : "2022-04-06 15:12:53",
        "isRefunded" : 0,
        "chargeTransactionRecords" : [ {
          "id" : "ffffffff00000000265ff80811ab200x",
          "transactionId" : "ffffffff00000000265ff80811ab2004",
          "chargeType" : 1,
          "productId" : "00000000000000000000000000000001",
          "productName" : "白术",
          "productType" : 5,
          "productSubType" : 0,
          "composeType" : 0,
          "productUnit" : "string",
          "productUnitCount" : 1.0,
          "doseCount" : 1.0,
          "totalPrice" : 0.0,
          "discountPrice" : 0.0,
          "created" : "2022-04-06 15:12:53",
          "sceneType" : 0,
          "composeChildren" : [ {
            "id" : "ffffffff00000000265ff80811ab200x",
            "transactionId" : "ffffffff00000000265ff80811ab2004",
            "chargeType" : 1,
            "productId" : "00000000000000000000000000000001",
            "productName" : "白术",
            "productType" : 5,
            "productSubType" : 0,
            "composeType" : 0,
            "productUnit" : "string",
            "productUnitCount" : 1.0,
            "doseCount" : 1.0,
            "totalPrice" : 0.0,
            "discountPrice" : 0.0,
            "created" : "2022-04-06 15:12:53",
            "sceneType" : 0,
            "composeChildren" : [ "..." ]
          } ]
        } ]
      } ],
      "chargeTransactionPaidRecords" : [ {
        "productId" : "00000000000000000000000000000001",
        "productName" : "白术",
        "productType" : 5,
        "productSubType" : 0,
        "composeType" : 0,
        "productUnit" : "string",
        "productUnitCount" : 1.0,
        "doseCount" : 1.0,
        "totalPrice" : 0.0,
        "discountPrice" : 0.0,
        "records" : 0
      } ],
      "sellerId" : "ffffff000000xxxxx",
      "sellerName" : "张三",
      "registrationSheetId" : "ffffffff0000000025b0df48001ae013",
      "patientOrderId" : "ffffffff00000000220e67a8116d8000",
      "isDraft" : 0,
      "isClosed" : 0
    } ]
  }
}

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

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.8. 发药接口

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

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

Path

id
必填

发药单ID

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/ffffffff00000000264a75300d752999
HTTP响应示例
响应 200
{
  "data" : {
    "clinicId" : "ffffffff000000002620d6280d751234",
    "dispensingForms" : [ {
      "dispensingFormItems" : [ {
        "dispensingBatches" : [ {
          "action" : "发药",
          "stockId" : 0,
          "supplier" : {
            "id" : "string",
            "name" : "string"
          },
          "batchNo" : "string",
          "expiryDate" : "string",
          "packageCount" : 0.0,
          "pieceCount" : 0.0,
          "packageCostPrice" : 0.0,
          "created" : "2023-01-01 00:00:00"
        } ],
        "id" : "ffffffff00000000264a75300d757777",
        "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剂,2日1剂等",
          "requirement" : "饭前服用,处方备注信息",
          "usageLevel" : "每次150ml",
          "processUsage" : "煎药,手工煎药,机器煎药(普通),制膏,儿童膏方,成人膏方,打粉,粗粉,细粉,超细粉,制丸,水丸,蜜丸,水蜜丸,浓缩丸,机器煎药(浓缩),颗粒,茶包,胶囊",
          "processRemark" : "加工备注信息",
          "usageDays" : "约服30天"
        },
        "productInfo" : {
          "children" : [ {
            "children" : [ "..." ],
            "id" : "string",
            "name" : "string",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "typeId" : 0,
            "typeName" : "string",
            "customTypeId" : "string",
            "customTypeName" : "string",
            "manufacturer" : "string",
            "medicineNmpn" : "string",
            "barCode" : "string",
            "pieceUnit" : "string",
            "pieceNum" : 0.0,
            "piecePrice" : 0.0,
            "packageUnit" : "string",
            "packagePrice" : 0.0,
            "shortId" : "string",
            "specification" : "1ml:0.5mg*10支/盒",
            "status" : 1,
            "lastModified" : "2022-05-13 12:22:56",
            "goodsSpu" : {
              "id" : "string",
              "name" : "string",
              "brandName" : "string",
              "material" : "string"
            },
            "goodsSpec" : {
              "color" : "string",
              "spec" : "string"
            }
          } ],
          "id" : "string",
          "name" : "string",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "typeId" : 0,
          "typeName" : "string",
          "customTypeId" : "string",
          "customTypeName" : "string",
          "manufacturer" : "string",
          "medicineNmpn" : "string",
          "barCode" : "string",
          "pieceUnit" : "string",
          "pieceNum" : 0.0,
          "piecePrice" : 0.0,
          "packageUnit" : "string",
          "packagePrice" : 0.0,
          "shortId" : "string",
          "specification" : "1ml:0.5mg*10支/盒",
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        },
        "totalPrice" : 10.3
      } ],
      "id" : "ffffffff00000000264a75300d759999",
      "dispseneFormType" : 0,
      "numberOfHerbs" : 0,
      "usageInfo" : {
        "usage" : "煎服,冲服,制膏,制丸,外用,贴敷,打粉,泡饮,泡酒,泡浴,泡脚,擦拭",
        "freq" : "1日3次",
        "medicineRequirement" : "先煎,先煎半小时,先煎一小时,后下,包煎,另煎,先炒,烊化,冲服,捣碎,另包",
        "doseCount" : "3剂",
        "dailyDosage" : "1日3剂,2日1剂等",
        "requirement" : "饭前服用,处方备注信息",
        "usageLevel" : "每次150ml",
        "processUsage" : "煎药,手工煎药,机器煎药(普通),制膏,儿童膏方,成人膏方,打粉,粗粉,细粉,超细粉,制丸,水丸,蜜丸,水蜜丸,浓缩丸,机器煎药(浓缩),颗粒,茶包,胶囊",
        "processRemark" : "加工备注信息",
        "usageDays" : "约服30天"
      },
      "totalPrice" : 30.23
    } ],
    "id" : "ffffffff000000002620d6280d751234",
    "doctorId" : "ffffffff0000000022e9e9580179a123",
    "patientOrderId" : "ffffffff0000000022e9e9580179a123",
    "patientOrderNo" : "诊号:00003447",
    "diagnosedDate" : "2022-07-14 12:00:00",
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛,干咳,咳痰",
      "pastHistory" : "既往体健,既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "patientInfo" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "deliveryInfo" : {
      "addressProvinceName" : "四川省",
      "addressCityName" : "成都市",
      "addressDistrictName" : "高新区",
      "addressDetail" : "四川省成都市高新区xxx街道xxx",
      "deliveryName" : "张三",
      "deliveryMobile" : "18088888888",
      "deliveryCompany" : {
        "id" : "127203805890060288",
        "name" : "string"
      },
      "deliveryOrderNo" : "20827634879930368"
    },
    "deliveryType" : 0,
    "status" : 0,
    "statusName" : "未发药",
    "dispensedBy" : "ffffffff000000002622cbd801e7777",
    "dispensedByName" : "张三",
    "dispensedTime" : "2022-07-14 12:00:00",
    "created" : "2022-07-14 12:00:00",
    "pharmacy" : {
      "no" : 0
    },
    "netIncomeFee" : 43.75,
    "doctor" : {
      "id" : "string",
      "name" : "string"
    },
    "department" : {
      "id" : "ffffffff0000000006dddfe002e22000",
      "name" : "儿保科室",
      "type" : 1,
      "mainMedicalName" : "儿科",
      "secondMedicalName" : "小儿呼吸"
    },
    "isShebaoPay" : 0
  }
}

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

HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/query-by-date?date=2022-01-03
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "chargeSheetId" : "string",
      "pharmacyNo" : 0,
      "pharmacyType" : 0,
      "status" : 0
    } ],
    "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

消耗
  • 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

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/ffffffff00000000264a75300d752999/undispense-all
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.8.5. 修改加工状态

PUT /api/v2/open-agency/dispensing/processing-status
参数
类型 名称 说明 类型

Body

-
必填

-

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/processing-status
请求 body
{
  "externalTrace" : [ {
    "content" : "string",
    "time" : "yyyy-MM-dd HH:mm:ss"
  } ],
  "dispensingSheetId" : "string",
  "dispensingFormId" : "string",
  "processGeneralStatus" : 0
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.8.6. 修改快递信息

PUT /api/v2/open-agency/dispensing/delivery
参数
类型 名称 说明 类型

Body

-
必填

-

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/delivery
请求 body
{
  "externalTrace" : [ {
    "content" : "string",
    "time" : "yyyy-MM-dd HH:mm:ss"
  } ],
  "dispensingSheetId" : "string",
  "deliveryStatus" : 700,
  "deliveryOrderNo" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.8.7. 更新快递物流信息

PUT /api/v2/open-agency/dispensing/delivery/trace/{deliveryOrderNo}
参数
类型 名称 说明 类型

Body

-
必填

-

Path

deliveryOrderNo
必填

快递单号

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/delivery/trace/string
请求 body
{
  "deliveryTraceData" : [ {
    "context" : "string",
    "ftime" : "string"
  } ]
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.8.8. 根据收费单ID查询发药单详情列表

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

Path

id
必填

收费单ID

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/by-charge-sheet-id/string
HTTP响应示例
响应 200
{
  "data" : {
    "dispensingSheets" : [ {
      "clinicId" : "ffffffff000000002620d6280d751234",
      "dispensingForms" : [ {
        "dispensingFormItems" : [ {
          "dispensingBatches" : [ {
            "action" : "发药",
            "stockId" : 0,
            "supplier" : {
              "id" : "string",
              "name" : "string"
            },
            "batchNo" : "string",
            "expiryDate" : "string",
            "packageCount" : 0.0,
            "pieceCount" : 0.0,
            "packageCostPrice" : 0.0,
            "created" : "2023-01-01 00:00:00"
          } ],
          "id" : "ffffffff00000000264a75300d757777",
          "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剂,2日1剂等",
            "requirement" : "饭前服用,处方备注信息",
            "usageLevel" : "每次150ml",
            "processUsage" : "煎药,手工煎药,机器煎药(普通),制膏,儿童膏方,成人膏方,打粉,粗粉,细粉,超细粉,制丸,水丸,蜜丸,水蜜丸,浓缩丸,机器煎药(浓缩),颗粒,茶包,胶囊",
            "processRemark" : "加工备注信息",
            "usageDays" : "约服30天"
          },
          "productInfo" : {
            "children" : [ {
              "children" : [ "..." ],
              "id" : "string",
              "name" : "string",
              "shebao" : {
                "nationalCode" : "T001700643",
                "insuranceTypes" : [ {
                  "insuranceType" : "391",
                  "reimbursementRatio" : 0.1
                } ]
              },
              "typeId" : 0,
              "typeName" : "string",
              "customTypeId" : "string",
              "customTypeName" : "string",
              "manufacturer" : "string",
              "medicineNmpn" : "string",
              "barCode" : "string",
              "pieceUnit" : "string",
              "pieceNum" : 0.0,
              "piecePrice" : 0.0,
              "packageUnit" : "string",
              "packagePrice" : 0.0,
              "shortId" : "string",
              "specification" : "1ml:0.5mg*10支/盒",
              "status" : 1,
              "lastModified" : "2022-05-13 12:22:56",
              "goodsSpu" : {
                "id" : "string",
                "name" : "string",
                "brandName" : "string",
                "material" : "string"
              },
              "goodsSpec" : {
                "color" : "string",
                "spec" : "string"
              }
            } ],
            "id" : "string",
            "name" : "string",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "typeId" : 0,
            "typeName" : "string",
            "customTypeId" : "string",
            "customTypeName" : "string",
            "manufacturer" : "string",
            "medicineNmpn" : "string",
            "barCode" : "string",
            "pieceUnit" : "string",
            "pieceNum" : 0.0,
            "piecePrice" : 0.0,
            "packageUnit" : "string",
            "packagePrice" : 0.0,
            "shortId" : "string",
            "specification" : "1ml:0.5mg*10支/盒",
            "status" : 1,
            "lastModified" : "2022-05-13 12:22:56",
            "goodsSpu" : {
              "id" : "string",
              "name" : "string",
              "brandName" : "string",
              "material" : "string"
            },
            "goodsSpec" : {
              "color" : "string",
              "spec" : "string"
            }
          },
          "totalPrice" : 10.3
        } ],
        "id" : "ffffffff00000000264a75300d759999",
        "dispseneFormType" : 0,
        "numberOfHerbs" : 0,
        "usageInfo" : {
          "usage" : "煎服,冲服,制膏,制丸,外用,贴敷,打粉,泡饮,泡酒,泡浴,泡脚,擦拭",
          "freq" : "1日3次",
          "medicineRequirement" : "先煎,先煎半小时,先煎一小时,后下,包煎,另煎,先炒,烊化,冲服,捣碎,另包",
          "doseCount" : "3剂",
          "dailyDosage" : "1日3剂,2日1剂等",
          "requirement" : "饭前服用,处方备注信息",
          "usageLevel" : "每次150ml",
          "processUsage" : "煎药,手工煎药,机器煎药(普通),制膏,儿童膏方,成人膏方,打粉,粗粉,细粉,超细粉,制丸,水丸,蜜丸,水蜜丸,浓缩丸,机器煎药(浓缩),颗粒,茶包,胶囊",
          "processRemark" : "加工备注信息",
          "usageDays" : "约服30天"
        },
        "totalPrice" : 30.23
      } ],
      "id" : "ffffffff000000002620d6280d751234",
      "doctorId" : "ffffffff0000000022e9e9580179a123",
      "patientOrderId" : "ffffffff0000000022e9e9580179a123",
      "patientOrderNo" : "诊号:00003447",
      "diagnosedDate" : "2022-07-14 12:00:00",
      "medicalRecord" : {
        "id" : "string",
        "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
        "chiefComplaint" : "咽痛,干咳,咳痰",
        "pastHistory" : "既往体健,既往有高血压",
        "familyHistory" : "string",
        "presentHistory" : "string",
        "physicalExamination" : "string",
        "diagnosis" : "急性上呼吸道感染",
        "doctorAdvice" : "string",
        "syndrome" : "string",
        "therapy" : "string",
        "chineseExamination" : "string",
        "obstetricalHistory" : "string",
        "eyeExamination" : {
          "items" : [ {
            "key" : "string",
            "name" : "string",
            "rightEyeValue" : "string",
            "leftEyeValue" : "string"
          } ]
        },
        "allergicHistory" : "青霉素过敏",
        "attachments" : [ {
          "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
          "fileName" : "NatGeo09.jpg",
          "fileSize" : 4771201
        } ]
      },
      "patientInfo" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "deliveryInfo" : {
        "addressProvinceName" : "四川省",
        "addressCityName" : "成都市",
        "addressDistrictName" : "高新区",
        "addressDetail" : "四川省成都市高新区xxx街道xxx",
        "deliveryName" : "张三",
        "deliveryMobile" : "18088888888",
        "deliveryCompany" : {
          "id" : "127203805890060288",
          "name" : "string"
        },
        "deliveryOrderNo" : "20827634879930368"
      },
      "deliveryType" : 0,
      "status" : 0,
      "statusName" : "未发药",
      "dispensedBy" : "ffffffff000000002622cbd801e7777",
      "dispensedByName" : "张三",
      "dispensedTime" : "2022-07-14 12:00:00",
      "created" : "2022-07-14 12:00:00",
      "pharmacy" : {
        "no" : 0
      },
      "netIncomeFee" : 43.75,
      "doctor" : {
        "id" : "string",
        "name" : "string"
      },
      "department" : {
        "id" : "ffffffff0000000006dddfe002e22000",
        "name" : "儿保科室",
        "type" : 1,
        "mainMedicalName" : "儿科",
        "secondMedicalName" : "小儿呼吸"
      },
      "isShebaoPay" : 0
    } ]
  }
}

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

HTTP请求示例
请求 path
/api/v2/open-agency/dispensing/patient/string
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "chargeSheetId" : "string",
      "pharmacyNo" : 0,
      "pharmacyType" : 0,
      "status" : 0,
      "created" : "2024-05-30 08:13:00",
      "sellerId" : "ffffffff000000002620d6280d751234",
      "sellerName" : "张三"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.9. 检查检验接口

5.9.1. 按患者查询检查检验单

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

Path

patientId
必填

患者ID

string

Query

endTime
可选

结束时间(格式yyyy-MM-dd HH:mm:ss)

string

Query

limit
可选

每页显示条数

integer (int32)

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

HTTP请求示例
请求 path
/api/v2/open-agency/examination/query-by-patient/af38e7591b864838a411c1fd9cd835ac
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "name" : "string",
      "type" : 1,
      "deviceType" : 0,
      "businessType" : 0,
      "created" : "string",
      "status" : 0,
      "statusName" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.9.2. 按创建时间查询检查检验单

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

Query

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

HTTP请求示例
请求 path
/api/v2/open-agency/examination/all/query-by-date
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "orderNo" : "string",
      "productId" : "string",
      "products" : [ {
        "productId" : "string",
        "productName" : "string",
        "examinationSheetId" : "string"
      } ],
      "productIds" : [ "string" ],
      "name" : "string",
      "type" : 1,
      "deviceType" : 0,
      "businessType" : 0,
      "sampleType" : "string",
      "patientOrderNo" : "string",
      "patientOrderType" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "createdTime" : "string",
      "patientInfo" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "status" : 0,
      "statusName" : "待检"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.9.3. 按就诊号查询检查检验单

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

Query

patientOrderNo
必填

就诊号

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/examination/query-by-patient-order-no?patientOrderNo=12212
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "diagnosis" : "string",
      "id" : "string",
      "orderNo" : "string",
      "productId" : "string",
      "products" : [ {
        "productId" : "string",
        "productName" : "string",
        "examinationSheetId" : "string"
      } ],
      "productIds" : [ "string" ],
      "name" : "string",
      "type" : 1,
      "deviceType" : 0,
      "businessType" : 0,
      "sampleType" : "string",
      "patientOrderNo" : "string",
      "patientOrderType" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "createdTime" : "string",
      "patientInfo" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "status" : 0,
      "statusName" : "待检"
    } ]
  }
}

5.9.4. 查询检查检验单详情

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

Path

id
必填

检查检验单id

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/examination/examination-sheet-detail/string
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "outpatientFormItemId" : "string",
    "patientOrderId" : "string",
    "patientOrderNumber" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "sn" : "100",
      "idCard" : "string",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      }
    },
    "doctorId" : "string",
    "doctorName" : "string",
    "doctorDepartmentId" : "string",
    "doctorDepartmentName" : "string",
    "sellerId" : "string",
    "sellerName" : "string",
    "sellerDepartmentId" : "string",
    "sellerDepartmentName" : "string",
    "productId" : "string",
    "products" : [ {
      "productId" : "string",
      "productName" : "string",
      "examinationSheetId" : "string"
    } ],
    "productIds" : [ "string" ],
    "composeParentProductId" : "string",
    "composeParentName" : "string",
    "name" : "string",
    "orderNo" : "202302140038",
    "status" : 0,
    "statusName" : "string",
    "sampleType" : "string",
    "samplerId" : "string",
    "samplerName" : "string",
    "sampleTime" : "string",
    "collectorId" : "string",
    "collectorName" : "string",
    "collectTime" : "string",
    "results" : [ {
      "id" : "string",
      "type" : 1,
      "name" : "string",
      "enName" : "string",
      "unit" : "string",
      "itemCode" : "string",
      "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
      "productId" : "string",
      "resultDisplayScale" : 0,
      "value" : { },
      "valueType" : "STRING",
      "abnormalFlag" : "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",
        "date" : "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
  }
}

5.9.5. 按单号查询检查检验单(条形码)

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

Path

orderNo
必填

订单号

string

Path

type
必填

类型 1:检验 2:检查

integer (int32)

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/examination/by-order-no/string/1
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "outpatientFormItemId" : "string",
    "patientOrderId" : "string",
    "patientOrderNumber" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "sn" : "100",
      "idCard" : "string",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      }
    },
    "doctorId" : "string",
    "doctorName" : "string",
    "doctorDepartmentId" : "string",
    "doctorDepartmentName" : "string",
    "sellerId" : "string",
    "sellerName" : "string",
    "sellerDepartmentId" : "string",
    "sellerDepartmentName" : "string",
    "productId" : "string",
    "products" : [ {
      "productId" : "string",
      "productName" : "string",
      "examinationSheetId" : "string"
    } ],
    "productIds" : [ "string" ],
    "composeParentProductId" : "string",
    "composeParentName" : "string",
    "name" : "string",
    "orderNo" : "202302140038",
    "status" : 0,
    "statusName" : "string",
    "sampleType" : "string",
    "samplerId" : "string",
    "samplerName" : "string",
    "sampleTime" : "string",
    "collectorId" : "string",
    "collectorName" : "string",
    "collectTime" : "string",
    "results" : [ {
      "id" : "string",
      "type" : 1,
      "name" : "string",
      "enName" : "string",
      "unit" : "string",
      "itemCode" : "string",
      "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
      "productId" : "string",
      "resultDisplayScale" : 0,
      "value" : { },
      "valueType" : "STRING",
      "abnormalFlag" : "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",
        "date" : "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
  }
}

5.9.6. 根据检验单号修改检验单信息

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

Body

-
必填

-

Path

orderNo
必填

订单号

string

Path

type
必填

类型 1:检验 2:检查

integer (int32)

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/examination/by-order-no/string/1
请求 body
{
  "attachments" : [ {
    "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
    "fileName" : "NatGeo09.jpg",
    "fileSize" : 4771201
  } ],
  "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" : "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",
      "date" : "string"
    }
  } ],
  "deviceModelId" : 0,
  "deviceId" : 0,
  "subType" : 0,
  "remark" : "string",
  "testerId" : "string",
  "testerName" : "string",
  "checkerId" : "string",
  "checkerName" : "string",
  "sampleType" : "string",
  "testTime" : "2022-11-14 14:00",
  "checkTime" : "2022-11-14 14:00",
  "reportTime" : "2022-11-14 14:00",
  "status" : 0,
  "relationPatientOrderId" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "outpatientFormItemId" : "string",
    "patientOrderId" : "string",
    "patientOrderNumber" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "sn" : "100",
      "idCard" : "string",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      }
    },
    "doctorId" : "string",
    "doctorName" : "string",
    "doctorDepartmentId" : "string",
    "doctorDepartmentName" : "string",
    "sellerId" : "string",
    "sellerName" : "string",
    "sellerDepartmentId" : "string",
    "sellerDepartmentName" : "string",
    "productId" : "string",
    "products" : [ {
      "productId" : "string",
      "productName" : "string",
      "examinationSheetId" : "string"
    } ],
    "productIds" : [ "string" ],
    "composeParentProductId" : "string",
    "composeParentName" : "string",
    "name" : "string",
    "orderNo" : "202302140038",
    "status" : 0,
    "statusName" : "string",
    "sampleType" : "string",
    "samplerId" : "string",
    "samplerName" : "string",
    "sampleTime" : "string",
    "collectorId" : "string",
    "collectorName" : "string",
    "collectTime" : "string",
    "results" : [ {
      "id" : "string",
      "type" : 1,
      "name" : "string",
      "enName" : "string",
      "unit" : "string",
      "itemCode" : "string",
      "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
      "productId" : "string",
      "resultDisplayScale" : 0,
      "value" : { },
      "valueType" : "STRING",
      "abnormalFlag" : "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",
        "date" : "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
  }
}

5.9.7. 保存检查检验单数据

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

Body

-
必填

-

Path

id
必填

检查检验单id

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/examination/examination-sheet-detail/string
请求 body
{
  "attachments" : [ {
    "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
    "fileName" : "NatGeo09.jpg",
    "fileSize" : 4771201
  } ],
  "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" : "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",
      "date" : "string"
    }
  } ],
  "deviceModelId" : 0,
  "deviceId" : 0,
  "subType" : 0,
  "remark" : "string",
  "testerId" : "string",
  "testerName" : "string",
  "checkerId" : "string",
  "checkerName" : "string",
  "sampleType" : "string",
  "testTime" : "2022-11-14 14:00",
  "checkTime" : "2022-11-14 14:00",
  "reportTime" : "2022-11-14 14:00",
  "status" : 0,
  "relationPatientOrderId" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "string",
    "outpatientFormItemId" : "string",
    "patientOrderId" : "string",
    "patientOrderNumber" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "sn" : "100",
      "idCard" : "string",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      }
    },
    "doctorId" : "string",
    "doctorName" : "string",
    "doctorDepartmentId" : "string",
    "doctorDepartmentName" : "string",
    "sellerId" : "string",
    "sellerName" : "string",
    "sellerDepartmentId" : "string",
    "sellerDepartmentName" : "string",
    "productId" : "string",
    "products" : [ {
      "productId" : "string",
      "productName" : "string",
      "examinationSheetId" : "string"
    } ],
    "productIds" : [ "string" ],
    "composeParentProductId" : "string",
    "composeParentName" : "string",
    "name" : "string",
    "orderNo" : "202302140038",
    "status" : 0,
    "statusName" : "string",
    "sampleType" : "string",
    "samplerId" : "string",
    "samplerName" : "string",
    "sampleTime" : "string",
    "collectorId" : "string",
    "collectorName" : "string",
    "collectTime" : "string",
    "results" : [ {
      "id" : "string",
      "type" : 1,
      "name" : "string",
      "enName" : "string",
      "unit" : "string",
      "itemCode" : "string",
      "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
      "productId" : "string",
      "resultDisplayScale" : 0,
      "value" : { },
      "valueType" : "STRING",
      "abnormalFlag" : "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",
        "date" : "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
  }
}

5.9.8. 创建检查检验单

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

Body

-
必填

-

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/examination
请求 body
{
  "patientId" : "string",
  "productSubType" : 0,
  "examinationFormItems" : [ {
    "productId" : "string",
    "name" : "string",
    "unitCount" : 0.0
  } ],
  "doctorId" : "string",
  "doctorDepartmentId" : "string",
  "operatorId" : "00000000000000000000000000000000"
}
HTTP响应示例
响应 200
{
  "data" : {
    "examinationSheets" : [ {
      "id" : "string",
      "orderNo" : "string",
      "productId" : "string",
      "products" : [ {
        "productId" : "string",
        "productName" : "string",
        "examinationSheetId" : "string"
      } ],
      "productIds" : [ "string" ],
      "name" : "string",
      "type" : 1,
      "deviceType" : 0,
      "businessType" : 0,
      "sampleType" : "string",
      "patientOrderNo" : "string",
      "patientOrderType" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "createdTime" : "string",
      "patientInfo" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "status" : 0,
      "statusName" : "待检"
    } ]
  }
}

5.9.9. 作废检查检验单

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

Path

id
必填

检查检验单id

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

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

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

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

Path

type
必填

类型 1:检验 2:检查

integer (int32)

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/examination/devices/1
HTTP响应示例
响应 200
{
  "data" : {
    "devices" : [ {
      "deviceId" : 0,
      "deviceShortId" : "string",
      "deviceModelId" : 0,
      "name" : "string",
      "model" : "string",
      "deviceUuid" : "string",
      "manufacture" : "string",
      "iconUrl" : "string",
      "buyUrl" : "string",
      "installUrl" : "string",
      "remarks" : "string",
      "type" : 0,
      "extendSpec" : "string",
      "deviceType" : 0,
      "usageType" : 0,
      "salePrice" : 0.0,
      "deviceNamePy" : "string",
      "deviceStatus" : 0,
      "deviceRoomId" : 0,
      "deviceRoomName" : "string",
      "department" : {
        "id" : "ffffffff0000000006dddfe002e22000",
        "name" : "儿保科室",
        "type" : 1,
        "mainMedicalName" : "儿科",
        "secondMedicalName" : "小儿呼吸"
      }
    } ]
  }
}

5.10. 统计接口

5.10.1. 收费明细-单据

GET /api/v2/open-agency/stat/revenue/detail/transaction
参数
类型 名称 说明 类型 默认值

Query

date
必填

日期(格式yyyy-MM-dd)

string

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/stat/revenue/detail/transaction?date=2020-03-05
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "clinicName" : "大源店",
      "receivableFee" : 0.0,
      "chargeSheetId" : "ffffffff00000000264a75300d752999",
      "departmentName" : "内科",
      "employeeName" : "张三",
      "chargeName" : "李四",
      "totalPrice" : 20.0,
      "adjustmentPrice" : 0.0,
      "discountPrice" : -9.0,
      "deductPrice" : 0.0,
      "amount" : 11.0,
      "created" : "2022-04-28 15:41:27",
      "sourceType" : "门诊",
      "action" : "收费",
      "patientName" : "张三",
      "no" : 100,
      "payMode" : "支付宝",
      "comment" : "-"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.10.2. 收费明细-分类

GET /api/v2/open-agency/stat/revenue/detail/classify
参数
类型 名称 说明 类型 默认值

Query

date
必填

日期(格式yyyy-MM-dd)

string

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/stat/revenue/detail/classify?date=2020-03-05
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "clinicName" : "大源店",
      "feeType" : "string",
      "departmentName" : "内科",
      "employeeName" : "张三",
      "chargeName" : "李四",
      "totalPrice" : 20.0,
      "adjustmentPrice" : 0.0,
      "discountPrice" : -9.0,
      "deductPrice" : 0.0,
      "amount" : 11.0,
      "created" : "2022-04-28 15:41:27",
      "sourceType" : "门诊",
      "action" : "收费",
      "patientName" : "张三",
      "no" : 100,
      "payMode" : "支付宝",
      "comment" : "-"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.10.3. 收费明细-明细

GET /api/v2/open-agency/stat/revenue/detail/items
参数
类型 名称 说明 类型 默认值

Query

date
必填

日期(格式yyyy-MM-dd)

string

Query

limit
必填

每页显示条数,最大不能超过 100

integer (int32)

20

Query

offset
必填

分页起始下标

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/stat/revenue/detail/items?date=2020-03-05&limit=20&offset=0
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "clinicName" : "大源店",
      "name" : "血清胰岛素、",
      "count" : 1.0,
      "departmentName" : "内科",
      "employeeName" : "张三",
      "price" : 5.0,
      "chargeName" : "李四",
      "feeType1" : "治疗",
      "feeType2" : "-",
      "totalPrice" : 20.0,
      "adjustmentPrice" : 0.0,
      "productType" : 1,
      "discountPrice" : -9.0,
      "productSubType" : 20,
      "deductPrice" : 0.0,
      "productCustomType" : 1000,
      "amount" : 11.0,
      "patientId" : "ffffffff00000000220e67a8116d8000",
      "created" : "2022-04-28 15:41:27",
      "sourceType" : "门诊",
      "action" : "收费",
      "patientName" : "张三",
      "no" : 100,
      "payMode" : "支付宝",
      "comment" : "-"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.11. 事件推送接口

5.11.1. 查询推送失败事件列表

GET /api/v2/open-agency/app-callback/{appId}/fail
参数
类型 名称 说明 类型

Path

appId
必填

应用id

string

Query

date
必填

日期(格式yyyy-MM-dd)

string

Query

limit
必填

每页显示条数,最大值为500

integer (int32)

Query

offset
必填

分页起始下标

integer (int32)

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/app-callback/2730297344132816890/fail?date=2022-01-03&limit=100&offset=0
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "2730297344132816890",
      "appId" : "1928374655",
      "appCallBackUrl" : "https://xxx.com/xx/xx",
      "callBackBody" : {
        "clinicId" : "string",
        "eventModule" : 1,
        "eventType" : 101,
        "eventName" : "收费完成",
        "eventData" : { }
      },
      "failReason" : "404 Not Found:",
      "status" : 2,
      "created" : "2022-04-06 15:12:53"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.12. 平台接口

5.12.1. 获取中国地区信息

GET /api/v2/open-agency/property/address/china
响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/property/address/china
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "510000",
    "name" : "四川",
    "children" : [ {
      "id" : "510000",
      "name" : "四川",
      "children" : [ "..." ]
    } ]
  }
}

5.12.2. 获取 OSS Token

GET /api/v2/open-agency/property/oss/token
说明

该接口用于生成可以将文件上传到 OSS 的 token。引入 阿里云SDK、代码参考示例 使用临时访问凭证上传文件至OSS

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/property/oss/token
HTTP响应示例
响应 200
{
  "data" : {
    "endpoint" : "string",
    "bucket" : "string",
    "fileDir" : "string",
    "securityToken" : "string",
    "accessKeySecret" : "string",
    "accessKeyId" : "string",
    "expiration" : "2022-11-09 12:00:00"
  }
}

5.12.3. 发送报警

POST /api/v2/open-agency/property/report/alert
参数
类型 名称 说明 类型

Body

-
必填

-

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/property/report/alert
请求 body
{
  "title" : "处理发药事件失败",
  "content" : "内容"
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.13. 执行接口

5.13.1. 按天查询执行单列表

GET /api/v2/open-agency/execute/query-by-date
参数
类型 名称 说明 类型

Query

date
必填

日期 yyyy-MM-dd

string (date)

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/execute/query-by-date?date=2023-08-13
HTTP响应示例
响应 200
{
  "data" : {
    "executeSheets" : [ {
      "id" : "ffffffff000000003484c3816487c002",
      "patientOrderId" : "ffffffff000000003484c3816487c002",
      "status" : 1,
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "abstractInfo" : "string",
      "created" : "2022-04-06 15:12:53"
    } ]
  }
}

5.13.2. 执行单详情

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

Path

id
必填

执行单ID

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/execute/ffffffff000000003484c3816487c002
HTTP响应示例
响应 200
{
  "data" : {
    "id" : "ffffffff000000003484c3816487c002",
    "patientOrderId" : "ffffffff000000003484c3816487c002",
    "items" : [ {
      "id" : "0002b62eaf9c461f85ff3fedc4583a79",
      "needExecutive" : 1,
      "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
      "executedUnitCount" : 2.0,
      "executeStatus" : 1,
      "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
      "productName" : "注射用青霉素钠",
      "status" : 0,
      "unit" : "支",
      "receivedFee" : 40.0,
      "unitPrice" : 10.0,
      "displayUnitPrice" : 10.0,
      "displayTotalPrice" : 40.0,
      "unitCount" : 4.0,
      "doseCount" : 1.0,
      "totalCount" : 4.0,
      "productType" : 1,
      "productSubType" : 3,
      "sourceItemType" : 0
    } ],
    "status" : 1,
    "created" : "2022-04-06 15:12:53",
    "sellerId" : "ffffffff000000003484c3816487c002",
    "sellerName" : "张三"
  }
}

5.13.3. 执行

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

Body

-
必填

-

Path

id
必填

执行单ID

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/execute/ffffffff000000003484c3816487c002/do
请求 body
{
  "items" : [ {
    "id" : "ffffffff000000003484c3816487c002",
    "executeCount" : 1
  } ],
  "executorIds" : [ "string" ],
  "operatorId" : "string",
  "comment" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.13.4. 查询执行单执行历史

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

Path

id
必填

执行单ID

string

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/execute/ffffffff000000003484c3816487c002/record
HTTP响应示例
响应 200
{
  "data" : {
    "executeRecords" : [ {
      "id" : "ffffffff000000003484c3816487c002",
      "status" : 0,
      "executors" : [ {
        "id" : "string",
        "name" : "string"
      } ],
      "items" : [ {
        "id" : 0,
        "executeItemId" : "ffffffff000000003484c3816487c002",
        "executeItemProductId" : "ffffffff000000003484c3816487c002",
        "executeItemProductName" : "雾化吸入",
        "executeCount" : 2
      } ],
      "executeTime" : "2022-04-06 15:12:53",
      "operator" : {
        "id" : "string",
        "name" : "string"
      }
    } ]
  }
}

5.13.5. 撤销执行

POST /api/v2/open-agency/execute/{id}/record/{executeRecordId}/undo
说明

撤销执行的维度是一次执行操作,而不是执行项目

参数
类型 名称 说明 类型

Body

-
必填

-

Path

executeRecordId
必填

执行记录ID

string

Path

id
必填

执行单ID

string

响应
HTTP Code 说明 类型

200

OK

消耗
  • application/json

HTTP请求示例
请求 path
/api/v2/open-agency/execute/ffffffff000000003484c3816487c002/record/ffffffff000000003484c3816487c003/undo
请求 body
{
  "operatorId" : "string"
}
HTTP响应示例
响应 200
{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.13.6. 查询患者执行单列表

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

Path

patientId
必填

患者ID

string

Query

beginDate
可选

开始日期,yyyy-MM-dd,为空则默认为三个月前

string

Query

endDate
可选

结束日期,yyyy-MM-dd,为空则默认为今天

string

Query

executeStatus
可选

执行状态 1:待执行 2:已执行 3:已取消(已退费)

integer (int32)

Query

limit
可选

分页大小,默认为 10,最大为 25

integer (int32)

10

Query

offset
可选

分页偏移,默认为 0

integer (int32)

0

响应
HTTP Code 说明 类型

200

OK

HTTP请求示例
请求 path
/api/v2/open-agency/execute/patient/ffffffff00000000287b8f500fa68000
HTTP响应示例
响应 200
{
  "data" : {
    "rows" : [ {
      "id" : "ffffffff0000000034be47d786e44000",
      "status" : 1,
      "created" : "2022-04-06 15:12:53",
      "items" : [ {
        "id" : "ffffffff0000000034be47d5e6e44002",
        "productId" : "ffffffff000000003499787109ea4003",
        "productName" : "推拿",
        "chargeStatus" : 1,
        "totalCount" : 10.0,
        "executedUnitCount" : 2.0
      } ],
      "sellerId" : "ffffffff0000000034be47d786e44000",
      "sellerName" : "张三"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

6. 模型定义

6.1. JsonNode

类型 : object

6.2. 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

6.3. OpenPatientChargeSheetBriefView

患者收费单摘要信息

名称 说明 类型

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)

6.4. OpenPatientDispensingSheetView

患者发药单信息

名称 说明 类型

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

6.5. R«OSS开放Token»

名称 说明 类型

data
可选

数据
样例 : OSS开放Token

6.6. R«事件推送详情»

名称 说明 类型

data
可选

数据
样例 : 事件推送详情

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

名称 说明 类型

data
可选

6.8. R«入库单详情»

名称 说明 类型

data
可选

数据
样例 : 入库单详情

6.9. R«出库单详情»

名称 说明 类型

data
可选

数据
样例 : 出库单详情

6.10. R«分页查询结果«OpenPatientChargeSheetBriefView»»

名称 说明 类型

data
可选

6.11. R«分页查询结果«OpenPatientDispensingSheetView»»

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

6.28. R«医生信息»

名称 说明 类型

data
可选

数据
样例 : 医生信息

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

6.31. R«发药单详情»

名称 说明 类型

data
可选

数据
样例 : 发药单详情

6.32. R«取消挂号响应»

名称 说明 类型

data
可选

数据
样例 : 取消挂号响应

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

名称 说明 类型

data
可选

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

6.34. R«商品详情»

名称 说明 类型

data
可选

数据
样例 : 商品详情

6.35. R«地区信息»

名称 说明 类型

data
可选

数据
样例 : 地区信息

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

6.42. R«患者列表响应»

名称 说明 类型

data
可选

数据
样例 : 患者列表响应

6.43. R«患者摘要信息»

名称 说明 类型

data
可选

数据
样例 : 患者摘要信息

6.44. R«患者详细信息»

名称 说明 类型

data
可选

数据
样例 : 患者详细信息

6.45. R«执行单详情»

名称 说明 类型

data
可选

数据
样例 : 执行单详情

6.46. R«挂号详细信息»

名称 说明 类型

data
可选

数据
样例 : 挂号详细信息

6.47. R«操作响应结果»

名称 说明 类型

data
可选

数据
样例 : 操作响应结果

6.48. R«收费单列表»

名称 说明 类型

data
可选

数据
样例 : 收费单列表

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

6.64. R«盘点单详情»

名称 说明 类型

data
可选

数据
样例 : 盘点单详情

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

名称 说明 类型

data
可选

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

6.66. R«科室详细信息(含科室人员列表)»

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

6.72. R«门店信息»

名称 说明 类型

data
可选

数据
样例 : 门店信息

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

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

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

名称 说明 类型

data
可选

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

名称 说明 类型

data
可选

6.77. 中药处方加工信息

名称 说明 类型

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

6.78. 事件推送详情

名称 说明 类型

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)

6.79. 事件推送请求

名称 说明 类型

clinicId
可选

机构ID
样例 : "string"

string

eventModule
可选

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

integer (int32)

eventType
可选

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

integer (int32)

eventName
可选

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

string

eventData
可选

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

6.80. 交易记录商品明细

名称 说明 类型

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
可选

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

6.81. 会员信息

名称 说明 类型

principal
可选

本金
样例 : 2866.6

number

present
可选

赠金
样例 : 368.0

number

created
可选

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

string (date-time)

memberTypeInfo
可选

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

6.82. 会员卡信息

名称 说明 类型

id
可选

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

string

name
可选

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

string

6.83. 住址

名称 说明 类型

addressProvinceId
可选

省编码
样例 : "510000"

string

addressProvinceName
可选

省名称
样例 : "四川"

string

addressCityId
可选

市编码
样例 : "510100"

string

addressCityName
可选

市名称
样例 : "成都市"

string

addressDistrictId
可选

区编码
样例 : "510109"

string

addressDistrictName
可选

区名称
样例 : "高新区"

string

addressDetail
可选

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

string

6.84. 供应商档案信息

名称 说明 类型

id
可选

供应商编码
样例 : "string"

string

name
可选

供应商名称
样例 : "string"

string

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

名称 说明 类型

supplierInfoList
可选

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

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

名称 说明 类型

externalTrace
可选

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

< 外部跟踪信息 > array

dispensingSheetId
可选

发药单ID
样例 : "string"

string

dispensingFormId
可选

发药处方ID
样例 : "string"

string

processGeneralStatus
可选

加工通用状态 0:初始状态 100:审方中 200:调配中 300:浸泡中 400:加工中 500:包装中 600:待快递 9999:已取消
样例 : 0

integer (int32)

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

名称 说明 类型

externalTrace
可选

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

< 外部跟踪信息 > array

dispensingSheetId
可选

发药单id
样例 : "string"

string

deliveryStatus
可选

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

integer (int32)

deliveryOrderNo
可选

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

string

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

名称 说明 类型

addTagIds
可选

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

< string > array

deleteTagIds
可选

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

< string > array

operatorId
可选

操作人ID
样例 : "string"

string

6.89. 修改患者请求体

名称 说明 类型

name
可选

姓名
样例 : "string"

string

mobile
可选

手机号
样例 : "string"

string

sex
可选

性别
样例 : "string"

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

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

名称 说明 类型

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

6.91. 入库单事件

名称 说明 类型

id
可选

入库单ID
样例 : 0

integer (int64)

inOrderItemList
可选

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

< 入库单条目 > array

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

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

integer (int32)

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
可选

入库药房
样例 : 药房详情

type
可选

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

integer (int32)

6.92. 入库单条目

名称 说明 类型

id
可选

条目ID
样例 : 0

integer (int64)

productId
可选

商品编码
样例 : "string"

string

productShortId
可选

商品short编码
样例 : "string"

string

productName
可选

商品名称
样例 : "string"

string

specification
可选

规格
样例 : "string"

string

expiryDate
可选

有效期
样例 : "yyyy-mm-dd"

string

productionDate
可选

生产日期
样例 : "yyyy-mm-dd"

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

packageCostPrice
可选

包装成本单价
样例 : 0.0

number

packageCount
可选

入库包装数量
样例 : 0.0

number

pieceCount
可选

入库制剂数量
样例 : 0.0

number

amount
可选

金额
样例 : 0.0

number

batchNo
可选

生产批号
样例 : "string"

string

lastModified
可选

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

string (date-time)

6.93. 入库单详情

名称 说明 类型

comment
可选

备注
样例 : 评论

id
可选

入库单ID
样例 : 0

integer (int64)

inOrderItemList
可选

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

< 入库单条目 > array

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

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

integer (int32)

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
可选

入库药房
样例 : 药房详情

type
可选

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

integer (int32)

6.94. 出库单事件

名称 说明 类型

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
可选

出库药房
样例 : 药房详情

6.95. 出库单条目

名称 说明 类型

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
可选

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

6.96. 出库单详情

名称 说明 类型

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
可选

出库药房
样例 : 药房详情

6.97. 分页查询结果«OpenPatientChargeSheetBriefView»

名称 说明 类型

rows
可选

数据集
样例 : [ "OpenPatientChargeSheetBriefView" ]

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

6.98. 分页查询结果«OpenPatientDispensingSheetView»

名称 说明 类型

rows
可选

数据集
样例 : [ "OpenPatientDispensingSheetView" ]

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

< 事件推送详情 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

< 医生信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

< 商品信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

< 患者摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

rows
可选

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称 说明 类型

isTotalPriceChanged
必填

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

integer (int32)

pharmacyNo
可选

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

integer (int32)

expectedTotalPrice
可选

期望处方总价(议价时使用)
样例 : 10.0

number

specification
必填

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

string

doseCount
必填

剂数
样例 : 3

integer (int32)

prescriptionFormItems
可选

usage
必填

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

string

dailyDosage
可选

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

string

freq
可选

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

string

usageLevel
可选

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

string

usageDays
可选

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

string

requirement
可选

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

string

processInfo
可选

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

6.114. 创建处方基类

名称 说明 类型

isTotalPriceChanged
必填

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

integer (int32)