卫宁单病种管理软件对外接口文档

# 档修订记录
| 版本号 | 修订类别 | 简要说明 | 日期 | 变更人 | 批准人 |
| --- | --- | --- | --- | --- | --- |
| V1.0.0 | A | 新增winex病人单病种触发 | 2023.08.29 | 谭长昆（7011） |  |
| V1.0.0 | A | 新增winex病人是否已触发单病种 | 2023.09.04 | 谭长昆（7011） |  |
| V1.0.0 | A | 新增主数据接口规范，新增winex床位卡规范 | 2023.11.22 | 谭长昆（7011） |  |
| V1.0.0 | A | 5.接口新增personId参数 | 2023.11.30 | 谭长昆（7011） |

修订类别：C = 创建，A = 增加，M = 修改，D = 删除

# 1 目的
为CIS5.6或者WINEX的CIS和病历系统对接提供对接依据，方便与外部系统，做数据对接，完善单病种上报质控数据
# 2 范围
适用于卫宁健康科技集团股份有限公司、子公司及各分支机构

# 3. 5.6病人单病种触发接口（对应老版本3.1接口）

- **接口说明** 调用病人单病种判触发
- **提供方**   单病种系统
- **调用方**   现在只适用与5.6调用，6.0还是通过以前5.6提供的API进行传入
- **请求地址** http://ip:port/api/drgs/trigger/patient
- **请求方式** POST
- **内容类型** Content-Type = application/json;charset=UTF-8
- **入参说明**
| 字段 | 字段名称 | 必输 | 说明 |
| --- | --- | --- | --- |
| scope | 病人就诊标志 | Y | 重要0门诊1住院integer(int32) |
| systemCode | 系统代码 |  | 卫宁集团版本专用5.5、5.66.0门诊6.0住院string |
| checkKind | 触发点 | Y | 重要-1：直接进入患者单病种，如右键单病种补录0：诊断下达\手术医嘱下达\第三方系统判定需主动纳入单病种2:出院医嘱下达\电子病历病案首页提交integer(int32) |
| patientId | 病人序号 | Y | 重要，数值型，病人的唯一标识integer(int64) |
| userId | 医生编号 | Y | 员工编码string |
| hospitalCode | 医院编码 | N | 有多个院区不能通过SYXH判别病人唯一号时使用string |
| wardId | 病区ID | Y | string |
| deptId | 科室ID | Y | string |

- **出参说明**
| 字段 |  | 字段名称 | 必输 | 说明 |
| --- | --- | --- | --- | --- |
| success | | 调用是否成功 | Y |  |
| errorDetail | |错误信息 errorDetail  对象 如果success为fase会返回错误消息 | |  |
| | code | 错误编号 | Y |
| | message | 错误消息 | Y |
| | detailMsg | 错误详细信息 | Y |
| data | |触发详情 data为数组 如果success为true 会返回消息 | |  |
| | code | 编号0没有新的触发信息，且不用跳转，100弹窗提醒，101询问提示，选择“是”则跳转102不提示直接跳转 | N | 提醒和询问语是msg 跳转地址为url给出 |
| | msg | 提醒消息 | N |  |
| | url | 跳转地址 | N |  |

- **请求消息体示例**
```js
{
	"checkKind": 1,
	"deptId": "测试01",
	"hospitalCode": "01",
	"patientId": 2501,
	"scope": 1,
	"systemCode": "5.6",
	"userId": "00",
	"wardId": "测试01"
}
```
注意：checkKind根据正式业务传入对应的参数，科室与病区都是当前操作员登陆科室与病区

- **返回消息体示例**
```js
{
  "success": true,
  "count": "0",
  "data": [
    {
      "code": 101,
      "msg": "病人符合【围手术期预防感染】单病种，是否立即填报？",
      "url": "http://172.17.1.251:9084/#/redirect?visitType=filling&token=41b6b4a10fd9475b8de13dc213bb9391&docId=00&areaId=01&deptId=&wardId=&patientId=2501&scope=1"
    }
  ],
  "errorDetail": null
}
```
注意：data返回的是一个数据集合，最好做for循环，根据code判断是否要弹窗提醒，并跳转到单病种填报网页

# 4. 直接跳转到单病种工作台接口（新增）
适用版本CIS5.6 、CIS6.0大临床
http://ip:port/#/redirect?visitType=home&token=41b6b4a10fd9475b8de13dc213bb9391&docId=00&areaId=01&deptId=ce01&wardId=cs01
参数解释：

| 名称 | 说明 |
| --- | --- |
| visitType | 默认home必传 |
| token | 41b6b4a10fd9475b8de13dc213bb9391默认值 |
| docId | 医生代码 |
| areaId | 院区编码 |
| deptId | 科室代码 |
| wardId | 病区代码 |

# 5. 对接winex病人单病种触发判断接口（对应老版本3.1接口）

**接口说明**  winex调用病人单病种
**提供方**    单病种系统
**调用方**    Winex门诊医生站，住院医生站，电子病历
**请求地址**  http://ip:port/api/drgs/trigger/winexPatient
**请求方式**  POST
**内容类型**   Content-Type = application/json;charset=UTF-8
**接口调用说明** 根据不同时机调用单病种触发服务接口，返回是否需要弹卡以及弹卡信息

**入参说明:**

| 字段 | 字段名称 | 必输 | 说明 |
| --- | --- | --- | --- |
| **基本信息** | ----- | ---- | ----- |
| systemType | 系统标志 | Y | 重要0门诊1住院数值型 |
| doctorCode | 医生代码 | Y | 当前登录系统职工号 |
| orgCode | 科室代码 | Y | 当前登录科室代码 |
| wardCode | 病区代码 | N | 有病区时传入，住院必须传入 |
| callTiming | 触发点 | Y | 重要数值型-1：直接进入患者单病种，如右键单病种补录（或者快捷按钮）门诊默认传-10：诊断下达\手术医嘱下达\第三方系统判定需主动纳入单病种2:出院医嘱下达3:电子病历病案首页提交4：病案首页提交9用于病人信息同步，不触发判断 |
| visitNo | 就诊唯一号 | Y | 重要，String，病人的就诊唯一标识 |
| personId | 患者唯一标识 | Y | 重要，String，病人的唯一标识 |
| areaId | 院区代码 | Y | 重要多院区病人 |
| patName | 患者姓名 | Y | 重要 |
| patNo | 病历号或门诊号 | Y | 重要 |
| sex | 性别 | Y | 重要，男、女 |
| birth | 出生日期 | Y | 重要yyyy-MM-dd |
| age | 病人显示年龄 | Y | 重要：如19岁 |
| patIdCard | 身份证号 | N | 有则需要传入，否则影响填报数据 |
| bedNo | 床位号 | N |  |
| weight | 体重(kg) | N | 数值型有则需要提供，否则填报医生需主动录入数值型 |
| height | 患者身高（cm） | N | 有则需要提供，否则填报医生需主动录入数值型 |
| registerDate | 入院日期或者挂号日期 | Y | 重要yyyy-MM-ddHH:mm:ss住院病人是入院日期，门诊病人是挂号日期 |
| inWardDate | 入区日期 | N | 重要yyyy-MM-ddHH:mm:ss |
| outWardDate | 出区日期 | N | 重要yyyy-MM-ddHH:mm:ss |
| outDate | 出院日期 | N | 重要yyyy-MM-ddHH:mm:ss病人出院时必须有值 |
| patientStatus | 病人状态 | Y | 重要，数值型1在院2出区3出院10门诊 |
| 出院时才允许提取病人费用信息门诊默认传10 |  |  |  |
| visitDate | 就诊日期 | N | 重要yyyy-MM-ddHH:mm:ss门诊必传 |
| callingType | 触发类型 | Y | 重要数值型0=自动触发默认传01=手动触发（门诊） |
| drgCode | 手动触发病种 | N | callingType=1时有效暂时传空传入空值，则会系统自动判断患者是否已纳入，已纳入就跳转填报界面，否则会跳转选择病种界面，选择后再跳转填报界面 |
| **elements** | 病人相关元素 | Y |  |
| type | 类别 | Y | 重要，01-病人当前科室（门诊挂号科室）、02-病人当前病区、03-管床医生、04-主治医师、05-病人入院科室、06-病人入区病区、07-就诊医生（门诊） |
| id | 编码 | Y |  |
| name | 名称 | Y |  |
|  |  |  |  |
|  |  |  |  |
| **诊断信息** | ----- | ---- | ----- |
| diagCategory | 诊断类别 | Y | 重要1入院诊断2出院诊断101电子病历病案首页出院诊断102病案系统病案首页出院诊断(可不传入)等，具体查看附件诊断类别 |
| diagType | 诊断序号 | Y | 重要，数值型0、1、2、3、4从0开始，0为主要诊断 |
| diagCode | 诊断编码（内码） | Y | 重要，字典PUB_ZDDMK.ID |
| diagName | 诊断名称 | Y |  |
|  |  |  |  |
|  |  |  |  |
| **手术信息** | ----- | ---- | ----- |
| operatSource | 手术类别 | Y | 重要数值型0手术医嘱1电子病历病案首页2病案系统病案首页（可不传入） |
| operatNo | 手术序号 | Y | 数值型1、2、3、4 |
| operatCode | 手术代码（内码） | Y | 重要，字典PUB_SSMZK.ID |
| operatName | 手术名称 | Y |  |
| operatDate | 手术日期 | N | yyyy-MM-ddHH:mm:ss |
| status | 手术结束日期 | Y | 数值型0=未完成，2已完成默认传2 |

- **出参说明**

| 字段 |  | 字段名称 | 必输 | 说明 |
| --- | --- | --- | --- | --- |
| success | | 调用是否成功 | Y |  |
| errorDetail | |错误信息 errorDetail  对象 如果success为fase会返回错误消息 | |  |
| | code | 错误编号 | Y |
| | message | 错误消息 | Y |
| | detailMsg | 错误详细信息 | Y |
| data | |触发详情 data为数组 如果success为true 会返回消息 | |  |
| | code | 编号0没有新的触发信息，且不用跳转，100弹窗提醒，101询问提示，选择“是”则跳转102不提示直接跳转 | N | 提醒和询问语是msg 跳转地址为url给出 |
| | msg | 提醒消息 | N |  |
| | url | 跳转地址 | N |  |

- **请求消息体示例**

```js
{
	"baseInfo": {
		"age": "18岁",
		"areaId": "01",
		"bedNo": "12",
		"birth": "2005-08-29",
		"callTiming": "3",
		"callingType": "0",
		"doctorCode": "2289",
		"drgCode": "",
		"elements": [
			{
				"id": "4011",
				"name": "普外一科",
				"type": "01"
			},
			{
				"id": "2912",
				"name": "十二病区普外一胸外",
				"type": "02"
			},
			{
				"id": "0067",
				"name": "陈晓飒",
				"type": "03"
			},
			{
				"id": "0067",
				"name": "陈晓飒",
				"type": "04"
			},
			{
				"id": "4011",
				"name": "普外一科",
				"type": "05"
			},
			{
				"id": "2912",
				"name": "十二病区普外一胸外",
				"type": "06"
			}
		],
		"height": "170",
		"inWardDate": "2022-11-10 08:04:02",
		"orgCode": "4011",
		"outDate": "2022-12-10 09:04:02",
		"outWardDate": "2022-12-09 16:04:02",
		"patIdCard": "xxxxxxxxxxxxxxxxxx",
		"patName": "住院病人",
		"patNo": "240515",
		"patientStatus": "3",
		"registerDate": "2022-11-10 08:04:02",
		"sex": "男",
		"systemType": "1",
		"visitDate": "",
		"visitNo": "57",
		"wardCode": "2912",
		"weight": "60"
	},
	"diagnoseInfos": [
		{
			"diagCategory": "1",
			"diagCode": "Z33.x00",
			"diagName": "附带妊娠状态",
			"diagType": "0"
		},
		{
			"diagCategory": "2",
			"diagCode": "O24.900",
			"diagName": "妊娠期糖尿病",
			"diagType": "0"
		},
		{
			"diagCategory": "101",
			"diagCode": "O24.900",
			"diagName": "妊娠期糖尿病",
			"diagType": "0"
		}	
	],
	"operationInfos": [
		{
			"operatCode": "0.01001",
			"operatDate": "2020-11-29 10:30:09",
			"operatName": "头部血管治疗性超声",
			"operatNo": "1",
			"operatSource": "0",
			"status": "2"
		},
		{
			"operatCode": "0.01001",
			"operatDate": "2020-11-29 10:30:09",
			"operatName": "头部血管治疗性超声",
			"operatNo": "1",
			"operatSource": "1",
			"status": "2"
		}
	]
}

```

- **返回消息体示例**
```js
{
  "success": true,
  "data": [
    {
      "code": 101,
      "msg": "病人符合【围手术期预防感染】单病种，是否立即填报？",
      "url": "http://172.17.1.251:9084/#/redirect?visitType=filling&token=41b6b4a10fd9475b8de13dc213bb9391&docId=00&areaId=01&deptId=&wardId=&patientId=2501&scope=1"
    }
  ],
  "errorDetail": null
}
```
注意：data返回的是一个数据集合，最好做for循环，根据code判断是否要弹窗提醒，并跳转到单病种填报网页

# 8. 单病种填报表单接口
| 接口说明 | 单病种填报表单接口 |
| --- | --- |
| 提供方 | 单病种系统 |
| 调用方 | 第三方 |
| 请求地址 | http://ip:port/api/drgs/trigger/winexVerificationTrigger |
| 请求方式 | POST |
| 内容类型 | Content-Type=application/json;charset=UTF-8 |
| 接口调用说明 | 查看当前病人是否触发，已触发，则直接返回患者填报表单URL，否则返回提示错误消息 |

- 入参
| 字段 | 字段名称 | 必输 | 说明 |
| --- | --- | --- | --- |
| 基本信息 |  |  |  |
| systemType | 系统标志 | Y | 重要0门诊1住院数值型 |
| doctorCode | 医生代码 | Y | 当前登录系统职工号 |
| orgCode | 科室代码 | Y | 当前登录科室代码 |
| wardCode | 病区代码 | N | 有病区时传入，住院必须传入 |
| visitNo | 就诊唯一号 | Y | 重要，数值型，病人的唯一标识 |
| personId | 患者唯一标识 | Y | 重要，String，病人的唯一标识 |
| areaId | 院区代码 | Y | 重要多院区病人 |
| patNo | 病历号或门诊号 | Y | 重要 |
| systemCode | 调用方 | N | 默认传cis |

```js
{
	"areaId": "01",
	"doctorCode": "2289",
	"orgCode": "4011",
	"patNo": "240515",
	"systemType": "0",
	"visitNo": "57",
	"wardCode": "2912",
}

```

- 出参
| 字段 | 字段名称 | 必输 | 说明 |
| --- | --- | --- | --- |
| success | 调用是否成功 | Y |  |
| errorDetail | 错误信息 errorDetail  对象 如果success为fase会返回错误消息 |  |  |
| ---code | 错误编号 | Y |  |
| ---message | 错误消息 |  |  |
| ---detailMsg | 错误详细信息 |  |  |
| data | 触发详情 data为数组 如果success为true 会返回消息 | --- | --- |
| ---retCode | 成功响应码 | Y | --- |
| ---url | 返回填报界面URL | Y | --- |

```js
{
  "success": true,
  "data":  {
      "retCode": 100,
      "url": "http://172.17.1.251:9084/#/redirect?visitType=filling&token=41b6b4a10fd9475b8de13dc213bb9391&docId=00&areaId=01&deptId=&wardId=&patientId=57&scope=0"
   },
  "errorDetail": null
}
```

# 9. 主数据接口
| 接口说明 | 单病种主数据推送接口 |
| --- | --- |
| 提供方 | 单病种系统 |
| 调用方 | 主数据平台 |
| 请求地址 | http://ip:port/mdmDataSync/syncBaseDataWin |
| 请求方式 | POST |
| 内容类型 | Content-Type=application/json;charset=UTF-8 |
| 接口调用说明 | 当对接WINEX的时候，基础数据是没有的。现在同步方案是通过主数据进行同步的。当后台服务部署好后，在主数据系统注册管理新增服务推送主数据范围包括：域值：(主)手术操作分类与代码(国家临床3.0版），诊断：（1.2.156.112604.1.2.1702.105），院区：（1.2.156.112604.1.2.1702.7），科室病区：（1.2.156.112604.1.2.1702.49），人员：（1.2.156.112604.1.2.1702.20），科室病区关联关系：（1.2.156.112604.1.2.1702.51） |

- 入参
```js
{
	"areaId": "01",
	"doctorCode": "2289",
	"orgCode": "4011",
	"patNo": "240515",
	"systemType": "0",
	"visitNo": "57",
	"wardCode": "2912",
}
```

- 出参
```js
{
  "success": true,
  "data":  {
      "retCode": 100,
      "url": "http://172.17.1.251:9084/#/redirect?visitType=filling&token=41b6b4a10fd9475b8de13dc213bb9391&docId=00&areaId=01&deptId=&wardId=&patientId=57&scope=0"
   },
  "errorDetail": null
}
```
# 10. winex床位卡接口
| 接口说明 | 单病种主数据推送接口 |
| --- | --- |
| 提供方 | winex大临床 |
| 调用方 | 单病种系统 |
| 请求地址 | http://ip:port/api/v2/biz_gateway/ipt/external/allInOne |
| 请求方式 | POST |
| 内容类型 | Content-Type=application/json;charset=UTF-8 |
| 接口调用说明 | 根据业务标识集合刷新床位卡标签[住院网关]根据业务标识集合（就诊标识或患者角色标识）、标签事件标识刷新床位卡标签 |

- 入参
```js
{
	"Request": {
		"Head": {
			"LicId": "20200222",
			"RecAppId": "HIS0513",
			"ContentType": "json",
			"TranCode": "4199-2042-02",
			"ContentEncoding": "gzip",
			"Timestamp": "2023-11-22 13:07:49",
			"TransferType": "",
			"Mac": "fe-fc-fe-a5-4d-b5",
			"SecurityContent": "winning",
			"OrgId": "991797",
			"Callback": "",
			"AppId": "HIS0513",
			"Version": "v1",
			"SecurityPolicy": "MD5",
			"ServiceVersion": "v1",
			"RecOrgId": "991797",
			"IPAddress": "172.17.1.251",
			"AppType": "PC",
			"MessageId": "1f85a028-958a-4837-847f-b3fceae455ad"
		},
		"Body": {
			"hospitalSOID": "991797",
			"tagFlag": "false",
			"tagIds": [
				"399582250"
			],
			"encounterIds": [
				"297993221215451136"
			]
		}
	}
}
```

- 出参
```js
{
	"traceid": "04f2b2b6b27949c5a905f00fcf287b08",
	"Response": {
		"blockInWarn": false,
		"hospitalSOID": "991797",
		"Head": {
			"Version": "v1",
			"AckCode": "100",
			"AckMessage": "SUCCESS",
			"ContentType": "json",
			"TranCode": "4199-2042-02",
			"AppId": "HIS0513",
			"OrgId": "991797",
			"RecOrgId": "991797",
			"RecAppId": "HIS0513",
			"MessageId": "1f85a028-958a-4837-847f-b3fceae455ad",
			"Timestamp": "2023-11-22 13:07:49",
			"ContentEncoding": "gzip",
			"SecurityPolicy": "MD5",
			"SecurityContent": "winning"
		}
	},
	"blockInWarn": false,
	"hostip": "172.16.7.25",
	"appid": "4199",
	"hostport": "41990"
}
```

# 11. 附件：诊断类别
如业务系统不做对照转换，则请提供业务系统自身的诊断类别数据字典。

| 诊断类别名称 | 诊断类别代码 |
| --- | --- |
| 门诊诊断 | 0 |
| 入院诊断 | 1 |
| 出院诊断 | 2 |
| 中医入院诊断 | 3 |
| 中医出院诊断 | 4 |
| 修正诊断 | 5 |
| 最终诊断 | 6 |
| 初步诊断 | 7 |
| 目前诊断 | 8 |
| 术前诊断 | 9 |
| 术后诊断 | 10 |
| 产后诊断 | 11 |
| 补充诊断 | 12 |
| 死亡诊断 | 13 |
| 明确诊断 | 14 |
| 中医初步诊断 | 15 |
| 中医目前诊断 | 16 |
| 中医补充诊断 | 17 |
| 中医修正诊断 | 18 |
| 中医死亡诊断 | 19 |
| 单病种诊断 | 20 |
| 术中诊断 | 21 |
| 其他诊断 | 99 |
| 电子病历病案首页出院诊断 | 101 |
| 病案系统病案首页出院诊断(可不传入) | 102 |