ABC数字医疗云开放平台

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/products/purchase-orders/string/review

请求 body

{
  "pass" : 1,
  "comment" : "药品数量超过限制"
}

HTTP响应示例

响应 200

{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.3.24. 审核修正入库单

PUT /api/v2/open-agency/products/fixed-in-orders/{fixInOrderId}/review

参数

类型

名称

说明

类型

Body

-
必填

修正入库单审核请求

Path

fixInOrderId
必填

修正入库单ID

string

响应

HTTP Code

说明

类型

200

OpenGoodsStockOutApplyOrderReviewReq

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/products/fixed-in-orders/string/review

请求 body

{
  "pass" : 1,
  "comment" : "确认通过"
}

HTTP响应示例

响应 200

{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.3.25. 创建入库单

POST /api/v2/open-agency/products/in-orders

参数

类型

名称

说明

类型

Body

-
必填

创建入库单请求

响应

HTTP Code

说明

类型

200

R«入库单详情»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/products/in-orders

请求 body

{
  "supplierId" : "string",
  "outOrderNo" : "20241112001",
  "pharmacyNo" : 0,
  "toClinicId" : "ffffffff000000000000000000000001",
  "comment" : "备注",
  "inOrderItemList" : [ {
    "goodsId" : "ffffffff000000000000000000000001",
    "goodsShortId" : "12345",
    "unit" : "瓶",
    "unitCount" : 0.0,
    "unitCostPrice" : 0.0,
    "totalCostPrice" : 0.0,
    "batchNo" : "string",
    "expireDate" : "string",
    "productionDate" : "string",
    "outDetailId" : "string"
  } ]
}

HTTP响应示例

响应 200

{
  "data" : {
    "comment" : {
      "time" : "string",
      "content" : "string",
      "employeeId" : "string",
      "employeeName" : "string"
    },
    "id" : 0,
    "inOrderItemList" : [ {
      "id" : 123456,
      "inId" : 3123456,
      "originalItemId" : 123456,
      "productId" : "ffffffff0000000034966c3a883ec000",
      "productShortId" : "1000001",
      "productName" : "阿莫西林",
      "specification" : "string",
      "expiryDate" : "2022-05-10",
      "productionDate" : "2024-05-10",
      "pieceNum" : 5.0,
      "pieceUnit" : "片",
      "packageUnit" : "盒",
      "packageCostPrice" : 12.5,
      "packageCount" : 2.0,
      "pieceCount" : 10.0,
      "amount" : 6033.23,
      "totalCost" : 6033.23,
      "batchId" : 100026529,
      "batchNo" : "20220526000001",
      "outDetailId" : "12312",
      "stockInOutDetailId" : "12312",
      "created" : "2022-05-10 12:22:56",
      "lastModified" : "2022-05-13 12:22:56"
    } ],
    "inOrderId" : 0,
    "orderNo" : "RK20220526000001",
    "status" : 0,
    "organName" : "高新大源店",
    "organId" : "ffffffff00000000264a75300d752999",
    "amount" : 6033.23,
    "count" : 12.0,
    "kindCount" : 5,
    "operator" : "string",
    "operatorId" : "string",
    "supplier" : "string",
    "supplierId" : "string",
    "effectiveDate" : "2022-04-07 15:12:53",
    "lastModified" : "2022-05-13 12:22:56",
    "pharmacy" : {
      "no" : 0
    },
    "type" : 0
  }
}

5.3.26. 创建退货出库单

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

说明

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

参数

类型

名称

说明

类型

Body

-
必填

创建出库单请求

响应

HTTP Code

说明

类型

200

R«入库单详情»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/products/out-orders

请求 body

{
  "inOrderId" : 0,
  "pharmacyNo" : 0,
  "toClinicId" : "ffffffff000000000000000000000001",
  "comment" : "备注",
  "outOrderItemList" : [ {
    "goodsId" : "ffffffff000000000000000000000001",
    "goodsShortId" : "12345",
    "pieceCount" : 0.0,
    "packageCount" : 0.0,
    "batchNo" : "string"
  } ]
}

HTTP响应示例

响应 200

{
  "data" : {
    "comment" : {
      "time" : "string",
      "content" : "string",
      "employeeId" : "string",
      "employeeName" : "string"
    },
    "id" : 0,
    "inOrderItemList" : [ {
      "id" : 123456,
      "inId" : 3123456,
      "originalItemId" : 123456,
      "productId" : "ffffffff0000000034966c3a883ec000",
      "productShortId" : "1000001",
      "productName" : "阿莫西林",
      "specification" : "string",
      "expiryDate" : "2022-05-10",
      "productionDate" : "2024-05-10",
      "pieceNum" : 5.0,
      "pieceUnit" : "片",
      "packageUnit" : "盒",
      "packageCostPrice" : 12.5,
      "packageCount" : 2.0,
      "pieceCount" : 10.0,
      "amount" : 6033.23,
      "totalCost" : 6033.23,
      "batchId" : 100026529,
      "batchNo" : "20220526000001",
      "outDetailId" : "12312",
      "stockInOutDetailId" : "12312",
      "created" : "2022-05-10 12:22:56",
      "lastModified" : "2022-05-13 12:22:56"
    } ],
    "inOrderId" : 0,
    "orderNo" : "RK20220526000001",
    "status" : 0,
    "organName" : "高新大源店",
    "organId" : "ffffffff00000000264a75300d752999",
    "amount" : 6033.23,
    "count" : 12.0,
    "kindCount" : 5,
    "operator" : "string",
    "operatorId" : "string",
    "supplier" : "string",
    "supplierId" : "string",
    "effectiveDate" : "2022-04-07 15:12:53",
    "lastModified" : "2022-05-13 12:22:56",
    "pharmacy" : {
      "no" : 0
    },
    "type" : 0
  }
}

5.3.27. 审核退货出库申请单

PUT /api/v2/open-agency/products/out-apply-orders/{outApplyOrderId}/review

参数

类型

名称

说明

类型

Body

-
必填

Path

outApplyOrderId
必填

outApplyOrderId

integer (int64)

响应

HTTP Code

说明

类型

200

R«AbcListPage«OpenBatchStockView»»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/products/out-apply-orders/0/review

请求 body

{
  "pass" : 1,
  "comment" : "确认通过"
}

HTTP响应示例

响应 200

{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.3.28. 查询门店库存

GET /api/v2/open-agency/products/batches

参数

类型名称说明类型默认值

Query

limit
可选

limit

integer (int32)

20

Query

offset
可选

offset

integer (int32)

0

响应

HTTP Code

说明

类型

200

HTTP请求示例

请求 path

/api/v2/open-agency/products/batches

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "goodsId" : "ffffffff000000003473c049d7ab4004",
      "goodsShortId" : "Z12312312",
      "batchId" : 123123,
      "pieceNum" : 8,
      "pharmacyType" : 0,
      "pharmacyNo" : 0,
      "expiryDate" : "2025-01-17",
      "productionDate" : "2025-01-17",
      "inDate" : "2025-01-17 02:36:00",
      "batchNo" : "100012157",
      "packageCostPrice" : 10.0,
      "leftCost" : 10.0,
      "pieceCount" : 10.0,
      "packageCount" : 20.0,
      "status" : 0,
      "stockInOutDetailId" : "string"
    } ],
    "total" : 0,
    "offset" : 0,
    "limit" : 0,
    "keyword" : "string"
  }
}

5.3.29. 获取调拨单列表

GET /api/v2/open-agency/products/trans-order-list

参数

类型名称说明类型默认值

Query

beginDate
必填

开始时间（格式yyyy-MM-dd）

string

Query

endDate
必填

结束时间（格式yyyy-MM-dd）

string

Query

limit
必填

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

integer (int32)

Query

offset
必填

分页起始下标，默认0

integer (int32)

Query

dateFieldType
可选

查询日期类型: 0-创建时间 1-调拨入库时间

integer (int32)

0

Query

transType
可选

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

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/products/trans-order-list?beginDate=2022-04-14&endDate=2022-04-14&limit=20&offset=0

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : 0,
      "amount" : 0.0,
      "count" : 0.0,
      "kindCount" : 0,
      "orderNo" : "string",
      "transType" : 0,
      "transCostPriceType" : 0,
      "createdUser" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "string",
      "reviewDate" : "string",
      "reviewUser" : {
        "id" : "string",
        "name" : "string"
      },
      "inConfirmDate" : "string",
      "inConfirmUser" : {
        "id" : "string",
        "name" : "string"
      },
      "toOrgan" : {
        "id" : "string",
        "name" : "string"
      },
      "inPharmacy" : {
        "no" : 0
      },
      "fromOrgan" : {
        "id" : "string",
        "name" : "string"
      },
      "outPharmacy" : {
        "no" : 0
      },
      "lastModified" : "string",
      "lastModifiedUser" : {
        "id" : "string",
        "name" : "string"
      },
      "status" : 1
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.3.30. 获取调拨单详情

GET /api/v2/open-agency/products/trans-order-detail/{orderId}

参数

类型

名称

说明

类型

Path

orderId
必填

调拨单id

integer (int64)

响应

HTTP Code

说明

类型

200

R«库存调拨单详情»

HTTP请求示例

请求 path

/api/v2/open-agency/products/trans-order-detail/1233

HTTP响应示例

响应 200

{
  "data" : {
    "id" : 0,
    "amount" : 0.0,
    "count" : 0.0,
    "kindCount" : 0,
    "orderNo" : "string",
    "transType" : 0,
    "transCostPriceType" : 0,
    "createdUser" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "string",
    "reviewDate" : "string",
    "reviewUser" : {
      "id" : "string",
      "name" : "string"
    },
    "inConfirmDate" : "string",
    "inConfirmUser" : {
      "id" : "string",
      "name" : "string"
    },
    "toOrgan" : {
      "id" : "string",
      "name" : "string"
    },
    "inPharmacy" : {
      "no" : 0
    },
    "fromOrgan" : {
      "id" : "string",
      "name" : "string"
    },
    "outPharmacy" : {
      "no" : 0
    },
    "lastModified" : "string",
    "lastModifiedUser" : {
      "id" : "string",
      "name" : "string"
    },
    "status" : 1,
    "items" : [ {
      "applicationPackageCount" : 0.0,
      "applicationPieceCount" : 0.0,
      "packageCount" : 0.0,
      "pieceCount" : 0.0,
      "goods" : {
        "id" : "string",
        "name" : "阿莫西林",
        "typeId" : 1,
        "typeName" : "药品",
        "customTypeId" : "213",
        "customTypeName" : "抗生素",
        "manufacturer" : "拜耳",
        "medicineNmpn" : "H20000001",
        "barCode" : "string",
        "pieceUnit" : "支",
        "pieceNum" : 10.0,
        "piecePrice" : 10.5,
        "packageUnit" : "盒",
        "packagePrice" : 105.0,
        "shortId" : "K1001",
        "specification" : "1ml:0.5mg*10支/盒",
        "otcType" : 1,
        "status" : 1,
        "lastModified" : "2022-05-13 12:22:56",
        "goodsSpu" : {
          "id" : "string",
          "name" : "string",
          "brandName" : "string",
          "material" : "string"
        },
        "goodsSpec" : {
          "color" : "string",
          "spec" : "string"
        }
      },
      "outTotalCostPrice" : 0.0,
      "outPackageCostPrice" : 0.0,
      "bathes" : [ {
        "stockId" : 0,
        "batchNo" : "string",
        "expiryDate" : "string",
        "packageCount" : 0.0,
        "pieceCount" : 0.0,
        "outPackageCostPrice" : 0.0
      } ],
      "transInBatches" : [ {
        "stockId" : 12312,
        "stockInOutDetailId" : "12312",
        "batchId" : 12312,
        "supplier" : {
          "id" : "string",
          "name" : "string"
        },
        "batchNo" : "555555",
        "productionDate" : "2023-01-11",
        "expiryDate" : "2023-01-11",
        "packageCount" : 1.0,
        "pieceCount" : 1.0,
        "packageCostPrice" : 1.0,
        "pieceNum" : 10,
        "costPrice" : 1.0
      } ],
      "lastModified" : "string"
    } ]
  }
}

5.4. 患者接口

5.4.1. 获取患者分页列表

GET /api/v2/open-agency/patient/query-list

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string

Query

limit
可选

每页显示条数，默认20

integer (int32)

20

Query

offset
可选

分页起始下标，默认0

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/patient/query-list?date=2022-01-03

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    } ],
    "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

R«患者列表响应»

HTTP请求示例

请求 path

/api/v2/open-agency/patient/query

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    } ]
  }
}

5.4.3. 获取患者详情

GET /api/v2/open-agency/patient/{id}

参数

类型

名称

说明

类型

Path

id
必填

患者id

string

响应

HTTP Code

说明

类型

200

R«患者详细信息»

HTTP请求示例

请求 path

/api/v2/open-agency/patient/000000fc446f4dbd989857e305b00d6d

HTTP响应示例

响应 200

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

5.4.4. 查询来源分类列表

GET /api/v2/open-agency/patient/source/types

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/patient/source/types

HTTP响应示例

响应 200

{
  "data" : {
    "list" : [ {
      "id" : "string",
      "name" : "张三",
      "relatedType" : 3,
      "relatedId" : "ffffffff00000000094c2a500293c000",
      "children" : [ {
        "id" : "string",
        "name" : "张三",
        "relatedType" : 3,
        "relatedId" : "ffffffff00000000094c2a500293c000",
        "children" : [ "..." ]
      } ]
    } ]
  }
}

5.4.5. 创建患者

POST /api/v2/open-agency/patient

参数

类型

名称

说明

类型

Body

-
必填

创建患者请求体

响应

HTTP Code

说明

类型

200

R«患者摘要信息»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/patient

请求 body

{
  "name" : "string",
  "mobile" : "string",
  "sex" : "男",
  "birthday" : "2010-01-15",
  "sourceId" : "医生推荐分类id, 导医推荐分类id, 顾客推荐分类id",
  "sourceFromId" : "string",
  "idCard" : "string",
  "pastHistory" : "string",
  "address" : {
    "addressProvinceId" : "510000",
    "addressProvinceName" : "四川",
    "addressCityId" : "510100",
    "addressCityName" : "成都市",
    "addressDistrictId" : "510109",
    "addressDistrictName" : "高新区",
    "addressDetail" : "交子大道180号"
  },
  "sn" : "string",
  "remark" : "string",
  "profession" : "string",
  "company" : "string",
  "marital" : "string",
  "weight" : "string"
}

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "000000fc446f4dbd989857e305b00d6s",
    "name" : "张三",
    "mobile" : "18080000000",
    "sex" : "男",
    "birthday" : "1970-08-14",
    "age" : {
      "year" : 60,
      "month" : 2,
      "day" : 1
    },
    "idCard" : "630101200010075758"
  }
}

5.4.6. 修改患者

PUT /api/v2/open-agency/patient/{id}

参数

类型

名称

说明

类型

Body

-
必填

修改患者请求体

Path

id
必填

患者id

string

响应

HTTP Code

说明

类型

200

R«患者摘要信息»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/patient/1928374566xxx

请求 body

{
  "name" : "string",
  "mobile" : "string",
  "sex" : "男",
  "birthday" : "2010-01-15",
  "sourceId" : "医生推荐分类id, 导医推荐分类id, 顾客推荐分类id",
  "sourceFromId" : "string",
  "idCard" : "string",
  "pastHistory" : "string",
  "address" : {
    "addressProvinceId" : "510000",
    "addressProvinceName" : "四川",
    "addressCityId" : "510100",
    "addressCityName" : "成都市",
    "addressDistrictId" : "510109",
    "addressDistrictName" : "高新区",
    "addressDetail" : "交子大道180号"
  },
  "sn" : "string",
  "remark" : "string",
  "profession" : "string",
  "company" : "string",
  "marital" : "string",
  "weight" : "string"
}

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "000000fc446f4dbd989857e305b00d6s",
    "name" : "张三",
    "mobile" : "18080000000",
    "sex" : "男",
    "birthday" : "1970-08-14",
    "age" : {
      "year" : 60,
      "month" : 2,
      "day" : 1
    },
    "idCard" : "630101200010075758"
  }
}

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

GET /api/v2/open-agency/patient/{patientId}/family-member

参数

类型

名称

说明

类型

Path

patientId
必填

患者ID

string

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/patient/string/family-member

HTTP响应示例

响应 200

{
  "data" : {
    "patientId" : "string",
    "familyRole" : 0,
    "familyPatients" : [ {
      "familyRole" : 0,
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "relation" : "儿子",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    } ]
  }
}

5.4.8. 查询患者附件

GET /api/v2/open-agency/patient/{patientId}/attachments

参数

类型名称说明类型默认值

Path

patientId
必填

患者ID

string

Query

limit
可选

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

integer (int32)

10

Query

offset
可选

分页起始下标

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/patient/ffffffff00000000220e67a8116d8000/attachments

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "123123121",
      "url" : "https://test.com/aaa.xlsx",
      "fileName" : "aaa.xlsx",
      "displayName" : "体检报告",
      "created" : "2024-08-15 19:18:50",
      "businessCategory" : 1
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.4.9. 新增患者附件

POST /api/v2/open-agency/patient/{patientId}/attachments

参数

类型

名称

说明

类型

Body

-
必填

添加患者附件请求

Path

patientId
必填

患者ID

string

响应

HTTP Code

说明

类型

200

R«添加患者附件响应»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/patient/ffffffff00000000220e67a8116d8000/attachments

请求 body

{
  "attachments" : [ {
    "url" : "https://test.com/aaa.png",
    "fileName" : "xxxx.png",
    "displayName" : "体检报告",
    "businessCategory" : 1
  } ]
}

HTTP响应示例

响应 200

{
  "data" : {
    "attachments" : [ {
      "id" : "123123121",
      "url" : "https://test.com/aaa.xlsx",
      "fileName" : "aaa.xlsx",
      "displayName" : "体检报告",
      "created" : "2024-08-15 19:18:50",
      "businessCategory" : 1
    } ]
  }
}

5.4.10. 删除患者附件

DELETE /api/v2/open-agency/patient/{patientId}/attachments/{attachmentId}

参数

类型

名称

说明

类型

Path

attachmentId
必填

附件ID

string

Path

patientId
必填

患者ID

string

响应

HTTP Code

说明

类型

200

HTTP请求示例

请求 path

/api/v2/open-agency/patient/ffffffff00000000220e67a8116d8000/attachments/12312321311

HTTP响应示例

响应 200

{
  "data" : {
    "code" : 200,
    "message" : "提示信息"
  }
}

5.4.11. 查询患者会员类型列表

GET /api/v2/open-agency/patient/members/types

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/patient/members/types

HTTP响应示例

响应 200

{
  "data" : {
    "memberTypes" : [ {
      "id" : "9dc6f28121a7d9ba9fa6af00b406b314",
      "name" : "普通卡"
    } ]
  }
}

5.4.12. 会员卡支付

PUT /api/v2/open-agency/patient/members/{memberCardId}/pay

参数

类型

名称

说明

类型

Body

-
必填

会员卡支付请求参数

Path

memberCardId
必填

会员卡ID

string

响应

HTTP Code

说明

类型

200

R«会员卡支付响应»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/patient/members/ffffffff0000000034c1e2173d268002/pay

请求 body

{
  "transactionPatientId" : "ffffffff0000000034c1e2173d268002",
  "amount" : 100.0,
  "businessId" : "3808805404481667072",
  "password" : "123456",
  "operatorId" : "00000000000000000000000000000000"
}

HTTP响应示例

响应 200

{
  "data" : {
    "transactionId" : "ffffffff0000000034c1e2173d268002",
    "principalBalance" : 200.0,
    "presentBalance" : 100.0,
    "principal" : 100.0,
    "present" : 50.0,
    "businessId" : "3808805404481667072"
  }
}

5.4.13. 会员卡退款

PUT /api/v2/open-agency/patient/members/{memberCardId}/refund

参数

类型

名称

说明

类型

Body

-
必填

会员卡退款请求参数

Path

memberCardId
必填

会员卡ID

string

响应

HTTP Code

说明

类型

200

R«会员卡退费响应»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/patient/members/ffffffff0000000034c1e2173d268002/refund

请求 body

{
  "amount" : 100.0,
  "transactionIds" : [ "string" ],
  "businessId" : "3808805404481667072",
  "operatorId" : "00000000000000000000000000000000"
}

HTTP响应示例

响应 200

{
  "data" : {
    "transactionId" : "ffffffff0000000034c1e2173d268002",
    "principalBalance" : 200.0,
    "presentBalance" : 100.0,
    "principal" : 100.0,
    "present" : 50.0,
    "businessId" : "3808805404481667072"
  }
}

5.5. 挂号接口

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

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

参数

类型名称说明类型默认值

Path

doctorId
必填

医生id

string

Query

workingDate
必填

工作日期 yyyy-MM-dd

string (date)

Query

departmentId
可选

科室id，门诊预约时必填

string

Query

registrationType
可选

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

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration/doctor/ffffffff00000000220e67a8116d8000?workingDate=2022-05-05

HTTP响应示例

响应 200

{
  "data" : {
    "doctorId" : "string",
    "departmentId" : "string",
    "workingDate" : "string",
    "dayOfWeek" : "string",
    "restCountToday" : 0,
    "canReserve" : 0,
    "scheduleIntervals" : [ {
      "timeOfDay" : "string",
      "start" : "string",
      "end" : "string",
      "list" : [ {
        "restCount" : 0,
        "timeOfDay" : "string",
        "orderNo" : 0,
        "type" : 2,
        "start" : "string",
        "end" : "string",
        "available" : 0
      } ]
    } ]
  }
}

5.5.2. 创建挂号

POST /api/v2/open-agency/registration

说明

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

参数

类型

名称

说明

类型

Body

-
必填

新增挂号请求参数

响应

HTTP Code

说明

类型

200

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

消耗

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

R«挂号详细信息»

HTTP请求示例

请求 path

/api/v2/open-agency/registration/ffffffff0000000006dddfe002e22000

HTTP响应示例

响应 200

{
  "data" : {
    "clinicName" : "string",
    "patientOrderId" : "string",
    "registrationSheetId" : "string",
    "visitSourceParentId" : "string",
    "patientId" : "string",
    "visitSourceParentName" : "string",
    "departmentId" : "string",
    "visitSourceId" : "string",
    "departmentName" : "string",
    "visitSourceName" : "string",
    "doctorId" : "string",
    "visitSourceFromId" : "string",
    "doctorName" : "string",
    "visitSourceFromName" : "string",
    "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

R«挂号详细信息»

HTTP请求示例

请求 path

/api/v2/open-agency/registration/by-patient-order-id/ffffffff0000000006dddfe002e22000

HTTP响应示例

响应 200

{
  "data" : {
    "clinicName" : "string",
    "patientOrderId" : "string",
    "registrationSheetId" : "string",
    "visitSourceParentId" : "string",
    "patientId" : "string",
    "visitSourceParentName" : "string",
    "departmentId" : "string",
    "visitSourceId" : "string",
    "departmentName" : "string",
    "visitSourceName" : "string",
    "doctorId" : "string",
    "visitSourceFromId" : "string",
    "doctorName" : "string",
    "visitSourceFromName" : "string",
    "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

R«取消挂号响应»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/registration/ffffffff0000000006dddfe002e22000/cancel

HTTP响应示例

响应 200

{
  "data" : {
    "isSuccess" : 0,
    "tips" : "string"
  }
}

5.5.6. 查询预约备注模板

GET /api/v2/open-agency/registration/remark-templates

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration/remark-templates

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "registrationType" : 0,
      "content" : "string",
      "sort" : 0,
      "disableModify" : 0,
      "disableDelete" : 0
    } ]
  }
}

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

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

说明

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

参数

类型

名称

说明

类型

Path

doctorId
必填

医生ID

string

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration/doctor/string/product

HTTP响应示例

响应 200

{
  "data" : {
    "registrationProducts" : [ {
      "id" : "ffffffff000000000000000000000001",
      "introduce" : "专业按摩，疏通筋骨",
      "name" : "针灸",
      "price" : 100.0,
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    } ]
  }
}

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

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

说明

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

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration/product

HTTP响应示例

响应 200

{
  "data" : {
    "registrationProducts" : [ {
      "id" : "ffffffff000000000000000000000001",
      "introduce" : "专业按摩，疏通筋骨",
      "name" : "针灸",
      "price" : 100.0,
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    } ]
  }
}

5.5.9. 查询项目每日号源

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

说明

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

参数

类型

名称

说明

类型

Path

registrationProductId
必填

预约项目ID

integer (int64)

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration/product/0/section-status

HTTP响应示例

响应 200

{
  "data" : {
    "reserveSectionStatusList" : [ {
      "date" : "2024-03-05",
      "status" : 0
    } ]
  }
}

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

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

说明

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

参数

类型

名称

说明

类型

Path

registrationProductId
必填

预约项目ID

integer (int64)

Query

reserveDate
必填

预约日期（yyyy-MM-dd）

string

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration/product/0/days-shifts?reserveDate=2024-03-03

HTTP响应示例

响应 200

{
  "data" : {
    "registrationCategoryDaysShifts" : [ {
      "status" : 0,
      "registrationCategory" : 0,
      "dayShifts" : [ {
        "start" : "08:00",
        "end" : "08:30",
        "timeOfDay" : "上午",
        "status" : 0,
        "shiftDoctors" : [ {
          "doctorId" : "ffffffff000000000000000000000001",
          "status" : 0
        } ]
      } ]
    } ]
  }
}

5.5.11. 查询患者预约列表

GET /api/v2/open-agency/registration/patient/{patientId}

参数

类型名称说明类型默认值

Path

patientId
必填

患者ID

string

Query

beginDate
可选

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

string (date)

Query

endDate
可选

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

string (date)

Query

limit
可选

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

integer (int32)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

registrationType
可选

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

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration/patient/string

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "张三",
      "reserveDate" : "2019-04-04",
      "reserveStart" : "10:10",
      "reserveEnd" : "10:30",
      "type" : 0,
      "status" : 10,
      "payStatus" : 0,
      "consultingRoomId" : "string",
      "consultingRoomName" : "string",
      "registrationProducts" : [ {
        "id" : "ffffffff000000000000000000000001",
        "name" : "针灸"
      } ],
      "created" : "2022-06-23 18:45:00"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.5.12. 查询门店指定日期医生号源状态

GET /api/v2/open-agency/registration/doctors-shift-status

参数

类型名称说明类型默认值

Query

reserveDate
必填

预约日期 yyyy-MM-dd

string

Query

registrationType
可选

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

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration/doctors-shift-status?reserveDate=2024-04-22

HTTP响应示例

响应 200

{
  "data" : {
    "doctorShifts" : [ {
      "showInWeClinic" : 1,
      "doctor" : {
        "id" : "string",
        "mobile" : "18088888888",
        "name" : "张三",
        "sex" : "男",
        "headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
        "introduction" : "毕业于陆军军医大学临床医学七年制",
        "practiceImgUrl" : "string",
        "doctorPageUrl" : "string",
        "doctorTags" : "省级名中医、市级名中医"
      },
      "status" : 0
    } ]
  }
}

5.5.13. 查询门店指定医生号源日期列表

GET /api/v2/open-agency/registration/doctor/{doctorId}/shift

说明

返回结果日期范围为：当天~（最大可预约日期+2天）

参数

类型名称说明类型默认值

Path

doctorId
必填

医生ID

string

Query

beginDate
可选

开始日期 yyyy-MM-dd

string

Query

endDate
可选

结束日期 yyyy-MM-dd

string

Query

registrationType
可选

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

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration/doctor/string/shift

HTTP响应示例

响应 200

{
  "data" : {
    "reserveSections" : [ {
      "date" : "2024-04-23",
      "departments" : [ {
        "id" : "ffffffff0000000022174678012e2000",
        "name" : "儿科",
        "restCount" : 9,
        "totalCount" : 10,
        "status" : 0,
        "fee" : 20.0,
        "registerStartTime" : "09:30",
        "registrationCategoryDayShifts" : [ {
          "departmentId" : "ffffffff0000000017e9b87008386000",
          "registrationCategory" : 0,
          "restCount" : 5,
          "totalCount" : 10,
          "status" : 0,
          "dayShifts" : [ {
            "shifts" : [ {
              "orderNo" : 5,
              "start" : "09:00",
              "end" : "09:20",
              "timeOfDay" : "上午",
              "count" : 1,
              "totalCount" : 1
            } ],
            "restCount" : 5,
            "totalCount" : 10,
            "status" : 0,
            "start" : "09:00",
            "end" : "10:00",
            "timeOfDay" : "上午"
          } ]
        } ]
      } ]
    } ]
  }
}

5.5.14. 查询挂号单列表

GET /api/v2/open-agency/registration

参数

类型名称说明类型默认值

Query

registrationType
必填

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

integer (int32)

0

Query

limit
可选

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

integer (int32)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

reserveDate
可选

预约日期，默认为当天

string

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/registration?registrationType=0

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "patientOrderId" : "string",
      "registrationSheetId" : "string",
      "patientId" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "status" : 10,
      "signIn" : 0,
      "consultingRoomId" : "string",
      "consultingRoomName" : "string",
      "type" : 0,
      "payStatus" : 0,
      "code" : 0,
      "registrationType" : 0,
      "created" : "2022-06-23 18:45:00"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.6. 门诊接口

5.6.1. 按患者查询门诊单

GET /api/v2/open-agency/outpatient/query-by-patient/{patientId}

说明

查询日期间隔不能超过 3 个月

参数

类型名称说明类型默认值

Path

patientId
必填

患者ID

string

Query

beginDate
可选

开始日期 yyyy-MM-dd，默认为3个月前

string (date)

Query

endDate
可选

结束日期 yyyy-MM-dd，默认为当前

string (date)

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/outpatient/query-by-patient/ffffffff000000001bc17db00f42e000

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "created" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "patientOrderNo" : "0000000001",
      "status" : 0,
      "statusName" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.6.2. 获取门诊单详情

GET /api/v2/open-agency/outpatient/{id}

参数

类型

名称

说明

类型

Path

id
必填

门诊单ID

string

响应

HTTP Code

说明

类型

200

R«门诊单详细信息»

HTTP请求示例

请求 path

/api/v2/open-agency/outpatient/ffffffff00000000216fab8810cde000

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "string",
    "clinicId" : "string",
    "patientOrderId" : "string",
    "patientOrderNo" : "00019691",
    "departmentId" : "string",
    "departmentName" : "string",
    "doctorId" : "string",
    "doctorName" : "string",
    "created" : "string",
    "diagnosedDate" : "string",
    "status" : 0,
    "statusName" : "string",
    "revisitStatus" : 1,
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "prescriptionChineseForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        },
        "productInfo" : {
          "children" : [ {
            "children" : [ "..." ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "disableSell" : 0,
            "typeId" : 1,
            "typeName" : "药品",
            "customTypeId" : "213",
            "customTypeName" : "抗生素",
            "manufacturer" : "拜耳",
            "medicineNmpn" : "H20000001",
            "barCode" : "string",
            "pieceUnit" : "支",
            "pieceNum" : 10.0,
            "piecePrice" : 10.5,
            "packageUnit" : "盒",
            "packagePrice" : 105.0,
            "shortId" : "K1001",
            "specification" : "1ml:0.5mg*10支/盒",
            "otcType" : 1,
            "status" : 1,
            "lastModified" : "2022-05-13 12:22:56",
            "goodsSpu" : {
              "id" : "string",
              "name" : "string",
              "brandName" : "string",
              "material" : "string"
            },
            "goodsSpec" : {
              "color" : "string",
              "spec" : "string"
            }
          } ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        }
      } ]
    } ],
    "prescriptionWesternForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        },
        "productInfo" : {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        }
      } ]
    } ],
    "prescriptionInfusionForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        },
        "productInfo" : "..."
      } ]
    } ],
    "prescriptionExternalForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        },
        "productInfo" : "..."
      } ]
    } ],
    "productForms" : [ {
      "id" : "string",
      "type" : 2,
      "productFormItems" : [ {
        "id" : "string",
        "productFormId" : "string",
        "productId" : "string",
        "name" : "string",
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "isDismounting" : 0,
        "type" : 1,
        "subType" : 0,
        "days" : 0,
        "dailyDosage" : 0,
        "remark" : "小心使用"
      } ]
    } ]
  }
}

5.6.3. 创建门诊单

POST /api/v2/open-agency/outpatient

参数

类型

名称

说明

类型

Body

req
必填

req

创建门诊单请求参数

响应

HTTP Code

说明

类型

200

R«门诊单详细信息»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/outpatient

请求 body

{
  "departmentId" : "string",
  "doctorId" : "string",
  "patientId" : "string",
  "operatorId" : "00000000000000000000000000000000",
  "medicalRecord" : {
    "chiefComplaint" : "咽痛，干咳，咳痰",
    "pastHistory" : "既往体健，既往有高血压",
    "familyHistory" : "string",
    "presentHistory" : "string",
    "physicalExamination" : "string",
    "diagnosis" : "急性上呼吸道感染",
    "doctorAdvice" : "string",
    "syndrome" : "string",
    "therapy" : "string",
    "chineseExamination" : "string",
    "obstetricalHistory" : "string"
  },
  "prescriptionChineseForms" : [ {
    "isTotalPriceChanged" : 1,
    "pharmacyNo" : 0,
    "expectedTotalPrice" : 10.0,
    "specification" : "中药饮片",
    "doseCount" : 3,
    "prescriptionFormItems" : [ {
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "specialRequirement" : "先煎",
      "productShortId" : "1907765200",
      "unitCount" : 2.0,
      "expectedUnitPrice" : 5.0,
      "expectedTotalPrice" : 5.0,
      "useDismounting" : 0
    } ],
    "usage" : "煎服",
    "dailyDosage" : "1日1剂",
    "freq" : "1日6次",
    "usageLevel" : "每次60ml",
    "usageDays" : "约服35天",
    "requirement" : "饭前服用",
    "processInfo" : {
      "usageType" : 0,
      "usageSubType" : 0,
      "unitCount" : 1.0,
      "totalCount" : 2.0,
      "price" : 0.0,
      "remark" : "string"
    }
  } ],
  "prescriptionWesternForms" : [ {
    "isTotalPriceChanged" : 1,
    "expectedTotalPrice" : 10.0,
    "prescriptionFormItems" : [ {
      "ast" : 1,
      "productId" : "483ac61f811640f5849a3d3aabceea58",
      "productShortId" : "1907765200",
      "usage" : "含服用",
      "freq" : "qd",
      "unitCount" : 2.0,
      "dosage" : 3.0,
      "expectedUnitPrice" : 5.0,
      "dosageUnit" : "片",
      "expectedTotalPrice" : 5.0,
      "days" : 5.0,
      "useDismounting" : 0,
      "specialRequirement" : "首次加倍",
      "pharmacyNo" : 0
    } ]
  } ]
}

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "string",
    "clinicId" : "string",
    "patientOrderId" : "string",
    "patientOrderNo" : "00019691",
    "departmentId" : "string",
    "departmentName" : "string",
    "doctorId" : "string",
    "doctorName" : "string",
    "created" : "string",
    "diagnosedDate" : "string",
    "status" : 0,
    "statusName" : "string",
    "revisitStatus" : 1,
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "prescriptionChineseForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        },
        "productInfo" : {
          "children" : [ {
            "children" : [ "..." ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "disableSell" : 0,
            "typeId" : 1,
            "typeName" : "药品",
            "customTypeId" : "213",
            "customTypeName" : "抗生素",
            "manufacturer" : "拜耳",
            "medicineNmpn" : "H20000001",
            "barCode" : "string",
            "pieceUnit" : "支",
            "pieceNum" : 10.0,
            "piecePrice" : 10.5,
            "packageUnit" : "盒",
            "packagePrice" : 105.0,
            "shortId" : "K1001",
            "specification" : "1ml:0.5mg*10支/盒",
            "otcType" : 1,
            "status" : 1,
            "lastModified" : "2022-05-13 12:22:56",
            "goodsSpu" : {
              "id" : "string",
              "name" : "string",
              "brandName" : "string",
              "material" : "string"
            },
            "goodsSpec" : {
              "color" : "string",
              "spec" : "string"
            }
          } ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        }
      } ]
    } ],
    "prescriptionWesternForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        },
        "productInfo" : {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        }
      } ]
    } ],
    "prescriptionInfusionForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        },
        "productInfo" : "..."
      } ]
    } ],
    "prescriptionExternalForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        },
        "productInfo" : "..."
      } ]
    } ],
    "productForms" : [ {
      "id" : "string",
      "type" : 2,
      "productFormItems" : [ {
        "id" : "string",
        "productFormId" : "string",
        "productId" : "string",
        "name" : "string",
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "isDismounting" : 0,
        "type" : 1,
        "subType" : 0,
        "days" : 0,
        "dailyDosage" : 0,
        "remark" : "小心使用"
      } ]
    } ]
  }
}

5.6.4. 按天查询门诊单

GET /api/v2/open-agency/outpatient/query-by-date

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string

Query

limit
可选

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

integer (int32)

20

Query

offset
可选

分页起始下标，默认0

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/outpatient/query-by-date?date=2022-01-03

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "created" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "patientOrderNo" : "0000000001",
      "status" : 0,
      "statusName" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.7. 收费接口

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

GET /api/v2/open-agency/charge/query-by-date

参数

类型

名称

说明

类型

Query

date
必填

日期 yyyy-MM-dd

string (date-time)

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/charge/query-by-date?date=2023-03-01

HTTP响应示例

响应 200

{
  "data" : {
    "chargeSheets" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "created" : "string",
      "doctorName" : "string",
      "isDraft" : 0,
      "status" : 0,
      "owedStatus" : 0,
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "type" : 1,
      "isClosed" : 0
    } ]
  }
}

5.7.2. 获取收费单明细

GET /api/v2/open-agency/charge/query-detail/{id}

参数

类型

名称

说明

类型

Path

id
必填

收费单ID

string

响应

HTTP Code

说明

类型

200

R«收费单详细信息»

HTTP请求示例

请求 path

/api/v2/open-agency/charge/query-detail/ffffffff00000000220e67a8116d8000

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "ffffffff00000000220e67a8116d8000",
    "status" : 0,
    "type" : 1,
    "created" : "2022-04-06 15:12:53",
    "receivableFee" : 0.01,
    "receivedFee" : 0.0,
    "refundFee" : 0.01,
    "discountFee" : -10.0,
    "refundTime" : "2022-04-07 15:12:53",
    "charger" : {
      "id" : "string",
      "name" : "张三"
    },
    "deliveryInfo" : {
      "addressProvinceName" : "四川省",
      "addressCityName" : "成都市",
      "addressDistrictName" : "高新区",
      "addressDetail" : "四川省成都市高新区xxx街道xxx",
      "deliveryName" : "张三",
      "deliveryMobile" : "18088888888",
      "deliveryCompany" : {
        "id" : "127203805890060288",
        "name" : "string"
      },
      "deliveryOrderNo" : "20827634879930368",
      "deliveryPayType" : 1,
      "deliveryFee" : 10.0
    },
    "doctor" : {
      "id" : "string",
      "mobile" : "18088888888",
      "name" : "张三",
      "sex" : "男",
      "headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
      "introduction" : "毕业于陆军军医大学临床医学七年制",
      "practiceImgUrl" : "string",
      "doctorPageUrl" : "string",
      "doctorTags" : "省级名中医、市级名中医"
    },
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "chargeFormItems" : [ {
      "id" : "0002b62eaf9c461f85ff3fedc4583a79",
      "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
      "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
      "productName" : "注射用青霉素钠",
      "status" : 0,
      "unit" : "支",
      "receivedFee" : 40.0,
      "unitPrice" : 10.0,
      "displayUnitPrice" : 10.0,
      "displayTotalPrice" : 40.0,
      "unitCount" : 4.0,
      "doseCount" : 1.0,
      "totalCount" : 4.0,
      "productType" : 1,
      "productSubType" : 3,
      "sourceItemType" : 0,
      "productInfo" : {
        "children" : [ {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        } ],
        "id" : "string",
        "name" : "阿莫西林",
        "shebao" : {
          "nationalCode" : "T001700643",
          "insuranceTypes" : [ {
            "insuranceType" : "391",
            "reimbursementRatio" : 0.1
          } ]
        },
        "disableSell" : 0,
        "typeId" : 1,
        "typeName" : "药品",
        "customTypeId" : "213",
        "customTypeName" : "抗生素",
        "manufacturer" : "拜耳",
        "medicineNmpn" : "H20000001",
        "barCode" : "string",
        "pieceUnit" : "支",
        "pieceNum" : 10.0,
        "piecePrice" : 10.5,
        "packageUnit" : "盒",
        "packagePrice" : 105.0,
        "shortId" : "K1001",
        "specification" : "1ml:0.5mg*10支/盒",
        "otcType" : 1,
        "status" : 1,
        "lastModified" : "2022-05-13 12:22:56",
        "goodsSpu" : {
          "id" : "string",
          "name" : "string",
          "brandName" : "string",
          "material" : "string"
        },
        "goodsSpec" : {
          "color" : "string",
          "spec" : "string"
        }
      },
      "composeChildren" : [ {
        "id" : "0002b62eaf9c461f85ff3fedc4583a79",
        "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
        "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
        "productName" : "注射用青霉素钠",
        "status" : 0,
        "unit" : "支",
        "receivedFee" : 40.0,
        "unitPrice" : 10.0,
        "displayUnitPrice" : 10.0,
        "displayTotalPrice" : 40.0,
        "unitCount" : 4.0,
        "doseCount" : 1.0,
        "totalCount" : 4.0,
        "productType" : 1,
        "productSubType" : 3,
        "sourceItemType" : 0,
        "productInfo" : {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        },
        "composeChildren" : [ "..." ]
      } ]
    } ],
    "chargeTransactions" : [ {
      "id" : "ffffffff00000000220e67a8116d8001",
      "payMode" : 1,
      "paySubMode" : 1,
      "payModeName" : "ABC支付",
      "payModeDisplayName" : "ABC支付-微信",
      "amount" : 0.0,
      "created" : "2022-04-06 15:12:53",
      "isRefunded" : 0,
      "chargeTransactionRecords" : [ {
        "id" : "ffffffff00000000265ff80811ab200x",
        "transactionId" : "ffffffff00000000265ff80811ab2004",
        "chargeType" : 1,
        "productId" : "00000000000000000000000000000001",
        "productName" : "白术",
        "productType" : 5,
        "productSubType" : 0,
        "composeType" : 0,
        "productUnit" : "string",
        "productUnitCount" : 1.0,
        "doseCount" : 1.0,
        "totalPrice" : 0.0,
        "discountPrice" : 0.0,
        "created" : "2022-04-06 15:12:53",
        "sceneType" : 0,
        "composeChildren" : [ {
          "id" : "ffffffff00000000265ff80811ab200x",
          "transactionId" : "ffffffff00000000265ff80811ab2004",
          "chargeType" : 1,
          "productId" : "00000000000000000000000000000001",
          "productName" : "白术",
          "productType" : 5,
          "productSubType" : 0,
          "composeType" : 0,
          "productUnit" : "string",
          "productUnitCount" : 1.0,
          "doseCount" : 1.0,
          "totalPrice" : 0.0,
          "discountPrice" : 0.0,
          "created" : "2022-04-06 15:12:53",
          "sceneType" : 0,
          "composeChildren" : [ "..." ]
        } ]
      } ]
    } ],
    "chargeTransactionPaidRecords" : [ {
      "productId" : "00000000000000000000000000000001",
      "productName" : "白术",
      "productType" : 5,
      "productSubType" : 0,
      "composeType" : 0,
      "productUnit" : "string",
      "productUnitCount" : 1.0,
      "doseCount" : 1.0,
      "totalPrice" : 0.0,
      "discountPrice" : 0.0,
      "records" : 0
    } ],
    "sellerId" : "ffffff000000xxxxx",
    "sellerName" : "张三",
    "registrationSheetId" : "ffffffff0000000025b0df48001ae013",
    "patientOrderId" : "ffffffff00000000220e67a8116d8000",
    "isDraft" : 0,
    "isClosed" : 0,
    "chargedTime" : "2022-04-06 15:12:53"
  }
}

5.7.3. 收费单付款（支持部分收费）

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

说明

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

参数

类型

名称

说明

类型

Body

-
必填

收费单支付请求

Path

chargeSheetId
必填

收费单ID

string

响应

HTTP Code

说明

类型

200

R«收费单收费结果»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/charge/string/pay

请求 body

{
  "payMode" : 1,
  "amount" : 100.0,
  "needPayFee" : 1000.0,
  "expectedOddFee" : 0.52,
  "operatorId" : "00000000000000000000000000000000",
  "comment" : "来自互联网医院"
}

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "string",
    "patientOrderId" : "string",
    "status" : 2,
    "statusName" : "已收费",
    "needPay" : 100.0,
    "receivedFee" : 100.0
  }
}

5.7.4. 收费单退款（支持部分退）

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

说明

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

参数

类型

名称

说明

类型

Body

-
必填

收费单退费请求

Path

chargeSheetId
必填

收费单ID

string

响应

HTTP Code

说明

类型

200

R«收费单退费响应»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/charge/string/refund

请求 body

{
  "operatorId" : "00000000000000000000000000000000",
  "needRefundFee" : 0.0,
  "refundFee" : 0.0,
  "payMode" : 1,
  "chargeForms" : [ {
    "id" : "00000000000000000000000000000000",
    "chargeFormItems" : [ {
      "id" : "00000000000000000000000000000000",
      "unitCount" : 1.0,
      "doseCount" : 1.0
    } ]
  } ]
}

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "string",
    "status" : 2,
    "statusName" : "已收费",
    "refundFee" : 10.0,
    "refundedFee" : 20.0
  }
}

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

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

说明

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

参数

类型

名称

说明

类型

Body

-
必填

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

Path

chargeSheetId
必填

收费单ID

string

响应

HTTP Code

说明

类型

200

R«收费单详细信息»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/charge/string/delivery

请求 body

{
  "addressProvinceId" : "510000",
  "addressProvinceName" : "四川",
  "addressCityId" : "510100",
  "addressCityName" : "成都市",
  "addressDistrictId" : "510109",
  "addressDistrictName" : "高新区",
  "addressDetail" : "交子大道180号",
  "deliveryName" : "张三",
  "deliveryMobile" : "18012312312",
  "deliveryCompanyName" : "顺丰快递",
  "deliveryFee" : 12.0,
  "deliveryOrderNo" : "string",
  "deliveryPayType" : 0,
  "operatorId" : "00000000000000000000000000000000"
}

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "ffffffff00000000220e67a8116d8000",
    "status" : 0,
    "type" : 1,
    "created" : "2022-04-06 15:12:53",
    "receivableFee" : 0.01,
    "receivedFee" : 0.0,
    "refundFee" : 0.01,
    "discountFee" : -10.0,
    "refundTime" : "2022-04-07 15:12:53",
    "charger" : {
      "id" : "string",
      "name" : "张三"
    },
    "deliveryInfo" : {
      "addressProvinceName" : "四川省",
      "addressCityName" : "成都市",
      "addressDistrictName" : "高新区",
      "addressDetail" : "四川省成都市高新区xxx街道xxx",
      "deliveryName" : "张三",
      "deliveryMobile" : "18088888888",
      "deliveryCompany" : {
        "id" : "127203805890060288",
        "name" : "string"
      },
      "deliveryOrderNo" : "20827634879930368",
      "deliveryPayType" : 1,
      "deliveryFee" : 10.0
    },
    "doctor" : {
      "id" : "string",
      "mobile" : "18088888888",
      "name" : "张三",
      "sex" : "男",
      "headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
      "introduction" : "毕业于陆军军医大学临床医学七年制",
      "practiceImgUrl" : "string",
      "doctorPageUrl" : "string",
      "doctorTags" : "省级名中医、市级名中医"
    },
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "chargeFormItems" : [ {
      "id" : "0002b62eaf9c461f85ff3fedc4583a79",
      "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
      "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
      "productName" : "注射用青霉素钠",
      "status" : 0,
      "unit" : "支",
      "receivedFee" : 40.0,
      "unitPrice" : 10.0,
      "displayUnitPrice" : 10.0,
      "displayTotalPrice" : 40.0,
      "unitCount" : 4.0,
      "doseCount" : 1.0,
      "totalCount" : 4.0,
      "productType" : 1,
      "productSubType" : 3,
      "sourceItemType" : 0,
      "productInfo" : {
        "children" : [ {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        } ],
        "id" : "string",
        "name" : "阿莫西林",
        "shebao" : {
          "nationalCode" : "T001700643",
          "insuranceTypes" : [ {
            "insuranceType" : "391",
            "reimbursementRatio" : 0.1
          } ]
        },
        "disableSell" : 0,
        "typeId" : 1,
        "typeName" : "药品",
        "customTypeId" : "213",
        "customTypeName" : "抗生素",
        "manufacturer" : "拜耳",
        "medicineNmpn" : "H20000001",
        "barCode" : "string",
        "pieceUnit" : "支",
        "pieceNum" : 10.0,
        "piecePrice" : 10.5,
        "packageUnit" : "盒",
        "packagePrice" : 105.0,
        "shortId" : "K1001",
        "specification" : "1ml:0.5mg*10支/盒",
        "otcType" : 1,
        "status" : 1,
        "lastModified" : "2022-05-13 12:22:56",
        "goodsSpu" : {
          "id" : "string",
          "name" : "string",
          "brandName" : "string",
          "material" : "string"
        },
        "goodsSpec" : {
          "color" : "string",
          "spec" : "string"
        }
      },
      "composeChildren" : [ {
        "id" : "0002b62eaf9c461f85ff3fedc4583a79",
        "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
        "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
        "productName" : "注射用青霉素钠",
        "status" : 0,
        "unit" : "支",
        "receivedFee" : 40.0,
        "unitPrice" : 10.0,
        "displayUnitPrice" : 10.0,
        "displayTotalPrice" : 40.0,
        "unitCount" : 4.0,
        "doseCount" : 1.0,
        "totalCount" : 4.0,
        "productType" : 1,
        "productSubType" : 3,
        "sourceItemType" : 0,
        "productInfo" : {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        },
        "composeChildren" : [ "..." ]
      } ]
    } ],
    "chargeTransactions" : [ {
      "id" : "ffffffff00000000220e67a8116d8001",
      "payMode" : 1,
      "paySubMode" : 1,
      "payModeName" : "ABC支付",
      "payModeDisplayName" : "ABC支付-微信",
      "amount" : 0.0,
      "created" : "2022-04-06 15:12:53",
      "isRefunded" : 0,
      "chargeTransactionRecords" : [ {
        "id" : "ffffffff00000000265ff80811ab200x",
        "transactionId" : "ffffffff00000000265ff80811ab2004",
        "chargeType" : 1,
        "productId" : "00000000000000000000000000000001",
        "productName" : "白术",
        "productType" : 5,
        "productSubType" : 0,
        "composeType" : 0,
        "productUnit" : "string",
        "productUnitCount" : 1.0,
        "doseCount" : 1.0,
        "totalPrice" : 0.0,
        "discountPrice" : 0.0,
        "created" : "2022-04-06 15:12:53",
        "sceneType" : 0,
        "composeChildren" : [ {
          "id" : "ffffffff00000000265ff80811ab200x",
          "transactionId" : "ffffffff00000000265ff80811ab2004",
          "chargeType" : 1,
          "productId" : "00000000000000000000000000000001",
          "productName" : "白术",
          "productType" : 5,
          "productSubType" : 0,
          "composeType" : 0,
          "productUnit" : "string",
          "productUnitCount" : 1.0,
          "doseCount" : 1.0,
          "totalPrice" : 0.0,
          "discountPrice" : 0.0,
          "created" : "2022-04-06 15:12:53",
          "sceneType" : 0,
          "composeChildren" : [ "..." ]
        } ]
      } ]
    } ],
    "chargeTransactionPaidRecords" : [ {
      "productId" : "00000000000000000000000000000001",
      "productName" : "白术",
      "productType" : 5,
      "productSubType" : 0,
      "composeType" : 0,
      "productUnit" : "string",
      "productUnitCount" : 1.0,
      "doseCount" : 1.0,
      "totalPrice" : 0.0,
      "discountPrice" : 0.0,
      "records" : 0
    } ],
    "sellerId" : "ffffff000000xxxxx",
    "sellerName" : "张三",
    "registrationSheetId" : "ffffffff0000000025b0df48001ae013",
    "patientOrderId" : "ffffffff00000000220e67a8116d8000",
    "isDraft" : 0,
    "isClosed" : 0,
    "chargedTime" : "2022-04-06 15:12:53"
  }
}

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

GET /api/v2/open-agency/charge/by-patient-order-id/{patientOrderId}

参数

类型

名称

说明

类型

Path

就诊单ID
必填

patientOrderId

string

响应

HTTP Code

说明

类型

200

R«收费单列表»

HTTP请求示例

请求 path

/api/v2/open-agency/charge/by-patient-order-id/{patientOrderId}

HTTP响应示例

响应 200

{
  "data" : {
    "chargeSheets" : [ {
      "id" : "ffffffff00000000220e67a8116d8000",
      "status" : 0,
      "type" : 1,
      "created" : "2022-04-06 15:12:53",
      "receivableFee" : 0.01,
      "receivedFee" : 0.0,
      "refundFee" : 0.01,
      "discountFee" : -10.0,
      "refundTime" : "2022-04-07 15:12:53",
      "charger" : {
        "id" : "string",
        "name" : "张三"
      },
      "deliveryInfo" : {
        "addressProvinceName" : "四川省",
        "addressCityName" : "成都市",
        "addressDistrictName" : "高新区",
        "addressDetail" : "四川省成都市高新区xxx街道xxx",
        "deliveryName" : "张三",
        "deliveryMobile" : "18088888888",
        "deliveryCompany" : {
          "id" : "127203805890060288",
          "name" : "string"
        },
        "deliveryOrderNo" : "20827634879930368",
        "deliveryPayType" : 1,
        "deliveryFee" : 10.0
      },
      "doctor" : {
        "id" : "string",
        "mobile" : "18088888888",
        "name" : "张三",
        "sex" : "男",
        "headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
        "introduction" : "毕业于陆军军医大学临床医学七年制",
        "practiceImgUrl" : "string",
        "doctorPageUrl" : "string",
        "doctorTags" : "省级名中医、市级名中医"
      },
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "medicalRecord" : {
        "id" : "string",
        "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
        "chiefComplaint" : "咽痛，干咳，咳痰",
        "pastHistory" : "既往体健，既往有高血压",
        "familyHistory" : "string",
        "presentHistory" : "string",
        "physicalExamination" : "string",
        "diagnosis" : "急性上呼吸道感染",
        "doctorAdvice" : "string",
        "syndrome" : "string",
        "therapy" : "string",
        "chineseExamination" : "string",
        "wearGlassesHistory" : "近视",
        "obstetricalHistory" : "string",
        "eyeExamination" : {
          "items" : [ {
            "key" : "string",
            "name" : "string",
            "rightEyeValue" : "string",
            "leftEyeValue" : "string"
          } ]
        },
        "allergicHistory" : "青霉素过敏",
        "attachments" : [ {
          "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
          "fileName" : "NatGeo09.jpg",
          "fileSize" : 4771201
        } ]
      },
      "chargeFormItems" : [ {
        "id" : "0002b62eaf9c461f85ff3fedc4583a79",
        "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
        "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
        "productName" : "注射用青霉素钠",
        "status" : 0,
        "unit" : "支",
        "receivedFee" : 40.0,
        "unitPrice" : 10.0,
        "displayUnitPrice" : 10.0,
        "displayTotalPrice" : 40.0,
        "unitCount" : 4.0,
        "doseCount" : 1.0,
        "totalCount" : 4.0,
        "productType" : 1,
        "productSubType" : 3,
        "sourceItemType" : 0,
        "productInfo" : {
          "children" : [ {
            "children" : [ "..." ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "disableSell" : 0,
            "typeId" : 1,
            "typeName" : "药品",
            "customTypeId" : "213",
            "customTypeName" : "抗生素",
            "manufacturer" : "拜耳",
            "medicineNmpn" : "H20000001",
            "barCode" : "string",
            "pieceUnit" : "支",
            "pieceNum" : 10.0,
            "piecePrice" : 10.5,
            "packageUnit" : "盒",
            "packagePrice" : 105.0,
            "shortId" : "K1001",
            "specification" : "1ml:0.5mg*10支/盒",
            "otcType" : 1,
            "status" : 1,
            "lastModified" : "2022-05-13 12:22:56",
            "goodsSpu" : {
              "id" : "string",
              "name" : "string",
              "brandName" : "string",
              "material" : "string"
            },
            "goodsSpec" : {
              "color" : "string",
              "spec" : "string"
            }
          } ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        },
        "composeChildren" : [ {
          "id" : "0002b62eaf9c461f85ff3fedc4583a79",
          "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
          "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
          "productName" : "注射用青霉素钠",
          "status" : 0,
          "unit" : "支",
          "receivedFee" : 40.0,
          "unitPrice" : 10.0,
          "displayUnitPrice" : 10.0,
          "displayTotalPrice" : 40.0,
          "unitCount" : 4.0,
          "doseCount" : 1.0,
          "totalCount" : 4.0,
          "productType" : 1,
          "productSubType" : 3,
          "sourceItemType" : 0,
          "productInfo" : {
            "children" : [ "..." ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "disableSell" : 0,
            "typeId" : 1,
            "typeName" : "药品",
            "customTypeId" : "213",
            "customTypeName" : "抗生素",
            "manufacturer" : "拜耳",
            "medicineNmpn" : "H20000001",
            "barCode" : "string",
            "pieceUnit" : "支",
            "pieceNum" : 10.0,
            "piecePrice" : 10.5,
            "packageUnit" : "盒",
            "packagePrice" : 105.0,
            "shortId" : "K1001",
            "specification" : "1ml:0.5mg*10支/盒",
            "otcType" : 1,
            "status" : 1,
            "lastModified" : "2022-05-13 12:22:56",
            "goodsSpu" : {
              "id" : "string",
              "name" : "string",
              "brandName" : "string",
              "material" : "string"
            },
            "goodsSpec" : {
              "color" : "string",
              "spec" : "string"
            }
          },
          "composeChildren" : [ "..." ]
        } ]
      } ],
      "chargeTransactions" : [ {
        "id" : "ffffffff00000000220e67a8116d8001",
        "payMode" : 1,
        "paySubMode" : 1,
        "payModeName" : "ABC支付",
        "payModeDisplayName" : "ABC支付-微信",
        "amount" : 0.0,
        "created" : "2022-04-06 15:12:53",
        "isRefunded" : 0,
        "chargeTransactionRecords" : [ {
          "id" : "ffffffff00000000265ff80811ab200x",
          "transactionId" : "ffffffff00000000265ff80811ab2004",
          "chargeType" : 1,
          "productId" : "00000000000000000000000000000001",
          "productName" : "白术",
          "productType" : 5,
          "productSubType" : 0,
          "composeType" : 0,
          "productUnit" : "string",
          "productUnitCount" : 1.0,
          "doseCount" : 1.0,
          "totalPrice" : 0.0,
          "discountPrice" : 0.0,
          "created" : "2022-04-06 15:12:53",
          "sceneType" : 0,
          "composeChildren" : [ {
            "id" : "ffffffff00000000265ff80811ab200x",
            "transactionId" : "ffffffff00000000265ff80811ab2004",
            "chargeType" : 1,
            "productId" : "00000000000000000000000000000001",
            "productName" : "白术",
            "productType" : 5,
            "productSubType" : 0,
            "composeType" : 0,
            "productUnit" : "string",
            "productUnitCount" : 1.0,
            "doseCount" : 1.0,
            "totalPrice" : 0.0,
            "discountPrice" : 0.0,
            "created" : "2022-04-06 15:12:53",
            "sceneType" : 0,
            "composeChildren" : [ "..." ]
          } ]
        } ]
      } ],
      "chargeTransactionPaidRecords" : [ {
        "productId" : "00000000000000000000000000000001",
        "productName" : "白术",
        "productType" : 5,
        "productSubType" : 0,
        "composeType" : 0,
        "productUnit" : "string",
        "productUnitCount" : 1.0,
        "doseCount" : 1.0,
        "totalPrice" : 0.0,
        "discountPrice" : 0.0,
        "records" : 0
      } ],
      "sellerId" : "ffffff000000xxxxx",
      "sellerName" : "张三",
      "registrationSheetId" : "ffffffff0000000025b0df48001ae013",
      "patientOrderId" : "ffffffff00000000220e67a8116d8000",
      "isDraft" : 0,
      "isClosed" : 0,
      "chargedTime" : "2022-04-06 15:12:53"
    } ]
  }
}

5.7.7. 查询患者的收费单

GET /api/v2/open-agency/charge/patient/{patientId}

说明

时间跨度最大为三个月

参数

类型名称说明类型默认值

Path

patientId
必填

患者ID

string

Query

beginDate
可选

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

string (date)

Query

endDate
可选

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

string (date)

Query

limit
可选

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

integer (int32)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

status
可选

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

string

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/charge/patient/ffffffff00000000349018418ff74000

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "ffffffff00000000348e4da767258000",
      "patientOrderId" : "ffffffff0000000034c1d861a2eb8000",
      "doctorId" : "ffffffff0000000034c1ed8a86f00003",
      "doctorName" : "王五",
      "status" : 0,
      "receivableFee" : 20.0,
      "sellerId" : "ffffffff00000000287b8f500fa68000",
      "sellerName" : "李四",
      "chargerId" : "ffffffff00000000348e4e60e7290000",
      "chargerName" : "张三",
      "type" : 1,
      "created" : "2022-04-06 15:12:53"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.7.8. 取消收费单快递费

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

说明

只有在待收费状态下可取消

参数

类型

名称

说明

类型

Body

-
必填

取消快递费请求参数

Path

chargeSheetId
必填

收费单ID

string

响应

HTTP Code

说明

类型

200

R«收费单详细信息»

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/charge/string/delivery/cancel

请求 body

{
  "operatorId" : "00000000000000000000000000000000"
}

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "ffffffff00000000220e67a8116d8000",
    "status" : 0,
    "type" : 1,
    "created" : "2022-04-06 15:12:53",
    "receivableFee" : 0.01,
    "receivedFee" : 0.0,
    "refundFee" : 0.01,
    "discountFee" : -10.0,
    "refundTime" : "2022-04-07 15:12:53",
    "charger" : {
      "id" : "string",
      "name" : "张三"
    },
    "deliveryInfo" : {
      "addressProvinceName" : "四川省",
      "addressCityName" : "成都市",
      "addressDistrictName" : "高新区",
      "addressDetail" : "四川省成都市高新区xxx街道xxx",
      "deliveryName" : "张三",
      "deliveryMobile" : "18088888888",
      "deliveryCompany" : {
        "id" : "127203805890060288",
        "name" : "string"
      },
      "deliveryOrderNo" : "20827634879930368",
      "deliveryPayType" : 1,
      "deliveryFee" : 10.0
    },
    "doctor" : {
      "id" : "string",
      "mobile" : "18088888888",
      "name" : "张三",
      "sex" : "男",
      "headImgUrl" : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg",
      "introduction" : "毕业于陆军军医大学临床医学七年制",
      "practiceImgUrl" : "string",
      "doctorPageUrl" : "string",
      "doctorTags" : "省级名中医、市级名中医"
    },
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "chargeFormItems" : [ {
      "id" : "0002b62eaf9c461f85ff3fedc4583a79",
      "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
      "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
      "productName" : "注射用青霉素钠",
      "status" : 0,
      "unit" : "支",
      "receivedFee" : 40.0,
      "unitPrice" : 10.0,
      "displayUnitPrice" : 10.0,
      "displayTotalPrice" : 40.0,
      "unitCount" : 4.0,
      "doseCount" : 1.0,
      "totalCount" : 4.0,
      "productType" : 1,
      "productSubType" : 3,
      "sourceItemType" : 0,
      "productInfo" : {
        "children" : [ {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        } ],
        "id" : "string",
        "name" : "阿莫西林",
        "shebao" : {
          "nationalCode" : "T001700643",
          "insuranceTypes" : [ {
            "insuranceType" : "391",
            "reimbursementRatio" : 0.1
          } ]
        },
        "disableSell" : 0,
        "typeId" : 1,
        "typeName" : "药品",
        "customTypeId" : "213",
        "customTypeName" : "抗生素",
        "manufacturer" : "拜耳",
        "medicineNmpn" : "H20000001",
        "barCode" : "string",
        "pieceUnit" : "支",
        "pieceNum" : 10.0,
        "piecePrice" : 10.5,
        "packageUnit" : "盒",
        "packagePrice" : 105.0,
        "shortId" : "K1001",
        "specification" : "1ml:0.5mg*10支/盒",
        "otcType" : 1,
        "status" : 1,
        "lastModified" : "2022-05-13 12:22:56",
        "goodsSpu" : {
          "id" : "string",
          "name" : "string",
          "brandName" : "string",
          "material" : "string"
        },
        "goodsSpec" : {
          "color" : "string",
          "spec" : "string"
        }
      },
      "composeChildren" : [ {
        "id" : "0002b62eaf9c461f85ff3fedc4583a79",
        "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
        "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
        "productName" : "注射用青霉素钠",
        "status" : 0,
        "unit" : "支",
        "receivedFee" : 40.0,
        "unitPrice" : 10.0,
        "displayUnitPrice" : 10.0,
        "displayTotalPrice" : 40.0,
        "unitCount" : 4.0,
        "doseCount" : 1.0,
        "totalCount" : 4.0,
        "productType" : 1,
        "productSubType" : 3,
        "sourceItemType" : 0,
        "productInfo" : {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        },
        "composeChildren" : [ "..." ]
      } ]
    } ],
    "chargeTransactions" : [ {
      "id" : "ffffffff00000000220e67a8116d8001",
      "payMode" : 1,
      "paySubMode" : 1,
      "payModeName" : "ABC支付",
      "payModeDisplayName" : "ABC支付-微信",
      "amount" : 0.0,
      "created" : "2022-04-06 15:12:53",
      "isRefunded" : 0,
      "chargeTransactionRecords" : [ {
        "id" : "ffffffff00000000265ff80811ab200x",
        "transactionId" : "ffffffff00000000265ff80811ab2004",
        "chargeType" : 1,
        "productId" : "00000000000000000000000000000001",
        "productName" : "白术",
        "productType" : 5,
        "productSubType" : 0,
        "composeType" : 0,
        "productUnit" : "string",
        "productUnitCount" : 1.0,
        "doseCount" : 1.0,
        "totalPrice" : 0.0,
        "discountPrice" : 0.0,
        "created" : "2022-04-06 15:12:53",
        "sceneType" : 0,
        "composeChildren" : [ {
          "id" : "ffffffff00000000265ff80811ab200x",
          "transactionId" : "ffffffff00000000265ff80811ab2004",
          "chargeType" : 1,
          "productId" : "00000000000000000000000000000001",
          "productName" : "白术",
          "productType" : 5,
          "productSubType" : 0,
          "composeType" : 0,
          "productUnit" : "string",
          "productUnitCount" : 1.0,
          "doseCount" : 1.0,
          "totalPrice" : 0.0,
          "discountPrice" : 0.0,
          "created" : "2022-04-06 15:12:53",
          "sceneType" : 0,
          "composeChildren" : [ "..." ]
        } ]
      } ]
    } ],
    "chargeTransactionPaidRecords" : [ {
      "productId" : "00000000000000000000000000000001",
      "productName" : "白术",
      "productType" : 5,
      "productSubType" : 0,
      "composeType" : 0,
      "productUnit" : "string",
      "productUnitCount" : 1.0,
      "doseCount" : 1.0,
      "totalPrice" : 0.0,
      "discountPrice" : 0.0,
      "records" : 0
    } ],
    "sellerId" : "ffffff000000xxxxx",
    "sellerName" : "张三",
    "registrationSheetId" : "ffffffff0000000025b0df48001ae013",
    "patientOrderId" : "ffffffff00000000220e67a8116d8000",
    "isDraft" : 0,
    "isClosed" : 0,
    "chargedTime" : "2022-04-06 15:12:53"
  }
}

5.8. 发药接口

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

GET /api/v2/open-agency/dispensing/{id}

参数

类型

名称

说明

类型

Path

id
必填

发药单ID

string

响应

HTTP Code

说明

类型

200

R«发药单详情»

HTTP请求示例

请求 path

/api/v2/open-agency/dispensing/ffffffff00000000264a75300d752999

HTTP响应示例

响应 200

{
  "data" : {
    "clinicId" : "ffffffff000000002620d6280d751234",
    "id" : "ffffffff000000002620d6280d751234",
    "sourceSheetId" : "ffffffff000000002620d6280d751234",
    "doctorId" : "ffffffff0000000022e9e9580179a123",
    "patientOrderId" : "ffffffff0000000022e9e9580179a123",
    "patientOrderNo" : "诊号：00003447",
    "diagnosedDate" : "2022-07-14 12:00:00",
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "wearGlassesHistory" : "近视",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "patientInfo" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "deliveryInfo" : {
      "addressProvinceName" : "四川省",
      "addressCityName" : "成都市",
      "addressDistrictName" : "高新区",
      "addressDetail" : "四川省成都市高新区xxx街道xxx",
      "deliveryName" : "张三",
      "deliveryMobile" : "18088888888",
      "deliveryCompany" : {
        "id" : "127203805890060288",
        "name" : "string"
      },
      "deliveryOrderNo" : "20827634879930368",
      "deliveryPayType" : 1,
      "deliveryFee" : 10.0
    },
    "deliveredStatus" : 0,
    "deliveryType" : 0,
    "status" : 0,
    "statusName" : "未发药",
    "dispensedBy" : "ffffffff000000002622cbd801e7777",
    "dispensedByName" : "张三",
    "dispensedTime" : "2022-07-14 12:00:00",
    "created" : "2022-07-14 12:00:00",
    "pharmacy" : {
      "no" : 0
    },
    "netIncomeFee" : 43.75,
    "doctor" : {
      "id" : "string",
      "name" : "string"
    },
    "department" : {
      "id" : "ffffffff0000000006dddfe002e22000",
      "name" : "儿保科室",
      "type" : 1,
      "mainMedicalName" : "儿科",
      "secondMedicalName" : "小儿呼吸"
    },
    "isShebaoPay" : 0,
    "dispensingForms" : [ {
      "id" : "ffffffff00000000264a75300d759999",
      "dispseneFormType" : 0,
      "numberOfHerbs" : 0,
      "usageInfo" : {
        "usage" : "煎服",
        "freq" : "1日3次",
        "medicineRequirement" : "先煎",
        "doseCount" : 3,
        "dailyDosage" : "1日3剂",
        "requirement" : "饭前服用",
        "usageLevel" : "每次150ml",
        "processUsage" : "机器煎药（普通）",
        "processRemark" : "加工备注信息",
        "usageDays" : "约服30天",
        "processBagUnitCount" : 3.0,
        "totalProcessCount" : 9.0
      },
      "totalPrice" : 30.23,
      "dispensingFormItems" : [ {
        "id" : "ffffffff00000000264a75300d757777",
        "sourceFormItemId" : "ffffffff00000000264a75300d757778",
        "status" : 1,
        "productId" : "02bb5357a5df05b65d028f8868472222",
        "productName" : "罗红霉素胶囊",
        "unit" : "12g/剂*3剂 的g",
        "unitCount" : "12g/剂*3剂 的12",
        "doseCount" : "12g/剂*3剂 的3 (同发药处方上的剂数相同)",
        "totalCount" : "12g/剂*3剂 的36=12*3 (totalCount = unitCount * doseCount)",
        "usageInfo" : {
          "usage" : "煎服",
          "freq" : "1日3次",
          "medicineRequirement" : "先煎",
          "doseCount" : 3,
          "dailyDosage" : "1日3剂",
          "requirement" : "饭前服用",
          "usageLevel" : "每次150ml",
          "processUsage" : "机器煎药（普通）",
          "processRemark" : "加工备注信息",
          "usageDays" : "约服30天",
          "processBagUnitCount" : 3.0,
          "totalProcessCount" : 9.0
        },
        "productInfo" : {
          "children" : [ {
            "children" : [ "..." ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "disableSell" : 0,
            "typeId" : 1,
            "typeName" : "药品",
            "customTypeId" : "213",
            "customTypeName" : "抗生素",
            "manufacturer" : "拜耳",
            "medicineNmpn" : "H20000001",
            "barCode" : "string",
            "pieceUnit" : "支",
            "pieceNum" : 10.0,
            "piecePrice" : 10.5,
            "packageUnit" : "盒",
            "packagePrice" : 105.0,
            "shortId" : "K1001",
            "specification" : "1ml:0.5mg*10支/盒",
            "otcType" : 1,
            "status" : 1,
            "lastModified" : "2022-05-13 12:22:56",
            "goodsSpu" : {
              "id" : "string",
              "name" : "string",
              "brandName" : "string",
              "material" : "string"
            },
            "goodsSpec" : {
              "color" : "string",
              "spec" : "string"
            }
          } ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        },
        "totalPrice" : 10.3,
        "dispensingBatches" : [ {
          "action" : "发药",
          "stockId" : 123456,
          "supplier" : {
            "id" : "ffffffff0000000034e6cae04206c09c",
            "name" : "药品供应商"
          },
          "batchId" : 3123455,
          "batchNo" : "Z123",
          "productionDate" : "2023-01-01",
          "expiryDate" : "2026-01-01",
          "packageCount" : -10.0,
          "piecePrice" : 1.0,
          "packagePrice" : 10.0,
          "pieceCount" : -10.0,
          "packageCostPrice" : 10.0,
          "costPrice" : -10.0,
          "salePrice" : 10.0,
          "stockInOutDetailId" : "Z123",
          "created" : "2023-01-01 00:00:00"
        } ]
      } ],
      "compoundInfo" : {
        "compoundBy" : "ffffffff00000000264a75300d757777",
        "compoundByName" : "张三",
        "compoundByHandSign" : "http://www.baidu.com",
        "compoundTime" : "2025-01-09 17:20:00"
      },
      "auditInfo" : {
        "auditBy" : "ffffffff00000000264a75300d757777",
        "auditByName" : "张三",
        "auditByHandSign" : "http://www.baidu.com",
        "auditTime" : "2025-01-09 17:20:00"
      }
    } ]
  }
}

5.8.2. 按天查询发药单

GET /api/v2/open-agency/dispensing/query-by-date

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string (date)

Query

dateType
可选

日期类型 0:发药单创建时间 1:发药单操作时间（如果发药单在几天都发生过发药或退药操作，则这几天都能查询到该发药单），默认为0创建时间

integer (int32)

0

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/dispensing/query-by-date?date=2022-01-03

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "patientOrderNo" : "000001",
      "chargeSheetId" : "string",
      "pharmacyNo" : 0,
      "pharmacyType" : 0,
      "status" : 0,
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      }
    } ],
    "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

消耗

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

消耗

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

消耗

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

消耗

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

消耗

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

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

HTTP请求示例

请求 path

/api/v2/open-agency/dispensing/by-charge-sheet-id/string

HTTP响应示例

响应 200

{
  "data" : {
    "dispensingSheets" : [ {
      "clinicId" : "ffffffff000000002620d6280d751234",
      "id" : "ffffffff000000002620d6280d751234",
      "sourceSheetId" : "ffffffff000000002620d6280d751234",
      "doctorId" : "ffffffff0000000022e9e9580179a123",
      "patientOrderId" : "ffffffff0000000022e9e9580179a123",
      "patientOrderNo" : "诊号：00003447",
      "diagnosedDate" : "2022-07-14 12:00:00",
      "medicalRecord" : {
        "id" : "string",
        "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
        "chiefComplaint" : "咽痛，干咳，咳痰",
        "pastHistory" : "既往体健，既往有高血压",
        "familyHistory" : "string",
        "presentHistory" : "string",
        "physicalExamination" : "string",
        "diagnosis" : "急性上呼吸道感染",
        "doctorAdvice" : "string",
        "syndrome" : "string",
        "therapy" : "string",
        "chineseExamination" : "string",
        "wearGlassesHistory" : "近视",
        "obstetricalHistory" : "string",
        "eyeExamination" : {
          "items" : [ {
            "key" : "string",
            "name" : "string",
            "rightEyeValue" : "string",
            "leftEyeValue" : "string"
          } ]
        },
        "allergicHistory" : "青霉素过敏",
        "attachments" : [ {
          "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
          "fileName" : "NatGeo09.jpg",
          "fileSize" : 4771201
        } ]
      },
      "patientInfo" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "deliveryInfo" : {
        "addressProvinceName" : "四川省",
        "addressCityName" : "成都市",
        "addressDistrictName" : "高新区",
        "addressDetail" : "四川省成都市高新区xxx街道xxx",
        "deliveryName" : "张三",
        "deliveryMobile" : "18088888888",
        "deliveryCompany" : {
          "id" : "127203805890060288",
          "name" : "string"
        },
        "deliveryOrderNo" : "20827634879930368",
        "deliveryPayType" : 1,
        "deliveryFee" : 10.0
      },
      "deliveredStatus" : 0,
      "deliveryType" : 0,
      "status" : 0,
      "statusName" : "未发药",
      "dispensedBy" : "ffffffff000000002622cbd801e7777",
      "dispensedByName" : "张三",
      "dispensedTime" : "2022-07-14 12:00:00",
      "created" : "2022-07-14 12:00:00",
      "pharmacy" : {
        "no" : 0
      },
      "netIncomeFee" : 43.75,
      "doctor" : {
        "id" : "string",
        "name" : "string"
      },
      "department" : {
        "id" : "ffffffff0000000006dddfe002e22000",
        "name" : "儿保科室",
        "type" : 1,
        "mainMedicalName" : "儿科",
        "secondMedicalName" : "小儿呼吸"
      },
      "isShebaoPay" : 0,
      "dispensingForms" : [ {
        "id" : "ffffffff00000000264a75300d759999",
        "dispseneFormType" : 0,
        "numberOfHerbs" : 0,
        "usageInfo" : {
          "usage" : "煎服",
          "freq" : "1日3次",
          "medicineRequirement" : "先煎",
          "doseCount" : 3,
          "dailyDosage" : "1日3剂",
          "requirement" : "饭前服用",
          "usageLevel" : "每次150ml",
          "processUsage" : "机器煎药（普通）",
          "processRemark" : "加工备注信息",
          "usageDays" : "约服30天",
          "processBagUnitCount" : 3.0,
          "totalProcessCount" : 9.0
        },
        "totalPrice" : 30.23,
        "dispensingFormItems" : [ {
          "id" : "ffffffff00000000264a75300d757777",
          "sourceFormItemId" : "ffffffff00000000264a75300d757778",
          "status" : 1,
          "productId" : "02bb5357a5df05b65d028f8868472222",
          "productName" : "罗红霉素胶囊",
          "unit" : "12g/剂*3剂 的g",
          "unitCount" : "12g/剂*3剂 的12",
          "doseCount" : "12g/剂*3剂 的3 (同发药处方上的剂数相同)",
          "totalCount" : "12g/剂*3剂 的36=12*3 (totalCount = unitCount * doseCount)",
          "usageInfo" : {
            "usage" : "煎服",
            "freq" : "1日3次",
            "medicineRequirement" : "先煎",
            "doseCount" : 3,
            "dailyDosage" : "1日3剂",
            "requirement" : "饭前服用",
            "usageLevel" : "每次150ml",
            "processUsage" : "机器煎药（普通）",
            "processRemark" : "加工备注信息",
            "usageDays" : "约服30天",
            "processBagUnitCount" : 3.0,
            "totalProcessCount" : 9.0
          },
          "productInfo" : {
            "children" : [ {
              "children" : [ "..." ],
              "id" : "string",
              "name" : "阿莫西林",
              "shebao" : {
                "nationalCode" : "T001700643",
                "insuranceTypes" : [ {
                  "insuranceType" : "391",
                  "reimbursementRatio" : 0.1
                } ]
              },
              "disableSell" : 0,
              "typeId" : 1,
              "typeName" : "药品",
              "customTypeId" : "213",
              "customTypeName" : "抗生素",
              "manufacturer" : "拜耳",
              "medicineNmpn" : "H20000001",
              "barCode" : "string",
              "pieceUnit" : "支",
              "pieceNum" : 10.0,
              "piecePrice" : 10.5,
              "packageUnit" : "盒",
              "packagePrice" : 105.0,
              "shortId" : "K1001",
              "specification" : "1ml:0.5mg*10支/盒",
              "otcType" : 1,
              "status" : 1,
              "lastModified" : "2022-05-13 12:22:56",
              "goodsSpu" : {
                "id" : "string",
                "name" : "string",
                "brandName" : "string",
                "material" : "string"
              },
              "goodsSpec" : {
                "color" : "string",
                "spec" : "string"
              }
            } ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "disableSell" : 0,
            "typeId" : 1,
            "typeName" : "药品",
            "customTypeId" : "213",
            "customTypeName" : "抗生素",
            "manufacturer" : "拜耳",
            "medicineNmpn" : "H20000001",
            "barCode" : "string",
            "pieceUnit" : "支",
            "pieceNum" : 10.0,
            "piecePrice" : 10.5,
            "packageUnit" : "盒",
            "packagePrice" : 105.0,
            "shortId" : "K1001",
            "specification" : "1ml:0.5mg*10支/盒",
            "otcType" : 1,
            "status" : 1,
            "lastModified" : "2022-05-13 12:22:56",
            "goodsSpu" : {
              "id" : "string",
              "name" : "string",
              "brandName" : "string",
              "material" : "string"
            },
            "goodsSpec" : {
              "color" : "string",
              "spec" : "string"
            }
          },
          "totalPrice" : 10.3,
          "dispensingBatches" : [ {
            "action" : "发药",
            "stockId" : 123456,
            "supplier" : {
              "id" : "ffffffff0000000034e6cae04206c09c",
              "name" : "药品供应商"
            },
            "batchId" : 3123455,
            "batchNo" : "Z123",
            "productionDate" : "2023-01-01",
            "expiryDate" : "2026-01-01",
            "packageCount" : -10.0,
            "piecePrice" : 1.0,
            "packagePrice" : 10.0,
            "pieceCount" : -10.0,
            "packageCostPrice" : 10.0,
            "costPrice" : -10.0,
            "salePrice" : 10.0,
            "stockInOutDetailId" : "Z123",
            "created" : "2023-01-01 00:00:00"
          } ]
        } ],
        "compoundInfo" : {
          "compoundBy" : "ffffffff00000000264a75300d757777",
          "compoundByName" : "张三",
          "compoundByHandSign" : "http://www.baidu.com",
          "compoundTime" : "2025-01-09 17:20:00"
        },
        "auditInfo" : {
          "auditBy" : "ffffffff00000000264a75300d757777",
          "auditByName" : "张三",
          "auditByHandSign" : "http://www.baidu.com",
          "auditTime" : "2025-01-09 17:20:00"
        }
      } ]
    } ]
  }
}

5.8.9. 查询患者发药单

GET /api/v2/open-agency/dispensing/patient/{patientId}

参数

类型名称说明类型默认值

Path

patientId
必填

patientId

string

Query

beginDate
可选

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

string (date)

Query

endDate
可选

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

string (date)

Query

limit
可选

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

integer (int32)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

status
可选

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

integer (int32)

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/dispensing/patient/string

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "chargeSheetId" : "string",
      "pharmacyNo" : 0,
      "pharmacyType" : 0,
      "status" : 0,
      "created" : "2024-05-30 08:13:00",
      "sellerId" : "ffffffff000000002620d6280d751234",
      "sellerName" : "张三"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

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

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

HTTP请求示例

请求 path

/api/v2/open-agency/examination/query-by-patient/af38e7591b864838a411c1fd9cd835ac

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "patientOrderId" : "string",
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "name" : "string",
      "type" : 1,
      "deviceType" : 0,
      "businessType" : 0,
      "created" : "string",
      "status" : 0,
      "statusName" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

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

GET /api/v2/open-agency/examination/all/query-by-date

参数

类型名称说明类型默认值

Query

dateFieldType
可选

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

integer (int32)

1

Query

endTime
可选

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

string

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

Query

startTime
可选

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

string

Query

type
可选

1：检验；2：检查

integer (int32)

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/examination/all/query-by-date

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "orderNo" : "string",
      "productId" : "string",
      "products" : [ {
        "productId" : "string",
        "productName" : "string",
        "examinationSheetId" : "string"
      } ],
      "productIds" : [ "string" ],
      "name" : "string",
      "type" : 1,
      "deviceType" : 0,
      "businessType" : 0,
      "sampleType" : "string",
      "patientOrderNo" : "string",
      "patientOrderType" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "createdTime" : "string",
      "patientInfo" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "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

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

HTTP请求示例

请求 path

/api/v2/open-agency/examination/query-by-patient-order-no?patientOrderNo=12212

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "diagnosis" : "string",
      "id" : "string",
      "orderNo" : "string",
      "productId" : "string",
      "products" : [ {
        "productId" : "string",
        "productName" : "string",
        "examinationSheetId" : "string"
      } ],
      "productIds" : [ "string" ],
      "name" : "string",
      "type" : 1,
      "deviceType" : 0,
      "businessType" : 0,
      "sampleType" : "string",
      "patientOrderNo" : "string",
      "patientOrderType" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "createdTime" : "string",
      "patientInfo" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "status" : 0,
      "statusName" : "待检"
    } ]
  }
}

5.9.4. 查询检查检验单详情

GET /api/v2/open-agency/examination/examination-sheet-detail/{id}

参数

类型

名称

说明

类型

Path

id
必填

检查检验单id

string

响应

HTTP Code

说明

类型

200

HTTP请求示例

请求 path

/api/v2/open-agency/examination/examination-sheet-detail/string

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "string",
    "outpatientFormItemId" : "string",
    "patientOrderId" : "string",
    "patientOrderNumber" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "sn" : "100",
      "idCard" : "string",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      }
    },
    "doctorId" : "string",
    "doctorName" : "string",
    "doctorDepartmentId" : "string",
    "doctorDepartmentName" : "string",
    "sellerId" : "string",
    "sellerName" : "string",
    "sellerDepartmentId" : "string",
    "sellerDepartmentName" : "string",
    "productId" : "string",
    "products" : [ {
      "productId" : "string",
      "productName" : "string",
      "examinationSheetId" : "string"
    } ],
    "productIds" : [ "string" ],
    "composeParentProductId" : "string",
    "composeParentName" : "string",
    "name" : "string",
    "orderNo" : "202302140038",
    "status" : 0,
    "statusName" : "string",
    "sampleType" : "string",
    "samplerId" : "string",
    "samplerName" : "string",
    "sampleTime" : "string",
    "collectorId" : "string",
    "collectorName" : "string",
    "collectTime" : "string",
    "results" : [ {
      "id" : "string",
      "type" : 1,
      "name" : "string",
      "enName" : "string",
      "unit" : "string",
      "itemCode" : "string",
      "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
      "productId" : "string",
      "resultDisplayScale" : 0,
      "value" : { },
      "valueType" : "STRING",
      "abnormalFlag" : "N",
      "abnormalText" : "string"
    } ],
    "eyeResults" : [ {
      "productId" : "string",
      "name" : "string",
      "children" : [ {
        "name" : "string",
        "children" : [ {
          "name" : "string",
          "children" : [ {
            "inspectType" : 0,
            "children" : [ {
              "items" : [ {
                "id" : "string",
                "productId" : "string",
                "type" : 0,
                "name" : "string",
                "enName" : "string",
                "unit" : "string",
                "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
                "resultDisplayScale" : 0,
                "inspectType" : 0,
                "componentType" : 0,
                "options" : [ "string" ],
                "constraints" : [ {
                  "message" : "string",
                  "required" : true,
                  "precision" : 0,
                  "scale" : 0,
                  "min" : 0,
                  "max" : 0,
                  "size" : 0,
                  "unit" : "string",
                  "validateType" : 0
                } ],
                "value" : "string",
                "sort" : 0,
                "groupId" : 0,
                "displayName" : "string"
              } ]
            } ]
          } ]
        } ]
      } ],
      "checker" : {
        "id" : "string",
        "name" : "string",
        "date" : "string"
      }
    } ],
    "reports" : [ {
      "id" : "string",
      "imageFiles" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ],
      "videoDescription" : "string",
      "suggestion" : "string",
      "inspectionSite" : "string",
      "deviceModelDesc" : "string",
      "diagnosisFlag" : 0,
      "recordDoctorId" : "string",
      "consultationDoctorId" : "string",
      "recordDoctorName" : "string",
      "consultationDoctorName" : "string",
      "diagnosisEntryItems" : [ {
        "id" : 0,
        "name" : "string",
        "abnormalFlag" : 0
      } ]
    } ],
    "attachments" : [ {
      "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
      "fileName" : "NatGeo09.jpg",
      "fileSize" : 4771201
    } ],
    "remark" : "string",
    "testerId" : "string",
    "testerName" : "string",
    "testTime" : "string",
    "checkerId" : "string",
    "checkerName" : "string",
    "checkTime" : "string",
    "reportTime" : "string",
    "created" : "string",
    "type" : 1,
    "subType" : 20,
    "diagnosis" : "急性上呼吸道感染",
    "reportUrl" : "string",
    "examinationApplySheetNo" : "string",
    "bedNo" : "string",
    "deviceType" : 0,
    "businessType" : 0,
    "relationPatientOrderId" : "string",
    "registrationFormItem" : {
      "patientOrderId" : "string",
      "registrationSheetId" : "string",
      "patientId" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "status" : 10,
      "signIn" : 0,
      "consultingRoomId" : "string",
      "consultingRoomName" : "string",
      "type" : 0,
      "payStatus" : 0,
      "code" : 0,
      "registrationType" : 0,
      "created" : "2022-06-23 18:45:00"
    }
  }
}

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

GET /api/v2/open-agency/examination/by-order-no/{orderNo}/{type}

参数

类型

名称

说明

类型

Path

orderNo
必填

订单号

string

Path

type
必填

类型 1:检验 2:检查

integer (int32)

响应

HTTP Code

说明

类型

200

HTTP请求示例

请求 path

/api/v2/open-agency/examination/by-order-no/string/1

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "string",
    "outpatientFormItemId" : "string",
    "patientOrderId" : "string",
    "patientOrderNumber" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "sn" : "100",
      "idCard" : "string",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      }
    },
    "doctorId" : "string",
    "doctorName" : "string",
    "doctorDepartmentId" : "string",
    "doctorDepartmentName" : "string",
    "sellerId" : "string",
    "sellerName" : "string",
    "sellerDepartmentId" : "string",
    "sellerDepartmentName" : "string",
    "productId" : "string",
    "products" : [ {
      "productId" : "string",
      "productName" : "string",
      "examinationSheetId" : "string"
    } ],
    "productIds" : [ "string" ],
    "composeParentProductId" : "string",
    "composeParentName" : "string",
    "name" : "string",
    "orderNo" : "202302140038",
    "status" : 0,
    "statusName" : "string",
    "sampleType" : "string",
    "samplerId" : "string",
    "samplerName" : "string",
    "sampleTime" : "string",
    "collectorId" : "string",
    "collectorName" : "string",
    "collectTime" : "string",
    "results" : [ {
      "id" : "string",
      "type" : 1,
      "name" : "string",
      "enName" : "string",
      "unit" : "string",
      "itemCode" : "string",
      "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
      "productId" : "string",
      "resultDisplayScale" : 0,
      "value" : { },
      "valueType" : "STRING",
      "abnormalFlag" : "N",
      "abnormalText" : "string"
    } ],
    "eyeResults" : [ {
      "productId" : "string",
      "name" : "string",
      "children" : [ {
        "name" : "string",
        "children" : [ {
          "name" : "string",
          "children" : [ {
            "inspectType" : 0,
            "children" : [ {
              "items" : [ {
                "id" : "string",
                "productId" : "string",
                "type" : 0,
                "name" : "string",
                "enName" : "string",
                "unit" : "string",
                "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
                "resultDisplayScale" : 0,
                "inspectType" : 0,
                "componentType" : 0,
                "options" : [ "string" ],
                "constraints" : [ {
                  "message" : "string",
                  "required" : true,
                  "precision" : 0,
                  "scale" : 0,
                  "min" : 0,
                  "max" : 0,
                  "size" : 0,
                  "unit" : "string",
                  "validateType" : 0
                } ],
                "value" : "string",
                "sort" : 0,
                "groupId" : 0,
                "displayName" : "string"
              } ]
            } ]
          } ]
        } ]
      } ],
      "checker" : {
        "id" : "string",
        "name" : "string",
        "date" : "string"
      }
    } ],
    "reports" : [ {
      "id" : "string",
      "imageFiles" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ],
      "videoDescription" : "string",
      "suggestion" : "string",
      "inspectionSite" : "string",
      "deviceModelDesc" : "string",
      "diagnosisFlag" : 0,
      "recordDoctorId" : "string",
      "consultationDoctorId" : "string",
      "recordDoctorName" : "string",
      "consultationDoctorName" : "string",
      "diagnosisEntryItems" : [ {
        "id" : 0,
        "name" : "string",
        "abnormalFlag" : 0
      } ]
    } ],
    "attachments" : [ {
      "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
      "fileName" : "NatGeo09.jpg",
      "fileSize" : 4771201
    } ],
    "remark" : "string",
    "testerId" : "string",
    "testerName" : "string",
    "testTime" : "string",
    "checkerId" : "string",
    "checkerName" : "string",
    "checkTime" : "string",
    "reportTime" : "string",
    "created" : "string",
    "type" : 1,
    "subType" : 20,
    "diagnosis" : "急性上呼吸道感染",
    "reportUrl" : "string",
    "examinationApplySheetNo" : "string",
    "bedNo" : "string",
    "deviceType" : 0,
    "businessType" : 0,
    "relationPatientOrderId" : "string",
    "registrationFormItem" : {
      "patientOrderId" : "string",
      "registrationSheetId" : "string",
      "patientId" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "status" : 10,
      "signIn" : 0,
      "consultingRoomId" : "string",
      "consultingRoomName" : "string",
      "type" : 0,
      "payStatus" : 0,
      "code" : 0,
      "registrationType" : 0,
      "created" : "2022-06-23 18:45:00"
    }
  }
}

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

PUT /api/v2/open-agency/examination/by-order-no/{orderNo}/{type}

参数

类型

名称

说明

类型

Body

-
必填

检验单修改信息

Path

orderNo
必填

订单号

string

Path

type
必填

类型 1:检验 2:检查

integer (int32)

响应

HTTP Code

说明

类型

200

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/examination/by-order-no/string/1

请求 body

{
  "attachments" : [ {
    "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
    "fileName" : "NatGeo09.jpg",
    "fileSize" : 4771201
  } ],
  "reports" : [ {
    "id" : "string",
    "imageFiles" : [ {
      "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
      "fileName" : "NatGeo09.jpg",
      "fileSize" : 4771201
    } ],
    "videoDescription" : "string",
    "suggestion" : "string",
    "diagnosisFlag" : 0,
    "recordDoctorId" : "string",
    "consultationDoctorId" : "string",
    "inspectionSite" : "string",
    "deviceModelDesc" : "string",
    "isDeleted" : 0,
    "diagnosisEntryItems" : [ {
      "id" : 0,
      "name" : "string",
      "abnormalFlag" : 0
    } ]
  } ],
  "results" : [ {
    "id" : "string",
    "type" : 1,
    "name" : "string",
    "enName" : "string",
    "unit" : "string",
    "itemCode" : "string",
    "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
    "productId" : "string",
    "resultDisplayScale" : 0,
    "value" : { },
    "valueType" : "STRING",
    "abnormalFlag" : "N",
    "abnormalText" : "string"
  } ],
  "eyeResults" : [ {
    "productId" : "string",
    "name" : "string",
    "children" : [ {
      "name" : "string",
      "children" : [ {
        "name" : "string",
        "children" : [ {
          "inspectType" : 0,
          "children" : [ {
            "items" : [ {
              "id" : "string",
              "productId" : "string",
              "type" : 0,
              "name" : "string",
              "enName" : "string",
              "unit" : "string",
              "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
              "resultDisplayScale" : 0,
              "inspectType" : 0,
              "componentType" : 0,
              "options" : [ "string" ],
              "constraints" : [ {
                "message" : "string",
                "required" : true,
                "precision" : 0,
                "scale" : 0,
                "min" : 0,
                "max" : 0,
                "size" : 0,
                "unit" : "string",
                "validateType" : 0
              } ],
              "value" : "string",
              "sort" : 0,
              "groupId" : 0,
              "displayName" : "string"
            } ]
          } ]
        } ]
      } ]
    } ],
    "checker" : {
      "id" : "string",
      "name" : "string",
      "date" : "string"
    }
  } ],
  "deviceModelId" : 0,
  "deviceId" : 0,
  "subType" : 0,
  "remark" : "string",
  "testerId" : "string",
  "testerName" : "string",
  "checkerId" : "string",
  "checkerName" : "string",
  "sampleType" : "string",
  "testTime" : "2022-11-14 14:00",
  "checkTime" : "2022-11-14 14:00",
  "reportTime" : "2022-11-14 14:00",
  "status" : 0,
  "relationPatientOrderId" : "string"
}

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "string",
    "outpatientFormItemId" : "string",
    "patientOrderId" : "string",
    "patientOrderNumber" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "sn" : "100",
      "idCard" : "string",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      }
    },
    "doctorId" : "string",
    "doctorName" : "string",
    "doctorDepartmentId" : "string",
    "doctorDepartmentName" : "string",
    "sellerId" : "string",
    "sellerName" : "string",
    "sellerDepartmentId" : "string",
    "sellerDepartmentName" : "string",
    "productId" : "string",
    "products" : [ {
      "productId" : "string",
      "productName" : "string",
      "examinationSheetId" : "string"
    } ],
    "productIds" : [ "string" ],
    "composeParentProductId" : "string",
    "composeParentName" : "string",
    "name" : "string",
    "orderNo" : "202302140038",
    "status" : 0,
    "statusName" : "string",
    "sampleType" : "string",
    "samplerId" : "string",
    "samplerName" : "string",
    "sampleTime" : "string",
    "collectorId" : "string",
    "collectorName" : "string",
    "collectTime" : "string",
    "results" : [ {
      "id" : "string",
      "type" : 1,
      "name" : "string",
      "enName" : "string",
      "unit" : "string",
      "itemCode" : "string",
      "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
      "productId" : "string",
      "resultDisplayScale" : 0,
      "value" : { },
      "valueType" : "STRING",
      "abnormalFlag" : "N",
      "abnormalText" : "string"
    } ],
    "eyeResults" : [ {
      "productId" : "string",
      "name" : "string",
      "children" : [ {
        "name" : "string",
        "children" : [ {
          "name" : "string",
          "children" : [ {
            "inspectType" : 0,
            "children" : [ {
              "items" : [ {
                "id" : "string",
                "productId" : "string",
                "type" : 0,
                "name" : "string",
                "enName" : "string",
                "unit" : "string",
                "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
                "resultDisplayScale" : 0,
                "inspectType" : 0,
                "componentType" : 0,
                "options" : [ "string" ],
                "constraints" : [ {
                  "message" : "string",
                  "required" : true,
                  "precision" : 0,
                  "scale" : 0,
                  "min" : 0,
                  "max" : 0,
                  "size" : 0,
                  "unit" : "string",
                  "validateType" : 0
                } ],
                "value" : "string",
                "sort" : 0,
                "groupId" : 0,
                "displayName" : "string"
              } ]
            } ]
          } ]
        } ]
      } ],
      "checker" : {
        "id" : "string",
        "name" : "string",
        "date" : "string"
      }
    } ],
    "reports" : [ {
      "id" : "string",
      "imageFiles" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ],
      "videoDescription" : "string",
      "suggestion" : "string",
      "inspectionSite" : "string",
      "deviceModelDesc" : "string",
      "diagnosisFlag" : 0,
      "recordDoctorId" : "string",
      "consultationDoctorId" : "string",
      "recordDoctorName" : "string",
      "consultationDoctorName" : "string",
      "diagnosisEntryItems" : [ {
        "id" : 0,
        "name" : "string",
        "abnormalFlag" : 0
      } ]
    } ],
    "attachments" : [ {
      "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
      "fileName" : "NatGeo09.jpg",
      "fileSize" : 4771201
    } ],
    "remark" : "string",
    "testerId" : "string",
    "testerName" : "string",
    "testTime" : "string",
    "checkerId" : "string",
    "checkerName" : "string",
    "checkTime" : "string",
    "reportTime" : "string",
    "created" : "string",
    "type" : 1,
    "subType" : 20,
    "diagnosis" : "急性上呼吸道感染",
    "reportUrl" : "string",
    "examinationApplySheetNo" : "string",
    "bedNo" : "string",
    "deviceType" : 0,
    "businessType" : 0,
    "relationPatientOrderId" : "string",
    "registrationFormItem" : {
      "patientOrderId" : "string",
      "registrationSheetId" : "string",
      "patientId" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "status" : 10,
      "signIn" : 0,
      "consultingRoomId" : "string",
      "consultingRoomName" : "string",
      "type" : 0,
      "payStatus" : 0,
      "code" : 0,
      "registrationType" : 0,
      "created" : "2022-06-23 18:45:00"
    }
  }
}

5.9.7. 保存检查检验单数据

PUT /api/v2/open-agency/examination/examination-sheet-detail/{id}

参数

类型

名称

说明

类型

Body

-
必填

检验单修改信息

Path

id
必填

检查检验单id

string

响应

HTTP Code

说明

类型

200

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/examination/examination-sheet-detail/string

请求 body

{
  "attachments" : [ {
    "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
    "fileName" : "NatGeo09.jpg",
    "fileSize" : 4771201
  } ],
  "reports" : [ {
    "id" : "string",
    "imageFiles" : [ {
      "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
      "fileName" : "NatGeo09.jpg",
      "fileSize" : 4771201
    } ],
    "videoDescription" : "string",
    "suggestion" : "string",
    "diagnosisFlag" : 0,
    "recordDoctorId" : "string",
    "consultationDoctorId" : "string",
    "inspectionSite" : "string",
    "deviceModelDesc" : "string",
    "isDeleted" : 0,
    "diagnosisEntryItems" : [ {
      "id" : 0,
      "name" : "string",
      "abnormalFlag" : 0
    } ]
  } ],
  "results" : [ {
    "id" : "string",
    "type" : 1,
    "name" : "string",
    "enName" : "string",
    "unit" : "string",
    "itemCode" : "string",
    "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
    "productId" : "string",
    "resultDisplayScale" : 0,
    "value" : { },
    "valueType" : "STRING",
    "abnormalFlag" : "N",
    "abnormalText" : "string"
  } ],
  "eyeResults" : [ {
    "productId" : "string",
    "name" : "string",
    "children" : [ {
      "name" : "string",
      "children" : [ {
        "name" : "string",
        "children" : [ {
          "inspectType" : 0,
          "children" : [ {
            "items" : [ {
              "id" : "string",
              "productId" : "string",
              "type" : 0,
              "name" : "string",
              "enName" : "string",
              "unit" : "string",
              "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
              "resultDisplayScale" : 0,
              "inspectType" : 0,
              "componentType" : 0,
              "options" : [ "string" ],
              "constraints" : [ {
                "message" : "string",
                "required" : true,
                "precision" : 0,
                "scale" : 0,
                "min" : 0,
                "max" : 0,
                "size" : 0,
                "unit" : "string",
                "validateType" : 0
              } ],
              "value" : "string",
              "sort" : 0,
              "groupId" : 0,
              "displayName" : "string"
            } ]
          } ]
        } ]
      } ]
    } ],
    "checker" : {
      "id" : "string",
      "name" : "string",
      "date" : "string"
    }
  } ],
  "deviceModelId" : 0,
  "deviceId" : 0,
  "subType" : 0,
  "remark" : "string",
  "testerId" : "string",
  "testerName" : "string",
  "checkerId" : "string",
  "checkerName" : "string",
  "sampleType" : "string",
  "testTime" : "2022-11-14 14:00",
  "checkTime" : "2022-11-14 14:00",
  "reportTime" : "2022-11-14 14:00",
  "status" : 0,
  "relationPatientOrderId" : "string"
}

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "string",
    "outpatientFormItemId" : "string",
    "patientOrderId" : "string",
    "patientOrderNumber" : "string",
    "patient" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "sn" : "100",
      "idCard" : "string",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      }
    },
    "doctorId" : "string",
    "doctorName" : "string",
    "doctorDepartmentId" : "string",
    "doctorDepartmentName" : "string",
    "sellerId" : "string",
    "sellerName" : "string",
    "sellerDepartmentId" : "string",
    "sellerDepartmentName" : "string",
    "productId" : "string",
    "products" : [ {
      "productId" : "string",
      "productName" : "string",
      "examinationSheetId" : "string"
    } ],
    "productIds" : [ "string" ],
    "composeParentProductId" : "string",
    "composeParentName" : "string",
    "name" : "string",
    "orderNo" : "202302140038",
    "status" : 0,
    "statusName" : "string",
    "sampleType" : "string",
    "samplerId" : "string",
    "samplerName" : "string",
    "sampleTime" : "string",
    "collectorId" : "string",
    "collectorName" : "string",
    "collectTime" : "string",
    "results" : [ {
      "id" : "string",
      "type" : 1,
      "name" : "string",
      "enName" : "string",
      "unit" : "string",
      "itemCode" : "string",
      "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
      "productId" : "string",
      "resultDisplayScale" : 0,
      "value" : { },
      "valueType" : "STRING",
      "abnormalFlag" : "N",
      "abnormalText" : "string"
    } ],
    "eyeResults" : [ {
      "productId" : "string",
      "name" : "string",
      "children" : [ {
        "name" : "string",
        "children" : [ {
          "name" : "string",
          "children" : [ {
            "inspectType" : 0,
            "children" : [ {
              "items" : [ {
                "id" : "string",
                "productId" : "string",
                "type" : 0,
                "name" : "string",
                "enName" : "string",
                "unit" : "string",
                "ref" : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}",
                "resultDisplayScale" : 0,
                "inspectType" : 0,
                "componentType" : 0,
                "options" : [ "string" ],
                "constraints" : [ {
                  "message" : "string",
                  "required" : true,
                  "precision" : 0,
                  "scale" : 0,
                  "min" : 0,
                  "max" : 0,
                  "size" : 0,
                  "unit" : "string",
                  "validateType" : 0
                } ],
                "value" : "string",
                "sort" : 0,
                "groupId" : 0,
                "displayName" : "string"
              } ]
            } ]
          } ]
        } ]
      } ],
      "checker" : {
        "id" : "string",
        "name" : "string",
        "date" : "string"
      }
    } ],
    "reports" : [ {
      "id" : "string",
      "imageFiles" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ],
      "videoDescription" : "string",
      "suggestion" : "string",
      "inspectionSite" : "string",
      "deviceModelDesc" : "string",
      "diagnosisFlag" : 0,
      "recordDoctorId" : "string",
      "consultationDoctorId" : "string",
      "recordDoctorName" : "string",
      "consultationDoctorName" : "string",
      "diagnosisEntryItems" : [ {
        "id" : 0,
        "name" : "string",
        "abnormalFlag" : 0
      } ]
    } ],
    "attachments" : [ {
      "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
      "fileName" : "NatGeo09.jpg",
      "fileSize" : 4771201
    } ],
    "remark" : "string",
    "testerId" : "string",
    "testerName" : "string",
    "testTime" : "string",
    "checkerId" : "string",
    "checkerName" : "string",
    "checkTime" : "string",
    "reportTime" : "string",
    "created" : "string",
    "type" : 1,
    "subType" : 20,
    "diagnosis" : "急性上呼吸道感染",
    "reportUrl" : "string",
    "examinationApplySheetNo" : "string",
    "bedNo" : "string",
    "deviceType" : 0,
    "businessType" : 0,
    "relationPatientOrderId" : "string",
    "registrationFormItem" : {
      "patientOrderId" : "string",
      "registrationSheetId" : "string",
      "patientId" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "orderNo" : "上午 01号",
      "reserveDate" : "2019-04-04",
      "reserveTime" : "10:10～10:30",
      "isReserved" : 1,
      "status" : 10,
      "signIn" : 0,
      "consultingRoomId" : "string",
      "consultingRoomName" : "string",
      "type" : 0,
      "payStatus" : 0,
      "code" : 0,
      "registrationType" : 0,
      "created" : "2022-06-23 18:45:00"
    }
  }
}

5.9.8. 创建检查检验单

POST /api/v2/open-agency/examination

参数

类型

名称

说明

类型

Body

-
必填

创建检查检验单请求

响应

HTTP Code

说明

类型

200

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

消耗

application/json

HTTP请求示例

请求 path

/api/v2/open-agency/examination

请求 body

{
  "patientId" : "string",
  "productSubType" : 0,
  "examinationFormItems" : [ {
    "productId" : "string",
    "name" : "string",
    "unitCount" : 0.0
  } ],
  "doctorId" : "string",
  "doctorDepartmentId" : "string",
  "operatorId" : "00000000000000000000000000000000"
}

HTTP响应示例

响应 200

{
  "data" : {
    "examinationSheets" : [ {
      "id" : "string",
      "orderNo" : "string",
      "productId" : "string",
      "products" : [ {
        "productId" : "string",
        "productName" : "string",
        "examinationSheetId" : "string"
      } ],
      "productIds" : [ "string" ],
      "name" : "string",
      "type" : 1,
      "deviceType" : 0,
      "businessType" : 0,
      "sampleType" : "string",
      "patientOrderNo" : "string",
      "patientOrderType" : "string",
      "departmentId" : "string",
      "departmentName" : "string",
      "doctorId" : "string",
      "doctorName" : "string",
      "createdTime" : "string",
      "patientInfo" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "status" : 0,
      "statusName" : "待检"
    } ]
  }
}

5.9.9. 作废检查检验单

PUT /api/v2/open-agency/examination/refund/{id}

参数

类型

名称

说明

类型

Path

id
必填

检查检验单id

string

响应

HTTP Code

说明

类型

200

R«分页查询结果«OpenMemberChargeDetailInfoView»»

消耗

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

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

HTTP请求示例

请求 path

/api/v2/open-agency/examination/devices/1

HTTP响应示例

响应 200

{
  "data" : {
    "devices" : [ {
      "deviceId" : 0,
      "deviceShortId" : "string",
      "deviceModelId" : 0,
      "name" : "string",
      "model" : "string",
      "deviceUuid" : "string",
      "manufacture" : "string",
      "iconUrl" : "string",
      "buyUrl" : "string",
      "installUrl" : "string",
      "remarks" : "string",
      "type" : 0,
      "extendSpec" : "string",
      "deviceType" : 0,
      "usageType" : 0,
      "salePrice" : 0.0,
      "deviceNamePy" : "string",
      "deviceStatus" : 0,
      "deviceRoomId" : 0,
      "deviceRoomName" : "string",
      "department" : {
        "id" : "ffffffff0000000006dddfe002e22000",
        "name" : "儿保科室",
        "type" : 1,
        "mainMedicalName" : "儿科",
        "secondMedicalName" : "小儿呼吸"
      }
    } ]
  }
}

5.10. 统计接口

5.10.1. 收费明细-单据

GET /api/v2/open-agency/stat/revenue/detail/transaction

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string (date)

Query

limit
可选

每页显示条数，默认20

integer (int32)

20

Query

offset
可选

分页起始下标默认0

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/stat/revenue/detail/transaction?date=2020-03-05

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "clinicName" : "大源店",
      "transactionId" : "ffffffff0000000034cebe945dc04002",
      "clinicId" : "ffffffff00000000264a75300d752999",
      "patientOrderId" : "ffffffff0000000034cebe945dc04002",
      "departmentName" : "内科",
      "receivableFee" : 0.0,
      "chargeSheetId" : "ffffffff00000000264a75300d752999",
      "departmentId" : "ffffffff00000000264a75300d752999",
      "employeeName" : "张三",
      "thirdPartyPayTransactionId" : "3811634313497509894",
      "employeeId" : "ffffffff00000000264a75300d752999",
      "visitSource" : {
        "parentId" : "string",
        "parentName" : "string",
        "id" : "string",
        "name" : "就诊推荐",
        "sourceFrom" : "推荐人ID",
        "sourceFromName" : "张三",
        "relatedType" : 3,
        "relatedId" : "ffffffff00000000094c2a500293c000",
        "relateName" : "string"
      },
      "chargeName" : "李四",
      "chargeId" : "ffffffff00000000264a75300d752999",
      "totalPrice" : 20.0,
      "adjustmentPrice" : 0.0,
      "discountPrice" : -9.0,
      "deductPrice" : 0.0,
      "amount" : 11.0,
      "created" : "2022-04-28 15:41:27",
      "sourceType" : "门诊",
      "action" : "收费",
      "patientId" : "ffffffff0000000034d22e0ce272c000",
      "patientName" : "张三",
      "no" : 100,
      "payMode" : "支付宝",
      "payModeId" : 1,
      "paySubModeId" : 0,
      "comment" : "-",
      "memberPatientId" : "fffffffff00000000349018418ff74000",
      "memberPatientName" : "张三",
      "memberPatientMobile" : "18012312312"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.10.2. 收费明细-分类

GET /api/v2/open-agency/stat/revenue/detail/classify

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string (date)

Query

limit
可选

每页显示条数，默认20

integer (int32)

20

Query

offset
可选

分页起始下标默认0

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/stat/revenue/detail/classify?date=2020-03-05

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "clinicName" : "大源店",
      "feeType" : "string",
      "clinicId" : "ffffffff00000000264a75300d752999",
      "departmentName" : "内科",
      "departmentId" : "ffffffff00000000264a75300d752999",
      "employeeName" : "张三",
      "employeeId" : "ffffffff00000000264a75300d752999",
      "chargeName" : "李四",
      "chargeId" : "ffffffff00000000264a75300d752999",
      "totalPrice" : 20.0,
      "adjustmentPrice" : 0.0,
      "discountPrice" : -9.0,
      "deductPrice" : 0.0,
      "amount" : 11.0,
      "created" : "2022-04-28 15:41:27",
      "sourceType" : "门诊",
      "action" : "收费",
      "patientId" : "ffffffff0000000034d22e0ce272c000",
      "patientName" : "张三",
      "no" : 100,
      "payMode" : "支付宝",
      "payModeId" : 1,
      "paySubModeId" : 0,
      "comment" : "-",
      "memberPatientId" : "fffffffff00000000349018418ff74000",
      "memberPatientName" : "张三",
      "memberPatientMobile" : "18012312312"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.10.3. 收费明细-明细

GET /api/v2/open-agency/stat/revenue/detail/items

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string (date)

Query

dimension
可选

维度 0:药品维度 1:批次维度，默认为药品维度

integer (int32)

0

Query

limit
可选

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

integer (int32)

20

Query

offset
可选

分页起始下标默认0

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/stat/revenue/detail/items?date=2020-03-05

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "clinicName" : "大源店",
      "patientMobile" : "13800000000",
      "clinicId" : "ffffffff00000000264a75300d752999",
      "id" : "ffffffff0000000034e501b0275a4074",
      "departmentName" : "内科",
      "name" : "血清胰岛素、",
      "departmentId" : "ffffffff00000000264a75300d752999",
      "productId" : "ffffffff0000000034e501b0275a4074",
      "employeeName" : "张三",
      "productShortId" : "1000001",
      "count" : 1.0,
      "employeeId" : "ffffffff00000000264a75300d752999",
      "chargeName" : "李四",
      "price" : 5.0,
      "chargeId" : "ffffffff00000000264a75300d752999",
      "feeType1" : "治疗",
      "feeType2" : "-",
      "totalPrice" : 20.0,
      "adjustmentPrice" : 0.0,
      "productType" : 1,
      "discountPrice" : -9.0,
      "productSubType" : 20,
      "deductPrice" : 0.0,
      "productCustomType" : 1000,
      "amount" : 11.0,
      "batchId" : 1000324,
      "batchNo" : "1234",
      "created" : "2022-04-28 15:41:27",
      "expiryDate" : "2022-03-28",
      "sourceType" : "门诊",
      "action" : "收费",
      "productionDate" : "2022-03-28",
      "chargeSheetId" : "ffffffff0000000034e501b0275a4074",
      "patientId" : "ffffffff0000000034d22e0ce272c000",
      "chargeFormItemId" : "ffffffff0000000034e501b0275a4074",
      "patientName" : "张三",
      "chargeTransactionId" : "ffffffff0000000034e501b0275a4074",
      "no" : 100,
      "itemAdjustmentAmount" : 5.0,
      "payMode" : "支付宝",
      "payModeId" : 1,
      "paySubModeId" : 0,
      "comment" : "-",
      "memberPatientId" : "fffffffff00000000349018418ff74000",
      "memberPatientName" : "张三",
      "memberPatientMobile" : "18012312312"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.10.4. 执行业绩-明细

GET /api/v2/open-agency/stat/execute/detail/items

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string (date)

Query

limit
可选

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

integer (int32)

20

Query

offset
可选

分页起始下标默认0

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/stat/execute/detail/items?date=2020-03-05

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "ffffffff00000000105f9cf8062ec000",
      "patientId" : "ffffffff00000000105f9cf8062ec000",
      "patientName" : "张三",
      "patientMobile" : "18888888888",
      "executeClinicId" : "ffffffff00000000105f9cf8062ec000",
      "executeClinicName" : "北京朝阳医院",
      "executorIds" : "ffffffff00000000105f9cf8062ec000",
      "executorNames" : "张三",
      "status" : 0,
      "executeDate" : "2022-03-28 10:00:00",
      "productId" : "ffffffff00000000105f9cf8062ec000",
      "productShortId" : "0001",
      "productName" : "注射",
      "productType" : 1,
      "productSubType" : 20,
      "executeCount" : 1.0,
      "totalPrice" : 20.0,
      "amount" : 18.0,
      "comment" : "执行备注",
      "recordEffectInfo" : "【方法】头针;【部位】[穴位]云门；;【反应】麻，酸;【病因】气血亏虚，阴虚内热;【结果】好转;",
      "sheetCreateClinicId" : "ffffffff00000000105f9cf8062ec000",
      "sheetCreateClinicName" : "北京朝阳医院",
      "sheetCreatedBy" : "张三",
      "sheetCreatedByName" : "张三",
      "sheetCreateDepartmentId" : "ffffffff00000000105f9cf8062ec000",
      "sheetCreateDepartmentName" : "张三",
      "sheetCreated" : "2022-03-28 10:00:00",
      "createdBy" : "ffffffff00000000105f9cf8062ec000",
      "createdByName" : "张三",
      "chargeFormItemId" : "ffffffff00000000105f9cf8062ec000",
      "chargeSheetId" : "ffffffff00000000105f9cf8062ec000"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.10.5. 开卡充值业绩-明细

GET /api/v2/open-agency/stat/card-recharge/detail/items

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string (date)

Query

limit
必填

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

integer (int32)

20

Query

offset
必填

分页起始下标

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/stat/card-recharge/detail/items?date=2020-03-05&limit=20&offset=0

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "3810522672384016386",
      "clinicId" : "ffffffff00000000105f9cf8062ec000",
      "rechargeTime" : "2025-01-06 10:00:00",
      "patientId" : "ffffffff00000000105f9cf8062ec000",
      "patientMobile" : "18888888888",
      "cardId" : "ffffffff00000000105f9cf8062ec000",
      "cardName" : "充送卡",
      "operationType" : 1,
      "actualAmount" : 100.0,
      "rechargePrincipal" : 100.0,
      "rechargePresent" : 20.0,
      "principalBalance" : 100.0,
      "presentBalance" : 20.0,
      "sellerId" : "ffffffff00000000105f9cf8062ec000",
      "sellerName" : "张三",
      "createdByName" : "张三",
      "createdBy" : "ffffffff00000000105f9cf8062ec000",
      "originPrice" : 100.0
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.10.6. 会员充值业绩-明细

GET /api/v2/open-agency/stat/member-recharge/detail/items

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string (date)

Query

limit
必填

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

integer (int32)

20

Query

offset
必填

分页起始下标

integer (int32)

0

响应

HTTP Code

说明

类型

200

HTTP请求示例

请求 path

/api/v2/open-agency/stat/member-recharge/detail/items?date=2020-03-05&limit=20&offset=0

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "string",
      "clinicId" : "string",
      "clinicName" : "string",
      "sellerId" : "string",
      "sellerName" : "string",
      "chargeTime" : "string",
      "chargePrincipal" : 0.0,
      "chargePresent" : 0.0,
      "patientId" : "string",
      "patientName" : "string",
      "patientMobile" : "string",
      "chargerId" : "string",
      "chargerName" : "string",
      "remark" : "string"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.11. 事件推送接口

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

GET /api/v2/open-agency/app-callback/{appId}/fail

说明

获取 appId 下指定日期的推送失败事件列表，不区分 clinicId

参数

类型名称说明类型默认值

Path

appId
必填

应用id

string

Query

date
必填

日期（格式yyyy-MM-dd）

string (date)

Query

limit
必填

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

integer (int32)

20

Query

offset
必填

分页起始下标

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

/api/v2/open-agency/app-callback/2730297344132816890/fail?date=2022-01-03&limit=100&offset=0

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "2730297344132816890",
      "appId" : "1928374655",
      "appCallBackUrl" : "https://xxx.com/xx/xx",
      "callBackBody" : {
        "clinicId" : "string",
        "eventModule" : 1,
        "eventType" : 101,
        "eventName" : "收费完成",
        "eventData" : { }
      },
      "failReason" : "404 Not Found:",
      "status" : 2,
      "created" : "2022-04-06 15:12:53"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.12. 平台接口

5.12.1. 获取中国地区信息

GET /api/v2/open-agency/property/address/china

响应

HTTP Code

说明

类型

200

R«地区信息»

HTTP请求示例

请求 path

/api/v2/open-agency/property/address/china

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "510000",
    "name" : "四川",
    "children" : [ {
      "id" : "510000",
      "name" : "四川",
      "children" : [ "..." ]
    } ]
  }
}

5.12.2. 获取 OSS Token

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

说明

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

响应

HTTP Code

说明

类型

200

R«OSS开放Token»

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

消耗

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

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

HTTP请求示例

请求 path

/api/v2/open-agency/execute/query-by-date?date=2023-08-13

HTTP响应示例

响应 200

{
  "data" : {
    "executeSheets" : [ {
      "id" : "ffffffff000000003484c3816487c002",
      "patientOrderId" : "ffffffff000000003484c3816487c002",
      "status" : 1,
      "patient" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "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

R«执行单详情»

HTTP请求示例

请求 path

/api/v2/open-agency/execute/ffffffff000000003484c3816487c002

HTTP响应示例

响应 200

{
  "data" : {
    "id" : "ffffffff000000003484c3816487c002",
    "patientOrderId" : "ffffffff000000003484c3816487c002",
    "items" : [ {
      "id" : "0002b62eaf9c461f85ff3fedc4583a79",
      "needExecutive" : 1,
      "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
      "executedUnitCount" : 2.0,
      "executeStatus" : 1,
      "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
      "productName" : "注射用青霉素钠",
      "status" : 0,
      "unit" : "支",
      "receivedFee" : 40.0,
      "unitPrice" : 10.0,
      "displayUnitPrice" : 10.0,
      "displayTotalPrice" : 40.0,
      "unitCount" : 4.0,
      "doseCount" : 1.0,
      "totalCount" : 4.0,
      "productType" : 1,
      "productSubType" : 3,
      "sourceItemType" : 0,
      "productInfo" : {
        "children" : [ {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        } ],
        "id" : "string",
        "name" : "阿莫西林",
        "shebao" : {
          "nationalCode" : "T001700643",
          "insuranceTypes" : [ {
            "insuranceType" : "391",
            "reimbursementRatio" : 0.1
          } ]
        },
        "disableSell" : 0,
        "typeId" : 1,
        "typeName" : "药品",
        "customTypeId" : "213",
        "customTypeName" : "抗生素",
        "manufacturer" : "拜耳",
        "medicineNmpn" : "H20000001",
        "barCode" : "string",
        "pieceUnit" : "支",
        "pieceNum" : 10.0,
        "piecePrice" : 10.5,
        "packageUnit" : "盒",
        "packagePrice" : 105.0,
        "shortId" : "K1001",
        "specification" : "1ml:0.5mg*10支/盒",
        "otcType" : 1,
        "status" : 1,
        "lastModified" : "2022-05-13 12:22:56",
        "goodsSpu" : {
          "id" : "string",
          "name" : "string",
          "brandName" : "string",
          "material" : "string"
        },
        "goodsSpec" : {
          "color" : "string",
          "spec" : "string"
        }
      },
      "composeChildren" : [ {
        "id" : "0002b62eaf9c461f85ff3fedc4583a79",
        "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
        "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
        "productName" : "注射用青霉素钠",
        "status" : 0,
        "unit" : "支",
        "receivedFee" : 40.0,
        "unitPrice" : 10.0,
        "displayUnitPrice" : 10.0,
        "displayTotalPrice" : 40.0,
        "unitCount" : 4.0,
        "doseCount" : 1.0,
        "totalCount" : 4.0,
        "productType" : 1,
        "productSubType" : 3,
        "sourceItemType" : 0,
        "productInfo" : {
          "children" : [ "..." ],
          "id" : "string",
          "name" : "阿莫西林",
          "shebao" : {
            "nationalCode" : "T001700643",
            "insuranceTypes" : [ {
              "insuranceType" : "391",
              "reimbursementRatio" : 0.1
            } ]
          },
          "disableSell" : 0,
          "typeId" : 1,
          "typeName" : "药品",
          "customTypeId" : "213",
          "customTypeName" : "抗生素",
          "manufacturer" : "拜耳",
          "medicineNmpn" : "H20000001",
          "barCode" : "string",
          "pieceUnit" : "支",
          "pieceNum" : 10.0,
          "piecePrice" : 10.5,
          "packageUnit" : "盒",
          "packagePrice" : 105.0,
          "shortId" : "K1001",
          "specification" : "1ml:0.5mg*10支/盒",
          "otcType" : 1,
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        },
        "composeChildren" : [ {
          "id" : "0002b62eaf9c461f85ff3fedc4583a79",
          "chargeFormId" : "0002b62eaf9c461f85ff3fedc4583a80",
          "productId" : "e8aa6074f8c44dfe9f49e076e30265a9",
          "productName" : "注射用青霉素钠",
          "status" : 0,
          "unit" : "支",
          "receivedFee" : 40.0,
          "unitPrice" : 10.0,
          "displayUnitPrice" : 10.0,
          "displayTotalPrice" : 40.0,
          "unitCount" : 4.0,
          "doseCount" : 1.0,
          "totalCount" : 4.0,
          "productType" : 1,
          "productSubType" : 3,
          "sourceItemType" : 0,
          "productInfo" : "...",
          "composeChildren" : [ "..." ]
        } ]
      } ]
    } ],
    "status" : 1,
    "created" : "2022-04-06 15:12:53",
    "sellerId" : "ffffffff000000003484c3816487c002",
    "sellerName" : "张三",
    "doctorId" : "ffffffff000000003484c3816487c002",
    "doctorName" : "李四",
    "diagnosis" : "慢性鼻窦炎，颞下间隙感染"
  }
}

5.13.3. 执行

POST /api/v2/open-agency/execute/{id}/do

参数

类型

名称

说明

类型

Body

-
必填

执行单执行请求参数

Path

id
必填

执行单ID

string

响应

HTTP Code

说明

类型

200

消耗

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

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

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

消耗

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

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

HTTP请求示例

请求 path

/api/v2/open-agency/execute/patient/ffffffff00000000287b8f500fa68000

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "id" : "ffffffff0000000034be47d786e44000",
      "status" : 1,
      "created" : "2022-04-06 15:12:53",
      "items" : [ {
        "id" : "ffffffff0000000034be47d5e6e44002",
        "productId" : "ffffffff000000003499787109ea4003",
        "productName" : "推拿",
        "chargeStatus" : 1,
        "totalCount" : 10.0,
        "executedUnitCount" : 2.0
      } ],
      "sellerId" : "ffffffff0000000034be47d786e44000",
      "sellerName" : "张三"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.14. 文件接口

5.14.1. 文件上传

POST /api/v2/open-agency/file/upload

参数

类型

名称

说明

类型

Body

file
必填

file

string (binary)

响应

HTTP Code

说明

类型

200

R«文件上传响应»

消耗

multipart/form-data

HTTP请求示例

请求 path

/api/v2/open-agency/file/upload

请求 body

{ }

HTTP响应示例

响应 200

{
  "data" : {
    "isSuccess" : 0,
    "message" : "string",
    "filePath" : "string"
  }
}

6. 错误码定义

错误码

说明

13903

会员手机号不能为空

13909

患者不存在

7. 模型定义

7.1. AbcListPage«OpenBatchStockView»

名称说明类型

rows
可选

样例 : [ "OpenBatchStockView" ]

< OpenBatchStockView > array

total
可选

样例 : 0

integer (int32)

offset
可选

样例 : 0

integer (int32)

limit
可选

样例 : 0

integer (int32)

keyword
可选

样例 : "string"

string

7.2. JsonNode

类型 : object

7.3. OSS开放Token

名称说明类型

endpoint
可选

endpoint
样例 : "string"

string

bucket
可选

bucket
样例 : "string"

string

fileDir
可选

文件目录
样例 : "string"

string

securityToken
可选

安全令牌
样例 : "string"

string

accessKeySecret
可选

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

string

accessKeyId
可选

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

string

expiration
可选

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

string

7.4. OpenBatchStockView

商品批次信息

名称说明类型

goodsId
必填

商品ID
样例 : "ffffffff000000003473c049d7ab4004"

string

goodsShortId
可选

商品编码
样例 : "Z12312312"

string

batchId
必填

批次ID
样例 : 123123

integer (int64)

pieceNum
可选

制剂数量
样例 : 8

integer (int32)

pharmacyType
必填

药房类型
样例 : 0

integer (int32)

pharmacyNo
必填

药房号
样例 : 0

integer (int32)

expiryDate
可选

效期
样例 : "2025-01-17"

string

productionDate
可选

生产日期
样例 : "2025-01-17"

string

inDate
可选

入库日期 yyyy-MM-dd HH:mm:ss
样例 : "2025-01-17 02:36:00"

string (date-time)

batchNo
可选

批号
样例 : "100012157"

string

packageCostPrice
可选

大包装成本单价
样例 : 10.0

number

leftCost
可选

剩余成本
样例 : 10.0

number

pieceCount
必填

小包装数量
样例 : 10.0

number

packageCount
必填

大包装数量
样例 : 20.0

number

status
必填

批次状态
样例 : 0

integer (int32)

stockInOutDetailId
可选

外部入库明细ID
样例 : "string"

string

7.5. OpenGoodsStockOutApplyOrderReviewReq

名称说明类型

pass
必填

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

integer (int32)

comment
可选

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

string

7.6. OpenMemberChargeDetailInfoView

名称说明类型

id
必填

流水id
样例 : "string"

string

clinicId
可选

门店id
样例 : "string"

string

clinicName
可选

门店名称
样例 : "string"

string

sellerId
可选

销售员id
样例 : "string"

string

sellerName
可选

销售员名称
样例 : "string"

string

chargeTime
可选

充值时间
样例 : "string"

string

chargePrincipal
可选

充值本金
样例 : 0.0

number

chargePresent
可选

充值赠金
样例 : 0.0

number

patientId
可选

患者id
样例 : "string"

string

patientName
可选

患者名称
样例 : "string"

string

patientMobile
可选

患者手机号
样例 : "string"

string

chargerId
可选

收费员id
样例 : "string"

string

unitCount
可选

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

number

totalCount
可选

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

number

price
可选

加工费
样例 : 0.0

number

remark
可选

备注
样例 : "string"

string

7.98. 事件推送详情

名称说明类型

id
可选

ID
样例 : "2730297344132816890"

string

appId
可选

应用ID
样例 : "1928374655"

string

appCallBackUrl
可选

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

string

callBackBody
可选

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

事件推送请求

failReason
可选

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

string

status
可选

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

integer (int32)

created
可选

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

string (date-time)

7.99. 事件推送请求

名称说明类型

clinicId
可选

机构ID
样例 : "string"

string

eventModule
可选

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

integer (int32)

eventType
可选

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

integer (int32)

eventName
可选

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

string

eventData
可选

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

JsonNode

7.100. 交易记录商品明细

名称说明类型

id
可选

唯一标识ID
样例 : "ffffffff00000000265ff80811ab200x"

string

transactionId
可选

交易流水ID
样例 : "ffffffff00000000265ff80811ab2004"

string

chargeType
可选

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

integer (int32)

productId
可选

商品id
样例 : "00000000000000000000000000000001"

string

productName
可选

商品名称
样例 : "白术"

string

productType
可选

商品类型
样例 : 5

integer (int32)

productSubType
可选

商品子类型
样例 : 0

integer (int32)

composeType
可选

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

integer (int32)

productUnit
可选

商品单位
样例 : "string"

string

productUnitCount
可选

商品数量
样例 : 1.0

number

doseCount
可选

商品剂量
样例 : 1.0

number

totalPrice
可选

商品总价
样例 : 0.0

number

discountPrice
可选

商品折扣价格
样例 : 0.0

number

created
可选

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

string (date-time)

sceneType
可选

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

integer (int32)

composeChildren
可选

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

< 交易记录商品明细 > array

7.101. 会员信息

名称说明类型

id
可选

会员卡ID
样例 : "ffffffff000000001dce673007782004"

string

principal
可选

本金
样例 : 2866.6

number

present
可选

赠金
样例 : 368.0

number

created
可选

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

string (date-time)

memberTypeInfo
可选

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

会员类型信息

7.102. 会员卡支付响应

名称说明类型

transactionId
必填

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

string

principalBalance
必填

本金余额
样例 : 200.0

number

presentBalance
必填

赠金余额
样例 : 100.0

number

principal
必填

此次扣除本金
样例 : 100.0

number

present
必填

此次扣除赠金
样例 : 50.0

number

businessId
必填

业务ID
样例 : "3808805404481667072"

string

7.103. 会员卡支付请求参数

名称说明类型

transactionPatientId
必填

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

string

amount
必填

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

number

businessId
必填

业务ID
样例 : "3808805404481667072"

string

password
可选

会员卡密码
样例 : "123456"

string

operatorId
可选

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

string

7.104. 会员卡退款请求参数

会员卡退款请求参数

名称说明类型

amount
必填

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

number

transactionIds
必填

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

< string > array

businessId
必填

业务ID
样例 : "3808805404481667072"

string

operatorId
可选

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

string

7.105. 会员卡退费响应

名称说明类型

transactionId
必填

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

string

principalBalance
必填

本金余额
样例 : 200.0

number

presentBalance
必填

赠金余额
样例 : 100.0

number

principal
必填

此次扣除本金
样例 : 100.0

number

present
必填

此次扣除赠金
样例 : 50.0

number

businessId
必填

业务ID
样例 : "3808805404481667072"

string

7.106. 会员类型信息

名称说明类型

id
必填

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

string

name
必填

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

string

7.107. 住址

名称说明类型

addressProvinceId
可选

省编码
样例 : "510000"

string

addressProvinceName
可选

省名称
样例 : "四川"

string

addressCityId
可选

市编码
样例 : "510100"

string

addressCityName
可选

市名称
样例 : "成都市"

string

addressDistrictId
可选

区编码
样例 : "510109"

string

addressDistrictName
可选

区名称
样例 : "高新区"

string

addressDetail
可选

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

string

7.108. 供应商信息

名称说明类型

id
可选

供应商ID
样例 : "string"

string

name
可选

供应商名称
样例 : "string"

string

status
可选

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

integer (int32)

licenseId
可选

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

string

contact
可选

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

string

mobile
可选

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

string

mark
可选

供应商备注
样例 : "string"

string

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

名称说明类型

supplierInfoList
可选

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

< 供应商信息 > array

7.110. 修改供应商请求参数

名称说明类型

name
必填

供应商名称
样例 : "string"

string

status
必填

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

integer (int32)

licenseId
可选

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

string

contact
可选

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

string

mobile
可选

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

string

mark
可选

供应商备注
样例 : "string"

string

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

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

名称说明类型

externalTrace
可选

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

< 外部跟踪信息 > array

dispensingSheetId
可选

发药单ID
样例 : "string"

string

dispensingFormId
可选

发药处方ID
样例 : "string"

string

processGeneralStatus
可选

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

integer (int32)

7.112. 修改商品请求参数

名称说明类型

type
必填

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

integer (int32)

subType
必填

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

integer (int32)

medicineCadn
可选

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

string

name
可选

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

string

shortId
可选

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

string

cMSpec
可选

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

string

dismounting
可选

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

integer (int32)

extendSpec
可选

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

string

materialSpec
可选

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

string

manufacturer
可选

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

string

medicineNmpn
可选

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

string

barCode
可选

条形码
样例 : "6920705211119"

string

pieceNum
可选

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

integer (int32)

pieceUnit
可选

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

string

packageUnit
可选

包装单位
样例 : "盒"

string

componentContentUnit
可选

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

string

componentContentNum
可选

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

number

medicineDosageNum
可选

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

number

medicineDosageUnit
可选

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

string

piecePrice
可选

拆零价格
样例 : 1.0

number

packagePrice
可选

零售价格
样例 : 10.0

number

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

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

名称说明类型

externalTrace
可选

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

< 外部跟踪信息 > array

dispensingSheetId
可选

发药单id
样例 : "string"

string

deliveryStatus
可选

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

integer (int32)

deliveryOrderNo
可选

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

string

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

名称说明类型

addTagIds
可选

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

< string > array

deleteTagIds
可选

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

< string > array

operatorId
可选

操作人ID
样例 : "string"

string

7.115. 修改患者请求体

名称说明类型

name
可选

姓名
样例 : "string"

string

mobile
可选

手机号
样例 : "string"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

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

string

sourceId
可选

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

string

sourceFromId
可选

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

string

idCard
可选

身份证
样例 : "string"

string

pastHistory
可选

既往史
样例 : "string"

string

address
可选

家庭住址
样例 : 住址

sn
可选

档案号
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

profession
可选

职业
样例 : "string"

string

company
可选

公司单位
样例 : "string"

string

marital
可选

婚姻状态
样例 : "string"

string

weight
可选

体重
样例 : "string"

string

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

名称说明类型

addressProvinceId
必填

省编码
样例 : "510000"

string

addressProvinceName
可选

省名称
样例 : "四川"

string

addressCityId
必填

市编码
样例 : "510100"

string

addressCityName
可选

市名称
样例 : "成都市"

string

addressDistrictId
必填

区编码
样例 : "510109"

string

addressDistrictName
可选

区名称
样例 : "高新区"

string

addressDetail
必填

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

string

deliveryName
必填

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

string

deliveryMobile
必填

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

string

deliveryCompanyName
必填

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

string

deliveryFee
可选

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

number

deliveryOrderNo
可选

快递单号
样例 : "string"

string

deliveryPayType
必填

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

integer (int32)

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.117. 修正入库单事件

名称说明类型

fixedInOrderItemList
可选

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

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

id
必填

修正入库单ID
样例 : 0

integer (int64)

orderNo
必填

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

string

status
必填

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

integer (int32)

organId
可选

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

string

organName
可选

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

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
必填

品种数量
样例 : 5

integer (int32)

operator
可选

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

string

supplier
可选

供应商
样例 : "string"

string

effectiveDate
必填

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

string (date-time)

lastModified
必填

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

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

originalOrder
可选

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

被修正的入库单信息

7.118. 修正入库单审核请求

名称说明类型

pass
必填

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

integer (int32)

comment
可选

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

string

7.119. 修正入库单明细视图

修正入库单明细视图

名称说明类型

id
必填

条目ID
样例 : 0

integer (int64)

outDetailId
可选

外部明细ID
样例 : "123123"

string

originalItemId
必填

来源条目ID
样例 : 0

integer (int64)

originalOutDetailId
可选

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

string

productId
必填

商品编码
样例 : "string"

string

productShortId
可选

商品short编码
样例 : "string"

string

productName
可选

商品名称
样例 : "string"

string

specification
可选

规格
样例 : "string"

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

originalPackageCount
可选

入库包装数量
样例 : 2.0

number

originalPieceCount
可选

入库制剂数量
样例 : 10.0

number

originalAmount
可选

金额
样例 : 6033.23

number

changePackageCount
可选

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

number

changePieceCount
可选

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

number

changeAmount
可选

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

number

originalBatchNo
可选

样例 : "string"

string

batchNo
可选

生产批号
样例 : "20220526000001"

string

created
必填

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

string (date-time)

7.120. 入库单事件

名称说明类型

id
可选

出/入库单ID
样例 : 0

integer (int64)

inOrderItemList
可选

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

< 入库单条目 > array

inOrderId
可选

退货的入库单ID
样例 : 0

integer (int64)

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

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

integer (int32)

organName
可选

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

string

organId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

operator
可选

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

string

operatorId
可选

操作人ID
样例 : "string"

string

supplier
可选

供应商
样例 : "string"

string

supplierId
可选

供应商ID
样例 : "string"

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

type
可选

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

integer (int32)

7.121. 入库单条目

名称说明类型

id
必填

条目ID
样例 : 123456

integer (int64)

inId
可选

退的入库项ID
样例 : 3123456

integer (int64)

originalItemId
可选

原始条目ID
样例 : 123456

integer (int64)

productId
必填

商品编码
样例 : "ffffffff0000000034966c3a883ec000"

string

productShortId
可选

商品short编码
样例 : "1000001"

string

productName
可选

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

string

specification
可选

规格
样例 : "string"

string

expiryDate
可选

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

string

productionDate
可选

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

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

packageCostPrice
可选

包装成本单价
样例 : 12.5

number

packageCount
可选

入库包装数量
样例 : 2.0

number

pieceCount
可选

入库制剂数量
样例 : 10.0

number

amount
可选

金额
样例 : 6033.23

number

totalCost
可选

变化的成本金额
样例 : 6033.23

number

batchId
可选

批次号
样例 : 100026529

integer (int64)

batchNo
可选

生产批号
样例 : "20220526000001"

string

outDetailId
可选

外部明细ID
样例 : "12312"

string

stockInOutDetailId
可选

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

string

created
必填

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

string (date-time)

lastModified
必填

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

string (date-time)

7.122. 入库单详情

名称说明类型

comment
可选

备注
样例 : 评论

id
可选

出/入库单ID
样例 : 0

integer (int64)

inOrderItemList
可选

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

< 入库单条目 > array

inOrderId
可选

退货的入库单ID
样例 : 0

integer (int64)

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

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

integer (int32)

organName
可选

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

string

organId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

operator
可选

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

string

operatorId
可选

操作人ID
样例 : "string"

string

supplier
可选

供应商
样例 : "string"

string

supplierId
可选

供应商ID
样例 : "string"

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

type
可选

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

integer (int32)

7.123. 入库明细

名称说明类型

goodsId
可选

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

string

goodsShortId
可选

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

string

unit
必填

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

string

unitCount
必填

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

number

unitCostPrice
必填

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

number

totalCostPrice
可选

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

number

batchNo
可选

批次号
样例 : "string"

string

expireDate
可选

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

string (date)

productionDate
可选

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

string (date)

outDetailId
可选

外部明细ID
样例 : "string"

string

7.124. 出入库单信息

名称说明类型

id
可选

出/入库单ID
样例 : 0

integer (int64)

inOrderId
可选

退货的入库单ID
样例 : 0

integer (int64)

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

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

integer (int32)

organName
可选

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

string

organId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

operator
可选

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

string

operatorId
可选

操作人ID
样例 : "string"

string

supplier
可选

供应商
样例 : "string"

string

supplierId
可选

供应商ID
样例 : "string"

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

type
可选

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

integer (int32)

7.125. 出库单事件

名称说明类型

id
可选

出库单id
样例 : 0

integer (int64)

outOrderItemList
可选

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

< 出库单条目 > array

orderNo
可选

出库单号
样例 : "CK20220526000001"

string

status
可选

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

integer (int32)

organName
可选

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

string

type
可选

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

integer (int32)

kindCount
可选

品种数量
样例 : 5

integer (int32)

count
可选

数量
样例 : 12.0

number

amount
可选

含税金额
样例 : 6033.23

number

receiver
可选

领取人
样例 : "string"

string

operator
可选

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

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

inOrderId
可选

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

string

pharmacy
可选

出库药房
样例 : 药房详情

7.126. 出库单条目

名称说明类型

id
可选

条目ID
样例 : 0

integer (int64)

productId
可选

商品编码
样例 : "string"

string

productShortId
可选

商品short编码
样例 : "string"

string

productName
可选

商品名称
样例 : "string"

string

specification
可选

规格
样例 : "string"

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

packageCount
可选

出库包装数量
样例 : 0.0

number

pieceCount
可选

出库制剂数量
样例 : 0.0

number

packageCostPrice
可选

包装成本单价
样例 : 0.0

number

stockInId
可选

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

integer (int64)

amount
可选

出库包装成本价
样例 : 0.0

number

lastModified
可选

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

string (date-time)

stockOutBatches
可选

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

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

7.127. 出库单详情

名称说明类型

comment
可选

备注
样例 : 评论

id
可选

出库单id
样例 : 0

integer (int64)

outOrderItemList
可选

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

< 出库单条目 > array

orderNo
可选

出库单号
样例 : "CK20220526000001"

string

status
可选

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

integer (int32)

organName
可选

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

string

type
可选

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

integer (int32)

kindCount
可选

品种数量
样例 : 5

integer (int32)

count
可选

数量
样例 : 12.0

number

amount
可选

含税金额
样例 : 6033.23

number

receiver
可选

领取人
样例 : "string"

string

operator
可选

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

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

inOrderId
可选

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

string

pharmacy
可选

出库药房
样例 : 药房详情

7.128. 出库明细

名称说明类型

goodsId
可选

商品ID
样例 : "ffffffff000000000000000000000001"

string

goodsShortId
可选

商品短ID
样例 : "12345"

string

pieceCount
必填

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

number

packageCount
必填

最小值 : 0
样例 : 0.0

number

batchNo
必填

批次号
样例 : "string"

string

7.129. 分页查询结果«OpenMemberChargeDetailInfoView»

名称说明类型

rows
可选

数据集
样例 : [ "OpenMemberChargeDetailInfoView" ]

< OpenMemberChargeDetailInfoView > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 事件推送详情 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 医生信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 发药单摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 商品信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 患者发药单信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 患者执行单信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 患者摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 患者附件 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 患者预约摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 执行业绩-明细 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 挂号单基础信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

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

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 检查检验摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 检查检验项目信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

rows
可选

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

< 门诊单摘要信息 > array

total
可选

总条数
样例 : 100

integer (int32)

offset
可选

查询偏移量
样例 : 0

integer (int32)

limit
可选

查询条数
样例 : 10

integer (int32)

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

名称说明类型

isTotalPriceChanged
必填

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

integer (int32)

pharmacyNo
可选

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

integer (int32)

expectedTotalPrice
可选

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

number

specification
必填

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

string

doseCount
必填

剂数
样例 : 3

integer (int32)

prescriptionFormItems
可选

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

< 创建处方药品请求基类 > array

usage
必填

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

string

dailyDosage
可选

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

string

freq
可选

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

string

usageLevel
可选

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

string

usageDays
可选

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

string

requirement
可选

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

string

processInfo
可选

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

中药处方加工信息

7.152. 创建供应商请求参数

名称说明类型

name
必填

供应商名称
样例 : "string"

string

status
必填

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

integer (int32)

licenseId
可选

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

string

contact
可选

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

string

mobile
可选

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

string

mark
可选

供应商备注
样例 : "string"

string

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.153. 创建入库单请求

名称说明类型

supplierId
必填

供应商Id
样例 : "string"

string

outOrderNo
可选

随货单号
样例 : "20241112001"

string

pharmacyNo
可选

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

integer (int32)

toClinicId
可选

入库门店ID，仅总部支持给其他子店入库，其他场景为当前门店ID
样例 : "ffffffff000000000000000000000001"

string

comment
可选

单据备注，不能超过 500 个字符
样例 : "备注"

string

inOrderItemList
必填

入库明细
样例 : [ "入库明细" ]

< 入库明细 > array

7.154. 创建出库单请求

名称说明类型

inOrderId
可选

入库单ID，如果没有传会通过 batchNo 随机获取
样例 : 0

integer (int64)

pharmacyNo
可选

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

integer (int32)

toClinicId
可选

出库门店ID，仅总部支持给其他子店入库，其他场景为当前门店ID
样例 : "ffffffff000000000000000000000001"

string

comment
可选

单据备注，不能超过 500 个字符
样例 : "备注"

string

outOrderItemList
必填

出库明细
样例 : [ "出库明细" ]

< 出库明细 > array

7.155. 创建商品请求参数

名称说明类型

type
必填

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

integer (int32)

subType
必填

integer (int32)

medicineCadn
可选

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

string

name
可选

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

string

shortId
可选

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

string

cMSpec
可选

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

string

dismounting
可选

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

integer (int32)

extendSpec
可选

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

string

materialSpec
可选

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

string

manufacturer
可选

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

string

medicineNmpn
可选

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

string

barCode
可选

条形码
样例 : "6920705211119"

string

pieceNum
可选

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

integer (int32)

pieceUnit
可选

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

string

packageUnit
可选

包装单位
样例 : "盒"

string

componentContentUnit
可选

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

string

componentContentNum
可选

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

number

medicineDosageNum
可选

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

number

medicineDosageUnit
可选

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

string

piecePrice
可选

拆零价格
样例 : 1.0

number

packagePrice
可选

零售价格
样例 : 10.0

number

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

7.156. 创建处方基类

名称说明类型

isTotalPriceChanged
必填

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

integer (int32)

expectedTotalPrice
可选

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

number

prescriptionFormItems
可选

样例 : [ "创建西药处方药品请求" ]

< 创建西药处方药品请求 > array

7.157. 创建处方药品请求基类

名称说明类型

productId
可选

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

string

specialRequirement
可选

特殊要求 [先煎,后下,冲服]
样例 : "先煎"

string

productShortId
可选

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

string

unitCount
必填

单位数量
样例 : 2.0

number

expectedUnitPrice
可选

期望单价（议价时使用）
样例 : 5.0

number

expectedTotalPrice
可选

期望总价格（议价时使用）
样例 : 5.0

number

useDismounting
可选

是否拆零销售 0:不拆零 1:拆零（需要药品物资支持拆零出售），默认为 0
样例 : 0

integer (int32)

7.158. 创建患者请求体

名称说明类型

name
必填

姓名
样例 : "string"

string

mobile
可选

手机号
样例 : "string"

string

sex
必填

性别[男,女]
样例 : "男"

string

birthday
必填

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

string

sourceId
可选

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

string

sourceFromId
可选

string

idCard
可选

身份证
样例 : "string"

string

pastHistory
可选

既往史
样例 : "string"

string

address
可选

家庭住址
样例 : 住址

sn
可选

档案号
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

profession
可选

职业
样例 : "string"

string

company
可选

公司单位
样例 : "string"

string

marital
可选

婚姻状态
样例 : "string"

string

weight
可选

体重
样例 : "string"

string

7.159. 创建挂号单响应结果

名称说明类型

registrationSheetId
必填

挂号单ID
样例 : "string"

string

patientOrderId
必填

就诊单ID
样例 : "string"

string

7.160. 创建检查检验单响应

名称说明类型

examinationSheets
必填

检查检验摘要信息列表
样例 : [ "检查检验摘要信息" ]

< 检查检验摘要信息 > array

7.161. 创建检查检验单请求

名称说明类型

patientId
必填

患者ID
样例 : "string"

string

productSubType
必填

商品子类型 1:检验 2:检查
最小值 : 0
最大值 : 9223372036854775807
样例 : 0

integer (int32)

examinationFormItems
必填

检查检验项列表
样例 : [ "创建检查检验项请求" ]

< 创建检查检验项请求 > array

doctorId
可选

开单医生ID
样例 : "string"

string

doctorDepartmentId
可选

开单医生科室ID
样例 : "string"

string

operatorId
可选

操作人ID，默认为 '00000000000000000000000000000000'
样例 : "00000000000000000000000000000000"

string

7.162. 创建检查检验项请求

名称说明类型

productId
必填

商品ID
样例 : "string"

string

name
必填

检查检验项名称
样例 : "string"

string

unitCount
必填

单位数量
样例 : 0.0

number

7.163. 创建病历请求

名称说明类型

chiefComplaint
必填

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

string

pastHistory
可选

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

string

familyHistory
可选

家族史
样例 : "string"

string

presentHistory
可选

现病史
样例 : "string"

string

physicalExamination
可选

体格检查
样例 : "string"

string

diagnosis
必填

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

string

doctorAdvice
可选

医嘱
样例 : "string"

string

syndrome
可选

辨症
样例 : "string"

string

therapy
可选

治法
样例 : "string"

string

chineseExamination
可选

望闻切诊
样例 : "string"

string

obstetricalHistory
可选

妇科月经婚育史
样例 : "string"

string

7.164. 创建西药处方药品请求

名称说明类型

ast
可选

皮试标识 1:皮试 2:续用 3:免试
样例 : 1

integer (int32)

productId
可选

string

productShortId
可选

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

string

usage
必填

用法
样例 : "含服用"

string

freq
可选

频率 qd:每天1次 bid:每天2次 tid:每天3次 qid:每天4次 qod:隔日1次 qw:每周1次 biw:每周2次 hs:临睡前 qn:每晚1次 st:立即 sos:需要时 prn:需要时(长期) qnd:每N天1次 qnw:每N周1次 qnh:每N小时1次
样例 : "qd"

string

unitCount
必填

单位数量
样例 : 2.0

number

dosage
可选

单次剂量
样例 : 3.0

number

expectedUnitPrice
可选

期望单价（议价时使用）
样例 : 5.0

number

dosageUnit
可选

单次单位
样例 : "片"

string

expectedTotalPrice
可选

期望总价格（议价时使用）
样例 : 5.0

number

days
可选

用药天数
样例 : 5.0

number

useDismounting
可选

是否拆零销售 0:不拆零 1:拆零（需要药品物资支持拆零出售），默认为 0
样例 : 0

integer (int32)

specialRequirement
可选

特殊用法
样例 : "首次加倍"

string

pharmacyNo
必填

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

integer (int32)

7.165. 创建门诊单请求参数

名称说明类型

departmentId
必填

医生科室ID
样例 : "string"

string

doctorId
必填

医生ID
样例 : "string"

string

patientId
必填

患者ID
样例 : "string"

string

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

medicalRecord
必填

病历
样例 : 创建病历请求

创建病历请求

prescriptionChineseForms
可选

中药处方列表
样例 : [ "创建中药处方请求参数" ]

< 创建中药处方请求参数 > array

prescriptionWesternForms
可选

西药处方列表
样例 : [ "创建处方基类" ]

< 创建处方基类 > array

7.166. 删除商品响应

名称说明类型

id
可选

商品ID
样例 : "string"

string

7.167. 医生信息

开方医生

名称说明类型

id
可选

ID：唯一标识
样例 : "string"

string

mobile
可选

手机号码
样例 : "18088888888"

string

name
可选

姓名
样例 : "张三"

string

sex
可选

性别
样例 : "男"

string

headImgUrl
可选

头像
样例 : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg"

string

introduction
可选

医生简介
样例 : "毕业于陆军军医大学临床医学七年制"

string

practiceImgUrl
可选

头像
样例 : "string"

string

doctorPageUrl
可选

医生微诊所页面
样例 : "string"

string

doctorTags
可选

医生标签
样例 : "省级名中医、市级名中医"

< string > array

7.168. 医生信息详情

名称说明类型

departments
可选

医生科室列表
样例 : [ "科室摘要信息" ]

< 科室摘要信息 > array

id
可选

ID：唯一标识
样例 : "string"

string

mobile
可选

手机号码
样例 : "18088888888"

string

name
可选

姓名
样例 : "张三"

string

sex
可选

性别
样例 : "男"

string

headImgUrl
可选

头像
样例 : "http://dev-img.abcyun.cn/avatar/1634032865347-986128.jpg"

string

introduction
可选

医生简介
样例 : "毕业于陆军军医大学临床医学七年制"

string

practiceImgUrl
可选

头像
样例 : "string"

string

doctorPageUrl
可选

医生微诊所页面
样例 : "string"

string

doctorTags
可选

医生标签
样例 : "省级名中医、市级名中医"

< string > array

7.169. 医生号源日期列表响应

名称说明类型

reserveSections
可选

预约日期列表
样例 : [ "医生预约排班信息" ]

< 医生预约排班信息 > array

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

名称说明类型

doctorId
可选

医生ID
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

workingDate
可选

工作日期
样例 : "string"

string

dayOfWeek
可选

周几
样例 : "string"

string

restCountToday
可选

当天余号
样例 : 0

integer (int32)

canReserve
可选

是否可预约 0:否 1:是
样例 : 0

integer (int32)

scheduleIntervals
可选

预约时段列表
样例 : [ "预约时段" ]

< 预约时段 > array

7.171. 医生科室排班预约信息

名称说明类型

id
必填

科室id
样例 : "ffffffff0000000022174678012e2000"

string

name
可选

科室名称
样例 : "儿科"

string

restCount
可选

余号
样例 : 9

integer (int32)

totalCount
可选

总数量
样例 : 10

integer (int32)

status
可选

排班状态 0:有号 1:约满 2:无号（排班班次拆分后的总预约单元格为空，如：班次时长不满足最小服务时长等） 3:未放号 4:完诊（最晚排班结束时间已过） 5:无排班
样例 : 0

integer (int32)

fee
可选

挂号费
样例 : 20.0

number

registerStartTime
可选

预约开始时间 HH:mm（开放平台的预约挂号接口没有这个限制）
样例 : "09:30"

string

registrationCategoryDayShifts
可选

挂号种类号源详情信息列表
样例 : [ "挂号种类号源信息" ]

< 挂号种类号源信息 > array

7.172. 医生预约排班信息

名称说明类型

date
可选

预约日期 yyyy-MM-dd
样例 : "2024-04-23"

string

departments
可选

科室列表
样例 : [ "医生科室排班预约信息" ]

< 医生科室排班预约信息 > array

7.173. 单据进销存批次信息

单据进销存批次信息

名称说明类型

stockId
可选

调拨GoodsStock的Id,如果没指定批次，这个字段为空
样例 : 12312

integer (int64)

stockInOutDetailId
可选

stockIn 外部明细ID
样例 : "12312"

string

batchId
可选

批次号
样例 : 12312

integer (int64)

supplier
可选

供应商
样例 : 库存商品供应商

库存商品供应商

batchNo
可选

调拨批号
样例 : "555555"

string

productionDate
可选

生产日期
样例 : "2023-01-11"

string

expiryDate
可选

有效期
样例 : "2023-01-11"

string

packageCount
可选

整包装库存变化量，正数代表增加库存，负数代表扣库
样例 : 1.0

number

pieceCount
可选

入库制剂数量，正数代表增加库存，负数代表扣库
样例 : 1.0

number

packageCostPrice
可选

包装成本单价
样例 : 1.0

number

pieceNum
必填

制剂数量
样例 : 10

integer (int32)

costPrice
可选

变更总成本
样例 : 1.0

number

7.174. 发药单-处方信息

名称说明类型

id
可选

唯一标识
样例 : "ffffffff00000000264a75300d759999"

string

dispseneFormType
可选

发药单类型 4:中西药处方 5:输注处方 6:中药处方 7:门诊单新加的项目收费 8:门诊单新加的商品收费 9:材料 10:赠品 11:套餐
样例 : 0

integer (int32)

numberOfHerbs
可选

中药处方中药味数
样例 : 0

integer (int32)

usageInfo
可选

门诊处方的用法用量医嘱等信息
样例 : 处方-药品使用信息

处方-药品使用信息

totalPrice
可选

总金额
样例 : 30.23

number

dispensingFormItems
可选

药品发药列表
样例 : [ "发药处方的药品发药信息" ]

< 发药处方的药品发药信息 > array

compoundInfo
可选

调配信息
样例 : 处方调配信息

处方调配信息

auditInfo
可选

审核信息
样例 : 处方审核信息

处方审核信息

7.175. 发药单事件

名称说明类型

clinicId
可选

门店ID
样例 : "ffffffff000000002620d6280d751234"

string

id
可选

唯一标识
样例 : "ffffffff000000002620d6280d751234"

string

sourceSheetId
可选

来源订单ID：门诊发药单-收费单ID
样例 : "ffffffff000000002620d6280d751234"

string

doctorId
可选

医生ID
样例 : "ffffffff0000000022e9e9580179a123"

string

patientOrderId
可选

本次发药单所属的就诊单ID
样例 : "ffffffff0000000022e9e9580179a123"

string

patientOrderNo
可选

本次发药单所属的就诊单的就诊号
样例 : "诊号：00003447"

string

diagnosedDate
可选

就诊诊断时间
样例 : "2022-07-14 12:00:00"

string (date-time)

medicalRecord
可选

病例诊断信息
样例 : 病历信息

patientInfo
可选

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

deliveryInfo
可选

快递信息
样例 : 快递信息

deliveredStatus
必填

快递状态 0:不需要快递 1:未发快递 2:已发快递
样例 : 0

integer (int32)

deliveryType
可选

快递类型 0:不需要快递 1:需要快递
样例 : 0

integer (int32)

status
可选

发药单状态 0:未发药 1:已发药 2:已退药
样例 : 0

integer (int32)

statusName
可选

发药状态名称
样例 : "未发药"

string

dispensedBy
可选

发药人ID
样例 : "ffffffff000000002622cbd801e7777"

string

dispensedByName
可选

发药人名称
样例 : "张三"

string

dispensedTime
可选

发药时间
样例 : "2022-07-14 12:00:00"

string (date-time)

created
可选

发药单创建时间
样例 : "2022-07-14 12:00:00"

string (date-time)

pharmacy
可选

药房信息
样例 : 药房详情

netIncomeFee
可选

总金额
样例 : 43.75

number

doctor
可选

医生信息
样例 : 员工信息

department
可选

科室
样例 : 科室摘要信息

科室摘要信息

isShebaoPay
可选

是否社保支付 0:不是 1:是
样例 : 0

integer (int32)

dispensingForms
可选

发药单包含的处方列表
样例 : [ "发药单-处方信息" ]

< 发药单-处方信息 > array

7.176. 发药单摘要信息

名称说明类型

id
必填

发药单ID
样例 : "string"

string

patientOrderId
必填

本次发药单所属的就诊单ID
样例 : "string"

string

patientOrderNo
必填

就诊单号
样例 : "000001"

string

chargeSheetId
必填

关联收费单ID
样例 : "string"

string

pharmacyNo
必填

药房号
样例 : 0

integer (int32)

pharmacyType
必填

药房类型：0:实体药房 1:空中药房 2:虚拟药房
样例 : 0

integer (int32)

status
必填

发药单状态 0:待发 1:已发 2:已退 3:关闭 4:取消
样例 : 0

integer (int32)

patient
可选

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

7.177. 发药单详情

名称说明类型

clinicId
可选

门店ID
样例 : "ffffffff000000002620d6280d751234"

string

id
可选

唯一标识
样例 : "ffffffff000000002620d6280d751234"

string

sourceSheetId
可选

来源订单ID：门诊发药单-收费单ID
样例 : "ffffffff000000002620d6280d751234"

string

doctorId
可选

医生ID
样例 : "ffffffff0000000022e9e9580179a123"

string

patientOrderId
可选

本次发药单所属的就诊单ID
样例 : "ffffffff0000000022e9e9580179a123"

string

patientOrderNo
可选

本次发药单所属的就诊单的就诊号
样例 : "诊号：00003447"

string

diagnosedDate
可选

就诊诊断时间
样例 : "2022-07-14 12:00:00"

string (date-time)

medicalRecord
可选

病例诊断信息
样例 : 病历信息

patientInfo
可选

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

deliveryInfo
可选

快递信息
样例 : 快递信息

deliveredStatus
必填

快递状态 0:不需要快递 1:未发快递 2:已发快递
样例 : 0

integer (int32)

deliveryType
可选

快递类型 0:不需要快递 1:需要快递
样例 : 0

integer (int32)

status
可选

发药单状态 0:未发药 1:已发药 2:已退药
样例 : 0

integer (int32)

statusName
可选

发药状态名称
样例 : "未发药"

string

dispensedBy
可选

发药人ID
样例 : "ffffffff000000002622cbd801e7777"

string

dispensedByName
可选

发药人名称
样例 : "张三"

string

dispensedTime
可选

发药时间
样例 : "2022-07-14 12:00:00"

string (date-time)

created
可选

发药单创建时间
样例 : "2022-07-14 12:00:00"

string (date-time)

pharmacy
可选

药房信息
样例 : 药房详情

netIncomeFee
可选

总金额
样例 : 43.75

number

doctor
可选

医生信息
样例 : 员工信息

department
可选

科室
样例 : 科室摘要信息

科室摘要信息

isShebaoPay
可选

是否社保支付 0:不是 1:是
样例 : 0

integer (int32)

dispensingForms
可选

发药单包含的处方列表
样例 : [ "发药单-处方信息" ]

< 发药单-处方信息 > array

7.178. 发药商品供应商

名称说明类型

id
可选

供应商Id
样例 : "ffffffff0000000034e6cae04206c09c"

string

name
可选

供应商的名字
样例 : "药品供应商"

string

7.179. 发药处方的药品发药信息

名称说明类型

id
可选

唯一标识
样例 : "ffffffff00000000264a75300d757777"

string

sourceFormItemId
可选

来源项目ID：门诊发药单-收费项ID
样例 : "ffffffff00000000264a75300d757778"

string

status
可选

发药状态 0:未发药 1:已发药 2:已退药
样例 : 1

integer (int32)

productId
可选

发药商品ID
样例 : "02bb5357a5df05b65d028f8868472222"

string

productName
可选

发药药品的名称
样例 : "罗红霉素胶囊"

string

unit
可选

发药单位
样例 : "12g/剂*3剂的g"

string

unitCount
可选

每剂发药数量
样例 : "12g/剂*3剂的12"

number

doseCount
可选

剂数
样例 : "12g/剂*3剂的3 (同发药处方上的剂数相同)"

number

totalCount
可选

药物总重量
样例 : "12g/剂*3剂的36=12*3 (totalCount = unitCount * doseCount)"

number

usageInfo
可选

药品的特别用法
样例 : 处方-药品使用信息

处方-药品使用信息

productInfo
可选

药品信息
样例 : 商品详情

totalPrice
可选

总金额
样例 : 10.3

number

dispensingBatches
可选

发药批次
样例 : [ "发药批次信息" ]

< 发药批次信息 > array

7.180. 发药批次信息

名称说明类型

action
可选

动作：发药;退药
样例 : "发药"

string

stockId
可选

GoodsStock的Id,如果没指定批次，这个字段为空
样例 : 123456

integer (int64)

supplier
可选

库存商品供应商信息
样例 : 发药商品供应商

发药商品供应商

batchId
可选

批次号
样例 : 3123455

integer (int64)

batchNo
可选

生产批号
样例 : "Z123"

string

productionDate
可选

生产日期
样例 : "2023-01-01"

string

expiryDate
可选

有效期
样例 : "2026-01-01"

string

packageCount
可选

整包装库存变化量，发药时为负值，退药时为正值
样例 : -10.0

number

piecePrice
可选

小包装销售单价
样例 : 1.0

number

packagePrice
可选

大包装销售单价
样例 : 10.0

number

pieceCount
可选

制剂数量，发药是为负值，退药时为正值
样例 : -10.0

number

packageCostPrice
可选

包装成本单价
样例 : 10.0

number

costPrice
可选

成本价变化量
样例 : -10.0

number

salePrice
可选

变更实收
样例 : 10.0

number

stockInOutDetailId
可选

入库外部明细ID
样例 : "Z123"

string

created
必填

名称说明类型

id
可选

商品 SPU ID
样例 : "string"

string

name
可选

SPU 名称
样例 : "string"

string

brandName
可选

品牌名称
样例 : "string"

string

material
可选

材质
样例 : "string"

string

7.186. 商品SPU规格属性

名称说明类型

color
可选

颜色（仅镜架商品 typeId 为 65 有该字段）
样例 : "string"

string

spec
可选

规格（仅太阳镜商品 typeId 为 69 有该字段）
样例 : "string"

string

7.187. 商品信息

名称说明类型

id
可选

商品编码
样例 : "string"

string

shortId
可选

商品短编码
样例 : "string"

string

name
可选

商品名称
样例 : "string"

string

specification
可选

规格型号
样例 : "string"

string

typeId
可选

分类id
样例 : 0

integer (int32)

typeName
可选

商品类型
样例 : "string"

string

combineType
可选

是否是组合类型 0:非组合类型 1:组合类型
样例 : 0

integer (int32)

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

lastModified
可选

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

string (date-time)

status
可选

商品状态 1:正常 99:删除
样例 : 1

integer (int32)

disableSell
可选

禁售销售 0:正常 1:禁止销售
样例 : 0

integer (int32)

7.188. 商品分类信息

名称说明类型

id
可选

分类ID
样例 : 0

integer (int32)

type
可选

一级分类
样例 : 0

integer (int32)

subType
可选

二级分类
样例 : 0

integer (int32)

category
可选

三级分类
样例 : "string"

string

isLeaf
可选

是否叶子结点 0非叶子结点 1 叶子结点
样例 : 0

integer (int32)

name
可选

分类名称
样例 : "string"

string

children
可选

children节点
样例 : [ "商品分类信息" ]

< 商品分类信息 > array

7.189. 商品分类信息响应

名称说明类型

typeTree
可选

商品分类信息列表
样例 : [ "商品分类信息" ]

< 商品分类信息 > array

7.190. 商品库存信息

名称说明类型

productId
必填

商品ID
样例 : "ffffffff000000000ef10788097b000c"

string

productShortId
必填

商品编码
样例 : "75724341"

string

stockPieceCount
必填

小包装可售库存数量: 总库存 - 禁售库存 - 锁定库存
样例 : 20.0

number

stockPackageCount
必填

大包装可售库存数量：总库存 - 禁售库存 - 锁定库存
样例 : 10.0

number

pharmacyStocks
必填

各药房库存列表
样例 : [ "药房库存信息" ]

< 药房库存信息 > array

7.191. 商品库存调拨单事件

名称说明类型

id
可选

调拨单ID
样例 : 0

integer (int64)

amount
可选

调拨总金额（含税)
样例 : 0.0

number

count
可选

所有调拨商品转成大包装的数量的累加
样例 : 0.0

number

kindCount
可选

种类数量（调拨单里面有几种类型的药）
样例 : 0

integer (int32)

orderNo
可选

可读的调拨库单号
样例 : "string"

string

transType
可选

调拨单类型0:门店间调拨1:药房间调拨
样例 : 0

integer (int32)

transCostPriceType
可选

调拨价格类型（0:同价调拨(调出方改入库成本加，会影响到掉入方的成本)1:异价调拨）
样例 : 0

integer (int32)

createdUser
可选

创建人
样例 : 员工信息

created
可选

出库单创建时间
样例 : "string"

string (date-time)

reviewDate
可选

总部审核时间
样例 : "string"

string (date-time)

reviewUser
可选

审核人
样例 : 员工信息

inConfirmDate
可选

调拨单调入确认时间
样例 : "string"

string (date-time)

inConfirmUser
可选

调拨单调入放确认人
样例 : 员工信息

toOrgan
可选

调入的门店
样例 : 门店摘要信息

inPharmacy
可选

调入的药房
样例 : 药房详情

fromOrgan
可选

调来的门店
样例 : 门店摘要信息

outPharmacy
可选

调出的药房
样例 : 药房详情

lastModified
可选

最近一次修改时间
样例 : "string"

string (date-time)

lastModifiedUser
可选

最近一次修改人
样例 : 员工信息

status
必填

调拨单状态 0:待出库房确认 5:待总部审核 9:拒绝 10:待入库方确认 20:调拨完成 31:撤回
样例 : 1

integer (int32)

items
可选

调拨项列表
样例 : [ "商品库存调拨项" ]

< 商品库存调拨项 > array

7.192. 商品库存调拨项

名称说明类型

applicationPackageCount
可选

申请调拨的大包数量
样例 : 0.0

number

applicationPieceCount
可选

申请调拨的小包数量
样例 : 0.0

number

packageCount
可选

实际调拨的大包数量
样例 : 0.0

number

pieceCount
可选

实际调拨的小包数量
样例 : 0.0

number

goods
可选

goods快照信息
样例 : 商品条目信息

商品条目信息

outTotalCostPrice
可选

总成本
样例 : 0.0

number

outPackageCostPrice
可选

调拨成本价
样例 : 0.0

number

bathes
可选

调拨批次（调出方指定了调拨批次时有效）
样例 : [ "调拨批次" ]

< 调拨批次 > array

transInBatches
可选

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

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

lastModified
可选

上次修改时间
样例 : "string"

string (date-time)

7.193. 商品批次信息

名称说明类型

batchId
必填

批次号
样例 : 123123

integer (int64)

stockInOutDetailId
可选

stockIn 外部明细ID
样例 : "123123"

string

batchNo
必填

批号
样例 : "100012157"

string

productionDate
可选

生产日期 yyyy-MM-dd
样例 : "2024-09-10"

string

expiryDate
可选

效期 yyyy-MM-dd
样例 : "2024-09-10"

string

stockPieceCount
必填

小包装可售库存数量: 总库存 - 禁售库存 - 锁定库存
样例 : 20.0

number

stockPackageCount
必填

大包装可售库存数量：总库存 - 禁售库存 - 锁定库存
样例 : 10.0

number

packageCostPrice
可选

大包装成本价
样例 : 10.0

number

inDate
可选

入库时间 yyyy-MM-dd HH:mm:ss
样例 : "2024-09-10 18:33:00"

string (date-time)

7.194. 商品批次汇总信息

名称说明类型

productId
必填

商品ID
样例 : "ffffffff000000000ef10788097b000c"

string

pieceNum
必填

制剂数量
样例 : 5.0

number

batches
可选

批次列表
样例 : [ "商品批次信息" ]

< 商品批次信息 > array

7.195. 商品明细信息

名称说明类型

cmspec
可选

样例 : "string"

string

id
可选

商品ID
样例 : "string"

string

medicineCadn
可选

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

string

name
可选

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

string

type
可选

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

integer (int32)

subType
可选

integer (int32)

typeId
可选

系统分类ID
样例 : 1

integer (int32)

typeName
可选

系统分类名称
样例 : "药品"

string

customTypeId
可选

自定义分类ID
样例 : "213"

string

customTypeName
可选

自定义分类名称
样例 : "抗生素"

string

manufacturer
可选

生产厂家
样例 : "拜耳"

string

medicineNmpn
可选

国药准字
样例 : "H20000001"

string

barCode
可选

条形码
样例 : "string"

string

extendSpec
可选

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

string

materialSpec
可选

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

string

pieceUnit
可选

制剂单位
样例 : "支"

string

pieceNum
可选

制剂数量（10支/盒中的10）
样例 : 10.0

number

piecePrice
可选

制剂单价
样例 : 10.5

number

packageUnit
可选

包装单位
样例 : "盒"

string

packagePrice
可选

包装单价
样例 : 105.0

number

shortId
可选

药品编码
样例 : "K1001"

string

displaySpec
可选

规格: 组装好的格式
样例 : "1ml:0.5mg*10支/盒"

string

displayName
可选

名称：组织名称
样例 : "醋酸泼尼松片(华意)"

string

status
可选

商品状态 1:正常 99:删除
样例 : 1

integer (int32)

7.196. 商品条目信息

商品条目信息

名称说明类型

id
可选

商品ID
样例 : "string"

string

name
可选

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

string

typeId
可选

系统分类ID
样例 : 1

integer (int32)

typeName
可选

系统分类名称
样例 : "药品"

string

customTypeId
可选

自定义分类ID
样例 : "213"

string

customTypeName
可选

自定义分类名称
样例 : "抗生素"

string

manufacturer
可选

生产厂家
样例 : "拜耳"

string

medicineNmpn
可选

国药准字
样例 : "H20000001"

string

barCode
可选

条形码
样例 : "string"

string

pieceUnit
可选

制剂单位
样例 : "支"

string

pieceNum
可选

制剂数量（10支/盒中的10）
样例 : 10.0

number

piecePrice
可选

制剂单价
样例 : 10.5

number

packageUnit
可选

包装单位
样例 : "盒"

string

packagePrice
可选

包装单价
样例 : 105.0

number

shortId
可选

药品编码
样例 : "K1001"

string

specification
可选

规格: 组装好的格式
样例 : "1ml:0.5mg*10支/盒"

string

otcType
可选

OTC药物 1处方药 2:甲类非处方 4:乙类非处方
样例 : 1

integer (int32)

status
可选

商品状态 1:正常 99:删除
样例 : 1

integer (int32)

lastModified
可选

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

string (date-time)

goodsSpu
可选

商品SPU信息（目前仅眼镜商品有值）
样例 : 商品SPU信息

商品SPU信息

goodsSpec
可选

商品SPU规格属性（目前仅眼镜商品有值）
样例 : 商品SPU规格属性

商品SPU规格属性

7.197. 商品社保信息

名称说明类型

nationalCode
可选

社保国家码
样例 : "T001700643"

string

insuranceTypes
可选

险种信息列表
样例 : [ "商品社保险种信息" ]

< 商品社保险种信息 > array

7.198. 商品社保险种信息

名称说明类型

insuranceType
可选

险种，和每个地区的医保相关
样例 : "391"

string

reimbursementRatio
可选

报销比例（范围为0到1）
样例 : 0.1

number

7.199. 商品详情

名称说明类型

children
可选

商品子项
样例 : [ "商品详情" ]

< 商品详情 > array

id
可选

商品ID
样例 : "string"

string

name
可选

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

string

shebao
可选

社保信息
样例 : 商品社保信息

商品社保信息

disableSell
可选

禁售销售 0:正常 1:禁止销售
样例 : 0

integer (int32)

typeId
可选

系统分类ID
样例 : 1

integer (int32)

typeName
可选

系统分类名称
样例 : "药品"

string

customTypeId
可选

自定义分类ID
样例 : "213"

string

customTypeName
可选

自定义分类名称
样例 : "抗生素"

string

manufacturer
可选

生产厂家
样例 : "拜耳"

string

medicineNmpn
可选

国药准字
样例 : "H20000001"

string

barCode
可选

条形码
样例 : "string"

string

pieceUnit
可选

制剂单位
样例 : "支"

string

pieceNum
可选

制剂数量（10支/盒中的10）
样例 : 10.0

number

piecePrice
可选

制剂单价
样例 : 10.5

number

packageUnit
可选

包装单位
样例 : "盒"

string

packagePrice
可选

包装单价
样例 : 105.0

number

shortId
可选

药品编码
样例 : "K1001"

string

specification
可选

规格: 组装好的格式
样例 : "1ml:0.5mg*10支/盒"

string

otcType
可选

OTC药物 1处方药 2:甲类非处方 4:乙类非处方
样例 : 1

integer (int32)

status
可选

商品状态 1:正常 99:删除
样例 : 1

integer (int32)

lastModified
可选

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

string (date-time)

goodsSpu
可选

商品SPU信息（目前仅眼镜商品有值）
样例 : 商品SPU信息

商品SPU信息

goodsSpec
可选

商品SPU规格属性（目前仅眼镜商品有值）
样例 : 商品SPU规格属性

商品SPU规格属性

7.200. 商品采购单审核请求

名称说明类型

pass
必填

是否通过 0:拒绝 1:通过，默认值 1
样例 : 1

integer (int32)

comment
可选

审核评论或备注
样例 : "药品数量超过限制"

string

7.201. 地区信息

名称说明类型

id
可选

地区ID
样例 : "510000"

string

name
可选

地区名称
样例 : "四川"

string

children
可选

下级区域列表
样例 : [ "地区信息" ]

< 地区信息 > array

7.202. 处方-药品使用信息

名称说明类型

usage
可选

处方用法（煎服,冲服,制膏,制丸,外用,贴敷,打粉,泡饮,泡酒,泡浴,泡脚,擦拭）
样例 : "煎服"

string

freq
可选

每日次数
样例 : "1日3次"

string

medicineRequirement
可选

处方药品特殊煎煮方式（先煎，先煎半小时，先煎一小时，后下，包煎，另煎，先炒，烊化，冲服，捣碎，另包）
样例 : "先煎"

string

doseCount
可选

处方剂量
样例 : 3

integer (int32)

dailyDosage
可选

每日使用剂数
样例 : "1日3剂"

string

requirement
可选

处方备注
样例 : "饭前服用"

string

usageLevel
可选

每次用量
样例 : "每次150ml"

string

processUsage
可选

加工制法（煎药，手工煎药，机器煎药（普通），制膏，儿童膏方，成人膏方，打粉，粗粉，细粉，超细粉，制丸，水丸，蜜丸，水蜜丸，浓缩丸，机器煎药（浓缩），颗粒，茶包，胶囊）
样例 : "机器煎药（普通）"

string

processRemark
可选

加工备注
样例 : "加工备注信息"

string

usageDays
可选

服用天数描述
样例 : "约服30天"

string

processBagUnitCount
可选

每剂加工数量，一剂煎X袋，共煎Y袋的X。
样例 : 3.0

number

totalProcessCount
可选

总加工数量，一剂煎X袋，共煎Y袋的Y。
样例 : 9.0

number

7.203. 处方信息

名称说明类型

id
可选

处方ID
样例 : "string"

string

type
可选

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

integer (int32)

specification
可选

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

string

doseCount
可选

剂数
样例 : 0

integer (int32)

dailyDosage
可选

每日剂量
样例 : "string"

string

usage
可选

用法
样例 : "string"

string

freq
可选

用药频次
样例 : "string"

string

requirement
可选

服用要求
样例 : "string"

string

usageLevel
可选

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

string

prescriptionFormItems
可选

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

< 处方单项信息 > array

7.204. 处方单项信息

名称说明类型

id
可选

处方单项ID
样例 : "string"

string

prescriptionFormId
可选

处方单ID
样例 : "string"

string

productId
可选

药品id
样例 : "string"

string

type
可选

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

integer (int32)

subType
可选

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

integer (int32)

name
可选

药品商用名
样例 : "string"

string

specification
可选

药品规格
样例 : "string"

string

manufacturer
可选

生产厂家
样例 : "string"

string

usage
可选

用法
样例 : "string"

string

ivgtt
可选

输液滴速
样例 : 0.0

number

ivgttUnit
可选

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

string

freq
可选

用药频次
样例 : "string"

string

dosage
可选

单次剂量
样例 : "string"

string

dosageUnit
可选

剂量单位
样例 : "string"

string

days
可选

用药天数
样例 : 0

integer (int32)

specialRequirement
可选

特殊要求
样例 : "string"

string

isDismounting
可选

是否使用拆零
样例 : 0

integer (int32)

unitCount
可选

数量
样例 : 0.0

number

unit
可选

单位
样例 : "string"

string

unitPrice
可选

单位价格
样例 : 0.0

number

groupId
可选

分组编号
样例 : 0

integer (int32)

isAst
可选

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

integer (int32)

astResult
可选

皮试结果
样例 : 皮试结果

皮试结果

productInfo
可选

药品信息
样例 : 商品详情

7.205. 处方审核信息

处方审核信息

名称说明类型

auditBy
可选

审核人ID
样例 : "ffffffff00000000264a75300d757777"

string

auditByName
可选

审核人名称
样例 : "张三"

string

auditByHandSign
可选

审核人手签
样例 : "http://www.baidu.com"

string

auditTime
可选

审核时间
样例 : "2025-01-09 17:20:00"

string (date-time)

7.206. 处方调配信息

处方调配信息

名称说明类型

compoundBy
可选

调配人ID
样例 : "ffffffff00000000264a75300d757777"

string

compoundByName
可选

调配人名称
样例 : "张三"

string

compoundByHandSign
可选

调配人手签
样例 : "http://www.baidu.com"

string

compoundTime
可选

调配时间 yyyy-MM-dd HH:mm:ss
样例 : "2025-01-09 17:20:00"

string (date-time)

7.207. 外部跟踪信息

名称说明类型

content
可选

信息内容
样例 : "string"

string

time
可选

时间
样例 : "yyyy-MM-dd HH:mm:ss"

string

7.208. 就诊单号查询发药单响应

名称说明类型

dispensingSheets
可选

发药单列表
样例 : [ "发药单详情" ]

< 发药单详情 > array

7.209. 就诊来源类型

名称说明类型

id
必填

类型ID
样例 : "string"

string

name
必填

类型名称或关联ID名称（当关联类型为单个员工时为员工名称；当关联类型为单个患者时为患者名称；当关联类型为员工角色时为角色名称，其他情况就是类型名称）
样例 : "张三"

string

relatedType
必填

关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色
样例 : 3

integer (int32)

relatedId
可选

关联ID，由 relatedType 确定关联的是什么ID，关联单个患者时，是患者ID；关联单个医生时，是医生ID；关联的是医生角色时，是角色ID；其他情况为空
样例 : "ffffffff00000000094c2a500293c000"

string

children
可选

就诊来源子类（和 relatedType 有关，只有在关联类型为 0 的时候才可能有值）
样例 : [ "就诊来源类型" ]

< 就诊来源类型 > array

7.210. 库存入库单列表

名称说明类型

stockInOrderList
可选

库存入库单列表
样例 : [ "出入库单信息" ]

< 出入库单信息 > array

7.211. 库存出库单列表

名称说明类型

stockOutOrderList
可选

库存出库单列表
样例 : [ "库存出库单摘要信息" ]

< 库存出库单摘要信息 > array

7.212. 库存出库单摘要信息

名称说明类型

id
可选

出库单id
样例 : 0

integer (int64)

orderNo
可选

出库单号
样例 : "CK20220526000001"

string

status
可选

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

integer (int32)

organName
可选

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

string

type
可选

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

integer (int32)

kindCount
可选

品种数量
样例 : 5

integer (int32)

count
可选

数量
样例 : 12.0

number

amount
可选

含税金额
样例 : 6033.23

number

receiver
可选

领取人
样例 : "string"

string

operator
可选

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

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

inOrderId
可选

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

string

pharmacy
可选

出库药房
样例 : 药房详情

7.213. 库存商品供应商

名称说明类型

id
可选

供应商Id
样例 : "string"

string

name
可选

供应商的名字
样例 : "string"

string

7.214. 库存盘点单列表

名称说明类型

checkOrderList
可选

库存盘点单列表
样例 : [ "库存盘点单摘要信息" ]

< 库存盘点单摘要信息 > array

7.215. 库存盘点单摘要信息

名称说明类型

id
可选

盘点单ID
样例 : 0

integer (int64)

orderNo
可选

盘点单号
样例 : "PD20220526000001"

string

status
可选

盘点单状态 0:未知初始状态 10:新建待审批 20:审批被拒绝 30:完成(审批通过) 40:撤回
样例 : 0

integer (int32)

organId
可选

门店ID
样例 : "ffffffff0000000019b354880922800a"

string

organName
可选

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

string

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

totalCostPriceChange
可选

盈亏金额（进价）
样例 : 0.0

number

totalPriceChange
可选

盈亏金额（售价）
样例 : 0.0

number

operator
可选

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

string

operatorId
可选

操作人ID
样例 : "123456"

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

7.216. 库存结算单信息

名称说明类型

id
可选

结算单ID
样例 : 0

integer (int64)

createdUser
可选

结算单创建人
样例 : "string"

string

createDate
可选

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

string (date-time)

supplierName
可选

供应商名称
样例 : "string"

string

status
可选

结算单状态 -1:未结算 0:审批中 1:通过审批 6:审批被拒绝 9:撤回申请
样例 : -1

integer (int32)

includeTaxPrice
可选

含税金额
样例 : 0.0

number

excludeTaxPrice
可选

不含税金额
样例 : 0.0

number

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

7.217. 库存结算单信息返回体

名称说明类型

settlementOrderList
可选

库存结算单列表
样例 : [ "库存结算单信息" ]

< 库存结算单信息 > array

7.218. 库存结算单详情

名称说明类型

id
可选

结算单ID
样例 : 0

integer (int64)

itemsList
可选

结算单条目列表
样例 : [ "结算单条目列表" ]

< 结算单条目列表 > array

createdUser
可选

结算单创建人
样例 : "string"

string

invoicesList
可选

结算单发票列表
样例 : [ "结算单发票列表" ]

< 结算单发票列表 > array

createDate
可选

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

string (date-time)

inOutList
可选

结算单入库单出库单列表
样例 : [ "结算单入库单出库单列表" ]

< 结算单入库单出库单列表 > array

supplierName
可选

供应商名称
样例 : "string"

string

status
可选

结算单状态 -1:未结算 0:审批中 1:通过审批 6:审批被拒绝 9:撤回申请
样例 : -1

integer (int32)

includeTaxPrice
可选

含税金额
样例 : 0.0

number

excludeTaxPrice
可选

不含税金额
样例 : 0.0

number

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

7.219. 库存调拨单列表视图

名称说明类型

id
可选

调拨单ID
样例 : 0

integer (int64)

amount
可选

调拨总金额（含税)
样例 : 0.0

number

count
可选

所有调拨商品转成大包装的数量的累加
样例 : 0.0

number

kindCount
可选

种类数量（调拨单里面有几种类型的药）
样例 : 0

integer (int32)

orderNo
可选

可读的调拨库单号
样例 : "string"

string

transType
可选

调拨单类型0:门店间调拨1:药房间调拨
样例 : 0

integer (int32)

transCostPriceType
可选

调拨价格类型（0:同价调拨(调出方改入库成本加，会影响到掉入方的成本)1:异价调拨）
样例 : 0

integer (int32)

createdUser
可选

创建人
样例 : 员工信息

created
可选

出库单创建时间
样例 : "string"

string (date-time)

reviewDate
可选

总部审核时间
样例 : "string"

string (date-time)

reviewUser
可选

审核人
样例 : 员工信息

inConfirmDate
可选

调拨单调入确认时间
样例 : "string"

string (date-time)

inConfirmUser
可选

调拨单调入放确认人
样例 : 员工信息

toOrgan
可选

调入的门店
样例 : 门店摘要信息

inPharmacy
可选

调入的药房
样例 : 药房详情

fromOrgan
可选

调来的门店
样例 : 门店摘要信息

outPharmacy
可选

调出的药房
样例 : 药房详情

lastModified
可选

最近一次修改时间
样例 : "string"

string (date-time)

lastModifiedUser
可选

最近一次修改人
样例 : 员工信息

status
必填

调拨单状态 0:待出库方确认 5:待总部审核 9:拒绝 10:待入库方确认 20:调拨完成 31:撤回
样例 : 1

integer (int32)

7.220. 库存调拨单详情

名称说明类型

id
可选

调拨单ID
样例 : 0

integer (int64)

amount
可选

调拨总金额（含税)
样例 : 0.0

number

count
可选

所有调拨商品转成大包装的数量的累加
样例 : 0.0

number

kindCount
可选

种类数量（调拨单里面有几种类型的药）
样例 : 0

integer (int32)

orderNo
可选

可读的调拨库单号
样例 : "string"

string

transType
可选

调拨单类型0:门店间调拨1:药房间调拨
样例 : 0

integer (int32)

transCostPriceType
可选

调拨价格类型（0:同价调拨(调出方改入库成本加，会影响到掉入方的成本)1:异价调拨）
样例 : 0

integer (int32)

createdUser
可选

创建人
样例 : 员工信息

created
可选

出库单创建时间
样例 : "string"

string (date-time)

reviewDate
可选

总部审核时间
样例 : "string"

string (date-time)

reviewUser
可选

审核人
样例 : 员工信息

inConfirmDate
可选

调拨单调入确认时间
样例 : "string"

string (date-time)

inConfirmUser
可选

调拨单调入放确认人
样例 : 员工信息

toOrgan
可选

调入的门店
样例 : 门店摘要信息

inPharmacy
可选

调入的药房
样例 : 药房详情

fromOrgan
可选

调来的门店
样例 : 门店摘要信息

outPharmacy
可选

调出的药房
样例 : 药房详情

lastModified
可选

最近一次修改时间
样例 : "string"

string (date-time)

lastModifiedUser
可选

最近一次修改人
样例 : 员工信息

status
必填

调拨单状态 0:待出库房确认 5:待总部审核 9:拒绝 10:待入库方确认 20:调拨完成 31:撤回
样例 : 1

integer (int32)

items
可选

调拨项列表
样例 : [ "商品库存调拨项" ]

< 商品库存调拨项 > array

7.221. 库存采购单信息

名称说明类型

id
可选

采购单ID
样例 : 0

integer (int64)

orderNo
可选

采购单号
样例 : "CG2024110600001"

string

status
可选

采购单状态,0:待审核 1:审核通过 9:审核驳回 31:撤回
样例 : 0

integer (int32)

orderType
可选

采购类型，0：线下集采，10：ABC商城采购
样例 : 0

integer (int32)

purchaseOrganName
可选

采购门店名称
样例 : "string"

string

purchaseOrganId
可选

采购门店ID
样例 : "string"

string

applyEmployeeId
可选

申请人ID
样例 : "string"

string

applyEmployeeName
可选

申请人
样例 : "string"

string

purchaseOrderDate
可选

采购日期
样例 : "2024-11-06 16:51:03"

string (date-time)

created
可选

创建时间
样例 : "2024-11-06 16:51:03"

string (date-time)

7.222. 开卡充值业绩明细视图

名称说明类型

id
可选

id
样例 : "3810522672384016386"

string

clinicId
必填

门店id
样例 : "ffffffff00000000105f9cf8062ec000"

string

rechargeTime
可选

操作时间 yyyy-MM-dd HH:mm:ss
样例 : "2025-01-06 10:00:00"

string

patientId
可选

患者id
样例 : "ffffffff00000000105f9cf8062ec000"

string

patientMobile
可选

患者手机号
样例 : "18888888888"

string

cardId
可选

卡id
样例 : "ffffffff00000000105f9cf8062ec000"

string

cardName
可选

卡名称
样例 : "充送卡"

string

operationType
可选

操作类型：1-开卡 2-销卡 4-充值 5-退储蓄金
样例 : 1

integer (int32)

actualAmount
可选

实收金额
样例 : 100.0

number (double)

rechargePrincipal
可选

充值本金
样例 : 100.0

number (double)

rechargePresent
可选

充值赠金
样例 : 20.0

number (double)

principalBalance
可选

剩余本金
样例 : 100.0

number (double)

presentBalance
可选

剩余赠金
样例 : 20.0

number (double)

sellerId
可选

销售员ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

sellerName
可选

销售员
样例 : "张三"

string

createdByName
可选

操作人
样例 : "张三"

string

createdBy
可选

操作人id
样例 : "ffffffff00000000105f9cf8062ec000"

string

originPrice
可选

原价金额
样例 : 100.0

number (double)

7.223. 当前时段可用的号源

名称说明类型

restCount
可选

当前号源剩余号数；0：当前号源不可用
样例 : 0

integer (int32)

timeOfDay
可选

号源对应上午/下午/晚上
样例 : "string"

string

orderNo
可选

号数
样例 : 0

integer (int32)

type
可选

预留号类型 0:非预留号 1:PC预留 2:会员预留号
样例 : 2

integer (int32)

start
可选

号源开始时间 HH:mm
样例 : "string"

string

end
可选

号源结束时间 HH:mm
样例 : "string"

string

available
可选

当前号源是否可用
样例 : 0

integer (int32)

7.224. 快递信息

名称说明类型

addressProvinceName
可选

省
样例 : "四川省"

string

addressCityName
可选

市
样例 : "成都市"

string

addressDistrictName
可选

区
样例 : "高新区"

string

addressDetail
可选

详细信息
样例 : "四川省成都市高新区xxx街道xxx"

string

deliveryName
可选

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

string

deliveryMobile
可选

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

string

deliveryCompany
可选

快递公司
样例 : 快递公司

快递公司

deliveryOrderNo
可选

快递单号
样例 : "20827634879930368"

string

deliveryPayType
必填

快递费用支付方式 0:到付 1:寄付
样例 : 1

integer (int32)

deliveryFee
可选

快递费用
样例 : 10.0

number

7.225. 快递公司

名称说明类型

id
可选

快递公司ID
样例 : "127203805890060288"

string

name
可选

快递公司名称
样例 : "string"

string

7.226. 快递物流轨迹节点信息

名称说明类型

context
可选

节点内容
样例 : "string"

string

ftime
可选

节点时间
样例 : "string"

string

7.227. 患者列表响应

名称说明类型

rows
可选

患者列表
样例 : [ "患者摘要信息" ]

< 患者摘要信息 > array

7.228. 患者发药单信息

名称说明类型

id
可选

发药单ID
样例 : "string"

string

patientOrderId
可选

本次发药单所属的就诊单ID
样例 : "string"

string

chargeSheetId
可选

关联收费单ID
样例 : "string"

string

pharmacyNo
可选

药房号
样例 : 0

integer (int32)

pharmacyType
可选

药房类型：0:实体药房 1:空中药房 2:虚拟药房
样例 : 0

integer (int32)

status
可选

发药单状态 0:待发 1:已发 2:已退 3:关闭 4:取消
样例 : 0

integer (int32)

created
可选

发药单创建时间
样例 : "2024-05-30 08:13:00"

string (date-time)

sellerId
可选

开单人ID
样例 : "ffffffff000000002620d6280d751234"

string

sellerName
可选

开单人姓名
样例 : "张三"

string

7.229. 患者合并事件信息

名称说明类型

sourcePatientIds
可选

参与合并的患者ID列表（目前只会有两个）
样例 : [ "string" ]

< string > array

mergedPatient
可选

合并后的患者信息
样例 : 患者更新事件信息

患者更新事件信息

7.230. 患者家庭成员信息

名称说明类型

familyRole
可选

家庭角色 0:不是家庭成员 1:家长 2:家庭成员
样例 : 0

integer (int32)

id
必填

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

name
必填

姓名
样例 : "张三"

string

relation
可选

关系
样例 : "儿子"

string

mobile
可选

手机号
样例 : "18080000000"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

age
可选

患者年龄大小
样例 : 患者年龄

idCard
可选

身份证号
样例 : "630101200010075758"

string

7.231. 患者年龄

名称说明类型

year
可选

岁
样例 : 60

integer (int32)

month
可选

月
样例 : 2

integer (int32)

day
可选

天
样例 : 1

integer (int32)

7.232. 患者执行单信息

名称说明类型

id
必填

执行单ID
样例 : "ffffffff0000000034be47d786e44000"

string

status
必填

执行状态 1:待执行 2:已执行 3:已取消（已退费）
样例 : 1

integer (int32)

created
必填

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

string (date-time)

items
可选

执行项列表
样例 : [ "患者执行项信息" ]

< 患者执行项信息 > array

sellerId
可选

开单人ID
样例 : "ffffffff0000000034be47d786e44000"

string

sellerName
可选

开单人姓名
样例 : "张三"

string

7.233. 患者执行项信息

名称说明类型

id
必填

执行项ID
样例 : "ffffffff0000000034be47d5e6e44002"

string

productId
必填

商品ID
样例 : "ffffffff000000003499787109ea4003"

string

productName
可选

商品名称
样例 : "推拿"

string

chargeStatus
可选

执行项收费状态 0:未收费 1:已收费 2:已退费
样例 : 1

integer (int32)

totalCount
可选

总次数（已退费的情况下为 null）
样例 : 10.0

number

executedUnitCount
可选

已执行数量（已退费的情况下为null）
样例 : 2.0

number

7.234. 患者摘要信息

名称说明类型

id
必填

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

name
必填

姓名
样例 : "张三"

string

mobile
可选

手机号
样例 : "18080000000"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

age
可选

患者年龄大小
样例 : 患者年龄

idCard
可选

身份证号
样例 : "630101200010075758"

string

7.235. 患者收费单摘要信息

名称说明类型

id
可选

收费单ID
样例 : "ffffffff00000000348e4da767258000"

string

patientOrderId
可选

就诊单ID
样例 : "ffffffff0000000034c1d861a2eb8000"

string

doctorId
可选

医生ID
样例 : "ffffffff0000000034c1ed8a86f00003"

string

doctorName
可选

医生名称
样例 : "王五"

string

status
可选

收费单状态 0:未付费 1:部分付费 2:已付费 3:部分退费 4:已退费
样例 : 0

integer (int32)

receivableFee
可选

应收金额
样例 : 20.0

number

sellerId
可选

开单人ID
样例 : "ffffffff00000000287b8f500fa68000"

string

sellerName
可选

开单人名称
样例 : "李四"

string

chargerId
可选

收费员ID
样例 : "ffffffff00000000348e4e60e7290000"

string

chargerName
可选

收费员名称
样例 : "张三"

string

type
可选

收费单类型 0:未知 1:挂号 2:门诊 3:零售 5:会员充值 6:执行站开单 7:在线问诊
样例 : 1

integer (int32)

created
可选

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

string (date-time)

7.236. 患者更新事件信息

名称说明类型

id
可选

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

name
可选

姓名
样例 : "张三"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

mobile
可选

手机号
样例 : "18080000000"

string

sex
可选

性别
样例 : "男"

string

idCard
可选

身份证号
样例 : "string"

string

address
可选

住址
样例 : 住址

sn
可选

档案号
样例 : "031756"

string

profession
可选

职业
样例 : "教师"

string

company
可选

公司
样例 : "ABC"

string

patientSource
可选

来源
样例 : 患者来源

患者来源

remark
可选

备注信息
样例 : "string"

string

7.237. 患者来源

名称说明类型

parentId
可选

来源类型上级ID
样例 : "string"

string

parentName
可选

来源类型上级名称
样例 : "string"

string

id
必填

来源类型ID
样例 : "string"

string

name
必填

就诊推荐
样例 : "就诊推荐"

string

sourceFrom
可选

就诊推荐人ID，当关联类型为所有员工、员工角色时为员工ID；当关联类型为所有患者时为患者ID；
样例 : "推荐人ID"

string

sourceFromName
可选

推荐人名称，当关联类型为所有员工、员工角色时为员工名称；当关联类型为所有患者时为患者名称；
样例 : "张三"

string

relatedType
必填

关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色
样例 : 3

integer (int32)

relatedId
可选

关联ID，由 relatedType 确定关联的是什么ID，关联单个患者时是患者ID；关联单个医生时是医生ID；关联的是医生角色时是角色ID；
样例 : "ffffffff00000000094c2a500293c000"

string

relateName
可选

就诊关联来源关联名称，和 relatedId 有关
样例 : "string"

string

7.238. 患者标签

名称说明类型

id
可选

标签ID
样例 : "as123"

string

name
可选

标签名称
样例 : "糖尿病"

string

7.239. 患者详细信息

名称说明类型

createdClinicId
可选

患者创建门店ID
样例 : "000000fc446f4dbd989857e305b00d6s"

string

id
必填

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

createdClinicName
可选

患者创建门店名称
样例 : "张三"

string

name
必填

姓名
样例 : "张三"

string

created
可选

创建日期
样例 : "2018-08-14 13:08:05"

string (date-time)

mobile
可选

手机号
样例 : "18080000000"

string

patientSource
可选

来源
样例 : 患者来源

患者来源

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

sn
可选

档案号
样例 : "031756"

string

age
可选

患者年龄大小
样例 : 患者年龄

idCard
可选

身份证号
样例 : "string"

string

profession
可选

职业
样例 : "教师"

string

company
可选

公司
样例 : "ABC"

string

remark
可选

remark
样例 : "string"

string

address
可选

住址
样例 : 住址

shebaoCardInfo
可选

社保信息
样例 : 社保信息

社保信息

tags
可选

标签信息
样例 : [ "患者标签" ]

< 患者标签 > array

memberInfo
可选

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

会员信息

7.240. 患者附件

名称说明类型

id
必填

附件ID
样例 : "123123121"

string

url
必填

附件路径
样例 : "https://test.com/aaa.xlsx"

string

fileName
必填

文件名称
样例 : "aaa.xlsx"

string

displayName
可选

展示名称
样例 : "体检报告"

string

created
必填

上传时间 yyyy-MM-dd HH:mm:ss
样例 : "2024-08-15 19:18:50"

string (date-time)

businessCategory
必填

业务分类 0:其他 100:未知 101:CT 102:DR 103:CR 104:XR 105:ECG 106:BMD 107:VA 108:CC 109:MR 110:GI 111:BC 112:EEG 113:其他
样例 : 1

integer (int32)

7.241. 患者附件信息

名称说明类型

url
必填

附件路径，长度不能超过512个字符，通过接口【5.12.2 获取 OSS Token】上传到阿里云得到
样例 : "https://test.com/aaa.png"

string

fileName
必填

文件名称，长度不能超过50个字符
样例 : "xxxx.png"

string

displayName
可选

展示名称，用于显示在界面上，长度不能超过50个字符
样例 : "体检报告"

string

businessCategory
可选

业务分类（默认为0） 0:其他 100:未知 101:CT 102:DR 103:CR 104:XR 105:ECG 106:BMD 107:VA 108:CC 109:MR 110:GI 111:BC 112:EEG 113:其他
样例 : 1

integer (int32)

7.242. 患者预约摘要信息

名称说明类型

id
必填

挂号单ID
样例 : "string"

string

patientOrderId
必填

就诊单ID
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

医生名称
样例 : "张三"

string

reserveDate
可选

预约就诊日期
样例 : "2019-04-04"

string

reserveStart
可选

预约开始时间
样例 : "10:10"

string

reserveEnd
可选

预约开始时间
样例 : "10:30"

string

type
必填

类型 0：pc预约/挂号；2：门诊快速接诊挂号Direct；3：微诊所预约/挂号；4：open api 预约；5：在线咨询预约
样例 : 0

integer (int32)

status
可选

状态 10：待支付；12：已预约（理疗预约）；20：待签到；21：已签到（理疗预约）；30：待诊；40：已诊；90：已退号；92：已取消
样例 : 10

integer (int32)

payStatus
可选

支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费
样例 : 0

integer (int32)

consultingRoomId
可选

诊室ID
样例 : "string"

string

consultingRoomName
可选

诊室名称
样例 : "string"

string

registrationProducts
可选

预约项目
样例 : [ "预约项目摘要信息" ]

< 预约项目摘要信息 > array

created
可选

创建时间
样例 : "2022-06-23 18:45:00"

string (date-time)

7.243. 执行业绩-明细

名称说明类型

id
必填

执行明细ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

patientId
可选

患者ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

patientName
可选

患者名称
样例 : "张三"

string

patientMobile
可选

患者手机号
样例 : "18888888888"

string

executeClinicId
必填

执行门店ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

executeClinicName
可选

执行门店名称
样例 : "北京朝阳医院"

string

executorIds
可选

执行人ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

executorNames
可选

执行人名称
样例 : "张三"

string

status
必填

状态 0:有效 1:撤销
样例 : 0

integer (int32)

executeDate
必填

执行时间 yyyy-MM-dd HH:mm:ss
样例 : "2022-03-28 10:00:00"

string

productId
必填

执行项目ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

productShortId
可选

执行项目编码
样例 : "0001"

string

productName
可选

执行项目名称
样例 : "注射"

string

productType
可选

商品类型
样例 : 1

integer (int32)

productSubType
可选

商品子类型
样例 : 20

integer (int32)

executeCount
可选

执行次数
样例 : 1.0

number

totalPrice
可选

原价
样例 : 20.0

number

amount
可选

实收金额
样例 : 18.0

number

comment
可选

备注
样例 : "执行备注"

string

recordEffectInfo
可选

执行记录
样例 : "【方法】头针;【部位】[穴位]云门；;【反应】麻，酸;【病因】气血亏虚，阴虚内热;【结果】好转;"

string

sheetCreateClinicId
可选

开单门店ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

sheetCreateClinicName
可选

开单门店名称
样例 : "北京朝阳医院"

string

sheetCreatedBy
可选

开单人
样例 : "张三"

string

sheetCreatedByName
可选

开单人名称
样例 : "张三"

string

sheetCreateDepartmentId
可选

开单科室ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

sheetCreateDepartmentName
可选

开单科室名称
样例 : "张三"

string

sheetCreated
可选

开单时间 yyyy-MM-dd HH:mm:ss
样例 : "2022-03-28 10:00:00"

string

createdBy
可选

登记人ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

createdByName
可选

登记人名称
样例 : "张三"

string

chargeFormItemId
可选

收费项ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

chargeSheetId
可选

收费单ID
样例 : "ffffffff00000000105f9cf8062ec000"

string

7.244. 执行事件消息

执行事件消息

名称说明类型

id
必填

执行记录ID
样例 : "ffffffff000000003484c3816487c002"

string

executeSheetId
必填

执行单ID
样例 : "ffffffff000000003484c3816487c002"

string

patientOrderId
必填

就诊单ID
样例 : "ffffffff000000003484c3816487c002"

string

patient
可选

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

executors
可选

执行人ID
样例 : [ "员工信息" ]

< 员工信息 > array

items
可选

执行项目列表
样例 : [ "执行记录执行项目信息" ]

< 执行记录执行项目信息 > array

operator
可选

操作人
样例 : 员工信息

executeTime
可选

执行时间
样例 : "2022-04-06 15:12:53"

string (date-time)

7.245. 执行单执行请求参数

执行单执行请求参数

名称说明类型

items
必填

执行项列表
样例 : [ "治疗项目执行请求" ]

< 治疗项目执行请求 > array

executorIds
必填

执行人列表
样例 : [ "string" ]

< string > array

operatorId
可选

操作人ID，如果不指定则取第一个执行人ID
样例 : "string"

string

comment
可选

备注
样例 : "string"

string

7.246. 执行单摘要信息

执行单摘要信息

名称说明类型

id
必填

执行单ID
样例 : "ffffffff000000003484c3816487c002"

string

patientOrderId
必填

就诊单ID
样例 : "ffffffff000000003484c3816487c002"

string

status
必填

执行状态 0:没有可执行项 1:待执行 2:已执行 3:已取消（已退费）
样例 : 1

integer (int32)

patient
必填

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

abstractInfo
可选

执行内容摘要信息
样例 : "string"

string

created
必填

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

string (date-time)

7.247. 执行单详情

执行单详情

名称说明类型

id
必填

执行单ID
样例 : "ffffffff000000003484c3816487c002"

string

patientOrderId
必填

就诊单ID
样例 : "ffffffff000000003484c3816487c002"

string

items
必填

执行项列表
样例 : [ "执行项" ]

< 执行项 > array

status
必填

执行状态 0:没有可执行项 1:待执行 2:已执行 3:已取消（已退费）
样例 : 1

integer (int32)

created
必填

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

string (date-time)

sellerId
可选

开单人ID
样例 : "ffffffff000000003484c3816487c002"

string

sellerName
可选

开单人姓名
样例 : "张三"

string

doctorId
可选

医生ID
样例 : "ffffffff000000003484c3816487c002"

string

doctorName
可选

医生名称
样例 : "李四"

string

diagnosis
可选

诊断
样例 : "慢性鼻窦炎，颞下间隙感染"

string

7.248. 执行记录

执行记录

名称说明类型

id
必填

执行记录ID
样例 : "ffffffff000000003484c3816487c002"

string

status
必填

执行状态 0:已执行 1:已取消
样例 : 0

integer (int32)

executors
可选

执行人ID
样例 : [ "员工信息" ]

< 员工信息 > array

items
可选

执行项目列表
样例 : [ "执行记录执行项目信息" ]

< 执行记录执行项目信息 > array

executeTime
可选

执行时间
样例 : "2022-04-06 15:12:53"

string (date-time)

operator
可选

操作人
样例 : 员工信息

7.249. 执行记录执行项目信息

执行记录执行项目信息

名称说明类型

id
可选

执行项执行记录ID
样例 : 0

integer (int64)

executeItemId
必填

执行项目ID
样例 : "ffffffff000000003484c3816487c002"

string

executeItemProductId
必填

执行项商品ID
样例 : "ffffffff000000003484c3816487c002"

string

executeItemProductName
必填

执行项商品名称
样例 : "雾化吸入"

string

executeCount
必填

执行次数
样例 : 2

integer (int32)

7.250. 执行项

名称说明类型

id
可选

ID:唯一标识
样例 : "0002b62eaf9c461f85ff3fedc4583a79"

string

needExecutive
必填

是否可以执行 0:不可以执行 1:可以执行
样例 : 1

integer (int32)

chargeFormId
可选

收费项FormId
样例 : "0002b62eaf9c461f85ff3fedc4583a80"

string

executedUnitCount
必填

已执行数量
样例 : 2.0

number

executeStatus
可选

执行状态 1:待执行 2:已执行 3:已取消（已退费）
样例 : 1

integer (int32)

productId
可选

收费商品ID
样例 : "e8aa6074f8c44dfe9f49e076e30265a9"

string

productName
可选

收费商品名称
样例 : "注射用青霉素钠"

string

status
可选

收费项状态 0未收费 1已收费 2已退费
样例 : 0

integer (int32)

unit
可选

单位
样例 : "支"

string

receivedFee
可选

实收，总金额，收费完成后有值
样例 : 40.0

number

unitPrice
可选

实收单价，收费完成后有值
样例 : 10.0

number

displayUnitPrice
可选

显示单价（待收费时是不使用任何优惠时的应收，部分收费或已收费时是优惠抵扣后的应收）
样例 : 10.0

number

displayTotalPrice
可选

显示总价（待收费时是不使用任何优惠时的总应收，部分收费或已收费时是优惠抵扣后的总应收）
样例 : 40.0

number

unitCount
可选

单位数量
样例 : 4.0

number

doseCount
可选

剂数
样例 : 1.0

number

totalCount
可选

总数量：totalCount = unitCount * doseCount
样例 : 4.0

number

productType
可选

商品一级分类: 参考api 5.3.5. 获取商品分类
样例 : 1

integer (int32)

productSubType
可选

商品二级分类: 参考api 5.3.5. 获取商品分类
样例 : 3

integer (int32)

sourceItemType
可选

收费项来源类型 0:普通 1:自备
样例 : 0

integer (int32)

productInfo
可选

商品信息
样例 : 商品详情

composeChildren
可选

套餐项目列表
样例 : [ "收费项目明细" ]

< 收费项目明细 > array

7.251. 挂号事件

名称说明类型

patientOrderId
可选

就诊单ID
样例 : "string"

string

visitSourceParentId
可选

就诊来源分类上级ID
样例 : "string"

string

registrationSheetId
可选

挂号单ID
样例 : "string"

string

visitSourceParentName
可选

就诊来源分类上级名称
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

visitSourceId
可选

就诊来源分类ID
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

visitSourceName
可选

就诊来源分类名称
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

visitSourceFromId
可选

就诊来源分类下具体来源ID，当关联类型为所有员工、员工角色时为员工ID；当关联类型为所有患者时为患者ID；
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

visitSourceFromName
可选

就诊来源分类下具体来源名称，当关联类型为所有员工、员工角色时为员工名称；当关联类型为所有患者时为患者名称；
样例 : "string"

string

doctorName
可选

医生名称
样例 : "string"

string

visitSourceRelatedType
可选

就诊来源关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色
样例 : 0

integer (int32)

orderNo
可选

号数
样例 : "上午 01号"

string

visitSourceRelatedId
可选

就诊来源关联ID，由 relatedType 确定关联的是什么ID，关联单个患者时是患者ID；关联单个医生时是医生ID；关联的是医生角色时是角色ID；
样例 : "string"

string

reserveDate
可选

预约就诊日期
样例 : "2019-04-04"

string

visitSourceRelateName
可选

就诊关联来源关联名称，和 visitSourceRelateId 有关
样例 : "string"

string

reserveTime
可选

预约具体的时间
样例 : "10:10～10:30"

string

visitSourceRemark
可选

就诊备注
样例 : "string"

string

isReserved
可选

是否是预约号 1:是 0:否
样例 : 1

integer (int32)

status
可选

状态 10：待支付；12：已预约（理疗预约）；20：待签到；21：已签到（理疗预约）；30：待诊；40：已诊；90：已退号；92：已取消
样例 : 10

integer (int32)

signIn
可选

签到状态 0:无需签到 1:待签到 2:已签到
样例 : 0

integer (int32)

consultingRoomId
可选

诊室id
样例 : "string"

string

consultingRoomName
可选

诊室名称
样例 : "string"

string

type
可选

预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号
样例 : 0

integer (int32)

payStatus
可选

支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费
样例 : 0

integer (int32)

code
可选

取号码
样例 : 0

integer (int32)

registrationType
可选

预约类型 0:门诊预约 1:理疗预约 10:检查预约
样例 : 0

integer (int32)

created
可选

创建时间
样例 : "2022-06-23 18:45:00"

string (date-time)

7.252. 挂号单基础信息

名称说明类型

patientOrderId
可选

就诊单ID
样例 : "string"

string

registrationSheetId
可选

挂号单ID
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

医生名称
样例 : "string"

string

orderNo
可选

号数
样例 : "上午 01号"

string

reserveDate
可选

预约就诊日期
样例 : "2019-04-04"

string

reserveTime
可选

预约具体的时间
样例 : "10:10～10:30"

string

isReserved
可选

是否是预约号 1:是 0:否
样例 : 1

integer (int32)

status
可选

状态 10：待支付；12：已预约（理疗预约）；20：待签到；21：已签到（理疗预约）；30：待诊；40：已诊；90：已退号；92：已取消
样例 : 10

integer (int32)

signIn
可选

签到状态 0:无需签到 1:待签到 2:已签到
样例 : 0

integer (int32)

consultingRoomId
可选

诊室id
样例 : "string"

string

consultingRoomName
可选

诊室名称
样例 : "string"

string

type
可选

预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号
样例 : 0

integer (int32)

payStatus
可选

支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费
样例 : 0

integer (int32)

code
可选

取号码
样例 : 0

integer (int32)

registrationType
可选

预约类型 0:门诊预约 1:理疗预约 10:检查预约
样例 : 0

integer (int32)

created
可选

创建时间
样例 : "2022-06-23 18:45:00"

string (date-time)

7.253. 挂号种类号源信息

名称说明类型

departmentId
可选

科室id
样例 : "ffffffff0000000017e9b87008386000"

string

registrationCategory
可选

挂号种类；0：普通门诊；1：专家门诊；2：便民门诊；
样例 : 0

integer (int32)

restCount
可选

剩余号源数量
样例 : 5

integer (int32)

totalCount
可选

总号源数量
样例 : 10

integer (int32)

status
可选

状态
样例 : 0

integer (int32)

dayShifts
可选

按时段展示，上午/下午/晚上或者自定义时段
样例 : [ "时间段信息" ]

< 时间段信息 > array

7.254. 挂号详细信息

名称说明类型

clinicName
可选

门店名称
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

registrationSheetId
可选

挂号单ID
样例 : "string"

string

visitSourceParentId
可选

就诊来源分类上级ID
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

visitSourceParentName
可选

就诊来源分类上级名称
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

visitSourceId
可选

就诊来源分类ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

visitSourceName
可选

就诊来源分类名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

visitSourceFromId
可选

就诊来源分类下具体来源ID，当关联类型为所有员工、员工角色时为员工ID；当关联类型为所有患者时为患者ID；
样例 : "string"

string

doctorName
可选

医生名称
样例 : "string"

string

visitSourceFromName
可选

就诊来源分类下具体来源名称，当关联类型为所有员工、员工角色时为员工名称；当关联类型为所有患者时为患者名称；
样例 : "string"

string

orderNo
可选

号数
样例 : "上午 01号"

string

visitSourceRelatedType
可选

就诊来源关联类型 0:不需要关联 1:所有员工 2:所有患者 3:单个员工 4:单个患者 5:员工角色
样例 : 0

integer (int32)

reserveDate
可选

预约就诊日期
样例 : "2019-04-04"

string

visitSourceRelatedId
可选

就诊来源关联ID，由 relatedType 确定关联的是什么ID，关联单个患者时是患者ID；关联单个医生时是医生ID；关联的是医生角色时是角色ID；
样例 : "string"

string

reserveTime
可选

预约具体的时间
样例 : "10:10～10:30"

string

visitSourceRelateName
可选

就诊关联来源关联名称，和 visitSourceRelateId 有关
样例 : "string"

string

isReserved
可选

是否是预约号 1:是 0:否
样例 : 1

integer (int32)

visitSourceRemark
可选

就诊备注
样例 : "string"

string

registrationProducts
可选

预约项目列表
样例 : [ "预约项目摘要信息" ]

< 预约项目摘要信息 > array

status
可选

状态 10：待支付；12：已预约（理疗预约）；20：待签到；21：已签到（理疗预约）；30：待诊；40：已诊；90：已退号；92：已取消
样例 : 10

integer (int32)

signIn
可选

签到状态 0:无需签到 1:待签到 2:已签到
样例 : 0

integer (int32)

consultingRoomId
可选

诊室id
样例 : "string"

string

consultingRoomName
可选

诊室名称
样例 : "string"

string

type
可选

预约挂号类型 0:pc预约/挂号 2:门诊快速接诊挂号 3:微诊所预约/挂号 4:开放平台预约/挂号
样例 : 0

integer (int32)

payStatus
可选

支付状态 0:未支付 10:部分支付 20:已支付 30:部分退费 40:已退费
样例 : 0

integer (int32)

code
可选

取号码
样例 : 0

integer (int32)

registrationType
可选

预约类型 0:门诊预约 1:理疗预约 10:检查预约
样例 : 0

integer (int32)

created
可选

创建时间
样例 : "2022-06-23 18:45:00"

string (date-time)

7.255. 推送内容

名称说明类型

eventModule
可选

事件模块
样例 : 0

integer (int32)

id
可选

事件id
样例 : "string"

string

clinicId
可选

机构ID
样例 : "string"

string

eventType
可选

事件类型
样例 : 0

integer (int32)

eventName
可选

事件名称
样例 : "string"

string

eventData
可选

事件数据
样例 : "object"

object

callbackCount
可选

回调次数，第一次请求时 1，失败后第一次重试时为 2
样例 : 0

integer (int32)

7.256. 推送内容«JsonNode»

名称说明类型

eventModule
可选

事件模块
样例 : 0

integer (int32)

id
可选

事件id
样例 : "string"

string

clinicId
可选

机构ID
样例 : "string"

string

eventType
可选

事件类型
样例 : 0

integer (int32)

eventName
可选

事件名称
样例 : "string"

string

eventData
可选

事件数据
样例 : JsonNode

JsonNode

callbackCount
可选

回调次数，第一次请求时 1，失败后第一次重试时为 2
样例 : 0

integer (int32)

7.257. 撤销执行请求参数

撤销执行请求参数

名称说明类型

operatorId
可选

操作人ID
样例 : "string"

string

7.258. 操作响应结果

名称说明类型

code
可选

返回码
样例 : 200

integer (int32)

message
可选

返回提示
样例 : "提示信息"

string

7.259. 收费单事件详细信息

名称说明类型

id
必填

收费单唯一标识
样例 : "ffffffff00000000220e67a8116d8000"

string

status
可选

收费单状态 0:未收费 1:部分收费 2:收费完成 3:部分退费 4:退费完成
样例 : 0

integer (int32)

type
可选

收费单类型 1:挂号 2:门诊 3:零售收费 5:会员卡充值\退费 6:执行站开单 7:咨询单 8:自主续方 9:家庭医生签约 10:营销卡开卡\销卡 11:营销卡项充值\退费
样例 : 1

integer (int32)

created
可选

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

string (date-time)

receivableFee
可选

应收金额
样例 : 0.01

number

receivedFee
可选

实收金额
样例 : 0.0

number

refundFee
可选

退费金额
样例 : 0.01

number

discountFee
必填

优惠金额（负值）
样例 : -10.0

number

refundTime
可选

退费时间
样例 : "2022-04-07 15:12:53"

string (date-time)

charger
可选

收费员
样例 : 收费员

收费员

deliveryInfo
可选

收货信息
样例 : 快递信息

doctor
可选

开方医生
样例 : 医生信息

医生信息

patient
可选

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

medicalRecord
可选

病历信息
样例 : 病历信息

chargeFormItems
可选

收费项目明细
样例 : [ "收费项目明细" ]

< 收费项目明细 > array

chargeTransactions
可选

收费记录：一张收费单可以分多次收费
样例 : [ "收退费交易记录" ]

< 收退费交易记录 > array

chargeTransactionPaidRecords
可选

收费记录：一张收费单可以有多个收费项只对收费记录进行合并
样例 : [ "收费项详细信息" ]

< 收费项详细信息 > array

sellerId
可选

销售员id
样例 : "ffffff000000xxxxx"

string

sellerName
可选

销售员名字
样例 : "张三"

string

registrationSheetId
可选

挂号单ID，注意：零售收费、在线咨询等与挂号不相关的途径产生的收退费事件，该字段返回的值为空
样例 : "ffffffff0000000025b0df48001ae013"

string

patientOrderId
可选

就诊单ID
样例 : "ffffffff00000000220e67a8116d8000"

string

isDraft
可选

是否是草稿 0:不是草稿 1:是草稿
样例 : 0

integer (int32)

isClosed
可选

是否关闭 0:未关闭 1:已关闭
样例 : 0

integer (int32)

chargedTime
可选

收费完成时间
样例 : "2022-04-06 15:12:53"

string (date-time)

7.260. 收费单列表

名称说明类型

chargeSheets
可选

收费单列表
样例 : [ "收费单详细信息" ]

< 收费单详细信息 > array

7.261. 收费单摘要信息

名称说明类型

id
可选

收费单ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

created
可选

收费单创建时间，而不是在收费台展示的时间，在任何可能会产生收费单场景都会预先创建收费单（例如与挂号预约时）
样例 : "string"

string (date-time)

doctorName
可选

医生名称
样例 : "string"

string

isDraft
可选

是否是草稿 0:不是草稿 1:是草稿
样例 : 0

integer (int32)

status
可选

收费单状态 0:未付费 1:部分付费 2:已付费 3:部分退费 4:已退费
样例 : 0

integer (int32)

owedStatus
可选

欠费状态 0:无欠费 10:欠费中
样例 : 0

integer (int32)

patient
可选

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

type
可选

收费单类型 0:未知 1:挂号 2:门诊 3:零售 5:会员充值 7:在线问诊
样例 : 1

integer (int32)

isClosed
可选

是否关闭 0:未关闭 1:已关闭
样例 : 0

integer (int32)

7.262. 收费单摘要信息列表

名称说明类型

chargeSheets
可选

收费单列表
样例 : [ "收费单摘要信息" ]

< 收费单摘要信息 > array

7.263. 收费单支付请求

名称说明类型

payMode
必填

支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项
最小值 : 1
样例 : 1

integer (int32)

amount
必填

当次支付金额（小数点前最多为12位，小数点后最多4位）
样例 : 100.0

number

needPayFee
可选

收费单剩余需要支付的金额（小数点前最多为12位，小数点后最多4位），部分收费场景该字段必填
样例 : 1000.0

number

expectedOddFee
可选

期望凑整抹零金额（不能小于-1，不能大于1），就算没有开启凑整抹零的开关依然生效！！！，如果是部分收费，只有第一次收费的时候这个值有效。
样例 : 0.52

number

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

comment
可选

备注信息（长度最大为 200 个字符）
样例 : "来自互联网医院"

string

7.264. 收费单收费结果

名称说明类型

id
必填

收费单ID
样例 : "string"

string

patientOrderId
必填

就诊单ID
样例 : "string"

string

status
必填

收费单状态 0:未收费 1:部分收费 2:已收费 3:部分退费 4:已退费
样例 : 2

integer (int32)

statusName
必填

状态名称
样例 : "已收费"

string

needPay
必填

收费单总共支付的金额
样例 : 100.0

number

receivedFee
必填

收费单已经收费单的金额
样例 : 100.0

number

7.265. 收费单详细信息

名称说明类型

id
必填

收费单唯一标识
样例 : "ffffffff00000000220e67a8116d8000"

string

status
可选

收费单状态 0:未收费 1:部分收费 2:收费完成 3:部分退费 4:退费完成
样例 : 0

integer (int32)

type
可选

integer (int32)

created
可选

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

string (date-time)

receivableFee
可选

应收金额
样例 : 0.01

number

receivedFee
可选

实收金额
样例 : 0.0

number

refundFee
可选

退费金额
样例 : 0.01

number

discountFee
必填

优惠金额（负值）
样例 : -10.0

number

refundTime
可选

退费时间
样例 : "2022-04-07 15:12:53"

string (date-time)

charger
可选

收费员
样例 : 收费员

收费员

deliveryInfo
可选

收货信息
样例 : 快递信息

doctor
可选

开方医生
样例 : 医生信息

医生信息

patient
可选

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

medicalRecord
可选

病历信息
样例 : 病历信息

chargeFormItems
可选

收费项目明细
样例 : [ "收费项目明细" ]

< 收费项目明细 > array

chargeTransactions
可选

收费记录：一张收费单可以分多次收费
样例 : [ "收退费交易记录" ]

< 收退费交易记录 > array

chargeTransactionPaidRecords
可选

收费记录：一张收费单可以有多个收费项只对收费记录进行合并
样例 : [ "收费项详细信息" ]

< 收费项详细信息 > array

sellerId
可选

销售员id
样例 : "ffffff000000xxxxx"

string

sellerName
可选

销售员名字
样例 : "张三"

string

registrationSheetId
可选

挂号单ID，注意：零售收费、在线咨询等与挂号不相关的途径产生的收退费事件，该字段返回的值为空
样例 : "ffffffff0000000025b0df48001ae013"

string

patientOrderId
可选

就诊单ID
样例 : "ffffffff00000000220e67a8116d8000"

string

isDraft
可选

是否是草稿 0:不是草稿 1:是草稿
样例 : 0

integer (int32)

isClosed
可选

是否关闭 0:未关闭 1:已关闭
样例 : 0

integer (int32)

chargedTime
可选

收费完成时间
样例 : "2022-04-06 15:12:53"

string (date-time)

7.266. 收费单退费响应

名称说明类型

id
必填

收费单ID
样例 : "string"

string

status
必填

收费单状态 0:未收费 1:部分收费 2:已收费 3:部分退费 4:已退费
样例 : 2

integer (int32)

statusName
必填

状态名称
样例 : "已收费"

string

refundFee
必填

本次已退金额
样例 : 10.0

number

refundedFee
必填

累积已退金额
样例 : 20.0

number

7.267. 收费单退费请求

名称说明类型

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

needRefundFee
可选

收费项需要退费金额（如果不传默认为收费单的实收金额），最大值为 chargeForms 中商品实收金额总和
样例 : 0.0

number

refundFee
可选

本次退费金额（如果不传默认为收费单的实收金额），最大值为 [needRefundFee] + 欠退金额
样例 : 0.0

number

payMode
可选

支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项（如果不传则默认为任意一次收费交易的支付方式）
最小值 : 1
样例 : 1

integer (int32)

chargeForms
可选

收费form列表，如果需要部分退的场景才传该值
样例 : [ "退费form请求" ]

< 退费form请求 > array

7.268. 收费员

名称说明类型

id
可选

ID：唯一标识
样例 : "string"

string

name
可选

姓名
样例 : "张三"

string

7.269. 收费明细-分类信息

名称说明类型

clinicName
可选

门店
样例 : "大源店"

string

feeType
可选

费用分类
样例 : "string"

string

clinicId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

departmentName
可选

科室
样例 : "内科"

string

departmentId
可选

科室ID
样例 : "ffffffff00000000264a75300d752999"

string

employeeName
可选

开单人
样例 : "张三"

string

employeeId
可选

开单人ID
样例 : "ffffffff00000000264a75300d752999"

string

chargeName
可选

收费员
样例 : "李四"

string

chargeId
可选

收费员ID
样例 : "ffffffff00000000264a75300d752999"

string

totalPrice
可选

原价
样例 : 20.0

number

adjustmentPrice
可选

整单议价金额
样例 : 0.0

number

discountPrice
可选

优惠金额
样例 : -9.0

number

deductPrice
可选

服务折扣金额
样例 : 0.0

number

amount
可选

实收金额
样例 : 11.0

number

created
可选

收费时间
样例 : "2022-04-28 15:41:27"

string

sourceType
可选

来源
样例 : "门诊"

string

action
可选

类型收费、退费、欠费、销欠费
样例 : "收费"

string

patientId
可选

患者ID
样例 : "ffffffff0000000034d22e0ce272c000"

string

patientName
可选

患者姓名
样例 : "张三"

string

no
可选

患者就诊号
样例 : 100

integer (int32)

payMode
可选

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

string

payModeId
必填

支付方式 1:现金 2:微信支付 3:阿里云 4:银行卡 7:现金券 8:美团支付 9:口碑支付 10:糯米支付 11:收钱吧 12:点评 13:付呗 14:拉卡拉 15:连连支付 16:有赞零售 17:有赞抵现 18:营销卡项
样例 : 1

integer (int32)

paySubModeId
可选

支付子类型
样例 : 0

integer (int32)

comment
可选

备注
样例 : "-"

string

memberPatientId
可选

会员患者ID
样例 : "fffffffff00000000349018418ff74000"

string

memberPatientName
可选

会员患者姓名
样例 : "张三"

string

memberPatientMobile
可选

会员患者手机号
样例 : "18012312312"

string

7.270. 收费明细-单据信息

名称说明类型

clinicName
可选

门店
样例 : "大源店"

string

transactionId
必填

交易流水ID
样例 : "ffffffff0000000034cebe945dc04002"

string

clinicId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

patientOrderId
可选

就诊单ID
样例 : "ffffffff0000000034cebe945dc04002"

string

departmentName
可选

科室
样例 : "内科"

string

receivableFee
可选

应收
样例 : 0.0

number

chargeSheetId
必填

收费单ID
样例 : "ffffffff00000000264a75300d752999"

string

departmentId
可选

科室ID
样例 : "ffffffff00000000264a75300d752999"

string

employeeName
可选

开单人
样例 : "张三"

string

thirdPartyPayTransactionId
可选

三方支付交易流水号
样例 : "3811634313497509894"

string

employeeId
可选

开单人ID
样例 : "ffffffff00000000264a75300d752999"

string

visitSource
可选

推荐来源
样例 : 患者来源

患者来源

chargeName
可选

收费员
样例 : "李四"

string

chargeId
可选

收费员ID
样例 : "ffffffff00000000264a75300d752999"

string

totalPrice
可选

原价
样例 : 20.0

number

adjustmentPrice
可选

整单议价金额
样例 : 0.0

number

discountPrice
可选

优惠金额
样例 : -9.0

number

deductPrice
可选

服务折扣金额
样例 : 0.0

number

amount
可选

实收金额
样例 : 11.0

number

created
可选

收费时间
样例 : "2022-04-28 15:41:27"

string

sourceType
可选

来源
样例 : "门诊"

string

action
可选

类型收费、退费、欠费、销欠费
样例 : "收费"

string

patientId
可选

患者ID
样例 : "ffffffff0000000034d22e0ce272c000"

string

patientName
可选

患者姓名
样例 : "张三"

string

no
可选

患者就诊号
样例 : 100

integer (int32)

payMode
可选

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

string

payModeId
必填

integer (int32)

paySubModeId
可选

支付子类型
样例 : 0

integer (int32)

comment
可选

备注
样例 : "-"

string

memberPatientId
可选

会员患者ID
样例 : "fffffffff00000000349018418ff74000"

string

memberPatientName
可选

会员患者姓名
样例 : "张三"

string

memberPatientMobile
可选

会员患者手机号
样例 : "18012312312"

string

7.271. 收费明细-明细信息

名称说明类型

clinicName
可选

门店
样例 : "大源店"

string

patientMobile
可选

患者手机号
样例 : "13800000000"

string

clinicId
可选

门店ID
样例 : "ffffffff00000000264a75300d752999"

string

id
必填

收费明细ID
样例 : "ffffffff0000000034e501b0275a4074"

string

departmentName
可选

科室
样例 : "内科"

string

name
可选

收费项名称
样例 : "血清胰岛素、"

string

departmentId
可选

科室ID
样例 : "ffffffff00000000264a75300d752999"

string

productId
必填

商品ID
样例 : "ffffffff0000000034e501b0275a4074"

string

employeeName
可选

开单人
样例 : "张三"

string

productShortId
可选

商品编码
样例 : "1000001"

string

count
可选

数量
样例 : 1.0

number

employeeId
可选

开单人ID
样例 : "ffffffff00000000264a75300d752999"

string

chargeName
可选

收费员
样例 : "李四"

string

price
可选

单价
样例 : 5.0

number

chargeId
可选

收费员ID
样例 : "ffffffff00000000264a75300d752999"

string

feeType1
可选

收费项一级分类名称
样例 : "治疗"

string

feeType2
可选

收费项二级分类名称
样例 : "-"

string

totalPrice
可选

原价
样例 : 20.0

number

adjustmentPrice
可选

整单议价金额
样例 : 0.0

number

productType
可选

商品类型
样例 : 1

integer (int32)

discountPrice
可选

优惠金额
样例 : -9.0

number

productSubType
可选

商品子类型
样例 : 20

integer (int32)

deductPrice
可选

服务折扣金额
样例 : 0.0

number

productCustomType
可选

用户自定义商品类型
样例 : 1000

integer (int32)

amount
可选

实收金额
样例 : 11.0

number

batchId
可选

批次号（批次维度有值）
样例 : 1000324

integer (int64)

batchNo
可选

批号（批次维度有值）
样例 : "1234"

string

created
可选

收费时间
样例 : "2022-04-28 15:41:27"

string

expiryDate
可选

效期（批次维度有值）
样例 : "2022-03-28"

string

sourceType
可选

来源
样例 : "门诊"

string

action
可选

类型收费、退费、欠费、销欠费
样例 : "收费"

string

productionDate
可选

生产日期（批次维度有值）
样例 : "2022-03-28"

string

chargeSheetId
必填

收费单ID
样例 : "ffffffff0000000034e501b0275a4074"

string

patientId
可选

患者ID
样例 : "ffffffff0000000034d22e0ce272c000"

string

chargeFormItemId
必填

收费项ID
样例 : "ffffffff0000000034e501b0275a4074"

string

patientName
可选

患者姓名
样例 : "张三"

string

chargeTransactionId
必填

收费交易ID
样例 : "ffffffff0000000034e501b0275a4074"

string

no
可选

患者就诊号
样例 : 100

integer (int32)

itemAdjustmentAmount
可选

项目议价金额
样例 : 5.0

number

payMode
可选

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

string

payModeId
必填

integer (int32)

paySubModeId
可选

支付子类型
样例 : 0

integer (int32)

comment
可选

备注
样例 : "-"

string

memberPatientId
可选

会员患者ID
样例 : "fffffffff00000000349018418ff74000"

string

memberPatientName
可选

会员患者姓名
样例 : "张三"

string

memberPatientMobile
可选

会员患者手机号
样例 : "18012312312"

string

7.272. 收费项目明细

名称说明类型

id
可选

ID:唯一标识
样例 : "0002b62eaf9c461f85ff3fedc4583a79"

string

chargeFormId
可选

收费项FormId
样例 : "0002b62eaf9c461f85ff3fedc4583a80"

string

productId
可选

收费商品ID
样例 : "e8aa6074f8c44dfe9f49e076e30265a9"

string

productName
可选

收费商品名称
样例 : "注射用青霉素钠"

string

status
可选

收费项状态 0未收费 1已收费 2已退费
样例 : 0

integer (int32)

unit
可选

单位
样例 : "支"

string

receivedFee
可选

实收，总金额，收费完成后有值
样例 : 40.0

number

unitPrice
可选

实收单价，收费完成后有值
样例 : 10.0

number

displayUnitPrice
可选

显示单价（待收费时是不使用任何优惠时的应收，部分收费或已收费时是优惠抵扣后的应收）
样例 : 10.0

number

displayTotalPrice
可选

显示总价（待收费时是不使用任何优惠时的总应收，部分收费或已收费时是优惠抵扣后的总应收）
样例 : 40.0

number

unitCount
可选

单位数量
样例 : 4.0

number

doseCount
可选

剂数
样例 : 1.0

number

totalCount
可选

总数量：totalCount = unitCount * doseCount
样例 : 4.0

number

productType
可选

商品一级分类: 参考api 5.3.5. 获取商品分类
样例 : 1

integer (int32)

productSubType
可选

商品二级分类: 参考api 5.3.5. 获取商品分类
样例 : 3

integer (int32)

sourceItemType
可选

收费项来源类型 0:普通 1:自备
样例 : 0

integer (int32)

productInfo
可选

商品信息
样例 : 商品详情

composeChildren
可选

套餐项目列表
样例 : [ "收费项目明细" ]

< 收费项目明细 > array

7.273. 收费项详细信息

名称说明类型

productId
可选

商品id
样例 : "00000000000000000000000000000001"

string

productName
可选

商品名称
样例 : "白术"

string

productType
可选

商品类型
样例 : 5

integer (int32)

productSubType
可选

商品子类型
样例 : 0

integer (int32)

composeType
可选

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

integer (int32)

productUnit
可选

商品单位
样例 : "string"

string

productUnitCount
可选

商品数量
样例 : 1.0

number

doseCount
可选

商品剂量
样例 : 1.0

number

totalPrice
可选

商品总价
样例 : 0.0

number

discountPrice
可选

商品折扣价格
样例 : 0.0

number

records
可选

收费记录详情只包含收费记录
样例 : 0

< 交易记录商品明细 > array

7.274. 收费项退费请求

名称说明类型

id
必填

收费项ID
样例 : "00000000000000000000000000000000"

string

unitCount
必填

退费单位数量
样例 : 1.0

number

doseCount
必填

退费剂数
样例 : 1.0

number

7.275. 收退费交易记录

名称说明类型

id
可选

ID:唯一表示
样例 : "ffffffff00000000220e67a8116d8001"

string

payMode
必填

支付方式
样例 : 1

integer (int32)

paySubMode
必填

支付子方式
样例 : 1

integer (int32)

payModeName
可选

支付方式
样例 : "ABC支付"

string

payModeDisplayName
可选

用于展示的支付方式
样例 : "ABC支付-微信"

string

amount
可选

金额
样例 : 0.0

number

created
可选

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

string (date-time)

isRefunded
可选

是否已退费 0:否 1:是
样例 : 0

integer (int32)

chargeTransactionRecords
可选

交易记录商品明细列表
样例 : [ "交易记录商品明细" ]

< 交易记录商品明细 > array

7.276. 文件上传响应

名称说明类型

isSuccess
可选

是否成功:0否，1是
样例 : 0

integer (int32)

message
可选

信息:失败的时候有值
样例 : "string"

string

filePath
可选

文件路径
样例 : "string"

string

7.277. 新增或修改患者会员请求

名称说明类型

memberTypeId
必填

会员类型ID
样例 : "ffffffff0000000034b7a61b5a37c000"

string

sourceId
可选

患者来源ID
样例 : "ffffffff0000000034b7a61b5a37c000"

string

sourceFromId
可选

患者具体来源ID
样例 : "ffffffff0000000034b7a61b5a37c000"

string

remark
可选

备注信息（不能超过200个字符）
长度 : 0 - 200
样例 : "老客户"

string

7.278. 新增挂号请求参数

名称说明类型

patientId
必填

患者ID
样例 : "string"

string

departmentId
可选

科室ID，门诊预约时必传
样例 : "string"

string

doctorId
必填

医生ID
样例 : "string"

string

orderNo
可选

号数，门诊预约必填
样例 : 0

integer (int32)

reserveDate
必填

预约日期 yyyy-MM-dd
样例 : "string"

string

reserveStart
必填

预约号源开始时间, HH:mm
样例 : "string"

string

reserveEnd
必填

预约号源结束时间, HH:mm
样例 : "string"

string

sourceId
可选

就诊来源分类ID
样例 : "医生推荐分类ID, 导医推荐分类ID, 顾客推荐分类ID"

string

sourceFromId
可选

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

string

sourceRemark
可选

就诊备注
样例 : "string"

string

registrationType
可选

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

integer (int32)

registrationProductIds
可选

预约项目列表，仅在理疗预约时有效
样例 : [ 0 ]

< integer (int64) > array

7.279. 时间段信息

名称说明类型

shifts
可选

时间单元格列表
样例 : [ "预约号单元格信息" ]

< 预约号单元格信息 > array

restCount
可选

余号
样例 : 5

integer (int32)

totalCount
可选

总号
样例 : 10

integer (int32)

status
可选

integer (int32)

start
可选

开始时间 HH:mm
样例 : "09:00"

string

end
可选

结束时间 HH:mm
样例 : "10:00"

查询患者的家庭角色 0:不是家庭成员 1:家长 2:家庭成员
样例 : 0

收费单ID
样例 : "string"

string

7.292. 检查人

名称说明类型

id
可选

检查人ID
样例 : "string"

string

name
可选

检查人姓名
样例 : "string"

string

date
可选

检查时间
样例 : "string"

string

7.293. 检查检验单摘要信息

名称说明类型

id
可选

检查检验ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

patient
可选

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

name
可选

项目名称
样例 : "string"

string

type
可选

类型 1:检验 2:检查
样例 : 1

integer (int32)

deviceType
可选

设备类型检验：1-临床检验 2-生化检验 3-免疫检验 4-微生物检验 5-PCR检验 6-未知分类；检查：1-CT 2-DR 3-CR 4-透视 5-心电图 6-骨密度 7-试光类 8-彩超 9-MR 10-内窥镜 11-B超 12-脑电图 13-其他分类 14-一般检查 15-内科检查 16-外科检查 17-耳鼻喉检查 18-口腔检查 19-体检眼科 20-公卫检查 21-动脉硬化 22-妇科常规 23-CBCT
样例 : 0

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

created
可选

创建时间
样例 : "string"

string (date-time)

status
可选

状态 0:等检状态 1:已检状态 2:已退款状态 3:待审核状态
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "string"

string

7.294. 检查检验单设备信息

名称说明类型

deviceId
可选

设备id
样例 : 0

integer (int64)

deviceShortId
可选

设备编号
样例 : "string"

string

deviceModelId
可选

设备型号id
样例 : 0

integer (int64)

name
可选

设备名字
样例 : "string"

string

model
可选

设备型号
样例 : "string"

string

deviceUuid
可选

设备唯一识别码
样例 : "string"

string

manufacture
可选

设备生产商
样例 : "string"

string

iconUrl
可选

设备图标链接
样例 : "string"

string

buyUrl
可选

设备购买链接
样例 : "string"

string

installUrl
可选

设备安装链接
样例 : "string"

string

remarks
可选

设备备注信息
样例 : "string"

string

type
可选

设备分类 1:检验 2:检查
样例 : 0

integer (int32)

extendSpec
可选

设备扩展分类检验：无意义检查：10-RIS检查 20-眼科检查
样例 : "string"

string

deviceType
可选

设备类型
样例 : 0

integer (int32)

usageType
可选

设备用途类型检验：0 未知类型 1 血液分析 2 生化分析 3尿液分析 4免疫分析 5 微生物分析
样例 : 0

integer (int32)

salePrice
可选

售价
样例 : 0.0

number

deviceNamePy
可选

设备名称拼音
样例 : "string"

string

deviceStatus
可选

设备状态 0 初始化 10启用 20停用 99删除
样例 : 0

integer (int32)

deviceRoomId
可选

设备机房id
样例 : 0

integer (int64)

deviceRoomName
可选

设备机房名称
样例 : "string"

string

department
可选

设备科室
样例 : 科室摘要信息

科室摘要信息

7.295. 检查检验单详情信息

名称说明类型

id
可选

检查检验单ID
样例 : "string"

string

outpatientFormItemId
可选

门诊单子项ID
样例 : "string"

string

patientOrderId
可选

门诊单ID
样例 : "string"

string

patientOrderNumber
可选

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

string

patient
可选

患者信息
样例 : 检查检验患者摘要信息

检查检验患者摘要信息

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

医生名称
样例 : "string"

string

doctorDepartmentId
可选

医生科室ID
样例 : "string"

string

doctorDepartmentName
可选

医生科室名称
样例 : "string"

string

sellerId
可选

开单人id
样例 : "string"

string

sellerName
可选

开单人名称
样例 : "string"

string

sellerDepartmentId
可选

开单人科室id
样例 : "string"

string

sellerDepartmentName
可选

开单人科室名称
样例 : "string"

string

productId
可选

检验项目ID，在开启了合并模式的情况下为空
样例 : "string"

string

products
必填

检验项目列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "检验项目摘要信息" ]

productIds
必填

检验项目ID列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "string" ]

< string > array

composeParentProductId
可选

套餐商品ID
样例 : "string"

string

composeParentName
可选

套餐名称
样例 : "string"

string

name
可选

检验项名称
样例 : "string"

string

orderNo
可选

检验单号(条形码) yyyyMMdd000X
样例 : "202302140038"

string

status
可选

状态 0:等检状态 1:已检状态 2:已退款状态 3:设备回传 4:待审核状态
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "string"

string

sampleType
可选

样本类型
样例 : "string"

string

samplerId
可选

采集人id
样例 : "string"

string

samplerName
可选

采集人名称
样例 : "string"

string

sampleTime
可选

采集时间
样例 : "string"

string (date-time)

collectorId
可选

核收人id
样例 : "string"

string

collectorName
可选

核收人名称
样例 : "string"

string

collectTime
可选

核收时间
样例 : "string"

string (date-time)

results
可选

检查检验结果
样例 : [ "检查检验结果" ]

< 检查检验结果 > array

eyeResults
可选

眼科检查结果
样例 : [ "眼科检查结果" ]

< 眼科检查结果 > array

reports
可选

检查检验报告
样例 : [ "检查检验报告" ]

< 检查检验报告 > array

attachments
可选

附件
样例 : [ "附件" ]

< 附件 > array

remark
可选

检验结果备注
样例 : "string"

string

testerId
可选

检验人ID
样例 : "string"

string

testerName
可选

检验人名称
样例 : "string"

string

testTime
可选

检验时间
样例 : "string"

string (date-time)

checkerId
可选

审核人ID
样例 : "string"

string

checkerName
可选

审核人名称
样例 : "string"

string

checkTime
可选

审核时间
样例 : "string"

string (date-time)

reportTime
可选

报告时间
样例 : "string"

string (date-time)

created
可选

创建时间
样例 : "string"

string (date-time)

type
可选

类型 1:检验 2:检查
样例 : 1

integer (int32)

subType
可选

子类型检验：无意义；检查： 10-RIS检查 20-眼科检查
样例 : 20

integer (int32)

diagnosis
可选

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

string

reportUrl
可选

报告url
样例 : "string"

string

examinationApplySheetNo
可选

检查申请单号
样例 : "string"

string

bedNo
可选

床位号
样例 : "string"

string

deviceType
可选

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

relationPatientOrderId
可选

关联的门诊单id(眼科检查特有)
样例 : "string"

string

registrationFormItem
可选

关联的挂号单(眼科检查特有)
样例 : 挂号单基础信息

挂号单基础信息

7.296. 检查检验患者摘要信息

名称说明类型

id
必填

患者ID:唯一标识
样例 : "000000fc446f4dbd989857e305b00d6s"

string

sn
可选

患者SN号，同一连锁下SN号唯一
样例 : "100"

string

idCard
可选

患者身份证号
样例 : "string"

string

name
必填

姓名
样例 : "张三"

string

mobile
可选

手机号
样例 : "18080000000"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1970-08-14"

string

age
可选

患者年龄大小
样例 : 患者年龄

7.297. 检查检验报告

名称说明类型

id
可选

检查/检验报告id
样例 : "string"

string

imageFiles
可选

检查图像
样例 : [ "附件" ]

< 附件 > array

videoDescription
可选

影像描述
样例 : "string"

string

suggestion
可选

建议
样例 : "string"

string

inspectionSite
可选

检查部位
样例 : "string"

string

deviceModelDesc
可选

设备型号描述
样例 : "string"

string

diagnosisFlag
可选

诊断标志 0-阴性 10-阳性
样例 : 0

integer (int32)

recordDoctorId
可选

记录医生id
样例 : "string"

string

consultationDoctorId
可选

会诊医生id
样例 : "string"

string

recordDoctorName
可选

记录医生名字
样例 : "string"

string

consultationDoctorName
可选

会诊医生名字
样例 : "string"

string

diagnosisEntryItems
可选

诊断建议
样例 : [ "检查诊断信息" ]

< 检查诊断信息 > array

7.298. 检查检验报告修改请求

名称说明类型

id
可选

检查/检验报告id
样例 : "string"

string

imageFiles
可选

检查图像
样例 : [ "附件" ]

< 附件 > array

videoDescription
可选

影像描述
样例 : "string"

string

suggestion
可选

建议
样例 : "string"

string

diagnosisFlag
可选

诊断标志 0-阴性 10-阳性
样例 : 0

integer (int32)

recordDoctorId
可选

记录医生id
样例 : "string"

string

consultationDoctorId
可选

会诊医生id
样例 : "string"

string

inspectionSite
可选

检查部位
样例 : "string"

string

deviceModelDesc
可选

设备型号描述
样例 : "string"

string

isDeleted
可选

是否删除(删除时需要显式的指定) 0-否 1-是
样例 : 0

integer (int32)

diagnosisEntryItems
可选

诊断建议
样例 : [ "检查诊断信息" ]

< 检查诊断信息 > array

7.299. 检查检验摘要信息

名称说明类型

id
可选

检验单ID
样例 : "string"

string

orderNo
可选

订单号(新条码)
样例 : "string"

string

productId
可选

检验项目ID，在开启了合并模式的情况下为空
样例 : "string"

string

products
必填

检验项目列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "检验项目摘要信息" ]

productIds
必填

检验项目ID列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "string" ]

< string > array

name
可选

检查项目名称
样例 : "string"

string

type
可选

类型 1:检验 2:检查
样例 : 1

integer (int32)

deviceType
可选

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

sampleType
可选

样本类型
样例 : "string"

string

patientOrderNo
可选

就诊单号
样例 : "string"

string

patientOrderType
可选

就诊单类型
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

送检医生
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string

patientInfo
可选

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

status
可选

状态
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "待检"

string

7.300. 检查检验数据摘要信息

名称说明类型

diagnosis
可选

诊断
样例 : "string"

string

id
可选

检验单ID
样例 : "string"

string

orderNo
可选

订单号(新条码)
样例 : "string"

string

productId
可选

检验项目ID，在开启了合并模式的情况下为空
样例 : "string"

string

products
必填

检验项目列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "检验项目摘要信息" ]

productIds
必填

检验项目ID列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "string" ]

< string > array

name
可选

检查项目名称
样例 : "string"

string

type
可选

类型 1:检验 2:检查
样例 : 1

integer (int32)

deviceType
可选

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

sampleType
可选

样本类型
样例 : "string"

string

patientOrderNo
可选

就诊单号
样例 : "string"

string

patientOrderType
可选

就诊单类型
样例 : "string"

string

departmentId
可选

科室ID
样例 : "string"

string

departmentName
可选

科室名称
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

doctorName
可选

送检医生
样例 : "string"

string

createdTime
可选

创建时间
样例 : "string"

string

patientInfo
可选

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

status
可选

状态
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "待检"

string

7.301. 检查检验结果

名称说明类型

id
可选

指标项id
样例 : "string"

string

type
可选

指标项类型 1 数值型 2 文字型 3 阴阳型
样例 : 1

integer (int32)

name
可选

指标项名称
样例 : "string"

string

enName
可选

指标项编码
样例 : "string"

string

unit
可选

单位
样例 : "string"

string

itemCode
可选

检查子项 code
样例 : "string"

string

ref
可选

指标项参考范围 json字符串
样例 : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}"

string

productId
可选

检验项目id
样例 : "string"

string

resultDisplayScale
可选

指标项检查结果页面展示小数位数
样例 : 0

integer (int32)

value
可选

检查检验结果值 String|List<Attachment>|List<ExaminationDiagnosisItem>，根据valueType对应不同的value：valueType为STRING时，value为字符串；valueType为IMAGE，value为url字符串；valueType为ATTACHMENTS时，value为附件列表类型，附件结构详情见6.134
样例 : JsonNode

JsonNode

valueType
可选

值类型 STRING、IMAGE、ATTACHMENTS 默认STRING
样例 : "STRING"

string

abnormalFlag
可选

异常标志 “H”- 结果高于参考范围上限； “L” – 结果低于参考范围下限； “HH”-危机值高； “LL”-危机值低； “A” 阴阳型异常； “TA” 文字型异常； “N” 正常
样例 : "N"

string

abnormalText
可选

异常描述 abnormalFlag为TA时有效
样例 : "string"

string

7.302. 检查检验退费摘要

名称说明类型

id
可选

指标项ID
样例 : "string"

string

chargeSheetId
可选

收费单ID
样例 : "string"

string

chargeFormItemId
可选

收费单子项ID
样例 : "string"

string

outpatientFormItemId
可选

门诊单子项ID
样例 : "string"

string

patientOrderId
可选

门诊单ID
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

doctorId
可选

医生ID
样例 : "string"

string

productId
可选

检验项目ID，在开启了合并模式的情况下为空
样例 : "string"

string

products
必填

检验项目列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "检验项目摘要信息" ]

productIds
必填

检验项目ID列表，在开启了合并模式下可能会返回多个，在未开启的情况下只会返回单个
样例 : [ "string" ]

< string > array

composeParentProductId
可选

套餐商品ID
样例 : "string"

string

composeParentName
可选

套餐名称
样例 : "string"

string

name
可选

检验项名称
样例 : "string"

string

orderNo
可选

检查单号
样例 : "string"

string

remark
可选

检验结果备注
样例 : "string"

string

testerId
可选

检验人ID
样例 : "string"

string

checkerId
可选

审核人ID
样例 : "string"

string

count
可选

检查报告次数
样例 : 0

integer (int32)

createdBy
可选

创建人
样例 : "string"

string

created
可选

创建时间
样例 : "string"

string (date-time)

type
可选

类型 1 检验 2 检查
样例 : 0

integer (int32)

subType
可选

子类型检验：无意义；检查： 10-RIS检查 20-眼科检查
样例 : 20

integer (int32)

deviceType
可选

integer (int32)

businessType
可选

业务类型 10-门诊 20-零售收费 30-住院医嘱 40检验工作站 50-检查工作站 100-开放平台 200-体检
样例 : 0

integer (int32)

7.303. 检查检验项目信息

名称说明类型

id
可选

主键ID
样例 : "string"

string

shortId
可选

检查检验项目shortId
样例 : "string"

string

name
可选

项目名称
样例 : "string"

string

code
可选

项目代码
样例 : "string"

string

7.304. 检查诊断信息

名称说明类型

id
可选

诊断id
样例 : 0

integer (int64)

name
可选

诊断名称
样例 : "string"

string

abnormalFlag
可选

异常关注 0-正常 10-异常
样例 : 0

integer (int32)

7.305. 检验单修改信息

名称说明类型

attachments
可选

附件
样例 : [ "附件" ]

< 附件 > array

reports
可选

检查报告
样例 : [ "检查检验报告修改请求" ]

< 检查检验报告修改请求 > array

results
可选

检查结果
样例 : [ "检查检验结果" ]

< 检查检验结果 > array

eyeResults
可选

眼科检查结果
样例 : [ "眼科检查结果" ]

< 眼科检查结果 > array

deviceModelId
可选

设备型号id
样例 : 0

integer (int64)

deviceId
可选

设备id
样例 : 0

integer (int64)

subType
可选

检验单子类型检验：无意义；检查： 10-RIS检查 20-眼科检查
样例 : 0

integer (int32)

remark
可选

备注
样例 : "string"

string

testerId
可选

检验人id，检验人ID和名称必须填一个
样例 : "string"

string

testerName
可选

检验人名称
样例 : "string"

string

checkerId
可选

审核人id，审核人ID和名称必须填一个
样例 : "string"

string

checkerName
可选

审核人名称
样例 : "string"

string

sampleType
可选

样本类型
样例 : "string"

string

testTime
必填

检验时间 yyyy-MM-dd HH:mm
样例 : "2022-11-14 14:00"

string

checkTime
可选

审核时间 yyyy-MM-dd HH:mm
样例 : "2022-11-14 14:00"

string

reportTime
可选

报告时间 yyyy-MM-dd HH:mm
样例 : "2022-11-14 14:00"

string

status
必填

名称说明类型

id
可选

治疗单子项ID
样例 : "string"

string

productFormId
可选

治疗单ID
样例 : "string"

string

productId
可选

治疗项ID
样例 : "string"

string

name
可选

治疗项名称
样例 : "string"

string

unitCount
可选

单位次数
样例 : 0.0

number

unit
可选

单位
样例 : "string"

string

unitPrice
可选

单位价格
样例 : 0.0

number

isDismounting
可选

是否拆零 0:未拆零 1:拆零
样例 : 0

integer (int32)

type
可选

类型 1:药品 2:物资 3:检查 4:治疗 5:挂号(保)
样例 : 1

integer (int32)

subType
可选

子类型
样例 : 0

integer (int32)

days
可选

诊疗项目天数
样例 : 0

integer (int32)

dailyDosage
可选

每天次数
样例 : 0

integer (int32)

remark
可选

备注
样例 : "小心使用"

string

7.310. 治疗项目执行请求

治疗项目执行请求

名称说明类型

id
必填

治疗项目ID
样例 : "ffffffff000000003484c3816487c002"

string

executeCount
必填

执行次数
最小值 : 0
样例 : 1

integer (int32)

7.311. 添加患者附件响应

名称说明类型

attachments
可选

附件列表
样例 : [ "患者附件" ]

< 患者附件 > array

7.312. 添加患者附件请求

名称说明类型

attachments
必填

附件列表
样例 : [ "患者附件信息" ]

< 患者附件信息 > array

7.313. 病历信息

名称说明类型

id
可选

病历ID
样例 : "string"

string

outpatientSheetId
可选

门诊单ID
样例 : "ffffffff00000000094c2a500293c000"

string

chiefComplaint
可选

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

string

pastHistory
可选

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

string

familyHistory
可选

家族史
样例 : "string"

string

presentHistory
可选

现病史
样例 : "string"

string

physicalExamination
可选

体格检查
样例 : "string"

string

diagnosis
可选

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

string

doctorAdvice
可选

医嘱
样例 : "string"

string

syndrome
可选

辨症
样例 : "string"

string

therapy
可选

治法
样例 : "string"

string

chineseExamination
可选

望闻切诊
样例 : "string"

string

wearGlassesHistory
可选

戴镜史
样例 : "近视"

string

obstetricalHistory
可选

妇科月经婚育史
样例 : "string"

string

eyeExamination
可选

眼科检查
样例 : 眼科检查

眼科检查

allergicHistory
可选

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

string

attachments
可选

附件列表
样例 : [ "附件" ]

< 附件 > array

7.314. 皮试结果

名称说明类型

result
可选

结果
样例 : "阴性"

string

description
可选

描述
样例 : "执行人：王萍，执行时间：2022-04-13"

string

7.315. 盘点单事件

名称说明类型

checkOrderItemList
可选

盘点条目列表
样例 : [ "盘点条目" ]

< 盘点条目 > array

id
可选

盘点单ID
样例 : 0

integer (int64)

orderNo
可选

盘点单号
样例 : "PD20220526000001"

string

status
可选

盘点单状态 0:未知初始状态 10:新建待审批 20:审批被拒绝 30:完成(审批通过) 40:撤回
样例 : 0

integer (int32)

organId
可选

门店ID
样例 : "ffffffff0000000019b354880922800a"

string

organName
可选

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

string

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

totalCostPriceChange
可选

盈亏金额（进价）
样例 : 0.0

number

totalPriceChange
可选

盈亏金额（售价）
样例 : 0.0

number

operator
可选

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

string

operatorId
可选

操作人ID
样例 : "123456"

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

7.316. 盘点单详情

名称说明类型

checkOrderItemList
可选

盘点条目列表
样例 : [ "盘点条目" ]

< 盘点条目 > array

comment
可选

备注
样例 : 评论

id
可选

盘点单ID
样例 : 0

integer (int64)

orderNo
可选

盘点单号
样例 : "PD20220526000001"

string

status
可选

盘点单状态 0:未知初始状态 10:新建待审批 20:审批被拒绝 30:完成(审批通过) 40:撤回
样例 : 0

integer (int32)

organId
可选

门店ID
样例 : "ffffffff0000000019b354880922800a"

string

organName
可选

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

string

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

totalCostPriceChange
可选

盈亏金额（进价）
样例 : 0.0

number

totalPriceChange
可选

盈亏金额（售价）
样例 : 0.0

number

operator
可选

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

string

operatorId
可选

操作人ID
样例 : "123456"

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

7.317. 盘点条目

名称说明类型

id
可选

条目ID
样例 : 0

integer (int64)

productId
可选

商品编码
样例 : "string"

string

productShortId
可选

商品short编码
样例 : "string"

string

productName
可选

商品名称
样例 : "string"

string

specification
可选

规格
样例 : "string"

string

expiryDate
可选

有效期
样例 : "string"

string

productionDate
可选

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

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

stockId
可选

盘点批次ID
样例 : "string"

string

packageCostPrice
可选

包装成本单价
样例 : 0.0

number

beforePieceCount
可选

盘点前包装数量
样例 : 0.0

number

beforePackageCount
可选

盘点前制剂数量
样例 : 0.0

number

afterPieceCount
可选

盘点后包装数量
样例 : 0.0

number

afterPackageCount
可选

盘点后制剂数量
样例 : 0.0

number

changePieceCount
可选

盘点变更包装数量
样例 : 0.0

number

changePackageCount
可选

盘点变更制剂数量
样例 : 0.0

number

amount
可选

盘点变更总金额
样例 : 0.0

number

lastModified
可选

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

string (date-time)

checkBatches
可选

名称说明类型

items
可选

指标项
样例 : [ "眼科检查指标项信息" ]

< 眼科检查指标项信息 > array

7.322. 眼科检查指标约束

名称说明类型

message
可选

消息
样例 : "string"

string

required
可选

是否必传
样例 : true

boolean

precision
可选

精度
样例 : 0

integer (int32)

scale
可选

小数位
样例 : 0

integer (int32)

min
可选

最小值
样例 : 0

integer (int32)

max
可选

最大值
样例 : 0

integer (int32)

size
可选

大小
样例 : 0

integer (int32)

unit
可选

单位
样例 : "string"

string

validateType
可选

验证类型
样例 : 0

integer (int32)

7.323. 眼科检查指标项信息

名称说明类型

id
可选

主键id
样例 : "string"

string

productId
可选

商品id
样例 : "string"

string

type
可选

指标项类型 1 数值型 2 文字型 3 阴阳型
样例 : 0

integer (int32)

name
可选

指标项名称
样例 : "string"

string

enName
可选

指标项名称编码
样例 : "string"

string

unit
可选

单位
样例 : "string"

string

ref
可选

指标项参考范围 json字符串
样例 : "阴性、阳性 | {\"min\":\"1\",\"max\":\"5\"}"

string

resultDisplayScale
可选

指标项检查结果页面展示小数位数
样例 : 0

integer (int32)

inspectType
可选

指标眼位类型 0 左眼 1 右眼 2 双眼
样例 : 0

integer (int32)

componentType
可选

指标组件类型
样例 : 0

integer (int32)

options
可选

指标项选项列表
样例 : [ "string" ]

< string > array

constraints
可选

指标项约束
样例 : [ "眼科检查指标约束" ]

< 眼科检查指标约束 > array

value
可选

检查结果值
样例 : "string"

string

sort
可选

排序编号
样例 : 0

integer (int32)

groupId
可选

名称说明类型

cardNo
可选

医保卡号
样例 : "shebaoCardInfo"

string

7.328. 科室人员信息

名称说明类型

employeeId
可选

员工ID
样例 : "10a861eb5b4d43b59721301073112029"

string

name
可选

员工姓名
样例 : "张三"

string

mobile
可选

手机号
样例 : "18088888888"

string

7.329. 科室列表返回体

名称说明类型

departmentList
可选

科室摘要信息列表
样例 : [ "科室摘要信息" ]

< 科室摘要信息 > array

7.330. 科室摘要信息

名称说明类型

id
可选

科室ID
样例 : "ffffffff0000000006dddfe002e22000"

string

name
可选

科室名称
样例 : "儿保科室"

string

type
可选

科室类型 0:普通科室；1:门诊科室；
样例 : 1

integer (int32)

mainMedicalName
可选

一级科目
样例 : "儿科"

string

secondMedicalName
可选

二级科目
样例 : "小儿呼吸"

string

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

名称说明类型

employees
可选

科室人员列表
样例 : [ "科室人员信息" ]

< 科室人员信息 > array

id
可选

科室ID
样例 : "ffffffff0000000006dddfe002e22000"

string

principal
可选

负责人
样例 : "张三"

string

name
可选

科室名称
样例 : "儿保科室"

string

phone
可选

联系电话
样例 : "18088888888"

string

created
可选

创建时间
样例 : "2019-04-11 10:48:07"

string (date-time)

type
可选

科室类型 0:普通科室；1:门诊科室；
样例 : 1

integer (int32)

mainMedicalName
可选

一级科目
样例 : "儿科"

string

secondMedicalName
可选

二级科目
样例 : "小儿呼吸"

string

7.332. 结算单入库单出库单列表

名称说明类型

id
可选

出入库单ID
样例 : 0

integer (int64)

includeTaxPrice
可选

出入库单含税金额
样例 : 0.0

number

excludeTaxPrice
可选

出入库单不含税金额
样例 : 0.0

number

totalPackageCount
可选

出入库单数量
样例 : 0.0

number

clinicId
可选

出入库单门店ID
样例 : "string"

string

clinicName
可选

出入库单门店名称
样例 : "string"

string

orderInOutDate
可选

出入库时间
样例 : "string"

string (date-time)

orderCreatedUserName
可选

单据创建人名字
样例 : "string"

string

type
可选

出入库单类型 0:入库 1:出库
样例 : 0

integer (int32)

7.333. 结算单发票列表

名称说明类型

id
可选

发票ID
样例 : 0

integer (int64)

invoicedDate
可选

发票日期
样例 : "string"

string

invoiceNo
可选

发票号
样例 : "string"

string

7.334. 结算单条目列表

名称说明类型

id
可选

结算单条目ID
样例 : 0

integer (int64)

name
可选

名称
样例 : "string"

string

specification
可选

规格型号
样例 : "string"

string

unit
可选

单位
样例 : "string"

string

totalPackageCount
可选

数量
样例 : 0

integer (int32)

includeTaxPrice
可选

含税金额
样例 : 0.0

number

excludeTaxPrice
可选

不含税金额
样例 : 0.0

number

7.335. 职称信息

名称说明类型

type
可选

类别
样例 : "04|护理人员"

string

title
可选

名称
样例 : "13|主管护师"

string

7.336. 药房库存信息

名称说明类型

pharmacyNo
必填

样例 : 0

integer (int32)

pharmacyName
必填

药房名称
样例 : "本地药房"

string

stockPieceCount
必填

可售小包装库存
样例 : 20.0

number

stockPackageCount
必填

可售大包装库存
样例 : 10.0

number

7.337. 药房详情

名称说明类型

no
可选

药房号
样例 : 0

integer (int32)

7.338. 被修正的入库单信息

被修正的入库单信息

名称说明类型

id
可选

入库单ID
样例 : 0

integer (int64)

orderNo
可选

入库单号
样例 : "string"

string

outOrderNo
可选

入库随货单号
样例 : "string"

string

7.339. 评论

名称说明类型

time
可选

评论时间
样例 : "string"

string (date-time)

content
可选

评论内容
样例 : "string"

string

employeeId
可选

评论人ID
样例 : "string"

string

employeeName
可选

评论人名称
样例 : "string"

string

7.340. 调拨批次

名称说明类型

stockId
可选

调拨库存ID（如果没指定批次，这个字段为空）
样例 : 0

integer (int64)

batchNo
可选

调拨批次号
样例 : "string"

string

expiryDate
可选

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

string

packageCount
可选

大包装数量
样例 : 0.0

number

pieceCount
可选

小包装数量
样例 : 0.0

number

outPackageCostPrice
可选

调拨成本价
样例 : 0.0

number

7.341. 进销存明细

名称说明类型

stockLogId
必填

进销存明细ID
样例 : "123456"

string

date
必填

进销存发生日期 yyyy-MM-dd HH:mm:ss
样例 : "2020-03-05 12:00:00"

string

productId
必填

商品ID
样例 : "ffffffff00000000347730f37eb54000"

string

productShortId
可选

商品编码
样例 : "H12334"

string

productName
可选

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

string

pieceCount
可选

制剂库存变化量
样例 : 10.0

number

packageCount
可选

整包装库存变化量
样例 : 1.0

number

action
必填

进销存类型：发药、退药、采购入库、退货出库…
样例 : "发药"

string

orderId
必填

单据ID
样例 : "123456"

string

orderItemId
必填

订单条目ID
样例 : "123456789"

string

patientOrderId
可选

就诊单ID，仅发药、退药时有值
样例 : "ffffffff00000000347ce07462de0001"

string

sourceOrderId
可选

来源单据ID 发药、退药：收费单ID
样例 : "ffffffff00000000347ce07462de0001"

string

sourceOrderItemId
可选

来源订单条目ID 发药、退药：收费项ID
样例 : "ffffffff00000000347ce07462de0001"

string

packageCostPrice
可选

大包装单位成本价
样例 : 10.0

number

batchId
必填

批次ID
样例 : 123456

integer (int64)

batchNo
可选

生产批号
样例 : "20200305"

string

productionDate
可选

生产日期
样例 : "2020-03-05"

string

expireDate
可选

效期
样例 : "2020-03-05"

string

inOrderId
可选

进销存关联的入库单ID
样例 : 123456

integer (int64)

inOrderItemId
可选

进销存关联的入库单条目ID
样例 : 12345678

integer (int64)

inOrderItemOutDetailId
可选

入库单明细外部明细ID
样例 : "X12345678"

string

costPrice
可选

成本价变化量
样例 : -10.0

number

salePrice
可选

变更实收
样例 : 10.0

number

pieceNum
可选

制剂数量
样例 : 7

integer (int32)

7.342. 进销存明细返回体

名称说明类型

detailsList
可选

进销存明细列表
样例 : [ "进销存明细" ]

< 进销存明细 > array

total
可选

总数
样例 : 10

integer (int32)

7.343. 进销存：进销存明细

名称说明类型

date
可选

日期（格式yyyy-MM-dd）
样例 : "2020-03-05"

string (date)

orderIdList
可选

入库单、出库单、盘点单、发药单ID
样例 : [ "12334234", "456667" ]

< string > array

chargeSheetList
可选

收费单列表，仅 type 为 3 时有效，orderIdList 的优先级更高
样例 : [ "根据收费单查询进销存明细" ]

< 根据收费单查询进销存明细 > array

type
必填

进销存单据类型 1:出库 2:盘点 3:发退药 4:调拨
样例 : 1

integer (int32)

offset
可选

页偏移，如果按照日期拉取，则必填，默认值为0
最小值 : 0
样例 : 0

integer (int32)

limit
可选

每页大小，如果按照日期拉取，则必填，默认值为 10，最大值为 100
最小值 : 1
最大值 : 100
样例 : 10

integer (int32)

7.344. 连锁商品自定义分类

名称说明类型

id
可选

自定义分类ID
样例 : "43794"

string

typeId
可选

所属系统分类ID
样例 : 18

integer (int32)

name
可选

自定义分类名称
样例 : "物资"

string

7.345. 连锁商品自定义分类响应

名称说明类型

list
可选

连锁商品自定义分类列表
样例 : [ "连锁商品自定义分类" ]

< 连锁商品自定义分类 > array

7.346. 退费form请求

名称说明类型

id
必填

收费formId
样例 : "00000000000000000000000000000000"

integer (int64)

orderNo
可选

采购单号
样例 : "CG2024110600001"

string

purchaseOrderItemList
可选

采购单条目列表
样例 : [ "采购单条目" ]

< 采购单条目 > array

status
可选

采购单状态,0:待审核 1:审核通过 9:审核驳回 31:撤回
样例 : 0

integer (int32)

orderType
可选

采购类型，0：线下集采，10：ABC商城采购
样例 : 0

integer (int32)

purchaseOrganName
可选

采购门店名称
样例 : "string"

string

purchaseOrganId
可选

采购门店ID
样例 : "string"

string

applyEmployeeId
可选

申请人ID
样例 : "string"

string

applyEmployeeName
可选

申请人
样例 : "string"

string

purchaseOrderDate
可选

采购日期
样例 : "2024-11-06 16:51:03"

string (date-time)

created
可选

创建时间
样例 : "2024-11-06 16:51:03"

string (date-time)

7.352. 采购单列表

名称说明类型

purchaseOrderList
可选

采购单列表
样例 : [ "库存采购单信息" ]

< 库存采购单信息 > array

7.353. 采购单条目

名称说明类型

id
可选

条目ID
样例 : 123123

integer (int64)

productId
可选

商品ID
样例 : "ffffffff000000003473c049d7ab4000"

string

productShortId
可选

商品编码
样例 : "000251"

string

productName
可选

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

string

pieceCount
可选

采购小包装数量
样例 : 0.0

number

packageCount
可选

采购大包装数量
样例 : "盒"

number

7.354. 采购单详情

名称说明类型

comment
可选

备注
样例 : 评论

id
可选

采购单ID
样例 : 0

integer (int64)

orderNo
可选

采购单号
样例 : "CG2024110600001"

string

purchaseOrderItemList
可选

采购单条目列表
样例 : [ "采购单条目" ]

< 采购单条目 > array

status
可选

采购单状态,0:待审核 1:审核通过 9:审核驳回 31:撤回
样例 : 0

integer (int32)

orderType
可选

采购类型，0：线下集采，10：ABC商城采购
样例 : 0

integer (int32)

purchaseOrganName
可选

采购门店名称
样例 : "string"

string

purchaseOrganId
可选

采购门店ID
样例 : "string"

string

applyEmployeeId
可选

申请人ID
样例 : "string"

string

applyEmployeeName
可选

申请人
样例 : "string"

string

purchaseOrderDate
可选

采购日期
样例 : "2024-11-06 16:51:03"

string (date-time)

created
可选

创建时间
样例 : "2024-11-06 16:51:03"

string (date-time)

7.355. 门店人员列表返回体

名称说明类型

employeeList
可选

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

< 门店人员详细信息 > array

7.356. 门店人员详细信息

名称说明类型

id
可选

员工ID
样例 : "ffffffff0000000017ea20500df64000"

string

position
可选

职务
样例 : "string"

string

headImgUrl
可选

头像
样例 : "string"

string

name
可选

员工姓名
样例 : "张三"

string

mobile
可选

手机号
样例 : "13888888888"

string

sex
可选

性别
样例 : "男"

string

birthday
可选

出生日期
样例 : "1987-04-12"

string

role
可选

角色
样例 : "医生"

string

introduction
可选

介绍
样例 : "毕业于陆军军医大学临床医学七年制"

string

nationalDoctorCode
可选

国家医生编码
样例 : "string"

string

practiceInfos
可选

职称信息列表
样例 : [ "职称信息" ]

< 职称信息 > array

practiceImgUrl
可选

执业照
样例 : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/clinic-usage/fff730ccc5ee45d783d82a85b8a0e52d/license/dog_v2vHea4SK8gb.jpeg"

string

goodAt
可选

医生擅长
样例 : "擅长中医内科"

string

roles
可选

员工角色列表 0-管理员：1-医生 2-护士 3-检验师 4-理疗师 5-医助 6-其他 7-库管 8-采购 9-视光师 10-检查技师 11-咨询师 …
样例 : [ 1, 2, 3 ]

< integer (int32) > array

doctorTags
可选

医生标签
样例 : "省级名中医、市级名中医"

< string > array

7.357. 门店信息

名称说明类型

id
可选

门店ID
样例 : "fff730ccc5ee45d783d82a85b8a0e52d"

string

parentId
可选

连锁ID（总部ID）
样例 : "fff730ccc5ee45d783d82a85b8a0e520"

string

hisType
可选

门店类型 0:ABC诊所管家 1:口腔管家 2:眼科管家
样例 : 0

integer (int32)

name
可选

门店名称
样例 : "中医诊所高新店"

string

phone
可选

联系电话
样例 : "13888888888"

string

category
可选

门店类型
样例 : "中医诊所"

string

provinceName
可选

门店所处省份
样例 : "四川省"

string

cityName
可选

门店所处城市
样例 : "成都市"

string

districtName
可选

门店所处区域
样例 : "高新区"

string

addressDetail
可选

门店详细地址
样例 : "高新区100号"

string

7.358. 门店医生排班状态响应

名称说明类型

doctorShifts
可选

门店医生排班列表
样例 : [ "门店排班医生信息" ]

< 门店排班医生信息 > array

7.359. 门店排班医生信息

名称说明类型

showInWeClinic
可选

是否展示在微诊所 0:否 1:是，因为开放平台的接口返回的是所有排版的医生，如果接入方想要保持和微诊所一致的话，就能自己通过这个标识做过滤
样例 : 1

integer (int32)

doctor
可选

医生信息
样例 : 医生信息

医生信息

status
可选

integer (int32)

7.360. 门店摘要信息

名称说明类型

id
可选

机构ID
样例 : "string"

string

name
可选

机构名称
样例 : "string"

string

7.361. 门诊单信息

名称说明类型

id
可选

门诊单ID
样例 : "string"

string

patientId
可选

患者ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

registrationSheetId
可选

挂号单ID
样例 : "string"

string

departmentId
可选

就诊科室ID
样例 : "string"

string

departmentName
可选

就诊科室名称
样例 : "string"

string

doctorId
可选

就诊医生ID
样例 : "string"

string

doctorName
可选

就诊医生名字
样例 : "string"

string

created
可选

创建时间
样例 : "string"

string (date-time)

diagnosedDate
可选

首次完成诊断时间
样例 : "string"

string (date-time)

status
可选

状态 0:未诊 1:已诊
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "string"

string

medicalRecord
可选

病历记录信息
样例 : 病历信息

prescriptionChineseForms
可选

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

< 处方信息 > array

prescriptionWesternForms
可选

西药处方
样例 : [ "处方信息" ]

< 处方信息 > array

prescriptionInfusionForms
可选

输注处方
样例 : [ "处方信息" ]

< 处方信息 > array

prescriptionExternalForms
可选

外治处方
样例 : [ "处方信息" ]

< 处方信息 > array

productForms
可选

治疗单处方
样例 : [ "治疗单信息" ]

< 治疗单信息 > array

7.362. 门诊单摘要信息

名称说明类型

id
可选

门诊单ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

patient
可选

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

created
可选

创建时间
样例 : "string"

string (date-time)

doctorId
可选

就诊医生ID
样例 : "string"

string

doctorName
可选

就诊医生名字
样例 : "string"

string

patientOrderNo
可选

诊号
样例 : "0000000001"

string

status
可选

状态 0:未诊 1:已诊
样例 : 0

integer (int32)

statusName
可选

状态名称
样例 : "string"

string

7.363. 门诊单详细信息

名称说明类型

id
必填

门诊单ID
样例 : "string"

string

clinicId
必填

门店ID
样例 : "string"

string

patientOrderId
可选

就诊单ID
样例 : "string"

string

patientOrderNo
可选

诊号
样例 : "00019691"

string

departmentId
可选

就诊科室ID
样例 : "string"

string

departmentName
可选

就诊科室名称
样例 : "string"

string

doctorId
可选

就诊医生ID
样例 : "string"

string

doctorName
可选

就诊医生名字
样例 : "string"

string

created
必填

创建时间
样例 : "string"

string (date-time)

diagnosedDate
可选

首次完成诊断时间
样例 : "string"

string (date-time)

status
必填

状态 0:未诊 1:已诊
样例 : 0

integer (int32)

statusName
必填

状态名称
样例 : "string"

string

revisitStatus
可选

初复诊标识 1:初诊 2:复诊
样例 : 1

integer (int32)

patient
可选

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

medicalRecord
可选

病历记录信息
样例 : 病历信息