某公司数据采集器客户端接口

.数据采集器客户端接口V321世纪38 / 38目 录1 简介31.1 目的31.2 围32 整体说明32.1 名词解释32.2 药监码模型32.3 文件说明32.4 角色定义42.4.1 企业客户端42.4.2 往来单位42.4.3 委托客户（第三方物流专用）43 功能需求43.1 业务功能需求43.1.1 主要功能43.1.2 补充功能103.2 系统功能需求133.2.1 数据通讯133.2.2 系统设置153.2.3 数据删除184 数据下载接口184.1 终端操作员数据下载接口184.2 上游企业出库数据下载接口194.3 往来单位列表下载接口（第三方物流PDA专用）204.4 委托客户列表下载接口（第三方物流PDA专用）204.5 药品产品编码信息下载接口（第三方物流PDA专用）215 业务数据上传接口225.1 接口规225.1.1 XML Schema规235.1.2 XML Schema规中基础数据属性表315.2 接口示例326 文件传输规396.1 文件大小396.2 文件拆分391 简介1.1 目的本文档的目的是分析药监项目中企业出入库（核准、核销）数据与中国药监网平台交互的文件接口的需求，满足企业入库核注、出库核销操作的条码数据采集和数据上传的要求。1.2 围 扫描终端围支持任何可扫描药监码的设备 适用企业围本文档适用企业包括生产企业、经营企业、第三方物流企业。2 整体说明2.1 名词解释中国药品电子监管码：最小销售单元（包装）的药监码包装药监码：外包装（中包装以上）的药监码包装级别：1级为最低级药监码，即产品药监码；2级为1级的上级包装码，依次类推。2.2 药监码模型药监码采用十六或二十位数字构成，采用Code 128C条码标识。2.3 文件说明企业按此规要求提交文件到中国药监网平台。对于文件的产生机制，企业根据自身情况实现。此规只涉与以下几类文件：1、平台下载到企业n 上游企业出库数据文件n 往来单位列表文件n 委托客户列表文件n 药品基本信息文件n 操作员信息文件2、企业上传到平台n 业务数据文件2.4 角色定义2.4.1 企业客户端部署在企业，负责运行出入库系统。根据用户输入生成企业入库单和企业出库单，并将手持终端下载到PC的数据文件(.XML)保存到本地，加密后上传到药监网平台。支持企业入库单和企业出货单查询，带有用户系统。2.4.2 往来单位与企业发生往来业务关系的单位2.4.3 委托客户（第三方物流专用）指委托第三方物流进行仓储、药品配送的客户，一般是药品生产企业。3 功能需求3.1 业务功能需求业务功能分为三种：主功能、补充功能主功能：系统核心功能。补充功能，辅助性功能。3.1.1 主要功能3.1.1.1 核注入库功能描述：该功能用于企业入库核注。1、入库操作时，用户需首先需要选择入库种类（生产入库、退货入库、购买入库、调拨入库）。2、如果用户选择退货入库、购买入库和调拨入库、且用户下载了上游企业的出库信息用来做入库数据对比。则用户首先需要扫描一个入库的药监码，终端根据该药监码显示该药品的上游企业名称、药品名称和生产批号。并将该药品的出库单作为当前的上游企业出库单号，然后进行第3步操作。如果对比药监码，没有发现任何匹配的上游企业出库单，则提示用户是否继续入库，如果用户选择“确认”，则直接执行第3，如果用户选择“取消“，则重复第2步 。如果用户未下载上游企业出库数据，则直接进行第3步操作。3、输入企业入库单号，之后根据系统设置该功能是否有附加功能，如果有，则输入附加功能所需关键数据，然后开始扫描药监码，扫描中，关键数据出现变更时，如生产日期变更，则需要重新输入，然后继续扫描。为了防止用户输入错误的单号，系统要增加一次校验，当第一次输入确认后提示“请再次输入入库单号”，如果两次输入一样则进行后续操作，如果不同，则提示“两次输入的单号不一致，请重新输入”，用户按确认后回到该步骤起始处继续输入单号；如果两次输入一样，则判断输入的入库单号在终端的入库单数据库中是否已存在，如果存在则提示用户“该入库单号已经在xxxx.xx.xx xx:xx执行了入库扫描”，同时给出两个选项“重新输入”（默认）和“追加扫描”，如果选择重新输入则回到该步骤起始处，如果选择追加扫描则进行后续操作。注：追加扫描操作的意思是指一个单子的货物分多次扫描。 xxxx.xx.xx xx:xx为时间格式，该时间为该单号起初扫描第一个码的时间4、设置药品类型。 药品类型包括：普药类型、特药类型、混合类型，系统自动读取设置中的药品类型； 系统设置为普药类型，则当前药品类型为普药类型，系统设置为特药类型，则当前药品类型为特药类型，系统设置为混合类型时，用户需再次选择药品类型（普药类型、特药类型）。 为满足一单据中仅包含一种药品类型的需求，扫描过程中需校验药监码是否匹配药品类型，如不匹配，则提示用户：“该码不符合当前药品类型，请重新扫描”，如匹配则继续扫描。（见4.1校验规则） 4.1校验规则：校验药监码类型时，可以根据码长度以与编码规则判断。4.1.1 码长度普药码长度均为20位；特药包含16、20位两种长度4.1.2 标志位普药：药监码前两位为标志位-80或81或82或83或84或85或88；特药：16位特药药监码第一位为标志位1；20位特药药监码前两位为标志位-895、扫描时，如果用户执行了第二步，则需要根据扫描的药监码查找对比数据，并显示该码所代表的药品名称、生产批号、生产日期。对比中，发现错误提示如下：a) 扫描的码属于上游企业出库的药监码，但是该码不在当前的出库单。则提示用户扫描“该码属于其他出库单”，并提示用户跳过该码。b) 扫描的码不属于上游企业出库的药监码，则提示用户“该码不属于任何出库单”，并提示用户强制输入或者重新扫描。同时，强制入库的药监码需要在上传数据时做出标记，具体见4.2.1接口规。6、用户如选择结束本次入库扫描。则返回输入企业入库单号界面。扫描完成后，软件需要显示此次扫描多少产品，表示本次入库完成。每次扫描的药监码软件需判断该药监码是否已经扫描过。如扫描过则报重码错误，用户确认后返回扫描界面继续扫描。重码判断在一样功能判断，如生产入库，则在所有入库扫描的码中判断，入库扫描后，如果做出库扫描，则不算重码。每次扫描药监码时，系统需要检查剩余药监码容量，当容量小于设定阀值时，需要报警。每次扫描药监码时，系统需要判断扫描进入的药监码长度是否等于16位或20位数字，如果不为其中一种情况，则提示用户扫描错误，并重新扫描。高端PDA专用需求：（第三方物流专用）物流企业输入出库单号时，系统需要显示出当前委托客户名称。如企业未设定当前委托客户，需要求企业输入当前委托客户。输入方式包括：1、检索方式，可通过客户名称、名称拼音简写进行模糊检索；2、可手工或者扫描输入委托客户的唯一编码，系统自动检索并进行填写。前置条件：无后置条件：入库数据导出到企业客户端。关键数据：入库种类、企业入库单编号、药监码、操作员编号、扫描时间、系统设置附加功能所需关键数据、上游企业出库数据。业务流程：3.1.1.2 核销出库功能描述：核销出库功能基本一样核注入库。区别在于用户首先需要选择出库种类（销售出库、退货出库、残次品返工出库、调拨出库、销毁出库），然后输入的是企业的出货单号。没有上游企业对比功能。重码判断、系统容量判断、码长度判断同样包括在该功能（该功能不在流程图中列出）。高端PDA专用需求：（增值服务、第三方物流专用）企业输入出库单号时，系统提供其输入收货方功能。用户可在其往来单位列表过模糊检索输入收货方。检索条件：收货方名称关键字，收货方名称拼音头字母简写。也可输入或者扫描收货方唯一编码，系统自动检索并进行输入。企业输入收货方后，系统须将该收货方编号记录，并写入上传业务数据中，具体位置和格式参加业务数据上传接口。如企业未导入往来单位列表，该字段可为空，等同于通用核销出库流程。高端PDA专用需求：（第三方物流专用）物流企业输入出库单号时，系统需要显示出当前委托客户名称。如企业未设定当前委托客户，需要求企业输入当前委托客户。输入方式包括：1、检索方式，可通过客户名称、名称拼音简写进行模糊检索；2、可手工或者扫描输入委托客户的唯一编码，系统自动检索并进行填写。前置条件：无；关键数据：企业出货单编号、药监码、操作员编号、扫描时间、系统设置附加功能所需关键数据。后置条件：出库数据上传到PC客户端。业务流程图：输入企业出库单号步骤：为了防止用户输入错误的单号，在输入单号后系统要增加一次校验，当第一次输入确认后提示“请再次输入出库单号”，如果两次输入一样则进行后续操作，如果不同，则提示“两次输入的单号不一致，请重新输入”，用户按确认后回到该步骤起始处继续输入单号；如果两次输入一样，则判断输入的出库单号在终端的出库单数据库中是否已存在，如果存在则提示用户“该出库单号已经在xxxx.xx.xx xx:xx执行了出库扫描”，同时给出两个选项“重新输入”（默认）和“追加扫描”，如果选择重新输入则回到该步骤起始处，如果选择追加扫描则进行后续操作。追加扫描操作的意思是指一个单号的货物分多次扫描。注：追加扫描操作的意思是指一个单子的货物分多次扫描。 xxxx.xx.xx xx:xx为时间格式，该时间为该单号起初扫描第一个码的时间设置药品类型。药品类型包括：普药类型、特药类型、混合类型，系统自动读取设置中的药品类型； 系统设置为普药类型，则当前药品类型为普药类型，系统设置为特药类型，则当前药品类型为特药类型，系统设置为混合类型时，用户需再次选择药品类型（普药类型、特药类型）。 为满足一单据中仅包含一种药品类型的需求，扫描过程中需校验药监码是否匹配药品类型，如不匹配，则提示用户：“该码不符合当前药品类型，请重新扫描”，如匹配则继续扫描。（见校验规则）校验规则：校验药监码类型时，可以根据码长度以与编码规则判断。 码长度普药码长度均为20位；特药包含16、20位两种长度 标志位-普药：药监码前两位为标志位-80或81或82或83或84或85或88；特药：16位特药药监码第一位为标志位1；20位特药药监码前两位为标志位-893.1.2 补充功能3.1.2.1 用户登陆功能描述：该功能用于操作员在终端登陆。用户信息从用户档案文件中读取，获得该操作员的编号。关键数据：用户名、密码业务流程图：3.1.2.2 库存盘点功能描述：该功能用于企业盘点库存数据。操作员盘点前，需要首先输入盘点任务的编号（该编号可从企业客户端处通过建立盘点任务获得），然后通过扫描药监码进行盘点操作。盘点结束后，需要显示本次盘点扫描的药监码数量。重码判断、系统容量判断、码长度判断同样包括在该功能（该功能不在流程图中列出）。关键数据：盘点任务编号、药监码、盘点数量业务流程图：3.1.2.3 药监码替换功能描述：该功能用于发生药监码损坏的情况下，将损坏码用中性码替换。该功能要求损坏药监码最少可人工识读，如果损坏药监码不可识读，则需要使用关联关系变更功能。替换药监码时，首先提示用户输入损坏的药监码，然后输入替换的中性码。重码判断、系统容量判断、码长度判断同样包括在该功能（该功能不在流程图中列出）。关键数据：损坏药监码、替换中性码、操作人前置条件：损坏药监码可人工识读后置条件：数据上传企业客户端。数据删除业务流程图：3.1.2.4 药监码注销功能描述：该功能用于企业注销药监码使用。用户使用此功能时，提示用户输入注销的药监码，用户可循环输入，直到手工选择结束为止。重码判断、系统容量判断、码长度判断同样包括在该功能（该功能不在流程图中列出）。关键数据：注销药监码，操作人业务流程图：3.2 系统功能需求3.2.1 数据通讯3.2.1.1 终端操作员数据下载功能描述：该功能用于下载用户档案基础数据，实现数据同步。下载时，由企业客户端在指定目录生成TXT文件，再由终端读取该文件并解析。下载文件后，软件自动更新现有档案文件。具体文件定义见4.1终端操作员数据下载接口关键数据：用户档案文件（操作员、编号、密码）3.2.1.2 上游企业出库数据下载功能描述：该功能用于从企业客户端上下载上游企业的出库数据使用。该数据下载后，企业在做入库时，需要先跟下载的上游企业出库数据进行对比，如果发现错误需要提示。下载接口定义见：4.2上游企业出库数据下载接口。关键数据：上游企业名称、上游企业出库单号、药监码3.2.1.3 企业业务数据上传功能描述：该功能用于将手持终端的数据整合成规定格式的XML文件，然后上传到企业客户端指定的目录。上传成功后，用户可选择清空或者继续保留手持终端数据。考虑到有可能文件会比较大，传输时间较长。上传控件必须提供检索当前文件传输百分比功能。上传数据时，需要将数据分成三部分，关联关系相关数据（建立关联、删除关联、重建关联和查验关联）生成一个XML文件，普药、特药分别生成不同的XML文件。普药、特药的XML文件分别放入两个相互独立的目录下。企业客户端上传XML文件时，选择上传普药文件，系统自动提取包含普药的所有XML文件，选择特药文件系统自动提取包含特药的所有XML文件，然后上传到企业客户端指定目录。关联关系数据上传格式见通讯接口关联关系数据上传接口其他数据上传格式见通讯接口业务数据上传接口3.2.1.4 往来单位列表下载（增值服务、第三方物流企业PDA专用）功能描述：该功能用于下载企业在客户端维护的往来单位列表。下载后，企业进行入出库操作时，可以通过检索的方式在往来单位列表中选择上游发货企业或者下游收货企业下载接口见4.3数据下载接口往来单位下载接口关键数据：往来单位名称、名称拼音简写、往来单位编码3.2.1.5 委托客户列表下载（增值服务、第三方物流企业PDA专用）功能描述：该接口用于物流企业从PC端下载委托客户列表到手持终端。用于企业进行当前委托客户设置使用。下载接口见4.4数据下载接口委托客户列表下载接口关键数据：委托客户名称、委托客户名称拼音简写、委托客户编码3.2.1.6 药品监管码基本信息下载（增值服务、第三方物流企业PDA专用）功能描述：该功能用于物流企业下载药品监管码网入围企业的药品产品编码信息。下载后，企业进行入出库操作时，可以通过检索的方式查询码对应的药品信息。下载接口见4.5数据下载接口药品产品编码信息下载接口关键数据：药品类型、生产企业、药品通用名、剂型、制剂规格、包装规格、批准文号、商品名、产品编码、包装比例、包装层级3.2.2 系统设置3.2.2.1 系统时间设置功能描述：该功能用于用户设定手持终端的系统时间。用户选择该功能后，显示系统当前时间。用户可手工输入时间，更改系统时间。关键数据：系统时间3.2.2.2 系统最低容量报警设置功能描述：该功能用于每次出库扫描时，检查系统容量，计算出剩余空间可容纳的药监码数量，显示。当剩余药监码容量小于系统预警设置的阀值时，提示用户上传并清空数据。关键数据：系统容量，药监码长度3.2.2.3 使用企业功能设置功能描述：该功能用于设置当前使用企业，备选项为生产企业、运营企业、使用单位。根据该项的设置，手持终端需要屏蔽相应的功能项，以免用户误操作。生产企业、运营企业、使用单位各自具备的功能项如下表：功能点生产企业运营企业使用单位第三方物流生产入库退货入库采购入库调拨入库销售出库销毁出库抽检出库退货出库调拨出库库存盘点药监码替换药监码注销上游企业出库单下载业务数据上传操作员数据下载往来单位列表下载委托客户列表下载委托客户设置3.2.2.4 药品类型设置功能描述：该功能用于设置采集器可支持的药品类型（药品类型包括：普药类型、特药类型、混合类型），每次制定单据时系统自动读取该设置。类型说明：1 普药类型：系统设置为普药类型，创建单据时系统自动设定为普药类型单据，扫描过程中仅可扫描属于普药类型的码。2特药类型：系统设置为特药类型，创建单据时系统自动设定为特药类型单据，扫描过程中仅可扫描属于特药类型的码。3 混合类型：系统设置为混合类型，创建单据时系统需提示用户设定药品类型（此时可选类型为：普药类型、特药类型），扫描过程中仅可扫描符合当前单据设定的药品码。关键数据：药品类型类型3.2.2.5 当前委托客户设置（第三方物流PDA专用）功能描述：该功能用于物流企业用户选择其当前操作的业务单据属于哪家客户。用户可在客户列表中设定其当前委托客户。企业选择当前委托客户的方式包括：1、检索方式，可通过客户名称、名称拼音简写进行模糊检索；2、可手工或者扫描输入委托客户的唯一编码，系统自动检索并进行填写。设定委托客户后，该客户名称需要PDA的显著位置随时可见。关键数据：委托客户名称、委托客户名称拼音简写3.2.3 数据删除功能描述：该功能用于将用户已经输入的数据。包括所有的主要功能和补充功能数据。用户删除数据时，可按照企业的出/入库单批量删除，也可按照药监码逐个删除。删除关联关系数据时，删除包装码时，同时删除下属产品码。 删除数据要求可以扫描删除。4 数据下载接口4.1 终端操作员数据下载接口接口描述：该接口用于从PC端下载手持终端操作员数据到手持终端。用于手持终端操作员登陆使用。文件名称Accounts.txt。接口标准：,（回车换行）,（回车换行）,数据属性：（长度定义为最大长度，不是指定长度）名称类型长度操作员编号数字4操作员名称字符10操作员密码字符8接口示例：0001,User1,111111110002,User2,11111.0101,User10,abcdefg4.2 上游企业出库数据下载接口接口描述：该接口用于从企业客户端下载上游企业的出库数据使用。接口标准：$，#说明：$符号：出库单开始符#符号：出库单结束符数据属性：名称类型长度企业名称字符20（汉字）出库单号字符20药品名称字符10(汉字)生产日期字符6生产批号字符20药监码字符16或20接口示例：$制药厂，10991213C2345，药品1，1234567890，0609012345，药品1，1234567890，060901#$制药厂，2932102346，药品1，1234567890，0609012345，药品1，1234567890，060901#4.3 往来单位列表下载接口（第三方物流PDA专用）接口描述：该接口用于从PC端下载往来单位列表到手持终端。用于企业入出库时，选择上游发货企业或者下游收货企业。文件名称Customers.txt。接口标准：,（回车换行）,（回车换行）,（回车换行）数据属性：（长度定义为最大长度，不是指定长度）名称类型长度往来单位名称字符30往来单位拼音头字母简写字符30往来单位编码字符12接口示例：天坛生物制品，bjttswzpysgs，BJ001积水潭医院,bjjstyy,00002.医药股份,shyyyxgs，SH2304.4 委托客户列表下载接口（第三方物流PDA专用）接口描述：该接口用于物流企业从PC端下载委托客户列表到手持终端。用于企业进行当前委托客户设置使用。接口标准：,（回车换行）,（回车换行）,（回车换行）数据属性：（长度定义为最大长度，不是指定长度）名称类型长度委托客户名称字符30委托客户拼音头字母简写字符30委托客户编码字符12接口示例：天坛生物制品，bjttswzpysgs，BJ001积水潭医院,bjjstyy,00002.医药股份,shyyyxgs，SH2304.5 药品监管码信息下载接口（第三方物流PDA专用）接口描述：该功能用于物流企业下载药品监管码网入围企业的药品产品编码信息。下载后，企业进行入出库操作时，可以通过检索的方式查询码对应的药品信息。接口标准：,，（回车换行）,，（回车换行）数据属性：（长度定义为最大长度，不是指定长度）名称类型长度药品类型字符30生产企业字符60药品通用名字符60剂型字符60制剂规格字符60包装规格字符60批准文号字符60商品名字符120药品本位码（SDC）字符30产品编码字符12包装比例字符20包装层级字符1接口示例：第二类精神药品,天坛生物制品,甘草片,片剂, 0.25mg, 袋200片, 国药准字Z1120100999,复方甘草片,00, 89300002,1:10:100,1.国家基本药物,华兰生物制品, 注射用青霉素, 注射剂, 10mg, 盒50支, 国药准字Z1120100888, 注射用青霉素,00, 8100001,1:10:50,1国家基本药物,华兰生物制品, 注射用青霉素, 注射剂, 10mg, 盒50支, 国药准字Z1120100888, 注射用青霉素,00, 8800001,1:10:20,25 业务数据上传接口5.1 接口规该接口规定义了手持终端的除关联关系数据外所有数据上传格式，上传时需要将数据按照接口规整合成一个XML文件，然后上传到企业客户端的制定目录。5.1.1 XML Schema规手持终端生成的业务数据XML文件必须符合我方提供的Schema规，结构如下：各节点注释如下表：节点名称节点含义节点属性下级节点举例：Document文档根节点License：可选EventsEventsDocument子节点，只可出现一次，用于区分多种事件产生的数据，如出库事件、码替换事件Comment扩展属性，可选Event、ActionMapping、DataMaping、DataDesc、DataFieldEventEvents子节点，定义当前事件发生哪些动作。Name：事件名称，可选PreAction：前置动作名称，可选MainAction：主动作名称，必选AfterAction：后置动作名称，可选Comment：扩展属性，可选ActionMapping、DataMaping、DataDesc、DataFieldActionMappingEvent子节点，定义当前事件激发的动作所需要的数据。例如出库动作所需数据ActionCorpOrderIDCorpOrderIDActorActorActDateCodeActionActionMapping子节点，可出现多次，定义每一个动作所需要的数据Name：Action描述的动作名称，必选ActionDataActionDataAction子节点，可出现多次，表示Action描述动作所需要要的一个数据名称DataMapingEvent子节点，当前事件所需所有数据的数据描述和列表MetaData/MetaDataDataMaping子节点，描述每一个数据的名称和属性Name：所需数据的名称Type：所需数据的类型DataDescEvent子节点，描述该事件所需所有数据的关系，该子节点可选MetaDataDescMetaDataDescDataDesc子节点，描述每一个数据与其他数据的关系，可嵌套自身节点MetaDataDescIsParent:该数据是否父属性MetaName:该数据的名称DataFieldEvent子节点，包含具体的数据具体格式见接口示例具体格式见接口示例源代码如下：5.1.2 XML Schema规中基础数据属性表类型最大长度举例备注企业出/入库单号(CorpOrderID)String201234567890；BN-01-20060707上游发货企业编号(FromCorpID)String2010192;BJ001增值服务、第三方物流PDA使用字段下游收货企业编号(ToCorpID)String2010192;BJ001增值服务、第三方物流PDA使用字段委托客户编号(OwnerCorpID)Date102006-10-09第三方物流PDA专用操作人(Actor)String12Test01操作时间(ActDate)Date192006-07-08 14:32:40是否错误码(WrongCode)Boolean5false、true上游企业出库单号(UpperCorpOrderID)String201234567890；BN-01-20060707手持终端硬件编号String30SN-19293213;232393235.2 接口示例CorpOrderIDActorActDateToCorpIDCodeEvent Name=SalesWareHouseOut MainAct