病案采集平台接口设计V1.7.2 - 院端(1).docx

病案首页采集

接口说明书

版本:V1.7.2

泰康保险集团

2020年5月

成文信息

主题词：

微服务、API、结算、接口

作者：

文档类别：

技术方案、设计文档

审核：

批准：

文档性质：

主送：

存档日期：

2019.7.10

抄送：

发布日期：

签收信息

发送方

接收方：

接收方：

接收方：

代表人：

代表人：

代表人：

代表人：

日期：

日期：

日期：

日期：

变更信息

版本

原因

作者

日期

V1.0

李妍

2019.5.29

V1.1

陈洁云

2019.7.10

V1.5.0

王坤

2019.11.18

V1.6

孙乐冉

2020.5.15

V1.7

孙乐冉

2020.5.19

V1.7.2

修改字段使用解释

YBBH、YWLSH、ZYLSH

孙乐冉

目录

TOC\o1-4\h\u第一章引言 5

1.1编写目的 5

1.2背景 5

1.3目标 5

第二章API规范 5

2.1访问路径 5

2.2服务版本 5

2.3访问地址 5

2.4过滤信息 6

2.5状态码 6

2.6返回值 6

第三章流程及接口服务设计 7

3.1业务及接口调用规则 7

3.2接口测试地址 7

3.3接口设计 8

3.3.1病案首页录入相关接口 8

检验录入接口 8

检查录入接口 11

病理录入接口 13

手术录入接口 15

中医病案首页录入接口 17

西医病案首页录入接口 36

检验作废接口 78

检查作废接口 79

病理作废接口 80

0手术作废接口 81

3.3.2结算清单信息上传接口 83

附录 146

第一章引言

1.1编写目的

本说明文档对医保支付方式改革（DRG）系统和专业系统关于结算部分的交互流程和接口做了定义和说明，开发及设计人员可以参照本说明文档进行开发和设计。

1.2背景

1.3目标

第二章API规范

RESTfulAPI是目前比较成熟的一套互联网应用程序的API设计理论。本文将遵循RESTfulAPI标准进行设计微服务的API。

2.1访问路径

在服务地址URL中定义主域名下定义api目录

例如：http(s):///api/

2.2服务版本

将服务的版本号放入URL中

例如：http(s):///api/v1/

2.3访问地址

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的集合（collection），所以API中的名词也应该使用复数。一个API提供用户（user）的信息，地址如下所示：

http(s):///api/v1/users/ID获取某个指定用户的信息

2.4过滤信息

如果需要对服务返回的信息进行过滤，客户端应该提供参数，服务器根据用户提供的参数对目标数据进行过滤，格式如下所示：

http(s):///api/v1/users?name=zhangsantelephone2.5状态码

200OK[GET]:服务器成功返回用户请求数据。

201create[POST/PUT]:新建或修改数据成功。

204NOCONTENT-[DELETE]：删除数据成功，但没有数据返回，浏览器不用刷新，不用向导新页面。

404NOTFOUND-[*]：发出的请求针对的是不存在的资源，服务器没有进行操作。

406NotAcceptable-[GET]：请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。

500INTERNALSERVERERROR-[*]：服务器发生错误，用户将无法判断发出的请求是否成功

2.6返回值

返回值一共包含4部分信息

状态码：status。

返回数据：datas是一个数据类型，里面包含要返回的一条或者多条数据

返回结果消息：message用来描述对应的相应信息，主要是给程序开发人员提供方便，通过返回message可以知道服务器处理的状态。

记录数：number如果是删除、更新操作表示影响记录数，如果是查询操作返回记录数。

具体样例

{

status:200,

datas:[{

id:123,

name:John

}],

number:1，

message:OK

}

第三章流程及接口服务设计

3.1业务及接口调用规则

医院可以依据当地的结算政策选择通过上传病案首页或者结算清单的方式