diff --git a/src/main/java/com/glxp/mipsdl/req/base/UdiwmsOrderDetailRequest.java b/src/main/java/com/glxp/mipsdl/req/base/UdiwmsOrderDetailRequest.java index 7c0cd03..84a7c6a 100644 --- a/src/main/java/com/glxp/mipsdl/req/base/UdiwmsOrderDetailRequest.java +++ b/src/main/java/com/glxp/mipsdl/req/base/UdiwmsOrderDetailRequest.java @@ -121,6 +121,9 @@ public class UdiwmsOrderDetailRequest { */ private String serialNo; + /** + * 码明细 + */ private List codeList; /** diff --git a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsBusTypeResponse.java b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsBusTypeResponse.java index 4797412..fbfe137 100644 --- a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsBusTypeResponse.java +++ b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsBusTypeResponse.java @@ -8,7 +8,24 @@ public class UdiwmsBusTypeResponse { @JsonIgnore private String id; + + /** + * 单据类型名称 + */ private String code; + + /** + * 单据类型名称 + */ private String name; + + /** + * 出入库类型 1：入库 2：出库 + */ + private Integer inoutType; + + /** + * 备注 + */ private String remark; } diff --git a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsInvProductResponse.java b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsInvProductResponse.java index cae4b31..de5e608 100644 --- a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsInvProductResponse.java +++ b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsInvProductResponse.java @@ -5,6 +5,9 @@ import lombok.Data; @Data public class UdiwmsInvProductResponse { + /** + * 库存产品编码 + */ private String code; private String name; private String spec; diff --git a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsOrderResponse.java b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsOrderResponse.java index 966ea21..c97a966 100644 --- a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsOrderResponse.java +++ b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsOrderResponse.java @@ -8,6 +8,10 @@ import java.util.List; public class UdiwmsOrderResponse { private String billNo; + + /** + * 单据日期 + */ private String billdate; private String corpId; private String corpName; @@ -21,7 +25,11 @@ public class UdiwmsOrderResponse { private String startDate; //起始时间 private String endDate; //结束时间 - private String billFlag; //单据状态 + + /** + * 单据状态 + */ + private String billFlag; private String createUser; //创建人 private String reviewUser; //审核人 private String address; //地址 diff --git a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsProductInfoResponse.java b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsProductInfoResponse.java index 4d45f2e..c1cd402 100644 --- a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsProductInfoResponse.java +++ b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsProductInfoResponse.java @@ -13,22 +13,57 @@ import java.util.Date; @Builder public class UdiwmsProductInfoResponse { - - private String code; //产品编码 - private String name; //通用名称 - private String measname; //计量单位 - private String spec; //规格型号 - private String registerNo; //注册证号 - private String manufactory; //生产厂家 - private String supName; //配送企业 - - private Date updateTime; //更新时间 - private boolean isChecked; // - - //产品类别 + /** + * 产品编码 + */ + private String code; + + /** + * 通用名称 + */ + private String name; + + /** + * 计量单位 + */ + private String measname; + + /** + * 规格型号 + */ + private String spec; + + /** + * 注册证号 + */ + private String registerNo; + + /** + * 生产厂家 + */ + private String manufactory; + + /** + * 配送企业 + */ + private String supName; + + /** + * 更新时间 + */ + private Date updateTime; + + + private boolean isChecked; + + /** + * 产品类别 + */ private String cplb; - //分类编码 + /** + * 分类编码 + */ private String flbm; //器械类别 @@ -82,8 +117,24 @@ public class UdiwmsProductInfoResponse { //阳光采购平台 耗材目录规格id private String productSpecId; + /** + * 物资编码 + */ private String hospHisCode; + + /** + * 价格 + */ private String price; + /** + * 生产厂家编码 + */ + private String manufactoryCode; + + /** + * 配送企业编码 + */ + private String supCode; } diff --git a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsUnitResponse.java b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsUnitResponse.java index 2077576..6e6cb8f 100644 --- a/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsUnitResponse.java +++ b/src/main/java/com/glxp/mipsdl/res/udiwms/UdiwmsUnitResponse.java @@ -5,12 +5,39 @@ import lombok.Data; @Data public class UdiwmsUnitResponse { - private String unitId; //必填 往来单位ID - private String name; //必填 往来单位名称 - private String spell; //往来单位简称 - private String addr; //地址 - private String creditNo; //社会信用号 - private String contact; //联系人 - private String mobile; //联系电话 + /** + * 必填 往来单位ID + */ + private String unitId; + + /** + * 必填 往来单位名称 + */ + private String name; + + /** + * 往来单位简称 + */ + private String spell; + + /** + * 地址 + */ + private String addr; + + /** + * 社会信用号 + */ + private String creditNo; + + /** + * 联系人 + */ + private String contact; + + /** + * 联系电话 + */ + private String mobile; } diff --git a/第三方接口文档_01.docx b/第三方接口文档_01.docx deleted file mode 100644 index c0a5ac3..0000000 --- a/第三方接口文档_01.docx +++ /dev/null @@ -1,2184 +0,0 @@ - - - - UDI管理系统 - 第三方接口说明文档 - - - - 版本号<3.0> - 发布时间<20200506> - 初稿编写人<翟润虎> - 修订人<吴毅鹏,叶文杰> - 版本管理 - 版本号 - 操作者 - 内容 - 操作日期 - 审批者 - 审批日期 - 2.0 -翟闰虎 -第三方接口需求 -2022-05-06 -叶文杰 -2022-05-08 - 3.0 -叶文杰 -第三方接口需求 -2022-09-15 -吴毅鹏 -2022-09-18 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 目录 - 1 公共参数 6 -2 接口调用方式 6 -3 接口需求列表 6 - 3.1 A001单位往来信息查询 9 - 3.1.1 接口说明 9 - 3.1.2 使用场景 9 - 3.1.3 输入参数说明 10 - 3.1.4 输入参数示例 10 - 3.1.5 返回说明 10 - 3.1.6 返回示例 10 - 3.2 A002产品信息查询 11 - 3.2.1 接口说明 11 - 3.2.2 使用场景 12 - 3.2.3 输入参数说明 12 - 3.2.4 输入参数示例 12 - 3.2.5 返回说明 12 - 3.2.6 返回示例 13 - 2.3 A003仓库(科室)信息查询 15 - 3.3.1 接口说明 15 - 3.2.2 使用场景 15 - 3.3.3 输入参数示例 15 - 3.3.4 输入参数说明 15 - 3.3.5 返回说明 16 - 3.3.6 返回示例 16 - 3.4 A004单据类型信息查询 17 - 3.4.1 接口说明 17 - 3.4.2 使用场景 17 - 3.4.3 输入参数说明 18 - 3.4.4 输入参数示例 18 - 3.4.5 返回说明 18 - 3.4.6 返回示例 18 - 2.5 A005单据(订单)信息查询 19 - 3.5.1 接口说明 19 - 3.5.2 使用场景 20 - 3.5.3 输入参数说明 20 - 3.5.5 输入参数示例 20 - 3.5.6 返回说明 20 - 3.5.7 返回示例 21 - 3.6 A006产品库存信息查询 24 - 3.6.1 接口说明 24 - 3.6.2 使用场景 24 - 3.6.3 输入参数示例 24 - 3.6.4 参数说明 25 - 3.6.5 返回说明 25 - 3.6.6 返回示例 26 - 3.7 A007患者信息查询 28 - 3.7.1 接口说明 28 - 3.7.2 使用场景 28 - 3.8 B001接收新增产品信息 28 - 3.8.1 接口说明 28 - 3.8.2 使用场景 28 - 3.8.3 输入参数示例 28 - 3.8.4 输入参数说明 29 - 3.8.5 返回说明 30 - 3.8.6 返回示例 30 - 3.9 B002接收新增往来单位信息 31 - 3.9.1 接口说明 31 - 3.9.2 使用场景 31 - 3.9.3 输入参数示例 31 - 3.9.4 输入参数说明 32 - 3.9.5 返回说明 32 - 3.8.6 返回示例 32 - 3.10 B003接收单据(订单)信息 32 - 3.10.1 接口说明 32 - 3.10.2 使用场景 33 - 3.10.3 输入参数示例 33 - 3.10.4 输入参数说明 35 - 3.10.5 返回说明 36 - 3.10.6 返回示例 36 - 3.11 C001产品库存信息查询 37 - 3.11.1 接口说明 37 - 3.11.2 使用场景 37 - 3.11.3 输入参数示例 37 - 3.11.4 参数说明 37 - 3.11.5 返回说明 37 - 3.11.6 返回示例 38 - - - - - - - - - - - - - - - - - - -名词解释 -"第三方系统"：一般是指医院已经在使用的其它系统，如：物资管理系统、HIS系统、试剂管理系统、结算系统、医保系统等等。 -"往来单位"：是供应商、客户等的统称。 -"统一编码"：是指院内各第三方系统（物资系统、HIS系统等）采用相同耗材字典、供应商字典等。 -单据类型：进行出入库作业的单据类型，如采购入库单、临床使用出库单、调拨出库单、调拨入库单等等。 - -公共参数 - 公共参数（api_key和secret_key）是"医院第三方系统"根据系统安全需要，可以提供给"医院UDI管理系统"调用接口时需要安全认证的信息，接口权限验证使用头部参数校验，"医院UDI管理系统"在发起调用时将接口授权参数携带在请求头（Header）中发送。 - 参数名称 - 是否必填 - 示例 - 参数说明 - api_key - 是 - ewKD2Cyr - - secret_key - 是 - rO4nDvNWKJ1uNuQQBnECPjnpDv4w6nh8 - -接口调用方式 -接口统一采用HTTP协议，调用时需要在请求头部中传递公共参数。 -接口地址为"服务地址 + 接口方法名"组成，接口参数要求参考对应接口参数说明。 - 3 接口需求列表 - "医院UDI管理系统"支持多系统数据交互服务，第三方服务模块提供公开的数据主动推送、主动查询和被查询服务，满足医院实际业务作业需要，"医院第三方系统"需要根据下表接口需求，具体实现接口。一般医院耗材流通包括以下环节: - 耗材采购 -- > 科室领用 -- > 临床使用 -- > 费用结算 - 注意，如果院内有多套第三方系统需要和UDI管理系统进行互联互通，并且这多套系统基础数据编码不统一，那么基础数据编码不统一的院内第三方系统需要分别实现接口需求列表中的部分或全部接口。 - - 提供被查询接口：由院内第三方系统各相关业务系统具体实现的被查询接口，各相关业务系统包括但不限于物资管理系统、试剂管理系统、HIS系统、结算系统、医保、集采等系统。 -编号 - 接口名称 - 使用场景描述 -A001 -单位往来信息查询 -(供应商信息查询) - 医院第三方系统提供往来单位信息查询接口，UDI管理系统通过此接口获取院内第三方系统的往来单位信息。当UDI管理系统和院内第三方系统的业务数据（接口A005、B002和B003）需要交互时，UDI管理系统能够自动把往来单位编码转换为符合双方系统的编码，再进行提交或保存。院内管理采购的系统（物资管理系统）必须实现本接口。 -A002 -产品信息查询 -(耗材字典查询) - 医院第三方系统提供产品信息查询接口，UDI管理系统通过此接口获取院内第三方系统的产品信息。当UDI管理系统和院内第三方系统的业务数据（接口A005、B001和B003）需要交互时，UDI管理系统能够自动把产品信息编码转换为符合双方系统的编码，再进行提交或保存。因此，除了院内管理采购的系统（物资管理系统）必须实现本接口外，其它需要进行出入库作业的各相关第三方系统通常也需要实现本接口，除非院内各第三方系统已经实现统一编码管理，其它业务系统则无需再实现此接口。 -A003 -仓库/科室信息查询 - 医院第三方系统提供的仓库/科室信息查询接口，UDI管理系统通过此接口获取院内第三方系统的仓库/科室信息。当UDI管理系统和院内第三方系统的业务单据信息（接口A005和B003）交互时，提交或获取的单据信息如果包含仓库/科室信息，则院内各相关第三方系统必须实现本接口。 -A004 -单据类型信息查询 - 医院第三方系统提供的单据类型信息查询接口，UDI管理系统通过此接口获取院内第三方系统的单据类型信息。当UDI管理系统需要和院内第三方目标系统交换业务单据信息（接口A005和B003）时，则院内各相关第三方目标系统必须实现本接口。 -A005 -单据(订单)信息查询 - 医院第三方系统提供的单据(订单)信息查询接口，UDI管理系统通过此接口获取院内第三方系统的单据(订单)信息。由院内第三方目标系统发起相关的业务，如采购订单、调拨(领用)单等，并需要把相关业务单据信息推送给UDI管理系统，则院内各相关第三方目标系统必须实现本接口。 -A006 -产品库存信息查询 - 医院第三方系统提供的产品库存信息查询接口，UDI管理系统通过此接口获取院内第三方仓库管理系统的产品库存信息，进行相关业务处理。当院内第三方系统需要对库存进行实时校验或定期扫码盘点时，院内各相关第三方系统必须实现本接口。 -A007 -患者信息查询 - 医院第三方系统提供的患者信息查询接口，UDI管理系统通过此接口获取院内第三方医嘱（HIS）系统的患者相关信息(病历、医嘱、处方)。UDI管理系统可以根据取得的患者信息，临床使用出库信息，统计患者耗材使用情况详细信息，可追溯溯源至耗材的单品或批次。 - 提供接收接口 -编号 - 接口名称 - 使用场景描述 -B001 -接收新增产品信息 - 医院第三方系统提供的接收新增产品信息接口，UDI管理系统通过此接口把供应商新增的配送产品信息推送至院内第三方系统（一般指物资管理系统），新增的产品信息为未审核状态。院内采购入库的第三方系统可以实现本接口，简化操作人员基础数据录入。 -B002 -接收新增往来单位信息 - 医院第三方系统提供的接收新增往来单位信息接口，UDI管理系统通过此接口把医院新增的合格往来单位（供应商）信息推送至院内第三方系统（一般指物资管理系统），新增的往来单位信息为未审核状态。院内采购入库的第三方系统可以实现本接口，简化操作人员基础数据录入。 -B003 -接收单据(订单)信息 - 医院第三方系统提供的接收单据(订单)信息接口，UDI管理系统通过此接口把现场出入库扫码生成的业务单据信息推送至院内第三方系统。院内采购入库、临床使用出库和出库结算的各相关第三方系统必须实现本接口。 - 主动查询接口 -编号 - 接口名称 - 使用场景描述 -C001 -产品库存信息查询 - UDI管理系统提供产品库存查询接口，院内第三方系统可以通过此接口查询产品库存信息，产品库存信息包含产品信息、批次号、生产日期、失效日期、数量、计量单位等信息。可以方便院内第三方系统业务开单出库前查询相关产品库存情况，如HIS系统中医生给患者开处方前查看特定耗材库存情况。 - - 3.1 A001单位往来信息查询 - 3.1.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.1.2 使用场景 - 医院第三方系统提供往来单位信息查询接口，UDI管理系统通过此接口获取院内第三方系统的往来单位信息。当UDI管理系统和院内第三方系统的业务数据（接口A005、B002和B003）需要交互时，UDI管理系统能够自动把往来单位编码转换为符合双方系统的编码，再进行提交或保存。院内管理采购的系统（物资管理系统）必须实现本接口。 - - 3.1.3 输入参数说明 - 参数名称 - 是否必填 - 类型 - 示例 - 参数说明 - lastUpdateTime - 否 - String - 2020-01-05 12:00:00 -最后更新时间 - unitId - 否 - String - 1673 -往来单位编码，支持模糊查询 - name - 否 - String - 福建省诏安县医院 -往来单位名称，支持模糊查询 - page - 是 - Integer - 1 - 页码 - limit - 是 - Integer - 50 - 条数 - 3.1.4 输入参数示例 -{ - "lastUpdateTime": "2020-01-05 12:00:00", - "unitId": "1673", - "name": "福建省诏安县医院", - "page": "1", - "limit": "50" -} - 3.1.5 返回说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - unitId - String - 是 - 1673 -往来单位ID - name - String - 是 - 福建省诏安县医院 -往来单位名称 - lastUpdateTime - String - 是 - 2020-01-05 12:00:00 -最后更新时间 - addr - String - 是 - 诏安县南诏镇江厝前路65号 -地址 - creditNo - String - 是 - 123506244897495930 -社会信用号 - contact - String - 是 - 沈主任 -联系人 - mobile - String - 是 - 13300000000 -联系电话 - 3.1.6 返回示例 -成功 -{ - "code": 20000, - "message": "success", - "data": { - "total": 300, - "list": [ - { - "unitId": "2468", - "name": "福建省诏安县医院", - "addr": "诏安县南诏镇江厝前路65号", - "creditNo": "123506244897495930", - "contact": "沈主任", - "mobile": "1330000000" - }, - { - "unitId": "2469", - "name": "福建省诏安县医院11", - "addr": "诏安县南诏镇江厝前路65号", - "creditNo": "123506244897495930", - "contact": "沈主任", - "mobile": "1330000000" - } - ] - } -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - 3.2 A002产品信息查询 - 3.2.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.2.2 使用场景 - 医院第三方系统提供产品信息查询接口，UDI管理系统通过此接口获取院内第三方系统的产品信息。当UDI管理系统和院内第三方系统的业务数据（接口A005、B001和B003）需要交互时，UDI管理系统能够自动把产品信息编码转换为符合双方系统的编码，再进行提交或保存。因此，除了院内管理采购的系统（物资管理系统）必须实现本接口外，其它需要进行出入库作业的各相关第三方系统通常也需要实现本接口，除非院内各第三方系统已经实现统一编码管理，其它业务系统则无需再实现此接口。 - 3.2.3 输入参数说明 - 参数名称 - 是否必填 - 类型 - 示例 - 参数说明 - lastUpdateTime - 否 - String - -最后更新时间 - code - 否 - String - -产品编码，支持模糊查询 - name - 否 - String - -器械通用名，支持模糊查询 - standard - 否 - String - -规格型号，支持模糊查询 - registerNo - 否 - String - -注册/备案号，支持模糊查询 - manufactory - 否 - String - -生产厂家 - ybbm - 否 - String - -医保编码 - page - 是 - Integer - -页码 - limit - 是 - Integer - -条数 - 3.2.4 输入参数示例 -{ - "lastUpdateTime": "2020-01-05 12:00:00", - "code": "6555", - "name": "下肢直型锁定", - "standard": "12孔", - "registerNo": "20153461024", - "manufactory": "江苏艾迪尔", - "ybbm": "32543534534", - "page": "1", - "limit": "50" -} - 3.2.5 返回说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - lastUpdateTime - String - 是 - -最后更新时间 - code - String - 是 - -产品编码 - name - String - 是 - -产品名称 - measname - String - 是 - -计量单位 - standard - String - 是 - -规格型号 - registerNo - String - 是 - -注册/备案号 - manufactoryCode - String - 是 - -生产厂家编码 - manufactory - String - 是 - -生产厂家 - supCode - String - 是 - -配送企业编码 - supName - String - 是 - -配送企业 - cplb - String - 是 - -产品类别 - flbm - String - 是 - -分类编码 - qxlb - String - 是 - -器械类别 - ybbm - String - 是 - -医保编码 - sptm - String - 是 - -商品条码 - tyshxydm - String - 是 - -注册人社会信用号 - ylqxzcrbarmc - String - 是 - -注册人/备案人名称 - ylqxzcrbarywmc - String - 是 - -注册人/备案人英文名称 - cpms - String - 是 - -产品描述 - spmc - String - 是 - -商品名称 - qtbm - String - 是 - -其他编码 - zczyxqz - String - 是 - -注册证有效期截止时间 - price - String - 是 - -产品价格 - remark - String - 否 - -4个备注字段，需要提供的字段在列表中不存在，可以使用备注字段 - remark1 - String - 否 - - - remark2 - String - 否 - - - remark3 - String - 否 - - - 3.2.6 返回示例 -成功 -{ - "code": 20000, - "message": "success", - "data": { - "total": 100, - "list": [ - { - "code": "6555", - "name": "下肢直型锁定钢板", - "measname": "块", - "spec": "12孔", - "registerNo": "20153461024", - "manufactoryCode": "9000006836", - "manufactory": "江苏艾迪尔", - "supCode": "9000009163", - "supName": "南昌必理商贸有限公司", - " lastUpdateTime": "2022-03-26 09:03:36", - "cplb": "产品类别", - "flbm": "分类编码", - "qxlb": "器械类别", - "ybbm": "医保编码", - "sptm": "商品条码", - "tyshxydm": "注册人社会信用号", - "ylqxzcrbarmc": "注册/备案人名称", - "ylqxzcrbarywmc": "注册/备案人英文名称", - "cpms": "产品描述", - "model": "12孔", - "standard": null, - "spmc": "商品名称", - "qtbm": "其他编码", - "zczyxqz": "注册证有效期截止时间", - "remark":"进口代理商", - "remark1": null, - "remark2": null, - "remark3": null, - "supName ": "配送企业", - "price": "价格", - } - ] - } -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - A003仓库(科室)信息查询 - 3.3.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.2.2 使用场景 - 医院第三方系统提供的仓库/科室信息查询接口，UDI管理系统通过此接口获取院内第三方系统的仓库/科室信息。当UDI管理系统和院内第三方系统的业务单据信息（接口A005和B003）交互时，提交或获取的单据信息如果包含仓库/科室信息，则院内各相关第三方系统必须实现本接口。 - 3.3.3 输入参数示例 -{ - "inventoryCode": "1001", - "warehouseCode": "1001001", - "page": "1", - "limit": "50" -} - 3.3.4 输入参数说明 - 参数名称 - 是否必填 - 类型 - 示例 - 参数说明 - inventoryCode - 否 - String - - 仓库号，支持模糊查询 - warehouseCode - 否 - String - - 货位号，支持模糊查询 - page - 是 - Integer - 1 - 页码 - limit - 是 - Integer - 50 - 条数 - 3.3.5 返回说明 -参数名称 -是否必填 -类型 -示例 -参数说明 -code -是 -String - -仓库号 -name -是 -String - -仓库名称 -remark -否 -String - -备注 -details -是 -List -见下表 -单据详情数组 -单据明细表 - 参数名称 - 是否必填 - 类型 - 示例 - 参数说明 - code - 是 - String - -货位号 - name - 是 - String - -货位名称 - remark - 否 - String - -备注 - 3.3.6 返回示例 -成功 -{ - "code": 20000, - "message": "success", - "data": { - "total": 100, - "list": [ - { - "code": "1001", - "name": "仓库1", - "remark": "", - "details": [ - { - "code": "1001001", - "name": "货位1", - "remark": "" - } - ] - }, - { - "code": "1002", - "name": "仓库2", - "remark": "", - "details": [ - { - "code": "1001002", - "name": "货位1", - "remark": "" - } - ] - } - ] - } -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - 3.4 A004单据类型信息查询 - 3.4.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.4.2 使用场景 - 医院第三方系统提供的单据类型信息查询接口，UDI管理系统通过此接口获取院内第三方系统的单据类型信息。当UDI管理系统需要和院内第三方目标系统交换业务单据信息（接口A005和B003）时，则院内各相关第三方目标系统必须实现本接口。 - 3.4.3 输入参数说明 - 参数名称 - 是否必填 - 类型 - 示例 - 参数说明 - code - 否 - String - - 单据类型编码 - name - 否 - String - 采购入库 - 单据类型名称 - page - 是 - Integer - 1 - 页码 - limit - 是 - Integer - 10 - 条数 - 3.4.4 输入参数示例 -{ - "code": "cark", - "name": "采购入库", - "page": "1", - "limit": "50" - -} - - 3.4.5 返回说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - code - String - 是 - cgrk -单据类型编码 - name - String - 是 - 采购入库单 -单据类型名称 - inoutType - Int - 是 - 出库 -1:入库，2:出库 - remark - String - 否 - -备注 - 3.4.6 返回示例 -成功 -{ - "code": 20000, - "message": "success", - "data": { - "total": 100, - "list": [ - { - "code": "cgrk", - "name": "采购入库单", - "remark": "测试" - }, - { - "code": "syck", - "name": "使用出库单", - "remark": "测试" - }, - { - "code": "cgrk", - "name": "采购入库单", - "remark": "测试" - }, - { - "code": "syck", - "name": "使用出库单", - "remark": "测试" - } - ] - } -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - A005单据(订单)信息查询 - 3.5.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.5.2 使用场景 - 医院第三方系统提供的单据(订单)信息查询接口，UDI管理系统通过此接口获取院内第三方系统的单据(订单)信息。由院内第三方目标系统发起相关的业务，如采购订单、调拨(领用)单等，并需要把相关业务单据信息推送给UDI管理系统，则院内各相关第三方目标系统必须实现本接口。 - 3.5.3 输入参数说明 - 参数名称 - 是否必填 - 类型 - 示例 - 参数说明 - lastUpdateTime - 是 - String - - 最后更新时间 - billNo - 否 - String - - 单据号 - corpName - 否 - String - - 往来单位 - billType - 否 - String - - 单据类型 - page - 是 - Int - 1 - 页码 - limit - 是 - Int - 50 - 条数 - 3.5.5 输入参数示例 -{ - "lastUpdateTime": "2022-03-13 00:00:00", - "billNo": "SP2022031376813", - "corpName": "片仔癀诊断", - "billType": "采购入库", - "page": "1", - "limit": "50" -} - 3.5.6 返回说明 -单据主表 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - billNo - String - 是 - SP2022030 -单据号 - billFlag - String - 是 - -单据状态 - billdate - String - 是 - 2022-03-04 -单据日期 - billType - String - 是 - -单据类型 - corpId - String - 是 - -往来单位编码（1:若往来信息为供应商则为供应商编码；2.若往来信息为仓库/科室，则为仓库/科室对应编码） - inoutType - Int - 是 - -1:入库，2:出库 - corpName - String - 是 - -单据往来单位名称 - createUser - String - 是 - -创建人 - reviewUser - String - 是 - -审核人 - address - String - 是 - -地址 - linkMan - String - 是 - -联系人 - linkTel - String - 是 - -电话 - invCode - String - 是 - -单据所属仓库/科室编码 - invName - String - 是 - -单据所属仓库/科室名称 - remark - String - 是 - -备注 - detailList - List - 是 - 见下表 -订单详情数组 - -单据明细表 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - detailId - String - 是 - -单据号 - productId - String - 是 - 6533 -产品编码 - count - Integer - 是 - -单据数量 - batchNo - String - 是 - 202203 -批次号 - expireDate - String - 是 - -失效日期 - productDate - String - 是 - -生产日期 - reCount - Integer - 是 - -实际数量 - price - BigDecimal - 是 - 20.20 -单价 - productName - String - 是 - -产品名称 - standard - String - 是 - -规格型号 - measname - String - 是 - -计量单位 - registerNo - String - 是 - -注册/备案凭证号 - manufactory - String - 是 - -生产厂家 - remark - String - 否 - -备注 - remark1 - String - 否 - -备注1 - remark2 - String - 否 - -备注2 - remark3 - String - 否 - -备注3 - 3.5.7 返回示例 -成功 -{ - "code": 20000, - "message": "success", - "data": { - "total": 100, - "list": [ - { - "billNo": "SP2022031376813", - "billdate": "2022-03-13 00:00:00", - "corpId": null, - "corpName": null, - "billType": "ST54467264148", - "billFlag": "单据状态", - "createUser": "沈先生", - "reviewUser": "沈先生", - "address": "福建省厦门市集美区", - "linkMan": "沈先生", - "linkTel": "13306961860", - "inoutType": 1, - "remark": null, -"invCode": "555255", -"invName": "设备仓库", - "detailList": [ - { - "detailId": "29607390140", - "productId": "6555", - "productName": null, - "standard": null, - "batchNo": "202203", - "expireDate": "2022-03-27", - "productDate": "2022-03-25", - "measname": "克", - "count": 10, - "reCount": 0, - "corpName": "福建片仔癀诊断技术有限公司", - "price": 10, - "registerNo": "32423424242", -"manufactory": "大博医疗", - "remark": null, - "remark1": null, - "remark2": null, - "remark3": null - }, - { - "detailId": "29607390214", - "productId": "6555", - "productName": null, - "standard": null, - "batchNo": "202203", - "expireDate": "2022-03-27", - "productDate": "2022-03-25", - "measname": "克", - "count": 10, - "reCount": 0, - "corpName": "福建片仔癀诊断技术有限公司", - "price": 10, - "registerNo": "32423424242", - "manufactory": "大博医疗", - "remark": null, - "remark1": null, - "remark2": null, - "remark3": null - } - ] - } - ] - } -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - 3.6 A006产品库存信息查询 - 3.6.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.6.2 使用场景 - 医院第三方系统提供的产品库存信息查询接口，UDI管理系统通过此接口获取院内第三方仓库管理系统的产品库存信息，进行相关业务处理。当院内第三方系统需要对库存进行实时校验或定期扫码盘点时，院内各相关第三方系统必须实现本接口。 - 3.6.3 输入参数示例 -{ - "warehouseCode": "1001", - "warehouseName": "货位1", - "inventoryCode": "1", - "inventoryName": "总库", - "productName": "下肢直型锁定钢板", - "productId": "6555", - "standard": "12孔", - "registerNo": "20153461024", - "manufactory": "江苏艾迪尔", - "supName": "南昌必理商贸有限公司", - "page": 1, - "limit": 50 -} - 3.6.4 参数说明 - 参数名称 - 是否必填 - 类型 - 示例 - 参数说明 - inventoryCode - 否 - String - -仓库编号，支持模糊查询 - inventoryName - 否 - String - -仓库名称，支持模糊查询 - warehouseCode - 否 - String - -货位编号，支持模糊查询 - warehouseName - 否 - String - -货位名称，支持模糊查询 - productId - 否 - String - -产品编号，支持模糊查询 - productName - 否 - String - -产品名称，支持模糊查询 - standard - 否 - String - -规格型号，支持模糊查询 - registerNo - 否 - String - -注册/备案证号，支持模糊查询 - manufactory - 否 - String - -生产厂家 - supName - 否 - String - -供应商名称（配送企业），支持模糊查询 - page - 是 - Integer - 1 - 页码 - limit - 是 - Integer - 50 - 条数 - 3.6.5 返回说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - inventoryCode - String - 是 - 1 -仓库号 - inventoryName - String - 是 - 总库 -仓库名称 - warehouseCode - String - 是 - 1001 -货位号 - warehouseName - String - 是 - 货位1 -货位名称 - productId - String - 是 - -产品ID - batchNo - String - 是 - 202203 -批次号 - productDate - String - 是 - -生产日期 - expireDate - String - 是 - -失效日期 - count - String - 是 - -数量 - productName - String - 是 - -产品名称 - standard - String - 是 - -规格型号 - registerNo - String - 是 - -注册/备案证号 - measname - String - 是 - -计量单位 - manufactory - String - 是 - -生产厂家 - supId - String - 是 - -供应商ID（配送企业） - supName - String - 是 - -配送企业名称 - 3.6.6 返回示例 -成功 -{ - "code": 20000, - "message": "success", - "data": { - "total": 100, - "list":[ { - "batchNo": "202203", - "warehouseCode": "1001", - "warehouseName": "货位1", - "count": 10, - "inventoryCode": "1", - "inventoryName": "总库", - "productName": "下肢直型锁定钢板", - "productDate": "2022-03-25", - "expireDate": "2022-03-27", - "productId": "6555", - "standard": "12孔", - "registerNo": "20153461024", - "manufactory": "江苏艾迪尔", - "measname": "盒", - "supId": "2001", - "supName": "南昌必理商贸有限公司" - }, - { - "batchNo": "202203", - "warehouseCode": "1001", - "warehouseName": "货位1", - "count": 10, - "inventoryCode": "1", - "inventoryName": "总库", - "productName": "下肢直型锁定钢板", - "productDate": "2022-03-25", - "expireDate": "2022-03-27", - "productId": "6555", - "standard": "12孔", - "registerNo": "20153461024", - "manufactory": "江苏艾迪尔", - "measname": "盒", - "supId": "2001", - "supName": "南昌必理商贸有限公司" - } -] -} -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - - 3.7 A007患者信息查询 - 3.7.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.7.2 使用场景 - 医院第三方系统提供的患者信息查询接口，UDI管理系统通过此接口获取院内第三方医嘱（HIS）系统的患者相关信息(病历、医嘱、处方)。UDI管理系统可以根据取得的患者信息，临床使用出库信息，统计患者耗材使用情况详细信息，可追溯溯源至耗材的单品或批次。。 -3.8.3 输入参数示例 - - 3.8 B001接收新增产品信息 - 3.8.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.8.2 使用场景 - 医院第三方系统提供的接收新增产品信息接口，UDI管理系统通过此接口把供应商新增的配送产品信息推送至院内第三方系统（一般指物资管理系统），新增的产品信息为未审核状态。院内采购入库的第三方系统可以实现本接口，简化操作人员基础数据录入。 - 3.8.3 输入参数示例 - - { - "code": "6555", - "name": "下肢直型锁定钢板", - "measname": "块", - "spec": "12孔", - "registerNo": "20153461024", - "manufactory": "江苏艾迪尔", - "cplb": "产品类别", - "flbm": "分类编码", - "qxlb": "器械类别", - "ybbm": "医保编码", - "sptm": "商品条码", - "tyshxydm": "注册人社会信用号", - "ylqxzcrbarmc": "注册/备案人名称", - "ylqxzcrbarywmc": "注册/备案人英文名称", - "cpms": "产品描述", - "model": "12孔", - "standard": null, - "spmc": "商品名称", - "qtbm": "其他编码", - "zczyxqz": "注册证有效期截止时间", - "remark": null, - "remark1": null, - "remark2": null, - "remark3": null, - "supName ": "配送企业", - "price": "价格" - } - - 3.8.4 输入参数说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - code - String - 是 - -产品编码 - name - String - 是 - -产品名称 - measname - String - 否 - -计量单位 - standard - String - 否 - -规格型号 - registerNo - String - 否 - -注册/备案号 - manufactory - String - 否 - -生产厂家 - supName - String - 否 - -配送企业 - cplb - String - 否 - -产品类别 - flbm - String - 否 - -分类编码 - qxlb - String - 否 - -器械类别 - ybbm - String - 否 - -医保编码 - sptm - String - 否 - -商品条码 - tyshxydm - String - 否 - -注册人社会信用号 - ylqxzcrbarmc - String - 否 - -注册人/备案人名称 - ylqxzcrbarywmc - String - 否 - -注册人/备案人英文名称 - cpms - String - 否 - -产品描述 - spmc - String - 否 - -商品名称 - qtbm - String - 否 - -其他编码 - zczyxqz - String - 否 - -注册证有效期截止时间 - price - String - 否 - -产品价格 - remark - String - 否 - -备注 - remark1 - String - 否 - -备注1 - remark2 - String - 否 - -备注2 - remark3 - String - 否 - -备注3 - - - - - 3.8.5 返回说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - code - String - 是 - 001 -添加成功后返回院内产品编码 - - - - 3.8.6 返回示例 -成功 -{ - "code": 20000, - "message": "success", -"data": { -"code":100 -} -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - 3.9 B002接收新增往来单位信息 - 3.9.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.9.2 使用场景 - 医院第三方系统提供的接收新增往来单位信息接口，UDI管理系统通过此接口把医院新增的合格往来单位（供应商）信息推送至院内第三方系统（一般指物资管理系统），新增的往来单位信息为未审核状态。院内采购入库的第三方系统可以实现本接口，简化操作人员基础数据录入。 - 3.9.3 输入参数示例 - { - "unitId": "2469", - "name": "福建省诏安县医院", - "addr": "诏安县南诏镇江厝前路65号", - "creditNo": "123506244897495930", - "contact": "沈主任", - "mobile": "1330000000" - } - - - 3.9.4 输入参数说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - unitId - String - 是 - 1673 -往来单位ID - name - String - 是 - 福建省诏安县医院 -往来单位名称 - addr - String - 否 - 诏安县南诏镇江厝前路65号 -地址 - creditNo - String - 否 - 123506244897495930 -社会信用号 - contact - String - 否 - 沈主任 -联系人 - mobile - String - 否 - 13300000000 -联系电话 - 3.9.5 返回说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - unitId - String - 是 - 001 -添加成功后返回院内往来信息编码编码 - - - - 3.8.6 返回示例 -成功 -{ - "code": 20000, - "message": "success", - "data":{" unitId ":"001"} -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - 3.10 B003接收单据(订单)信息 - 3.10.1 接口说明 -url - -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.10.2 使用场景 - 医院第三方系统提供的接收单据(订单)信息接口，UDI管理系统通过此接口把现场出入库扫码生成的业务单据信息推送至院内第三方系统。院内采购入库、临床使用出库和出库结算的各相关第三方系统必须实现本接口。 - - 3.10.3 输入参数示例 -{ - "billNo": "ZY202205070001", - "billdate": "2022-05-07", - "corpId": "65119908299161", - "corpName": "福建片仔癀诊断技术有限公司", - "billType": "采购入库", - "billFlag": 1, - "thirdSys": "thirdId", - "locInvCode": "11001", - "locInvName": "总仓库", - "inoutType": "1", - "remark": "", - "item": [ - { - "billNo": "ZY202205070001", - "productId": "7864", - "productName": "通用脊柱内固定器-6.0连接棒", - "standard": "70-450mm/理贝尔", - "expireDate": "2025-01-03", - "productDate": "2021-03-01", - "batchNo": "202003", - "count": "10", - "measname":"计量单位", - "registerNo": "国食药监械（准）字2006第3460057号", - "price": 10.0, - "secSalesInvNo": "21232424", - "invoiceDate": "2323243", - "secSalesListNo": "42342", - "firstSalesInvNo": "423424", - "remark": "", - "remakr1": "", - "remakr2": "", - "codeList": [ - { - "code": "01069125473843801121041410210290075", - "nameCode": "06912547384380", - "count": 1 - } - ] - }, - { - "productId": "7901", - "productName": "亲水性丙烯酸折叠式人工晶状体Hydrophilic Acrylic Foldable Intraocular Lens", - "standard": "S1AW00", - "batchNo": "202103", - "expireDate": "2025-01-03", - "productDate": "2021-03-01", - "count": "10", - "measname":"计量单位", - "registerNo": "国械注进20153162635", - "price": 10.0, - "secSalesInvNo": "21232424", - "invoiceDate": "2323243", - "secSalesListNo": "42342", - "firstSalesInvNo": "423424", - "remark": "", - "remakr1": "", - "remakr2": "", - "codeList": [ - { - "code": "01069125473843801121041410210290075", - "nameCode": "06912547384380", - "count": 1 - } - ] - } - ] -} - - 3.10.4 输入参数说明 -参数名称 -是否必填 -类型 -示例 -参数说明 -billNo -是 -String -ZY202205070001 -单据号 -billDate -是 -String -2022-03-04 -单据日期 -corpId -是 -String - -往来单位ID -corpName -否 -String - -往来单位名称 -billType -是 -String - -单据类型/业务类型 -inoutType -是 -Integer - -出入库类型：1:入库，2:出库 -billFlag -否 -String - -单据状态 -remark -否 -String - -备注 -item - -List -见下表 -单据详情数组 -单据明细表 - 参数名称 - 是否必填 - 类型 - 示例 - 参数说明 - billNo - 是 - String - ZY202205070001 -单据号 - productId - 是 - String - 7864 -产品ID - batchNo - 是 - String - -批次号 - productDate - 是 - String - -生产日期 - expireDate - 是 - String - -失效日期 - count - 是 - Integer - 10 -数量 - price - 是 - BigDecimal - 20.20 -单价 - secSalesInvNo - 是 - String - -销售发票号（第二票） - invoiceDate - 是 - String - -发票日期 - secSalesListNo - 是 - String - -第二票销售清单号 - firstSalesInvNo - 是 - String - -销售发票号（第一票） - productName - 否 - String - -产品名称 - standard - 否 - String - -规格型号 - registerNo - 否 - String - -注册/备案证号 - manufactory - 否 - String - -生产厂家 - remark - 否 - String - -备注 - remakr1 - 否 - String - -备注1 - remakr2 - 否 - String - -备注2 - remakr3 - 否 - String - -备注3 - 3.10.5 返回说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - billNo - String - 是 - SP2022030417981 -单据号 - - - - 3.10.6 返回示例 -成功 -{ - "code": 20000, - "message": "success", - "data": "29587734565" -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - 3.11 C001产品库存信息查询 - 3.11.1 接口说明 -url -/udiwms/inv/products/filter -协议 -http -请求方式 -POST -说明 -请求参数放在body中，以json格式传递 - 3.11.2 使用场景 - UDI管理系统提供产品库存查询接口，院内第三方系统可以通过此接口查询产品库存信息，产品库存信息包含产品信息、批次号、生产日期、失效日期、数量、计量单位等信息。可以方便院内第三方系统业务开单出库前查询相关产品库存情况，如HIS系统中医生给患者开处方前查看特定耗材库存情况。 - 3.11.3 输入参数示例 -{ - "diCode": "10848782020505", - "productName": "可吸收免打结外科缝线", - "batchNo": "202006", - "supName": "片仔癀诊断", - "page": 1, - "limit": 50 -} - 3.11.4 参数说明 - 参数名称 - 是否必填 - 类型 - 示例 - 参数说明 - diCode - 否 - String - -DI产品标识 - productName - 否 - String - -产品名称 - batchNo - 否 - String - -批次号 - supName - 否 - String - -配送商名称 - page - 是 - Integer - 1 - 页码 - limit - 是 - Integer - 50 - 条数 - 3.11.5 返回说明 - 参数名称 - 类型 -是否必填 - 示例 - 描述 - id - String - 是 - -Id主键 - productName - String - 是 - -产品名称 - diCode - String - 是 - -DI产品标识 - spec - String - 否 - -规格型号 - batchNo - String - 否 - -批次号 - productionDate - String - 否 - -生产日期 - expireDate - String - 否 - -失效日 - registerCompany - String - 否 - -注册备案人名称 - registerCert - String - 否 - -注册备案证 - inCount - String - 是 - -入库数量 - outCount - String - 是 - -出库数量 - supName - String - 否 - -配送商名称 - invStorageCode - String - 否 - -所在仓库编号 - invStorageName - String - 否 - -所在仓库名称 - invSubStorageName - String - 否 - -所在分库名称 - invWarehouseCode - String - 否 - -所在分库编码 - 3.11.6 返回示例 -成功 -{ - "code": 20000, - "message": "success", - "data": { - "total": 1, - "list": [ - { - "id": 153, - "productName": "椎体成形球囊导管及组件", - "diCode": "06941332222033", - "spec": "QJ902；Φ2.9x15", - "batchNo": "212599012", - "productionDate": "210608", - "expireDate": "240608", - "registerCompany ": "浙江科惠医疗器械股份有限公司", - "registerCert": "国械注准20173040809", - "inCount": 2, - "outCount": 5, - "supName": "福建国药器械有限公司漳州分公司", - "invStorageCode": "1000", - "invStorageName": "总库", - "invSubStorageName": "骨科、试剂耗材库", - "invWarehouseCode": "1000000" - } - ] - } -} -失败 -{ - "code": 500, - "message": "错误原因", - "data": {} -} - - - diff --git a/第三方接口文档（新版）.docx b/第三方接口文档（新版）.docx new file mode 100644 index 0000000..96c185b --- /dev/null +++ b/第三方接口文档（新版）.docx @@ -0,0 +1,2247 @@ + + + + UDI管理系统 + 第三方接口说明文档 + + + + 版本号<3.0> + 发布时间<20200506> + 初稿编写人<翟闰虎> + 修订人<吴毅鹏,叶文杰> + 版本管理 + 版本号 + 操作者 + 内容 + 操作日期 + 审批者 + 审批日期 + 2.0 +翟闰虎 +第三方接口需求 +2022-05-06 +叶文杰 +2022-05-08 + 3.0 +叶文杰 +第三方接口需求 +2022-09-15 +吴毅鹏 +2022-09-18 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 目录 + 1 公共参数 6 +2 接口调用方式 6 +3 接口需求列表 6 + 3.1 A001单位往来信息查询 9 + 3.1.1 接口说明 9 + 3.1.2 使用场景 9 + 3.1.3 输入参数说明 10 + 3.1.4 输入参数示例 10 + 3.1.5 返回说明 10 + 3.1.6 返回示例 10 + 3.2 A002产品信息查询 11 + 3.2.1 接口说明 11 + 3.2.2 使用场景 12 + 3.2.3 输入参数说明 12 + 3.2.4 输入参数示例 12 + 3.2.5 返回说明 12 + 3.2.6 返回示例 13 + 2.3 A003仓库(科室)信息查询 15 + 3.3.1 接口说明 15 + 3.2.2 使用场景 15 + 3.3.3 输入参数示例 15 + 3.3.4 输入参数说明 15 + 3.3.5 返回说明 16 + 3.3.6 返回示例 16 + 3.4 A004单据类型信息查询 17 + 3.4.1 接口说明 17 + 3.4.2 使用场景 17 + 3.4.3 输入参数说明 18 + 3.4.4 输入参数示例 18 + 3.4.5 返回说明 18 + 3.4.6 返回示例 18 + 2.5 A005单据(订单)信息查询 19 + 3.5.1 接口说明 19 + 3.5.2 使用场景 20 + 3.5.3 输入参数说明 20 + 3.5.5 输入参数示例 20 + 3.5.6 返回说明 20 + 3.5.7 返回示例 21 + 3.6 A006产品库存信息查询 24 + 3.6.1 接口说明 24 + 3.6.2 使用场景 24 + 3.6.3 输入参数示例 24 + 3.6.4 参数说明 25 + 3.6.5 返回说明 25 + 3.6.6 返回示例 26 + 3.7 A007患者信息查询 28 + 3.7.1 接口说明 28 + 3.7.2 使用场景 28 + 3.8 B001接收新增产品信息 28 + 3.8.1 接口说明 28 + 3.8.2 使用场景 28 + 3.8.3 输入参数示例 28 + 3.8.4 输入参数说明 29 + 3.8.5 返回说明 30 + 3.8.6 返回示例 30 + 3.9 B002接收新增往来单位信息 31 + 3.9.1 接口说明 31 + 3.9.2 使用场景 31 + 3.9.3 输入参数示例 31 + 3.9.4 输入参数说明 32 + 3.9.5 返回说明 32 + 3.8.6 返回示例 32 + 3.10 B003接收单据(订单)信息 32 + 3.10.1 接口说明 32 + 3.10.2 使用场景 33 + 3.10.3 输入参数示例 33 + 3.10.4 输入参数说明 35 + 3.10.5 返回说明 36 + 3.10.6 返回示例 36 + 3.11 C001产品库存信息查询 37 + 3.11.1 接口说明 37 + 3.11.2 使用场景 37 + 3.11.3 输入参数示例 37 + 3.11.4 参数说明 37 + 3.11.5 返回说明 37 + 3.11.6 返回示例 38 + + + + + + + + + + + + + + + + + + +名词解释 +"第三方系统"：一般是指医院已经在使用的其它系统，如：物资管理系统、HIS系统、试剂管理系统、结算系统、医保系统等等。 +"往来单位"：是供应商、客户等的统称。 +"统一编码"：是指院内各第三方系统（物资系统、HIS系统等）采用相同耗材字典、供应商字典等。 +单据类型：进行出入库作业的单据类型，如采购入库单、临床使用出库单、调拨出库单、调拨入库单等等。 + +公共参数 + 公共参数（api_key和secret_key）是"医院第三方系统"根据系统安全需要，可以提供给"医院UDI管理系统"调用接口时需要安全认证的信息，接口权限验证使用头部参数校验，"医院UDI管理系统"在发起调用时将接口授权参数携带在请求头（Header）中发送。 + 参数名称 + 是否必填 + 示例 + 参数说明 + api_key + 是 + ewKD2Cyr + + secret_key + 是 + rO4nDvNWKJ1uNuQQBnECPjnpDv4w6nh8 + +接口调用方式 +接口统一采用HTTP协议，调用时需要在请求头部中传递公共参数。 +接口地址为"服务地址 + 接口方法名"组成，接口参数要求参考对应接口参数说明。 + 3 接口需求列表 + "医院UDI管理系统"支持多系统数据交互服务，第三方服务模块提供公开的数据主动推送、主动查询和被查询服务，满足医院实际业务作业需要，"医院第三方系统"需要根据下表接口需求，具体实现接口。一般医院耗材流通包括以下环节: + 耗材采购 -- > 科室领用 -- > 临床使用 -- > 费用结算 + 注意，如果院内有多套第三方系统需要和UDI管理系统进行互联互通，并且这多套系统基础数据编码不统一，那么基础数据编码不统一的院内第三方系统需要分别实现接口需求列表中的部分或全部接口。 + + 提供被查询接口：由院内第三方系统各相关业务系统具体实现的被查询接口，各相关业务系统包括但不限于物资管理系统、试剂管理系统、HIS系统、结算系统、医保、集采等系统。 +编号 + 接口名称 + 使用场景描述 +A001 +单位往来信息查询 +(供应商信息查询) + 医院第三方系统提供往来单位信息查询接口，UDI管理系统通过此接口获取院内第三方系统的往来单位信息。当UDI管理系统和院内第三方系统的业务数据（接口A005、B002和B003）需要交互时，UDI管理系统能够自动把往来单位编码转换为符合双方系统的编码，再进行提交或保存。院内管理采购的系统（物资管理系统）必须实现本接口。 +A002 +产品信息查询 +(耗材字典查询) + 医院第三方系统提供产品信息查询接口，UDI管理系统通过此接口获取院内第三方系统的产品信息。当UDI管理系统和院内第三方系统的业务数据（接口A005、B001和B003）需要交互时，UDI管理系统能够自动把产品信息编码转换为符合双方系统的编码，再进行提交或保存。因此，除了院内管理采购的系统（物资管理系统）必须实现本接口外，其它需要进行出入库作业的各相关第三方系统通常也需要实现本接口，除非院内各第三方系统已经实现统一编码管理，其它业务系统则无需再实现此接口。 +A003 +仓库/科室信息查询 + 医院第三方系统提供的仓库/科室信息查询接口，UDI管理系统通过此接口获取院内第三方系统的仓库/科室信息。当UDI管理系统和院内第三方系统的业务单据信息（接口A005和B003）交互时，提交或获取的单据信息如果包含仓库/科室信息，则院内各相关第三方系统必须实现本接口。 +A004 +单据类型信息查询 + 医院第三方系统提供的单据类型信息查询接口，UDI管理系统通过此接口获取院内第三方系统的单据类型信息。当UDI管理系统需要和院内第三方目标系统交换业务单据信息（接口A005和B003）时，则院内各相关第三方目标系统必须实现本接口。 +A005 +单据(订单)信息查询 + 医院第三方系统提供的单据(订单)信息查询接口，UDI管理系统通过此接口获取院内第三方系统的单据(订单)信息。由院内第三方目标系统发起相关的业务，如采购订单、调拨(领用)单等，并需要把相关业务单据信息推送给UDI管理系统，则院内各相关第三方目标系统必须实现本接口。 +A006 +产品库存信息查询 + 医院第三方系统提供的产品库存信息查询接口，UDI管理系统通过此接口获取院内第三方仓库管理系统的产品库存信息，进行相关业务处理。当院内第三方系统需要对库存进行实时校验或定期扫码盘点时，院内各相关第三方系统必须实现本接口。 +A007 +患者信息查询 + 医院第三方系统提供的患者信息查询接口，UDI管理系统通过此接口获取院内第三方医嘱（HIS）系统的患者相关信息(病历、医嘱、处方)。UDI管理系统可以根据取得的患者信息，临床使用出库信息，统计患者耗材使用情况详细信息，可追溯溯源至耗材的单品或批次。 + 提供接收接口 +编号 + 接口名称 + 使用场景描述 +B001 +接收新增产品信息 + 医院第三方系统提供的接收新增产品信息接口，UDI管理系统通过此接口把供应商新增的配送产品信息推送至院内第三方系统（一般指物资管理系统），新增的产品信息为未审核状态。院内采购入库的第三方系统可以实现本接口，简化操作人员基础数据录入。 +B002 +接收新增往来单位信息 + 医院第三方系统提供的接收新增往来单位信息接口，UDI管理系统通过此接口把医院新增的合格往来单位（供应商）信息推送至院内第三方系统（一般指物资管理系统），新增的往来单位信息为未审核状态。院内采购入库的第三方系统可以实现本接口，简化操作人员基础数据录入。 +B003 +接收单据(订单)信息 + 医院第三方系统提供的接收单据(订单)信息接口，UDI管理系统通过此接口把现场出入库扫码生成的业务单据信息推送至院内第三方系统。院内采购入库、临床使用出库和出库结算的各相关第三方系统必须实现本接口。 + 主动查询接口 +编号 + 接口名称 + 使用场景描述 +C001 +产品库存信息查询 + UDI管理系统提供产品库存查询接口，院内第三方系统可以通过此接口查询产品库存信息，产品库存信息包含产品信息、批次号、生产日期、失效日期、数量、计量单位等信息。可以方便院内第三方系统业务开单出库前查询相关产品库存情况，如HIS系统中医生给患者开处方前查看特定耗材库存情况。 + + 3.1 A001单位往来信息查询 + 3.1.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.1.2 使用场景 + 医院第三方系统提供往来单位信息查询接口，UDI管理系统通过此接口获取院内第三方系统的往来单位信息。当UDI管理系统和院内第三方系统的业务数据（接口A005、B002和B003）需要交互时，UDI管理系统能够自动把往来单位编码转换为符合双方系统的编码，再进行提交或保存。院内管理采购的系统（物资管理系统）必须实现本接口。 + + 3.1.3 输入参数说明 + 参数名称 + 是否必填 + 类型 + 示例 + 参数说明 + lastUpdateTime + 否 + String + 2020-01-05 12:00:00 +最后更新时间 + key + 否 + String + 福建省诏安县医院 +关键字，匹配往来单位编码，往来单位名称，往来单位简称，支持模糊查询 + unitId + 否 + String + 1673 +往来单位编码，支持模糊查询 + name + 否 + String + 福建省诏安县医院 +往来单位名称，支持模糊查询 + page + 是 + Integer + 1 + 页码 + limit + 是 + Integer + 50 + 条数 + 3.1.4 输入参数示例 +{ + "lastUpdateTime": "2020-01-05 12:00:00", + "key": "福建省诏安县医院", + "unitId": "1673", + "name": "福建省诏安县医院", + "page": "1", + "limit": "50" +} + 3.1.5 返回说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + unitId + String + 是 + 1673 +往来单位ID + name + String + 是 + 福建省诏安县医院 +往来单位名称 + lastUpdateTime + String + 是 + 2020-01-05 12:00:00 +最后更新时间 + addr + String + 是 + 诏安县南诏镇江厝前路65号 +地址 + creditNo + String + 是 + 123506244897495930 +社会信用号 + spell + String + 是 + zaxyy +往来单位简称 + contact + String + 是 + 沈主任 +联系人 + mobile + String + 是 + 13300000000 +联系电话 + 3.1.6 返回示例 +成功 +{ + "code": 20000, + "message": "success", + "data": { + "total": 300, + "list": [ + { + "unitId": "2468", + "name": "福建省诏安县医院", + "addr": "诏安县南诏镇江厝前路65号", + "creditNo": "123506244897495930", + "contact": "沈主任", + "mobile": "1330000000", + "spell": "zaxyy" + }, + { + "unitId": "2469", + "name": "福建省诏安县医院11", + "addr": "诏安县南诏镇江厝前路65号", + "creditNo": "123506244897495930", + "contact": "沈主任", + "mobile": "1330000000", + "spell": "zaxyy" + } + ] + } +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + 3.2 A002产品信息查询 + 3.2.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.2.2 使用场景 + 医院第三方系统提供产品信息查询接口，UDI管理系统通过此接口获取院内第三方系统的产品信息。当UDI管理系统和院内第三方系统的业务数据（接口A005、B001和B003）需要交互时，UDI管理系统能够自动把产品信息编码转换为符合双方系统的编码，再进行提交或保存。因此，除了院内管理采购的系统（物资管理系统）必须实现本接口外，其它需要进行出入库作业的各相关第三方系统通常也需要实现本接口，除非院内各第三方系统已经实现统一编码管理，其它业务系统则无需再实现此接口。 + 3.2.3 输入参数说明 + 参数名称 + 是否必填 + 类型 + 示例 + 参数说明 + lastUpdateTime + 否 + String + +最后更新时间 + code + 否 + String + +产品编码，支持模糊查询 + name + 否 + String + +器械通用名，支持模糊查询 + standard + 否 + String + +规格型号，支持模糊查询 + registerNo + 否 + String + +注册/备案号，支持模糊查询 + manufactory + 否 + String + +生产厂家 + ybbm + 否 + String + +医保编码 + page + 是 + Integer + +页码 + limit + 是 + Integer + +条数 + 3.2.4 输入参数示例 +{ + "lastUpdateTime": "2020-01-05 12:00:00", + "code": "6555", + "name": "下肢直型锁定", + "standard": "12孔", + "registerNo": "20153461024", + "manufactory": "江苏艾迪尔", + "ybbm": "32543534534", + "page": "1", + "limit": "50" +} + 3.2.5 返回说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + lastUpdateTime + String + 是 + +最后更新时间 + code + String + 是 + +产品编码 + name + String + 是 + +产品名称 + measname + String + 是 + +计量单位 + standard + String + 是 + +规格型号 + registerNo + String + 是 + +注册/备案号 + manufactoryCode + String + 是 + +生产厂家编码 + manufactory + String + 是 + +生产厂家 + supCode + String + 是 + +配送企业编码 + supName + String + 是 + +配送企业名称 + cplb + String + 是 + +产品类别 + flbm + String + 是 + +分类编码 + qxlb + String + 是 + +器械类别 + ybbm + String + 是 + +医保编码 + sptm + String + 是 + +商品条码 + tyshxydm + String + 是 + +注册人社会信用号 + ylqxzcrbarmc + String + 是 + +注册人/备案人名称 + ylqxzcrbarywmc + String + 是 + +注册人/备案人英文名称 + cpms + String + 是 + +产品描述 + spmc + String + 是 + +商品名称 + qtbm + String + 是 + +其他编码 + zczyxqz + String + 是 + +注册证有效期截止时间 + price + String + 是 + +产品价格 + remark + String + 否 + +4个备注字段，需要提供的字段在列表中不存在，可以使用备注字段 + remark1 + String + 否 + + + remark2 + String + 否 + + + remark3 + String + 否 + + + 3.2.6 返回示例 +成功 +{ + "code": 20000, + "message": "success", + "data": { + "total": 100, + "list": [ + { + "code": "6555", + "name": "下肢直型锁定钢板", + "measname": "块", + "spec": "12孔", + "registerNo": "20153461024", + "manufactoryCode": "9000006836", + "manufactory": "江苏艾迪尔", + "supCode": "9000009163", + "supName": "南昌必理商贸有限公司", + "lastUpdateTime": "2022-03-26 09:03:36", + "cplb": "产品类别", + "flbm": "分类编码", + "qxlb": "器械类别", + "ybbm": "医保编码", + "sptm": "商品条码", + "tyshxydm": "注册人社会信用号", + "ylqxzcrbarmc": "注册/备案人名称", + "ylqxzcrbarywmc": "注册/备案人英文名称", + "cpms": "产品描述", + "model": "12孔", + "standard": "规格型号", + "spmc": "商品名称", + "qtbm": "其他编码", + "zczyxqz": "注册证有效期截止时间", + "remark":"进口代理商", + "remark1": "", + "remark2": "", + "remark3": "", + "supName ": "配送企业", + "price": "500.00" + } + ] + } +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + A003仓库(科室)信息查询 + 3.3.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.2.2 使用场景 + 医院第三方系统提供的仓库/科室信息查询接口，UDI管理系统通过此接口获取院内第三方系统的仓库/科室信息。当UDI管理系统和院内第三方系统的业务单据信息（接口A005和B003）交互时，提交或获取的单据信息如果包含仓库/科室信息，则院内各相关第三方系统必须实现本接口。 + 3.3.3 输入参数示例 +{ + "inventoryCode": "1001", + "warehouseCode": "1001001", + "page": "1", + "limit": "50" +} + 3.3.4 输入参数说明 + 参数名称 + 是否必填 + 类型 + 示例 + 参数说明 +inventoryCode + 否 +String + + 仓库号，支持模糊查询 +warehouseCode + 否 +String + + 货位号，支持模糊查询 + page + 是 +Integer + 1 + 页码 + limit + 是 +Integer + 50 + 条数 + 3.3.5 返回说明 +参数名称 +是否必填 +类型 +示例 +参数说明 +code +是 +String + +仓库号 +name +是 +String + +仓库名称 +remark +否 +String + +备注 +details +是 +List +见下表 +货位详情数组 +货位明细表 + 参数名称 + 是否必填 + 类型 + 示例 + 参数说明 + code + 是 + String + +货位号 + name + 是 + String + +货位名称 + remark + 否 + String + +备注 + 3.3.6 返回示例 +成功 +{ + "code": 20000, + "message": "success", + "data": { + "total": 100, + "list": [ + { + "code": "1001", + "name": "仓库1", + "remark": "", + "details": [ + { + "code": "1001001", + "name": "货位1", + "remark": "" + } + ] + }, + { + "code": "1002", + "name": "仓库2", + "remark": "", + "details": [ + { + "code": "1001002", + "name": "货位1", + "remark": "" + } + ] + } + ] + } +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + 3.4 A004单据类型信息查询 + 3.4.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.4.2 使用场景 + 医院第三方系统提供的单据类型信息查询接口，UDI管理系统通过此接口获取院内第三方系统的单据类型信息。当UDI管理系统需要和院内第三方目标系统交换业务单据信息（接口A005和B003）时，则院内各相关第三方目标系统必须实现本接口。 + 3.4.3 输入参数说明 + 参数名称 + 是否必填 + 类型 + 示例 + 参数说明 + code + 否 + String + cgrk + 单据类型编码 + name + 否 + String + 采购入库 + 单据类型名称 + page + 是 + Integer + 1 + 页码 + limit + 是 + Integer + 10 + 条数 + 3.4.4 输入参数示例 +{ + "code": "cgrk", + "name": "采购入库", + "page": "1", + "limit": "50" +} + 3.4.5 返回说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + code + String + 是 + cgrk +单据类型编码 + name + String + 是 + 采购入库单 +单据类型名称 + inoutType + Integer + 是 + 1 +1:入库，2:出库 + remark + String + 否 + +备注 + 3.4.6 返回示例 +成功 +{ + "code": 20000, + "message": "success", + "data": { + "total": 100, + "list": [ + { + "code": "cgrk", + "name": "采购入库单", + "inoutType": 1, + "remark": "测试" + }, + { + "code": "syck", + "name": "使用出库单", + "inoutType": 2, + "remark": "测试" + }, + { + "code": "cgrk", + "name": "采购入库单", + "inoutType": 1, + "remark": "测试" + }, + { + "code": "syck", + "name": "使用出库单", + "inoutType": 2, + "remark": "测试" + } + ] + } +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + A005单据(订单)信息查询 + 3.5.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.5.2 使用场景 + 医院第三方系统提供的单据(订单)信息查询接口，UDI管理系统通过此接口获取院内第三方系统的单据(订单)信息。由院内第三方目标系统发起相关的业务，如采购订单、调拨(领用)单等，并需要把相关业务单据信息推送给UDI管理系统，则院内各相关第三方目标系统必须实现本接口。 + 3.5.3 输入参数说明 + 参数名称 + 是否必填 + 类型 + 示例 + 参数说明 + lastUpdateTime + 是 + String + + 最后更新时间 + billNo + 否 + String + + 单据号 + corpName + 否 + String + + 往来单位 + billType + 否 + String + + 单据类型 + page + 是 + Int + 1 + 页码 + limit + 是 + Int + 50 + 条数 + 3.5.5 输入参数示例 +{ + "lastUpdateTime": "2022-03-13 00:00:00", + "billNo": "SP2022031376813", + "corpName": "片仔癀诊断", + "billType": "采购入库", + "page": "1", + "limit": "50" +} + 3.5.6 返回说明 +单据主表 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + billNo + String + 是 + SP2022030 +单据号 + billFlag + String + 是 + +单据状态 + billdate + String + 是 + 2022-03-04 +单据日期 + billType + String + 是 + +单据类型 + corpId + String + 是 + +往来单位编码（1:若往来信息为供应商则为供应商编码；2.若往来信息为仓库/科室，则为仓库/科室对应编码） + inoutType + Int + 是 + +1:入库，2:出库 + corpName + String + 是 + +单据往来单位名称 + createUser + String + 是 + +创建人 + reviewUser + String + 是 + +审核人 + address + String + 是 + +地址 + linkMan + String + 是 + +联系人 + linkTel + String + 是 + +电话 + invCode + String + 是 + +单据所属仓库/科室编码 + invName + String + 是 + +单据所属仓库/科室名称 + remark + String + 是 + +备注 + detailList + List + 是 + 见下表 +订单详情数组 + +单据明细表 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + detailId + String + 是 + +单据号 + productId + String + 是 + 6533 +产品编码 + count + Integer + 是 + +单据数量 + batchNo + String + 是 + 202203 +批次号 + expireDate + String + 是 + +失效日期 + productDate + String + 是 + +生产日期 + reCount + Integer + 是 + +实际数量 + price + BigDecimal + 是 + 20.20 +单价 + productName + String + 是 + +产品名称 + standard + String + 是 + +规格型号 + measname + String + 是 + +计量单位 + registerNo + String + 是 + +注册/备案凭证号 + manufactory + String + 是 + +生产厂家 + remark + String + 否 + +备注 + remark1 + String + 否 + +备注1 + remark2 + String + 否 + +备注2 + remark3 + String + 否 + +备注3 + 3.5.7 返回示例 +成功 +{ + "code": 20000, + "message": "success", + "data": { + "total": 100, + "list": [ + { + "billNo": "SP2022031376813", + "billdate": "2022-03-13 00:00:00", + "corpId": null, + "corpName": null, + "billType": "ST54467264148", + "billFlag": "单据状态", + "createUser": "沈先生", + "reviewUser": "沈先生", + "address": "福建省厦门市集美区", + "linkMan": "沈先生", + "linkTel": "13306961860", + "inoutType": 1, + "remark": null, +"invCode": "555255", +"invName": "设备仓库", + "detailList": [ + { + "detailId": "29607390140", + "productId": "6555", + "productName": null, + "standard": null, + "batchNo": "202203", + "expireDate": "2022-03-27", + "productDate": "2022-03-25", + "measname": "克", + "count": 10, + "reCount": 0, + "corpName": "福建片仔癀诊断技术有限公司", + "price": 10, + "registerNo": "32423424242", +"manufactory": "大博医疗", + "remark": null, + "remark1": null, + "remark2": null, + "remark3": null + }, + { + "detailId": "29607390214", + "productId": "6555", + "productName": null, + "standard": null, + "batchNo": "202203", + "expireDate": "2022-03-27", + "productDate": "2022-03-25", + "measname": "克", + "count": 10, + "reCount": 0, + "corpName": "福建片仔癀诊断技术有限公司", + "price": 10, + "registerNo": "32423424242", + "manufactory": "大博医疗", + "remark": null, + "remark1": null, + "remark2": null, + "remark3": null + } + ] + } + ] + } +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + 3.6 A006产品库存信息查询 + 3.6.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.6.2 使用场景 + 医院第三方系统提供的产品库存信息查询接口，UDI管理系统通过此接口获取院内第三方仓库管理系统的产品库存信息，进行相关业务处理。当院内第三方系统需要对库存进行实时校验或定期扫码盘点时，院内各相关第三方系统必须实现本接口。 + 3.6.3 输入参数示例 +{ + "warehouseCode": "1001", + "warehouseName": "货位1", + "inventoryCode": "1", + "inventoryName": "总库", + "productName": "下肢直型锁定钢板", + "productId": "6555", + "standard": "12孔", + "registerNo": "20153461024", + "manufactory": "江苏艾迪尔", + "supName": "南昌必理商贸有限公司", + "batchNo": "pch1", + "page": 1, + "limit": 50 +} + 3.6.4 输入参数说明 + 参数名称 + 是否必填 + 类型 + 示例 + 参数说明 + inventoryCode + 否 + String + +仓库编号，支持模糊查询 + inventoryName + 否 + String + +仓库名称，支持模糊查询 + warehouseCode + 否 + String + +货位编号，支持模糊查询 + warehouseName + 否 + String + +货位名称，支持模糊查询 + productId + 否 + String + +产品编号，支持模糊查询 + productName + 否 + String + +产品名称，支持模糊查询 + standard + 否 + String + +规格型号，支持模糊查询 + registerNo + 否 + String + +注册/备案证号，支持模糊查询 + manufactory + 否 + String + +生产厂家 + batchNo + 否 + String + +批次号，支持模糊查询 + supName + 否 + String + +供应商名称（配送企业），支持模糊查询 + page + 是 + Integer + 1 + 页码 + limit + 是 + Integer + 50 + 条数 + 3.6.5 返回说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + inventoryCode + String + 是 + 1 +仓库号 + inventoryName + String + 是 + 总库 +仓库名称 + warehouseCode + String + 是 + 1001 +货位号 + warehouseName + String + 是 + 货位1 +货位名称 + productId + String + 是 + +产品ID + batchNo + String + 是 + 202203 +批次号 + productDate + String + 是 + +生产日期 + expireDate + String + 是 + +失效日期 + count + String + 是 + +数量 + productName + String + 是 + +产品名称 + standard + String + 是 + +规格型号 + registerNo + String + 是 + +注册/备案证号 + measname + String + 是 + +计量单位 + manufactory + String + 是 + +生产厂家 + supId + String + 是 + +供应商ID（配送企业） + supName + String + 是 + +配送企业名称 + 3.6.6 返回示例 +成功 +{ + "code": 20000, + "message": "success", + "data": { + "total": 100, + "list":[ { + "batchNo": "202203", + "warehouseCode": "1001", + "warehouseName": "货位1", + "count": 10, + "inventoryCode": "1", + "inventoryName": "总库", + "productName": "下肢直型锁定钢板", + "productDate": "2022-03-25", + "expireDate": "2022-03-27", + "productId": "6555", + "standard": "12孔", + "registerNo": "20153461024", + "manufactory": "江苏艾迪尔", + "measname": "盒", + "supId": "2001", + "supName": "南昌必理商贸有限公司" + }, + { + "batchNo": "202203", + "warehouseCode": "1001", + "warehouseName": "货位1", + "count": 10, + "inventoryCode": "1", + "inventoryName": "总库", + "productName": "下肢直型锁定钢板", + "productDate": "2022-03-25", + "expireDate": "2022-03-27", + "productId": "6555", + "standard": "12孔", + "registerNo": "20153461024", + "manufactory": "江苏艾迪尔", + "measname": "盒", + "supId": "2001", + "supName": "南昌必理商贸有限公司" + } +] +} +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + + 3.7 A007患者信息查询 + 3.7.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.7.2 使用场景 + 医院第三方系统提供的患者信息查询接口，UDI管理系统通过此接口获取院内第三方医嘱（HIS）系统的患者相关信息(病历、医嘱、处方)。UDI管理系统可以根据取得的患者信息，临床使用出库信息，统计患者耗材使用情况详细信息，可追溯溯源至耗材的单品或批次。。 +3.8.3 输入参数示例 + + 3.8 B001接收新增产品信息 + 3.8.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.8.2 使用场景 + 医院第三方系统提供的接收新增产品信息接口，UDI管理系统通过此接口把供应商新增的配送产品信息推送至院内第三方系统（一般指物资管理系统），新增的产品信息为未审核状态。院内采购入库的第三方系统可以实现本接口，简化操作人员基础数据录入。 + 3.8.3 输入参数示例 + + { + "code": "6555", + "name": "下肢直型锁定钢板", + "measname": "块", + "spec": "12孔", + "registerNo": "20153461024", + "manufactory": "江苏艾迪尔", + "cplb": "产品类别", + "flbm": "分类编码", + "qxlb": "器械类别", + "ybbm": "医保编码", + "sptm": "商品条码", + "tyshxydm": "注册人社会信用号", + "ylqxzcrbarmc": "注册/备案人名称", + "ylqxzcrbarywmc": "注册/备案人英文名称", + "cpms": "产品描述", + "model": "12孔", + "standard": null, + "spmc": "商品名称", + "qtbm": "其他编码", + "zczyxqz": "注册证有效期截止时间", + "remark": null, + "remark1": null, + "remark2": null, + "remark3": null, + "supName ": "配送企业", + "price": "价格" + } + + 3.8.4 输入参数说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + code + String + 是 + +产品编码 + name + String + 是 + +产品名称 + measname + String + 否 + +计量单位 + standard + String + 否 + +规格型号 + registerNo + String + 否 + +注册/备案号 + manufactory + String + 否 + +生产厂家 + supName + String + 否 + +配送企业 + cplb + String + 否 + +产品类别 + flbm + String + 否 + +分类编码 + qxlb + String + 否 + +器械类别 + ybbm + String + 否 + +医保编码 + sptm + String + 否 + +商品条码 + tyshxydm + String + 否 + +注册人社会信用号 + ylqxzcrbarmc + String + 否 + +注册人/备案人名称 + ylqxzcrbarywmc + String + 否 + +注册人/备案人英文名称 + cpms + String + 否 + +产品描述 + spmc + String + 否 + +商品名称 + qtbm + String + 否 + +其他编码 + zczyxqz + String + 否 + +注册证有效期截止时间 + price + String + 否 + +产品价格 + remark + String + 否 + +备注 + remark1 + String + 否 + +备注1 + remark2 + String + 否 + +备注2 + remark3 + String + 否 + +备注3 + + + + + 3.8.5 返回说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + code + String + 是 + 001 +添加成功后返回院内产品编码 + + + + 3.8.6 返回示例 +成功 +{ + "code": 20000, + "message": "success", +"data": { +"code":100 +} +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + 3.9 B002接收新增往来单位信息 + 3.9.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.9.2 使用场景 + 医院第三方系统提供的接收新增往来单位信息接口，UDI管理系统通过此接口把医院新增的合格往来单位（供应商）信息推送至院内第三方系统（一般指物资管理系统），新增的往来单位信息为未审核状态。院内采购入库的第三方系统可以实现本接口，简化操作人员基础数据录入。 + 3.9.3 输入参数示例 + { + "unitId": "2469", + "name": "福建省诏安县医院", + "addr": "诏安县南诏镇江厝前路65号", + "creditNo": "123506244897495930", + "contact": "沈主任", + "mobile": "1330000000" + } + + + 3.9.4 输入参数说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + unitId + String + 是 + 1673 +往来单位ID + name + String + 是 + 福建省诏安县医院 +往来单位名称 + addr + String + 否 + 诏安县南诏镇江厝前路65号 +地址 + creditNo + String + 否 + 123506244897495930 +社会信用号 + contact + String + 否 + 沈主任 +联系人 + mobile + String + 否 + 13300000000 +联系电话 + 3.9.5 返回说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + unitId + String + 是 + 001 +添加成功后返回院内往来信息编码编码 + + + + 3.8.6 返回示例 +成功 +{ + "code": 20000, + "message": "success", + "data":{" unitId ":"001"} +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + 3.10 B003接收单据(订单)信息 + 3.10.1 接口说明 +url + +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.10.2 使用场景 + 医院第三方系统提供的接收单据(订单)信息接口，UDI管理系统通过此接口把现场出入库扫码生成的业务单据信息推送至院内第三方系统。院内采购入库、临床使用出库和出库结算的各相关第三方系统必须实现本接口。 + + 3.10.3 输入参数示例 +{ + "billNo": "ZY202205070001", + "billdate": "2022-05-07", + "corpId": "65119908299161", + "corpName": "福建片仔癀诊断技术有限公司", + "billType": "采购入库", + "billFlag": 1, + "thirdSys": "thirdId", + "locInvCode": "11001", + "locInvName": "总仓库", + "inoutType": "1", + "remark": "", + "item": [ + { + "billNo": "ZY202205070001", + "productId": "7864", + "productName": "通用脊柱内固定器-6.0连接棒", + "standard": "70-450mm/理贝尔", + "expireDate": "2025-01-03", + "productDate": "2021-03-01", + "batchNo": "202003", + "count": "10", + "measname":"计量单位", + "registerNo": "国食药监械（准）字2006第3460057号", + "price": 10.0, + "secSalesInvNo": "21232424", + "invoiceDate": "2323243", + "secSalesListNo": "42342", + "firstSalesInvNo": "423424", + "remark": "", + "remakr1": "", + "remakr2": "", + "codeList": [ + { + "code": "01069125473843801121041410210290075", + "nameCode": "06912547384380", + "count": 1 + } + ] + }, + { + "productId": "7901", + "productName": "亲水性丙烯酸折叠式人工晶状体Hydrophilic Acrylic Foldable Intraocular Lens", + "standard": "S1AW00", + "batchNo": "202103", + "expireDate": "2025-01-03", + "productDate": "2021-03-01", + "count": "10", + "measname":"计量单位", + "registerNo": "国械注进20153162635", + "price": 10.0, + "secSalesInvNo": "21232424", + "invoiceDate": "2323243", + "secSalesListNo": "42342", + "firstSalesInvNo": "423424", + "remark": "", + "remakr1": "", + "remakr2": "", + "codeList": [ + { + "code": "01069125473843801121041410210290075", + "nameCode": "06912547384380", + "count": 1 + } + ] + } + ] +} + + 3.10.4 输入参数说明 +参数名称 +是否必填 +类型 +示例 +参数说明 +billNo +是 +String +ZY202205070001 +单据号 +billDate +是 +String +2022-03-04 +单据日期 +corpId +是 +String + +往来单位ID +corpName +否 +String + +往来单位名称 +billType +是 +String + +单据类型/业务类型 +inoutType +是 +Integer +1 +出入库类型：1:入库，2:出库 +billFlag +否 +String + +单据状态 +locInvCode +是 +String + +仓库编码 +locInvName +否 +String + +仓库名称 +remark +否 +String + +备注 +item + +List +见下表 +单据详情数组 +单据明细表 + 参数名称 + 是否必填 + 类型 + 示例 + 参数说明 + billNo + 是 + String + ZY202205070001 +单据号 + productId + 是 + String + 7864 +产品ID + batchNo + 是 + String + +批次号 + productDate + 是 + String + +生产日期 + expireDate + 是 + String + +失效日期 + count + 是 + Integer + 10 +数量 + price + 是 + BigDecimal + 20.20 +单价 + secSalesInvNo + 是 + String + +销售发票号（第二票） + invoiceDate + 是 + String + +发票日期 + secSalesListNo + 是 + String + +第二票销售清单号 + firstSalesInvNo + 是 + String + +销售发票号（第一票） + productName + 否 + String + +产品名称 + standard + 否 + String + +规格型号 + registerNo + 否 + String + +注册/备案证号 + manufactory + 否 + String + +生产厂家 + measname + 否 + String + +计量单位 + remark + 否 + String + +备注 + remakr1 + 否 + String + +备注1 + remakr2 + 否 + String + +备注2 + remakr3 + 否 + String + +备注3 +codeList + 否 + List + +码详情，参数见下表 +码详情参数表 + 参数名称 + 类型 +是否必填 + 示例 + 参数说明 + code + String + 是 + 0106973262860009112201101724011010JY11121001 +UDI码 + nameCode + String + 是 + 06973262860009 +DI标识 + count + Integer + 是 + 2 +数量 + + 3.10.5 返回说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + billNo + String + 是 + SP2022030417981 +单据号 + + + + 3.10.6 返回示例 +成功 +{ + "code": 20000, + "message": "success", + "data": "29587734565" +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + 3.11 C001产品库存信息查询 + 3.11.1 接口说明 +url +/udiwms/inv/products/filter +协议 +http +请求方式 +POST +说明 +请求参数放在body中，以json格式传递 + 3.11.2 使用场景 + UDI管理系统提供产品库存查询接口，院内第三方系统可以通过此接口查询产品库存信息，产品库存信息包含产品信息、批次号、生产日期、失效日期、数量、计量单位等信息。可以方便院内第三方系统业务开单出库前查询相关产品库存情况，如HIS系统中医生给患者开处方前查看特定耗材库存情况。 + 3.11.3 输入参数示例 +{ + "diCode": "10848782020505", + "productName": "可吸收免打结外科缝线", + "batchNo": "202006", + "supName": "片仔癀诊断", + "page": 1, + "limit": 50 +} + 3.11.4 输入参数说明 + 参数名称 + 是否必填 + 类型 + 示例 + 参数说明 + diCode + 否 + String + +DI产品标识 + productName + 否 + String + +产品名称 + batchNo + 否 + String + +批次号 + supName + 否 + String + +配送商名称 + page + 是 + Integer + 1 + 页码 + limit + 是 + Integer + 50 + 条数 + 3.11.5 返回说明 + 参数名称 + 类型 +是否必填 + 示例 + 描述 + id + String + 是 + +Id主键 + productName + String + 是 + +产品名称 + diCode + String + 是 + +DI产品标识 + spec + String + 否 + +规格型号 + batchNo + String + 否 + +批次号 + productionDate + String + 否 + +生产日期 + expireDate + String + 否 + +失效日 + registerCompany + String + 否 + +注册备案人名称 + registerCert + String + 否 + +注册备案证 + inCount + String + 是 + +入库数量 + outCount + String + 是 + +出库数量 + supName + String + 否 + +配送商名称 + invStorageCode + String + 否 + +所在仓库编号 + invStorageName + String + 否 + +所在仓库名称 + invSubStorageName + String + 否 + +所在分库名称 + invWarehouseCode + String + 否 + +所在分库编码 + 3.11.6 返回示例 +成功 +{ + "code": 20000, + "message": "success", + "data": { + "total": 1, + "list": [ + { + "id": 153, + "productName": "椎体成形球囊导管及组件", + "diCode": "06941332222033", + "spec": "QJ902；Φ2.9x15", + "batchNo": "212599012", + "productionDate": "210608", + "expireDate": "240608", + "registerCompany ": "浙江科惠医疗器械股份有限公司", + "registerCert": "国械注准20173040809", + "inCount": 2, + "outCount": 5, + "supName": "福建国药器械有限公司漳州分公司", + "invStorageCode": "1000", + "invStorageName": "总库", + "invSubStorageName": "骨科、试剂耗材库", + "invWarehouseCode": "1000000" + } + ] + } +} +失败 +{ + "code": 500, + "message": "错误原因", + "data": {} +} + + +