企业数据采集接口规范.doc

广东省食品药品监督管理局国家电子监管系统省局端系统，企业数据采集接口规范广东省食品药品监督管理局国家电子监管系统省局端系统企业数据采集接口规范建设单位：广东省食品药品监督管理局监理单位：广州市信佰信息技术咨询有限公司承建单位：深圳市天驰医药信息技术开发有限公司2012年12月12日 修改情况记录：版本号修改批准人修改人修改日期签收人目录1.概述41.1.接口内容41.2.实现方式41.3.安全控制42.术语与缩写解释43.系统入口54.接口详细说明54.1.接口功能列表54.2.响应数据格式公共约定54.3.下载经营品种库74.4.下载往来企业库104.5.上传文件124.6.下载文件处理情况14附录一 企业上传xml数据文件格式15库存记录16不合格药品记录17生产入库18采购入库19批发退货入库20零售退货入库22批发出库23零售出库24退货出库26毁损出库27抽检出库29附录二 xml数字签名30附录三 附件说明321. 概述本文档描述广东省食品药品监督管理局国家电子监管系统省局端系统平台与广东省内药品流通相关企业内部系统之间的接口规范。1.1. 接口内容提供企业经营品种库药品标准数据及其更新信息下载；提供企业往来企业库企业标准数据及其更新信息下载；接收企业上传已数字签名xml格式数据文件；提供企业上传文件处理情况。1.2. 实现方式标准HTTPS GET/POST。1.3. 安全控制 要求客户端数字证书以实现服务器端与客户端双向身份验证。 备注：目前仅支持网证通数字证书，且必须在药监局已备案。2. 术语与缩写解释缩写、术语解 释药品标准数据 以药品本位码及包装规格联合作为唯一标识，并包含药品通用名、剂型、规格、计量单位、生产企业名称属性,用于规范药品信息。企业标准数据 以企业名称为唯一标识，并包含企业类型、所属地区、详细地址属性，用于规范企业信息。企业经营品种库 与企业生产经营相关的药品标准数据集，企业可通过在企业网上办事平台手工设置、企业数据采集接口上传数据文件自动设置方式配置本企业经营品种库。企业往来企业库企业的上游供货商或下游采购商企业标准数据集，企业可通过在企业网上办事平台手工设置、企业数据采集接口上传数据文件自动设置方式配置本企业往来企业库。3. 系统入口服务器IP及端口号如下，完整连接请参照具体接口功能请求路径模板测试服务器入口：生产服务器入口：部署调整中，请联系技术支持人员。4. 接口详细说明4.1. 接口功能列表请求路径模板：https:/服务器IP及端口号/data/ clientAccept/请求入口功能名称请求入口描述下载经营品种库toOperationCommodity.do获取经营品种库药品标准数据及药品标准数据更新信息。下载往来企业库toContactsBusiness.do获取往来企业库企业标准数据及企业标准数据更新信息。上传文件toUploadFile.do上传已数字签名XML格式数据文件。下载文件处理情况toDowloadFileDeal.do获取已上传数据文件处理情况。4.2. 响应数据格式公共约定描述所有功能或特定类别的响应数据格式模板，具体功能响应描述部分不再重复介绍本部分已定义数据格式。4.2.1. 通用数据格式所有响应数据的共有格式。字段代码字段名称数据类型可为null备注resultCode操作状态代码整数否请求操作执行状态0 请求操作处理成功；1 身份验证失败，数字证书无效或未关联企业；2 系统繁忙；3 数据验证失败，缺少必须的请求参数或请求参数值无效。resultText操作状态描述文本否对操作结果的补充说明。操作成功为空。data返回结果集合/对象/具体值是请求操作的实际响应结果，根据具体功能有不同定义。resultCode=0时设置。详见各功能响应说明。JSON格式响应示例：data:,resultCode:0,resultText:XML格式响应示例： 0 4.2.2. 分页响应数据格式返回结果集合的响应数据的特定格式。字段代码字段名称数据类型可为null备注data结果数据集合集合结果数据的集合，结果数据如：药品标准数据、企业标准数据。dataId数据增量标识整数否下次请求时必选参数，仅用于标识结果数据增量信息。pageCount最大记录数整数否结果数据集合data中最大可能数据记录数量。total结果数据记录数整数否结果数据集合data中当前实际数据记录数量。如果total = pageCount表示需继续获取数据。JSON格式响应示例蓝色字体部分：data:data:,dataId:403,pageCount:100,total:2,resultCode:0,resultText:XML格式响应示例蓝色字体部分： 0 2 100 0 4.3. 下载经营品种库企业端调用此接口功能以实现企业内部药品信息与药监药品标准信息的一致性。本功能仅提供药监系统中，企业已维护的本企业经营品种库范围内的药品标准信息及其更新信息。4.3.1. 接入URLhttps:/服务器IP及端口号/data/clientAccept/ toOperationCommodity.do4.3.2. 接入方式POST/GET4.3.3. 请求参数名称是否必须描述dataId是药品数据增量标识。用于限制药品数据获取范围，第一次请求dataId可为0； 下一次请求的dataId从响应结果中的 dataId中获取。resType否响应数据格式。可选值为：xml或json;不设置本参数，缺省响应格式为json。请求示例：https:/test20120401-1:8081/data/clientAccept/toOperationCommodity.do?dataId=0&resType=xml4.3.4. 响应本功能响应格式为分页响应数据格式。响应结果集合数据对象描述示例中蓝色字体部分：字段代码字段名称数据类型可为null备注medicineCodeNumber药品本位码文本14否药品标准数据唯一标识，企业上报数据中药品数据以此两项为准。packagSpecifications包装规格文本200否medicineGeneralName药品通用名文本200否doseType剂型文本200否specifications规格文本200否measureUnit计量单位文本50否企业上报数据中药品数量单位。productionEprice生产企业名称文本200否medicineOfficeNumber批准文号文本200否JSON格式响应示例：data:data:doseType:颗粒剂,measureUnit:盒,medicineCodeNumber:15503690274573,medicineGeneralName:阿奇霉素颗粒,packagSpecifications:6袋/盒,productionEprice:药品生产企业名称,specifications:0.1g(10万单位）,doseType:小容量注射液,measureUnit:盒,medicineCodeNumber:84627325991603,medicineGeneralName:甘草酸二铵注射液,packagSpecifications:5支/盒,productionEprice:药品生产企业名称,specifications:10ml:50mg,dataId:403,pageCount:100,total:2,resultCode:0,resultText:XML格式响应示例： 0 药品本位码 注射用骨肽 注射用无菌粉末（冻干粉针） 10mg 10支/盒 支 生产企业名称 药品本位码 注射用阿奇霉素 注射用无菌粉末（冻干粉针） 0.5g 1支/支 支 生产企业名称 2 100 0 4.4. 下载往来企业库企业端调用此接口功能以实现企业内部往来企业信息与药监企业标准信息的一致性。本功能仅提供药监系统中，企业已维护的本企业往来企业库范围内的企业标准信息及其更新信息。4.4.1. 接入URLhttps:/服务器IP及端口号/data/clientAccept/toContactsBusiness.do4.4.2. 接入方式POST/GET4.4.3. 请求参数名称是否必须描述dataId是企业数据增量标识。用于限制企业数据获取范围，第一次请求dataId可为0； 下一次请求的dataId从响应结果中的 dataId中获取。resType否响应数据格式。可选值为：xml或json;不设置本参数，缺省响应格式为json。请求示例：https:/test20120401-1:8081/data/clientAccept/toContactsBusiness.do?dataId=0&resType=xml4.4.4. 响应本功能响应格式为分页响应数据格式。响应结果集合数据对象描述示例中蓝色字体部分：字段代码字段名称数据类型可为null备注enterPriceName企业名称文本200否企业标准数据唯一标识，企业上报数据中企业数据以此项为准。enterPriceType企业类型文本50否district所属地区文本200否fullAddress企业详细地址文本200否businessCodeNumber工商营业执照号文本200是JSON格式响应示例：data:data:enterPriceName:阳江市中西医结合医院,enterPriceType:药品零售企业,district:阳江江城区,fullAddress:广东省阳江市江城区建设路,enterPriceName:潮安县凤凰中心卫生院,enterPriceType:药品零售企业,district:潮州潮安县,fullAddress:潮安县凤凰镇,dataId:0,pageCount:100,total:2,resultCode:0,resultText:XML格式响应示例： 0 封开县罗董镇中心卫生院 医疗机构 封开县罗董镇罗董街2号 广东省肇庆市封开县 石药集团欧意药业有限公司 药品生产企业 石家庄市中山西路276号 河北省石家庄市桥西区 2 100 0 4.5. 上传文件企业端通过本功能接口上传已签名xml数据文件。根据企业经营性质，建议企业需上传数据业务类型如下：l 药品生产企业用户药品库存、不合格品记录、生产入库、采购入库、退货入库、批发销售出库、退货出库、毁损出库、抽检出库数据。l 药品批发企业用户药品库存、不合格品记录、采购入库、退货入库、批发销售出库、退货出库、毁损出库、抽检出库数据。l 药品零售企业用户药品库存、不合格品记录、采购入库、零售退货入库、零售销售出库、退货出库、毁损出库、抽检出库数据。除药品库存需定期上传外，其它按实际发生上传。4.5.1. 接入URLhttps:/服务器IP及端口号/data/clientAccept/toUploadFile.do 4.5.2. 接入方式POST4.5.3. 请求参数名称是否必须描述signFile是已数字签名xml文件。数据文件格式详见附录一，xml数字签名详见附录二.resType否响应数据格式。可选值为：xml或json;不设置本参数，缺省响应格式为json。请求示例：HTML格式请求表单源码： 4.5.4. 响应本功能响应格式为简单通用数据格式。响应结果描述示例中蓝色字体部分：字段代码字段名称数据类型可为null备注data文件标识整数否成功上传文件后设置，用于下载文件处理情况功能。JSON格式响应示例：data:622,resultCode:0,resultText:XML格式响应示例： 0 6224.6. 下载文件处理情况基于服务器端并发性能考虑，企业上传的文件不实时处理并反馈处理结果。文件上传成功时，系统仅反馈文件唯一标识。经过一个固定的周期，系统后台服务处理完成后，企业端可依据该唯一标识从服务器获取文件处理情况。4.6.1. 接入URLhttps:/服务器IP及端口号/data/clientAccept/toDowloadFileDeal.do 4.6.2. 接入方式POST/GET4.6.3. 请求参数名称是否必须描述fid是文件唯一标识，上传文件操作响应中的data。resType否响应数据格式。可选值为：xml或json;不设置本参数，缺省响应格式为json。请求示例：https:/test20120401-1:8081/data/clientAccept/toDowloadFileDeal.do?fid=622&resType=xml4.6.4. 响应本功能响应格式为通用数据格式。响应结果对象描述示例中蓝色字体部分：字段代码字段名称数据类型可为null备注fileId文件标识整数否dealStatus处理状态整数否文件处理状态 0 未处理；1已经处理。该值为0，后续字段无意义dealResult处理结果代码整数是文件处理结果 0：文件解析或数字签名验证失败，需解决错误问题后重新上传；1：文件处理成功，已生成正确业务单据；2：文件中药品或企业数据标准化验证失败，已生成业务单据，需登录企业网上办事平台手工修正。dealDesc处理结果描述文本是dealResult不为1时，附加错误提示。dealTime处理时间时间是other补充说明文本是JSON格式响应示例：data:dealDesc:,dealResult:,dealStatus:0,dealTime:,fileId:622,other:,resultCode:0,resultText:XML格式响应示例： 0 622 0 附录一 企业上传xml数据文件格式企业数据采集接口接收的xml数据文件分为库存记录、不合格药品记录、生产入库、采购入库、批发退货入库、零售退货入库、批发出库、零售出库、退货出库、毁损出库、抽检出库这11种业务类型。重点提示：各业务类型表单或明细条目属性描述中标记为标准化数据字段的属性，表示应为药品标准数据或企业标准数据唯一标识。各业务类型xml数据文件中根节点xmlns属性值最后部分为对应xml架构文件名称，可从本文档同一目录下的“xml架构”子目录获取对应的xml架构文件。库存记录xsd架构文件名称：yjj_qyjk_kc.xsd表单属性说明：代码名称数据类型约束/限制是否必填pdsj库存盘点截至日期日期不能晚于系统当前日期是明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生产日期是kcsl库存数量整数大于0是bz备注文本长度200否不合格药品记录xsd架构文件名称：yjj_qyjk_bhg.xsd明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是sl不合格数量整数大于0是yy不合格原因文本长度50是sfcl是否已处理布尔True/False是clfs处理方式文本长度50否clrq处理日期日期否bz备注文本长度200否生产入库xsd架构文件名称：yjj_qyjk_scrk.xsd表单属性说明：代码名称数据类型约束/限制是否必填djbh入库单号文本长度50是rqrq入库日期日期不能晚于系统当前日期是clr处理人文本长度20否明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是sl数量整数大于0是bz备注文本长度200否采购入库xsd架构文件名称：yjj_qyjk_cgrk.xsd表单属性说明：代码名称数据类型约束/限制是否必填djbh入库单号（采购方入库单号）文本长度50是rqrq购进日期日期不能晚于系统当前日期是ghqy供货企业名称文本长度200标准化数据字段是xsdh销售单号（供货方随货单号）文本长度50是yssb运输设备文本长度100否yskssj运输开始时间时间否ysjssj运输结束时间时间否wdjl温度记录文本长度100否clr验收员名称文本长度20是ysjl购进结论文本长度30是明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是sl采购数量整数大于0是bz备注文本长度200否批发退货入库xsd架构文件名称：yjj_qyjk_pfthrk.xsd表单属性说明：代码名称数据类型约束/限制是否必填djbh入库单号文本长度50是rqrq退货日期日期不能晚于系统当前日期是thqy退货企业名称文本长度200标准化数据字段是yssb运输设备文本长度100否yskssj运输开始时间时间否ysjssj运输结束时间时间否wdjl温度记录文本长度100否clr验收员名称文本长度20是ysjl验收结论文本长度30是明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是sl退货数量整数大于0是yy退货原因文本长度50是xsdh销售单号文本长度50是bz备注文本长度200否零售退货入库xsd架构文件名称：yjj_qyjk_lsthrk.xsd表单属性说明：代码名称数据类型约束/限制是否必填djbh入库单号文本长度50是rqrq退货日期日期不能晚于系统当前日期是clr处理人文本长度20否明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是sl退货数量整数大于0是yy退货原因文本长度50是xsdh销售单号文本长度50否bz备注文本长度200否批发出库xsd架构文件名称：yjj_qyjk_pfck.xsd表单属性说明：代码名称数据类型约束/限制是否必填djbh销售单号文本长度50是ckrq销售日期日期不能晚于系统当前日期是cgqy采购企业名称文本长度200标准化数据字段是clr销售员文本长度20否ysfs运输方式文本长度100否cyr承运人文本长度200否yskssj运输开始时间时间否ysjssj运输结束时间时间否qywd起运温度文本长度20 单位:摄氏度否ddwd到达温度文本长度20单位:摄氏度否明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是sl销售数量整数大于0是bz备注文本长度200否零售出库xsd架构文件名称：yjj_qyjk_lsck.xsd表单属性说明：代码名称数据类型约束/限制是否必填djbh销售单号文本长度50是ckrq销售日期日期不能晚于系统当前日期是clr销售员文本长度20否明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是sl销售数量整数大于0是bz备注文本长度200否退货出库xsd架构文件名称：yjj_qyjk_thck.xsd表单属性说明：代码名称数据类型约束/限制是否必填djbh出库单号文本长度50是ckrq退货日期日期不能晚于系统当前日期是ghqy供货企业名称文本长度200标准化数据字段是clr处理人文本长度20否ysfs运输方式文本长度100否cyr承运人文本长度200否yskssj运输开始时间时间否ysjssj运输结束时间时间否qywd起运温度文本长度20 单位:摄氏度否ddwd到达温度文本长度20单位:摄氏度否明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是sl退货数量整数大于0是yy退货原因文本长度50否xsdh销售单号（供货企业随货单号）文本长度50是bz备注文本长度200否毁损出库xsd架构文件名称：yjj_qyjk_hsck.xsd表单属性说明：代码名称数据类型约束/限制是否必填djbh出库单号文本长度50是ckrq出库日期日期不能晚于系统当前日期是clr处理人文本长度20否明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是sl毁损数量整数大于0是yy毁损原因文本长度50否ghqy供货企业名称文本长度200否xsdh销售单号文本长度50否bz备注文本长度200否抽检出库xsd架构文件名称：yjj_qyjk_cjck.xsd表单属性说明：代码名称数据类型约束/限制是否必填djbh出库单号文本长度50是ckrq出库日期日期不能晚于系统当前日期是cjdw抽检单位名称文本长度200否cjyy抽检原因文本长度200否clr处理人文本长度20否明细条目属性说明：代码名称数据类型约束/限制是否必填bwm本位码文本长度 14标准化数据字段是bzgg包装规格文本长度200标准化数据字段是scph生产批号文本长度50是scrq生产日期日期不能晚于系统当前日期是yxqz有效期至日期大于生成日期是kcsl库存数量整数大于0否cjsl抽检数量整数大于0是bz备注文本长度200否附录二 xml数字签名为保障企业上报数据的安全，便于确认企业上报原始文档未被修改，企业通过“企业数据采集接口”上报的xml文件必须经过数字签名。本接口可接受的xml文件数字签名遵循W3C 推荐规范- XML签名的语法和处理规范XML-Signature Syntax and Processing W3C Recommendation 12 February 2002。补充约定如下：采用封装签名（Enveloping）格式，签名和原始xml文件内容在同一个XML文档中，原始xml文件内容作为签名的内部节点；签名文件必须附带数字证书信息,签名文件中证书信息相关部分必须设置，且按如下所示指定顺序提供/。示例:pHdUADSXDNMmM7py0zuNlx6gQKE=Ym9uW9ePzi1f0F6vMtTMIpiUC2gNI0o2X8gYvF7yiuXLtUPqN4G1yavil/VTrbFvPxpfEZkdlxL7PU+9oYie4k4pF+fbQhxbkSr5v81t+JHtt37evQyTvWi+8gi7kU/ZbjpF4Msk7PuwrDUOez1e6bWBBvyIvet6UfMN3YXP92U=CN=NETCA Individual ClassA CA, OU=Individual ClassA CA, O=NETCA Certificate Authority, C=CN53721960771501034418789216508892913400MIID9zCCAt+gAwIBAgIQKGp5KavX8ujDBgo/bvee+DANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJDTjEkMCIGA1UEChMbTkVUQ0EgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MR0wGwYDVQQLExRJbmRpdmlkdWFsIENsYXNzQSBDQTEjMCEGA1UEAxMaTkVUQ0EgSW5kaXZpZHVhbCBDbGFzc0EgQ0EwHhcNMTIwNDE4MTYwMDAwWhcNMTMwNDE5MTU1OTU5WjBkMQswCQYDVQQGEwJDTjESMBAGA1UECBMJR3Vhbmdkb25nMSUwIwYDVQQDHhxOKk66bUuL1QAyADAAMQAxADAANAAyADIAMQA2MRowGAYJKoZ