02.接口清单宝瑞达药品领jinhua-dsg soa jinyiv0

1、金华市SOA项目 SOA集成接口SOA与业务系统的接口说明国际商业机器(中国)文档信息文档目标（以下简称 IBM）在实施金华市中心与各业务系统之间的接口说明。本文档描述了国际商业机器（中国）医院SOA 集成项目过程中有关集成修订历史文档名称金华市SOA集成与司之间的接口说明作者类别文件名称a-DSG-SOA-Jinyi-20131021-v0.1.doc摘要修订历史版本号日期修订人摘 要0.12013-10-21新建目 录文档信息2文档目标2修订历史2接口规范5公共接口6服务监测6功能描述6接口描述6认证ID6功能描述6接口描述6药品采购7药品信息7功能描述7接口描述7药品库

2、存7功能描述7接口描述8药品请领8功能描述8接口描述8药品出库9功能描述9接口描述9数据定义10通用返回10通用返回BasicMsg10字符串返回StringMsg10药品采购...药品信息Medi10药品库存返回MSMsg11药品库存MS12请领单主信息MR..7.请领单表体MRBody13出库单主信息MO14出库单表体MOBody155. 附录175.1. 结果代码171.接口规范详细接口规范参见“a-DSG-SOA-Format-20130625-v0.1.doc”2.公共接口服务监测功能描述通过该健康检查机制

3、监测业务系统服务的可用性，对接入业务系统提供的服务进行可用性检查，以获得时间应答，从而确保能够及时发现应用是否可用。2.1.2.接口描述详细接口定义参见“a-DSG-SOA-COC-20130515-v0.1.doc”。认证 ID功能描述公共编码为各接入到 SOA 集成的业务系统生成唯一的认证 ID，即所有接口方法的输入参数 authID，各业务系统可根据取到authID。的系统代码或者自身服务地址从 SOA 获为了安全性考虑，各业务系统需要将接收到的 authID 与本系统 authID 进行验证。如果一致，则通过验证，进行下一步接口处理，如果不一致，则验证不通过，直接返回身份验证失败的错误

4、消息。同样，本系统在调用其他业务系统的接口时，需要将本系统authID 作为输入参数。2.2.2.接口描述详细接口定义参见“a-DSG-SOA-COC-20130515-v0.1.doc”。3.药品采购药品信息功能描述HIS 将药品信息和好的药品编码等信息实时上传到司系统，由司进行将 HIS司系统药品信息的数据对照工作，在后续的请领和出库过程中，均采用HIS的药品信息。该接口是由司系统作为服务端提供服务，HIS 作为客户端调用司系统提供的服务实现药品信息的实施上传。3.1.2.接描述药品库存功能描述司系统在制定药品采购计划时，有可能需要参考HIS的各个药品仓库各药品当前的即时库存信息，但不需要

5、实时获取。因此，司系统可根据自身的业务需求在制定计划时，适时通过该接口从HIS 获取到药品的即时库存信息。接口名称WS_MEDI方法名称SUBMIT_MEDI_INFO功能描述HIS通过SOA集成提交好的药品信息到司系统服务提供方司系统服务请求方HIS输入参数序号参数数据类型说明1authIDString系统认证ID，由SOA提供2mediListList药品基本信息列表，对象定义参见数据定义Medi输出参数序号参数数据类型说明1basicMsgBasicMsg接口调用通用返回，对象定义参见数据定义BasicMsg备注口3.2.2.接描述药品请领功能描述HIS 提交药品请领信息到多个药品的请领

6、信息。司系次可提交多个请领单，一个请领单可包含司系统接收到药品请领信息后，立即进行数据处理，并同步将处理成功与否的信息返回给 HIS。如果处理失败，司系统需要给出详细的处理失败的原因，HIS 需要处理失败的原因，以便后续排查。3.3.2.接描述接口名称WS_MEDI方法名称SUBMIT_MEDI_MPR功能描述HIS通过SOA集成提交药品请领信息到司系统服务提供方司系统服务请求方HIS口接口名称WS_MEDI方法名称GET_MEDI_MS功能描述司系统通过SOA集成从HIS查询各仓库药品的即时库存信息服务提供方HIS服务请求方司系统输入参数序号参数数据类型说明1authIDString系统认证

7、ID，由SOA提供2valueString查询条件值。当type为 0 时，查询所有仓库所有药品的库存；当type为 1 时，查询指定药品的库存，多个药品之间用英文半角逗号分隔；当type为 2 时，查询指定仓库的所有药品库存。3typeString查询类型，0-所有，1-药品，2-仓库输出参数序号参数数据类型说明1msMsgMSMsg药品库存信息，对象定义参见数据定义MSMsg备注口3.4.药品出库3.4.1.功能描述司系统将药品请领所对应的出库信息传输到 HIS。一次可提交多个药品的出库，每条药品出库与一个药品请领单对应，以便数据核对。HIS 接收到信息司系统的药品出库信息后，立即进行数据

8、处理，并同步将处理成功与否的信息返回给金益公司系统，然后再进行 HIS出详细的处理失败的原因，的药品入库等业务流程。如果处理失败，HIS 需要给司处理失败的原因，以便后续排查。3.4.2.接描述接口名称WS_MEDI方法名称SUBMIT_MEDI_MOR功能描述司系统通过SOA集成将药品请领单对应的药品出库信息提交到HIS服务提供方HIS服务请求方司系统输入参数序号参数数据类型说明1authIDString系统认证ID，由SOA提供2morListList药品出库信息，对象定义参见数据定义MOR输出参数序号参数数据类型说明1basicMsgBasicMsg接口调用通用返回，对象定义参见数据定义

9、BasicMsg备注口输入参数序号参数数据类型说明1authIDString系统认证ID，由SOA提供2mprListList药品请领信息，对象定义参见数据定义MPR输出参数序号参数数据类型说明1basicMsgBasicMsg接口调用通用返回，对象定义参见数据定义BasicMsg备注4.数据定义通用返回通用返回BasicMsg4.1.2.字符串返回StringMsg药品采购药品信息Medi序号字段名数据类型长度是否可空注释1.mediIdString20否药品ID序号字段名数据类型长度是否可空注释1.valueString-否接口调用返回代码2.descString-是接口调用返回代码描述3

10、.basicMsgBasicMsg-否通用返回对象，对象定义参见通用返回对象BasicMsg4.res1String-是预留字段5.res2String-是预留字段6.res3String-是预留字段7.res4String-是预留字段8.res5String-是预留字段序号字段名数据类型长度是否可空注释1.retCodeString10否接口调用结果代码，参见附录2.retDescString-是接口调用结果描述3.res1String-是预留字段4.res2String-是预留字段5.res3String-是预留字段6.res4String-是预留字段7.res5String-是预留字段4

11、.2.2.药品库存返MSMsg序号字段名数据类型长度是否可空注释1.msListList-否药品库存信息2.basicMsgBasicMsg-否通用返回对象，对象定义参见通用返回对象 BasicMsg3.res1String-预留字段4.res2String-预留字段5.res3String-预留字段6.res4String-预留字段7.res5String-预留字段回2.mediNameString100否药品名称3.factIdString20否产地ID4.factNameString100否产地名称5.cateCodeString10否药品分类代码6.cateNameString50否药

12、品分类名称7.specString100否规格8.formCodeString10否剂型代码9.formNameString50否剂型名称10.purUnitCodeString10否请领计量代码11.purUnitNameString50否请领计量名称12.packCoefeger-否拆零系数13.pyCodeString20是拼音码14. res1String是预留字段15. res2String是预留字段16. res3String是预留字段17. res4String是预留字段18. res5String是预留字段4.2.3.药品库存MS4.2.4.hau 请领单主信息MPR序号字段名

13、数据类型长度是否可空注释1.mrSeqeger-否序号序号字段名数据类型长度是否可空注释1.mediIdString20否药品ID2.mediNameString100否药品名称3.factIdString20否产地ID4.factNameString100否产地名称5.whCodeString20否仓库代码6.whNameString100否仓库名称7.cateCodeString10否药品分类代码8.cateNameString50否药品分类名称9.specString100否规格10.formCodeString10否剂型代码11.formNameString50否剂型名称12.retU

14、nitCodeString10否零售计量代码13.retUnitNameString50否零售计量名称14.packCoefeger-否拆零系数15.-是零售单价，保留两位小数，人民币，：元retPritring16.pyCodeString20是拼音码17.tyString-否实际库存量18.res1String-是预留字段19.res2String-是预留字段20.res3String-是预留字段21.res4String-是预留字段22.res5String-是预留字段4.2.5.请领单表体MPRBody序号字段名数据类型长度是否可空注释1.mprbSeqeger否排序号2.mprSeq

15、eger-否关联的计划单主信息序号3.mprBillNoString20否关联的请领单主信息据号2.whCodeString20否仓库代码3.whNameString100否仓库名称4.billNoString20否计划单据号5.bizDateString20否请领日期，格式：yyyy MM dd6.billTypeString2否单据类型，0 请领，1 到货（公司出库单），2 退货7.cateCodeString10否药品分类代码8.cateNameString50否药品分类名称9.mprBodyList-否单据表体，对象定义参见请领单表体MRBody10. susString2否单据状态，

16、0 保存，1 提交， 2 生效，3 作废，4 HIS已到货（公司已出库）5 部分退货，5 整单退货，6 关闭11.creatorString50否制单人12.createTsString20否创建时间，格式：yyyy-MM-dd HH:mm:ss13. lastUpdUserString50是最后修改人14. lastUpdTsString20是最后修改时间，格式：yyyy MM dd HH:mm:ss15. res1String是预留字段16. res2String是预留字段17. res3String是预留字段18. res4String是预留字段19. res5String是预留字段20

17、.audituseraudituser否人21.auditdateauditdate否日期4.2.6.出库单主信息MOR序号字段名数据类型长度是否可空注释1.morSeqeger-否序号2.mprSeqeger否关联的请领单主信息序号3.whCodeString20否仓库代码4.whNameString100否仓库名称5.billNoString20否出库单据号6.mprBillNoString20否关联的请领单主信息单据号7.bizDateString20否出库日期，格式：yyyy-MM-dd4.mediIdString20否药品ID5.mediNameString100否药品名称6.fac

18、tIdString20否产地ID7.factNameString100否产地名称8.specString100否药品规格9.cateCodeString10否药品分类代码10. cateNameString50否药品分类名称11. purUnitCodeString10否计量代码12.purUnitNameString50否计量名称13. packCoefeger否拆零系数14. 是含税采购单价，保留两位小数，：元taxedPritring15.tyString-否请领数量16. susString2否行状态，0 未到货，1 已到 货，2 已退货17. res1String是预留字段18. r

19、es2String是预留字段19. res3String是预留字段20. res4String是预留字段21. res5String是预留字段4.2.7.出库单表体MORBody序号字段名数据类型长度是否可空注释1.morbSeqeger-否排序号2.morSeqeger-否关联的出库单主信息序号3.mprbSeqeger-否关联的请领单明细信息序号4.mprBillNoString20否关联的请领单主信息据号5.mediIdString20否药品ID6.mediNameString100否药品名称7.factIdString20否产地ID8.factNameString100否产地名称9.s

20、pecString100否药品规格10. cateCodeString10否药品分类代码8.cateCodeString10否药品分类代码9.cateNameString50否药品分类名称10.morBodiesList-否单据表体，对象定义参见出库单表体MOBody11.taxedAmtString-否含税总金额，保留两位小数，：元12. susString2否单据状态，0 保存，1 提交， 2 生效，3 作废，4 HIS已到货（公司已出库）5 部分退 货，5 整单退货，6 关闭13.creatorString50否制单人14.createTsString20否创建时间，格式：yyyy-MM-dd HH:mm:ss15.lastUpdUserStrin