ABC数字医疗云开放平台

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/{patientId}/members

参数

类型

名称

说明

类型

Body

-
必填

新增或修改患者会员请求

Path

patientId
必填

患者ID

string

响应

HTTP Code

说明

类型

200

消耗

application/json

HTTP请求示例

请求 path

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

请求 body

{
  "memberTypeId" : "ffffffff0000000034b7a61b5a37c000",
  "sourceId" : "ffffffff0000000034b7a61b5a37c000",
  "sourceFromId" : "ffffffff0000000034b7a61b5a37c000",
  "remark" : "老客户"
}

HTTP响应示例

响应 200

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

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.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",
      "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",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "prescriptionChineseForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        }
      } ]
    } ],
    "prescriptionWesternForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        }
      } ]
    } ],
    "prescriptionInfusionForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        }
      } ]
    } ],
    "prescriptionExternalForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        }
      } ]
    } ],
    "productForms" : [ {
      "id" : "string",
      "type" : 2,
      "productFormItems" : [ {
        "id" : "string",
        "productFormId" : "string",
        "productId" : "string",
        "name" : "string",
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "isDismounting" : 0,
        "type" : 1,
        "subType" : 0,
        "days" : 0,
        "dailyDosage" : 0,
        "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",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "prescriptionChineseForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        }
      } ]
    } ],
    "prescriptionWesternForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        }
      } ]
    } ],
    "prescriptionInfusionForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        }
      } ]
    } ],
    "prescriptionExternalForms" : [ {
      "id" : "string",
      "type" : 1,
      "specification" : "string",
      "doseCount" : 0,
      "dailyDosage" : "string",
      "usage" : "string",
      "freq" : "string",
      "requirement" : "string",
      "usageLevel" : "string",
      "prescriptionFormItems" : [ {
        "id" : "string",
        "prescriptionFormId" : "string",
        "productId" : "string",
        "type" : 1,
        "subType" : 1,
        "name" : "string",
        "specification" : "string",
        "manufacturer" : "string",
        "usage" : "string",
        "ivgtt" : 0.0,
        "ivgttUnit" : "string",
        "freq" : "string",
        "dosage" : "string",
        "dosageUnit" : "string",
        "days" : 0,
        "specialRequirement" : "string",
        "isDismounting" : 0,
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "groupId" : 0,
        "isAst" : 0,
        "astResult" : {
          "result" : "阴性",
          "description" : "执行人：王萍，执行时间：2022-04-13"
        }
      } ]
    } ],
    "productForms" : [ {
      "id" : "string",
      "type" : 2,
      "productFormItems" : [ {
        "id" : "string",
        "productFormId" : "string",
        "productId" : "string",
        "name" : "string",
        "unitCount" : 0.0,
        "unit" : "string",
        "unitPrice" : 0.0,
        "isDismounting" : 0,
        "type" : 1,
        "subType" : 0,
        "days" : 0,
        "dailyDosage" : 0,
        "remark" : "小心使用"
      } ]
    } ]
  }
}

5.6.4. 按天查询门诊单

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

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

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

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

说明

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

参数

类型

名称

说明

类型

Body

-
必填

收费单支付请求

Path

chargeSheetId
必填

收费单ID

string

响应

HTTP Code

说明

类型

200

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

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

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

参数

类型

名称

说明

类型

Path

就诊单ID
必填

patientOrderId

string

响应

HTTP Code

说明

类型

200

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

5.7.7. 查询患者的收费单

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

说明

时间跨度最大为三个月

参数

类型名称说明类型默认值

Path

patientId
必填

患者ID

string

Query

beginDate
可选

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

string (date)

Query

endDate
可选

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

string (date)

Query

limit
可选

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

integer (int32)

10

Query

offset
可选

分页偏移

integer (int32)

0

Query

status
可选

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

string

响应

HTTP Code

说明

类型

200

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.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",
    "dispensingForms" : [ {
      "dispensingFormItems" : [ {
        "dispensingBatches" : [ {
          "action" : "发药",
          "stockId" : 0,
          "supplier" : {
            "id" : "string",
            "name" : "string"
          },
          "batchNo" : "string",
          "expiryDate" : "string",
          "packageCount" : 0.0,
          "pieceCount" : 0.0,
          "packageCostPrice" : 0.0,
          "created" : "2023-01-01 00:00:00"
        } ],
        "id" : "ffffffff00000000264a75300d757777",
        "status" : 1,
        "productId" : "02bb5357a5df05b65d028f8868472222",
        "productName" : "罗红霉素胶囊",
        "unit" : "12g/剂*3剂 的g",
        "unitCount" : "12g/剂*3剂 的12",
        "doseCount" : "12g/剂*3剂 的3 (同发药处方上的剂数相同)",
        "totalCount" : "12g/剂*3剂 的36=12*3 (totalCount = unitCount * doseCount)",
        "usageInfo" : {
          "usage" : "煎服",
          "freq" : "1日3次",
          "medicineRequirement" : "先煎",
          "doseCount" : 3,
          "dailyDosage" : "1日3剂",
          "requirement" : "饭前服用",
          "usageLevel" : "每次150ml",
          "processUsage" : "机器煎药（普通）",
          "processRemark" : "加工备注信息",
          "usageDays" : "约服30天"
        },
        "productInfo" : {
          "children" : [ {
            "children" : [ "..." ],
            "id" : "string",
            "name" : "阿莫西林",
            "shebao" : {
              "nationalCode" : "T001700643",
              "insuranceTypes" : [ {
                "insuranceType" : "391",
                "reimbursementRatio" : 0.1
              } ]
            },
            "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支/盒",
            "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
            } ]
          },
          "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支/盒",
          "status" : 1,
          "lastModified" : "2022-05-13 12:22:56",
          "goodsSpu" : {
            "id" : "string",
            "name" : "string",
            "brandName" : "string",
            "material" : "string"
          },
          "goodsSpec" : {
            "color" : "string",
            "spec" : "string"
          }
        },
        "totalPrice" : 10.3
      } ],
      "id" : "ffffffff00000000264a75300d759999",
      "dispseneFormType" : 0,
      "numberOfHerbs" : 0,
      "usageInfo" : {
        "usage" : "煎服",
        "freq" : "1日3次",
        "medicineRequirement" : "先煎",
        "doseCount" : 3,
        "dailyDosage" : "1日3剂",
        "requirement" : "饭前服用",
        "usageLevel" : "每次150ml",
        "processUsage" : "机器煎药（普通）",
        "processRemark" : "加工备注信息",
        "usageDays" : "约服30天"
      },
      "totalPrice" : 30.23
    } ],
    "id" : "ffffffff000000002620d6280d751234",
    "doctorId" : "ffffffff0000000022e9e9580179a123",
    "patientOrderId" : "ffffffff0000000022e9e9580179a123",
    "patientOrderNo" : "诊号：00003447",
    "diagnosedDate" : "2022-07-14 12:00:00",
    "medicalRecord" : {
      "id" : "string",
      "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
      "chiefComplaint" : "咽痛，干咳，咳痰",
      "pastHistory" : "既往体健，既往有高血压",
      "familyHistory" : "string",
      "presentHistory" : "string",
      "physicalExamination" : "string",
      "diagnosis" : "急性上呼吸道感染",
      "doctorAdvice" : "string",
      "syndrome" : "string",
      "therapy" : "string",
      "chineseExamination" : "string",
      "obstetricalHistory" : "string",
      "eyeExamination" : {
        "items" : [ {
          "key" : "string",
          "name" : "string",
          "rightEyeValue" : "string",
          "leftEyeValue" : "string"
        } ]
      },
      "allergicHistory" : "青霉素过敏",
      "attachments" : [ {
        "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
        "fileName" : "NatGeo09.jpg",
        "fileSize" : 4771201
      } ]
    },
    "patientInfo" : {
      "id" : "000000fc446f4dbd989857e305b00d6s",
      "name" : "张三",
      "mobile" : "18080000000",
      "sex" : "男",
      "birthday" : "1970-08-14",
      "age" : {
        "year" : 60,
        "month" : 2,
        "day" : 1
      },
      "idCard" : "630101200010075758"
    },
    "deliveryInfo" : {
      "addressProvinceName" : "四川省",
      "addressCityName" : "成都市",
      "addressDistrictName" : "高新区",
      "addressDetail" : "四川省成都市高新区xxx街道xxx",
      "deliveryName" : "张三",
      "deliveryMobile" : "18088888888",
      "deliveryCompany" : {
        "id" : "127203805890060288",
        "name" : "string"
      },
      "deliveryOrderNo" : "20827634879930368",
      "deliveryPayType" : 1
    },
    "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
  }
}

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",
      "chargeSheetId" : "string",
      "pharmacyNo" : 0,
      "pharmacyType" : 0,
      "status" : 0
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.8.3. 发药

PUT /api/v2/open-agency/dispensing/{dispenseSheetId}/dispense-all

参数

类型名称说明类型默认值

Path

dispenseSheetId
必填

发药单id

string

Query

operatorId
可选

发药员id

string

"00000000000000000000000000000000"

响应

HTTP Code

说明

类型

200

消耗

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",
      "dispensingForms" : [ {
        "dispensingFormItems" : [ {
          "dispensingBatches" : [ {
            "action" : "发药",
            "stockId" : 0,
            "supplier" : {
              "id" : "string",
              "name" : "string"
            },
            "batchNo" : "string",
            "expiryDate" : "string",
            "packageCount" : 0.0,
            "pieceCount" : 0.0,
            "packageCostPrice" : 0.0,
            "created" : "2023-01-01 00:00:00"
          } ],
          "id" : "ffffffff00000000264a75300d757777",
          "status" : 1,
          "productId" : "02bb5357a5df05b65d028f8868472222",
          "productName" : "罗红霉素胶囊",
          "unit" : "12g/剂*3剂 的g",
          "unitCount" : "12g/剂*3剂 的12",
          "doseCount" : "12g/剂*3剂 的3 (同发药处方上的剂数相同)",
          "totalCount" : "12g/剂*3剂 的36=12*3 (totalCount = unitCount * doseCount)",
          "usageInfo" : {
            "usage" : "煎服",
            "freq" : "1日3次",
            "medicineRequirement" : "先煎",
            "doseCount" : 3,
            "dailyDosage" : "1日3剂",
            "requirement" : "饭前服用",
            "usageLevel" : "每次150ml",
            "processUsage" : "机器煎药（普通）",
            "processRemark" : "加工备注信息",
            "usageDays" : "约服30天"
          },
          "productInfo" : {
            "children" : [ {
              "children" : [ "..." ],
              "id" : "string",
              "name" : "阿莫西林",
              "shebao" : {
                "nationalCode" : "T001700643",
                "insuranceTypes" : [ {
                  "insuranceType" : "391",
                  "reimbursementRatio" : 0.1
                } ]
              },
              "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支/盒",
              "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
              } ]
            },
            "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支/盒",
            "status" : 1,
            "lastModified" : "2022-05-13 12:22:56",
            "goodsSpu" : {
              "id" : "string",
              "name" : "string",
              "brandName" : "string",
              "material" : "string"
            },
            "goodsSpec" : {
              "color" : "string",
              "spec" : "string"
            }
          },
          "totalPrice" : 10.3
        } ],
        "id" : "ffffffff00000000264a75300d759999",
        "dispseneFormType" : 0,
        "numberOfHerbs" : 0,
        "usageInfo" : {
          "usage" : "煎服",
          "freq" : "1日3次",
          "medicineRequirement" : "先煎",
          "doseCount" : 3,
          "dailyDosage" : "1日3剂",
          "requirement" : "饭前服用",
          "usageLevel" : "每次150ml",
          "processUsage" : "机器煎药（普通）",
          "processRemark" : "加工备注信息",
          "usageDays" : "约服30天"
        },
        "totalPrice" : 30.23
      } ],
      "id" : "ffffffff000000002620d6280d751234",
      "doctorId" : "ffffffff0000000022e9e9580179a123",
      "patientOrderId" : "ffffffff0000000022e9e9580179a123",
      "patientOrderNo" : "诊号：00003447",
      "diagnosedDate" : "2022-07-14 12:00:00",
      "medicalRecord" : {
        "id" : "string",
        "outpatientSheetId" : "ffffffff00000000094c2a500293c000",
        "chiefComplaint" : "咽痛，干咳，咳痰",
        "pastHistory" : "既往体健，既往有高血压",
        "familyHistory" : "string",
        "presentHistory" : "string",
        "physicalExamination" : "string",
        "diagnosis" : "急性上呼吸道感染",
        "doctorAdvice" : "string",
        "syndrome" : "string",
        "therapy" : "string",
        "chineseExamination" : "string",
        "obstetricalHistory" : "string",
        "eyeExamination" : {
          "items" : [ {
            "key" : "string",
            "name" : "string",
            "rightEyeValue" : "string",
            "leftEyeValue" : "string"
          } ]
        },
        "allergicHistory" : "青霉素过敏",
        "attachments" : [ {
          "url" : "https://cd-cis-static-assets-dev.oss-cn-chengdu.aliyuncs.com/123.jpg",
          "fileName" : "NatGeo09.jpg",
          "fileSize" : 4771201
        } ]
      },
      "patientInfo" : {
        "id" : "000000fc446f4dbd989857e305b00d6s",
        "name" : "张三",
        "mobile" : "18080000000",
        "sex" : "男",
        "birthday" : "1970-08-14",
        "age" : {
          "year" : 60,
          "month" : 2,
          "day" : 1
        },
        "idCard" : "630101200010075758"
      },
      "deliveryInfo" : {
        "addressProvinceName" : "四川省",
        "addressCityName" : "成都市",
        "addressDistrictName" : "高新区",
        "addressDetail" : "四川省成都市高新区xxx街道xxx",
        "deliveryName" : "张三",
        "deliveryMobile" : "18088888888",
        "deliveryCompany" : {
          "id" : "127203805890060288",
          "name" : "string"
        },
        "deliveryOrderNo" : "20827634879930368",
        "deliveryPayType" : 1
      },
      "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
    } ]
  }
}

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"
      }
    } ],
    "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"
      }
    } ],
    "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
  } ],
  "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"
      }
    } ],
    "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
  } ],
  "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"
      }
    } ],
    "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

消耗

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

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

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" : "大源店",
      "receivableFee" : 0.0,
      "chargeSheetId" : "ffffffff00000000264a75300d752999",
      "departmentName" : "内科",
      "employeeName" : "张三",
      "chargeName" : "李四",
      "totalPrice" : 20.0,
      "adjustmentPrice" : 0.0,
      "discountPrice" : -9.0,
      "deductPrice" : 0.0,
      "amount" : 11.0,
      "created" : "2022-04-28 15:41:27",
      "sourceType" : "门诊",
      "action" : "收费",
      "patientName" : "张三",
      "no" : 100,
      "payMode" : "支付宝",
      "comment" : "-"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.10.2. 收费明细-分类

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

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string

Query

limit
可选

每页显示条数

integer (int32)

20

Query

offset
可选

分页起始下标

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

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

HTTP响应示例

响应 200

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

5.10.3. 收费明细-明细

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

参数

类型名称说明类型默认值

Query

date
必填

日期（格式yyyy-MM-dd）

string

Query

limit
必填

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

integer (int32)

20

Query

offset
必填

分页起始下标

integer (int32)

0

响应

HTTP Code

说明

类型

200

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

HTTP请求示例

请求 path

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

HTTP响应示例

响应 200

{
  "data" : {
    "rows" : [ {
      "clinicName" : "大源店",
      "name" : "血清胰岛素、",
      "count" : 1.0,
      "departmentName" : "内科",
      "employeeName" : "张三",
      "price" : 5.0,
      "chargeName" : "李四",
      "feeType1" : "治疗",
      "feeType2" : "-",
      "totalPrice" : 20.0,
      "adjustmentPrice" : 0.0,
      "productType" : 1,
      "discountPrice" : -9.0,
      "productSubType" : 20,
      "deductPrice" : 0.0,
      "productCustomType" : 1000,
      "amount" : 11.0,
      "patientId" : "ffffffff00000000220e67a8116d8000",
      "created" : "2022-04-28 15:41:27",
      "sourceType" : "门诊",
      "action" : "收费",
      "patientName" : "张三",
      "no" : 100,
      "payMode" : "支付宝",
      "comment" : "-"
    } ],
    "total" : 100,
    "offset" : 0,
    "limit" : 10
  }
}

5.11. 事件推送接口

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

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

参数

类型

名称

说明

类型

Path

appId
必填

应用id

string

Query

date
必填

日期（格式yyyy-MM-dd）

string

Query

limit
必填

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

integer (int32)

Query

offset
必填

分页起始下标

integer (int32)

响应

HTTP Code

说明

类型

200

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,
      "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,
        "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,
          "composeChildren" : [ "..." ]
        } ]
      } ]
    } ],
    "status" : 1,
    "created" : "2022-04-06 15:12:53",
    "sellerId" : "ffffffff000000003484c3816487c002",
    "sellerName" : "张三"
  }
}

5.13.3. 执行

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

参数

类型

名称

说明

类型

Body

-
必填

执行单执行请求参数

Path

id
必填

执行单ID

string

响应

HTTP Code

说明

类型

200

消耗

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
  }
}

6. 模型定义

6.1. JsonNode

类型 : object

6.2. OSS开放Token

名称说明类型

endpoint
可选

endpoint
样例 : "string"

string

bucket
可选

bucket
样例 : "string"

string

fileDir
可选

文件目录
样例 : "string"

string

securityToken
可选

安全令牌
样例 : "string"

string

accessKeySecret
可选

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

string

名称说明类型

usageType
可选

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

integer (int32)

usageSubType
可选

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

integer (int32)

unitCount
可选

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

number

totalCount
可选

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

number

price
可选

加工费
样例 : 0.0

number

remark
可选

备注
样例 : "string"

string

6.79. 事件推送详情

名称说明类型

id
可选

ID
样例 : "2730297344132816890"

string

appId
可选

应用ID
样例 : "1928374655"

string

appCallBackUrl
可选

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

string

callBackBody
可选

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

事件推送请求

failReason
可选

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

string

status
可选

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

integer (int32)

created
可选

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

string (date-time)

6.80. 事件推送请求

名称说明类型

clinicId
可选

机构ID
样例 : "string"

string

eventModule
可选

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

integer (int32)

eventType
可选

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

integer (int32)

eventName
可选

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

string

eventData
可选

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

JsonNode

6.81. 交易记录商品明细

名称说明类型

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

6.82. 会员信息

名称说明类型

principal
可选

本金
样例 : 2866.6

number

present
可选

赠金
样例 : 368.0

number

created
可选

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

string (date-time)

memberTypeInfo
可选

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

会员类型信息

6.83. 会员类型信息

名称说明类型

id
必填

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

string

name
必填

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

string

6.84. 住址

名称说明类型

addressProvinceId
可选

省编码
样例 : "510000"

string

addressProvinceName
可选

省名称
样例 : "四川"

string

addressCityId
可选

市编码
样例 : "510100"

string

addressCityName
可选

市名称
样例 : "成都市"

string

addressDistrictId
可选

区编码
样例 : "510109"

string

addressDistrictName
可选

区名称
样例 : "高新区"

string

addressDetail
可选

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

string

6.85. 供应商档案信息

addTagIds
可选

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

< string > array

deleteTagIds
可选

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

< string > array

operatorId
可选

操作人ID
样例 : "string"

string

6.90. 修改患者请求体

名称说明类型

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

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

名称说明类型

addressProvinceId
必填

省编码
样例 : "510000"

string

addressProvinceName
可选

省名称
样例 : "四川"

string

addressCityId
必填

市编码
样例 : "510100"

string

addressCityName
可选

市名称
样例 : "成都市"

string

addressDistrictId
必填

区编码
样例 : "510109"

string

addressDistrictName
可选

区名称
样例 : "高新区"

string

addressDetail
可选

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

string

deliveryName
必填

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

string

deliveryMobile
必填

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

string

deliveryCompanyName
必填

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

string

deliveryFee
可选

快递费，寄付时快递费必填
样例 : 12.0

number

deliveryOrderNo
可选

快递单号
样例 : "string"

string

deliveryPayType
必填

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

integer (int32)

operatorId
必填

操作人ID
样例 : "00000000000000000000000000000000"

string

6.92. 入库单事件

名称说明类型

id
可选

入库单ID
样例 : 0

integer (int64)

inOrderItemList
可选

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

< 入库单条目 > array

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

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

integer (int32)

organName
可选

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

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

operator
可选

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

string

supplier
可选

供应商
样例 : "string"

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

type
可选

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

integer (int32)

6.93. 入库单条目

名称说明类型

id
可选

条目ID
样例 : 0

integer (int64)

productId
可选

商品编码
样例 : "string"

string

productShortId
可选

商品short编码
样例 : "string"

string

productName
可选

商品名称
样例 : "string"

string

specification
可选

规格
样例 : "string"

string

expiryDate
可选

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

string

productionDate
可选

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

string

pieceNum
可选

制剂数量
样例 : 5.0

number

pieceUnit
可选

制剂单位
样例 : "片"

string

packageUnit
可选

包装单位
样例 : "盒"

string

packageCostPrice
可选

包装成本单价
样例 : 0.0

number

packageCount
可选

入库包装数量
样例 : 0.0

number

pieceCount
可选

入库制剂数量
样例 : 0.0

number

amount
可选

金额
样例 : 0.0

number

batchNo
可选

生产批号
样例 : "string"

string

lastModified
可选

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

string (date-time)

6.94. 入库单详情

名称说明类型

comment
可选

备注
样例 : 评论

id
可选

入库单ID
样例 : 0

integer (int64)

inOrderItemList
可选

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

< 入库单条目 > array

orderNo
可选

入库单号
样例 : "RK20220526000001"

string

status
可选

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

integer (int32)

organName
可选

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

string

amount
可选

含税金额
样例 : 6033.23

number

count
可选

数量
样例 : 12.0

number

kindCount
可选

品种数量
样例 : 5

integer (int32)

operator
可选

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

string

supplier
可选

供应商
样例 : "string"

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

pharmacy
可选

入库药房
样例 : 药房详情

type
可选

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

integer (int32)

6.95. 出库单事件

名称说明类型

id
可选

出库单id
样例 : 0

integer (int64)

outOrderItemList
可选

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

< 出库单条目 > array

orderNo
可选

出库单号
样例 : "CK20220526000001"

string

status
可选

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

integer (int32)

organName
可选

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

string

type
可选

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

integer (int32)

kindCount
可选

品种数量
样例 : 5

integer (int32)

count
可选

数量
样例 : 12.0

number

amount
可选

含税金额
样例 : 6033.23

number

receiver
可选

领取人
样例 : "string"

string

operator
可选

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

string

effectiveDate
可选

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

string (date-time)

lastModified
可选

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

string (date-time)

inOrderId
可选

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

string

pharmacy
可选

出库药房
样例 : 药房详情

6.96. 出库单条目

名称说明类型

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

6.97. 出库单详情

名称说明类型

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

出库药房
样例 : 药房详情