灵医智惠CDSS标准版API开发指南v1——HIS/EMR系统¶
| 产品功能 | API | method |
|---|---|---|
| 医嘱质控 | 医嘱质控API | cdss-reminder-emr |
| 疑似诊断推荐 | 疑似诊断推荐API | cdss-diagnose |
| 疑似诊断推荐理由详情API | cdss-detail-diagnose | |
| 鉴别诊断推荐API | cdss-ddx | |
| 治疗方案推荐 | 治疗方案推荐API | cdss-treat |
| 知识库 | 知识库检索API | cdss-kb-search |
| 知识库详情API | cdss-kb-detail-new | |
| 相似病历 | 相似病历推荐API | cdss-emr-similar |
| 病历检索API | cdss-emr-search | |
| 病历详情API | cdss-detail-emr |
患者数据规范¶
医嘱可以和门诊记录/入院记录支持同时提交，也支持分开提交。
门诊记录¶
{
"场景": ["门诊记录"],
"trigger": "保存/提交/CDSS", // 触发CDSS的方式
// 1) 保存：点击保存时自动触发；
// 2) 提交：点击提交时自动触发；
// 3) CDSS：点击单独新增的CDSS按钮触发。
// 工作人员信息
"医院": "", // [必填]医院名称
"科室": "", // [必填]科室名称
"医生": "", // [必填]工作人员姓名
"uid": "", // [必填]医疗信息系统账号
// 患者信息
"诊疗类型": "门诊/急诊/体检", // [必填]
"诊疗次数": "", // "1":初诊，大于1表示复诊
"rid": "", // [必填] 住院号 或者 门诊号
"pid": "", // [必填] 患者ID
"年龄": "28岁", // [必填] xx岁/xx月/xx天/xx小时
"性别": "男/女", // [必填]
"出生日期": "", // YYYY-MM-DD
"职业": "",
"出生地": "",
"现住地": "",
"费用类型": "医保/商保/自费/公费/等",
"身高": "180cm",
"体重": "70kg",
"ABO血型": "A/B/AB/O",
"Rh血型": "阴/阳",
"婚姻状态": "未婚/已婚/离异/丧偶",
// 门诊记录
"门诊科室": "",
"门诊日期": "yyyy-MM-dd HH:mm:ss",
"主诉": "",
"现病史": "",
"既往史": "",
"个人史": "",
"月经史": "",
"婚育史": "",
"家族史": "",
"过敏史": "",
"接种史": "",
"体格检查": "",
"辅助检查": "",
"专科检查": "",
"诊断": [
{
"诊断类型": "初步诊断/补充诊断/确诊诊断/其他诊断/门诊诊断",
"诊断结果": "",
"主要诊断": "是/否"
}
]
}
入院记录¶
{
"场景": ["入院记录"],
"trigger": "保存/提交/CDSS", // 触发CDSS的方式
// 1) 保存：点击保存时自动触发；
// 2) 提交：点击提交时自动触发；
// 3) CDSS：点击单独新增的CDSS按钮触发。
// 工作人员信息
"医院": "", // [必填]医院名称
"科室": "", // [必填]科室名称
"医生": "", // [必填]工作人员姓名
"uid": "", // [必填]医疗信息系统账号
// 患者信息
"诊疗类型": "门诊/急诊/体检", // [必填]
"诊疗次数": "", // "1":初诊，大于1表示复诊
"rid": "", // [必填] 住院号 或者 门诊号
"pid": "", // [必填] 患者ID
"年龄": "28岁", // [必填] xx岁/xx月/xx天/xx小时
"性别": "男/女", // [必填]
"出生日期": "", // YYYY-MM-DD
"职业": "",
"出生地": "",
"现住地": "",
"费用类型": "医保/商保/自费/公费/等",
"身高": "180cm",
"体重": "70kg",
"ABO血型": "A/B/AB/O",
"Rh血型": "阴/阳",
"婚姻状态": "未婚/已婚/离异/丧偶",
// 入院记录
"入院科室": "",
"入院日期": "yyyy-MM-dd HH:mm:ss",
"主诉": "",
"现病史": "",
"既往史": "",
"个人史": "",
"月经史": "",
"婚育史": "",
"家族史": "",
"过敏史": "",
"接种史": "",
"体格检查": "",
"辅助检查": "",
"专科检查": "",
"诊断": [
{
"诊断类型": "初步诊断/入院诊断/补充诊断/确诊诊断/其他诊断/鉴别诊断/出院诊断",
"诊断结果": "",
"主要诊断": "是/否"
}
]
}
医嘱¶
{
"场景": ["医嘱"],
"trigger": "保存/提交/CDSS", // 触发CDSS的方式
// 1) 保存：点击保存时自动触发；
// 2) 提交：点击提交时自动触发；
// 3) CDSS：点击单独新增的CDSS按钮触发。
// 工作人员信息
"医院": "", // [必填]医院名称
"科室": "", // [必填]科室名称
"医生": "", // [必填]工作人员姓名
"uid": "", // [必填]医疗信息系统账号
// 患者信息
"诊疗类型": "门诊/急诊/体检", // [必填]
"rid": "", // [必填] 住院号 或者 门诊号
"pid": "", // [必填] 患者ID
"年龄": "28岁", // [必填] xx岁/xx月/xx天/xx小时
"性别": "男/女", // [必填]
"医嘱": [
{
"处方ID": "", // 处方号
"医嘱单号": "", // [必填] 医嘱项目的唯一ID，一个门诊处方下的药品之间医嘱ID不同，处方ID相同，请注意：医嘱ID是全局唯一的，不是医嘱项目院内编码
"医嘱类型": "用药/检验/检查/诊疗/手术/护理/出院带药", // [必填]
"医嘱项": "", // [必填]
"长期或临时": "长期/临时", // [必填]
"医嘱状态": "新开/执行/停止/取消", // [必填]
"创建时间": "yyyy-MM-dd HH:mm:ss", // 医嘱创建时间
"审核时间": "yyyy-MM-dd HH:mm:ss", // 医嘱审核时间
"开始时间": "yyyy-MM-dd HH:mm:ss", // 医嘱下达的预期开始时间
"结束时间": "yyyy-MM-dd HH:mm:ss", // 医嘱下达的预期结束时间
"医嘱开立科室": "",
"医嘱开立者": "",
"医嘱审核科室": "",
"医嘱审核者": "",
// 以下为用药医嘱独有字段
"用药天数":"",
"国药准字号": "", // 医嘱类型=用药时 [必填]
"输液单号": "1",
"服药途径": "口服/皮下注射/肌肉注射/静脉注射/外用/雾化吸入/等", // 医嘱类型=用药时 [必填]
"服药频率": "", // 医嘱类型=用药时 [必填]
"单次剂量": "", // 医嘱类型=用药时 [必填]
"总剂量": "", // 医嘱类型=用药时 [必填]
"剂量单位": "", // 医嘱类型=用药时 [必填]
"药物商品名": "", // 医嘱类型=用药时 [必填]
"药物通用名": "",
"药物编码": "",
"药物类别": "电解质平衡调节药",
"药物剂型": "注射剂/片剂/胶囊剂/丸剂/散剂/气雾剂/等",
// 以下为检查医嘱、检验医嘱独有字段
"报告单号": "" // 检验报告单号或者检查报告单号
},
{ // 医嘱执行记录, 不需要传完整的医嘱信息，只需要传如下字段即可，同一条医嘱多次执行拆成多条医嘱（这些医嘱ID相同，执行时间不同）
"医嘱单号": "", // [必填] 医嘱ID
"医嘱类型": "用药/检验/检查/诊疗/手术/护理/出院带药", // [必填]
"医嘱项": "", // [必填]
"长期或临时": "长期/临时", // [必填]
"医嘱状态": "新开/执行/停止/取消", // [必填]
"执行时间": "yyyy-MM-dd HH:mm:ss", // [必填] 医嘱实际执行的时间
"医嘱执行科室": "",
"医嘱执行者": "",
"皮试结果": "" // 皮试结果
}
]
}
医嘱质控功能¶
医嘱质控API¶
Warning
01cdss.baidu.com仅用于开发、测试和联调，禁止用于真实线上/线下诊疗服务。
临床真实环境请使用医院内网私有化部署的正式服务。
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-reminder-emr)"
> **[warning] 注意**
>
> 此处emr格式只有部分字段，仅用于示例，不是完整定义，emr的详细定义请严格遵守《患者数据规范》中的医嘱
```json
{
"method": "cdss-reminder-emr",
"emr": {
"场景": ["医嘱"],
"trigger": "保存/提交/CDSS",
"医院": "",
"科室": "",
"医生": "",
"uid": "",
"rid": "",
"pid": "",
"年龄": "28岁",
"性别": "男/女",
"诊疗类型": "急诊/门诊/住院/体检",
"医嘱": [
{
"医嘱单号": "",
"医嘱类型": "用药/检验/检查/诊疗/手术/护理/出院带药",
"医嘱项": "",
... // 完整定义请严格遵守《患者数据规范》中的医嘱
}
]
}
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"level": "notice/warning/error", //提醒级别
"type": "文书/检验/检查/手术/治疗", // 提醒类型
"message": "提醒详细内容"
}
]
}
```
疑似诊断推荐功能¶
疑似诊断推荐API¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-diagnose)"
> **[warning] 注意**
>
> 此处emr格式只有部分字段，仅用于示例，不是完整定义，emr的详细定义请严格遵守《患者数据规范》中的门诊记录或入院记录
```json
{
"method": "cdss-diagnose",
"emr": {
"场景": ["门诊记录/入院记录"],
"trigger": "保存/提交/CDSS",
"医院": "",
"科室": "",
"uid": "",
"rid": "",
"pid": "",
"诊疗类型": "门诊/住院/急诊/体检",
"年龄": "28岁",
"性别": "男/女",
"主诉": "",
"现病史": "",
"既往史": "",
... // 完整定义请严格遵守《患者数据规范》中的门诊记录或入院记录
}
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"kgid": "013", // CDSS内部诊断id，用于请求治疗方案推荐和鉴别诊断推荐API
"name": "支气管哮喘", // 诊断疾病名
"tag": [""], // 诊断标签：甲类传染病、甲类传染病、乙类传染病、待查
"selected": 1, // 勾选状态
// 0: 未勾选
// 1: 勾选，医生写的诊断默认处于勾选状态
"hospital_code": "", // 医院诊断编码，完成术语对照后才会返回该字段
"detail": 1, // 1: 该诊断有知识库详情数据，可通过kgid请求“知识库详情API”
// 0: 该诊断没有知识库详情数据
"expand": 1, // 1: 该诊断有疑似诊断推荐理由数据，可通过kgid请求“疑似诊断推荐理由API”
// 0: 该诊断没有疑似诊断推荐理由数据
}
]
}
```
疑似诊断推荐理由详情API¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-detail-diagnose)"
```json
{
"method": "cdss-detail-diagnose",
"emr": {}, // emr可选，格式同疑似诊断推荐API
// 传入emr可以支持诊断理由高亮
// 不传emr字段无法高亮与患者病历内容匹配的诊断理由
"id": ["疑似诊断推荐API结果中的kgid"]
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"fields": ["症状", "体征", "诱因", "检查", "检验", "家族史", "个人史", "病史"], // fields中字段是动态展现的，并不是所有诊断的推荐理由都有上述字段
"症状": [
{
"name": "",
"highlight": 1 // 高亮标记，代表患者病历中有该症状
}
],
"体征": [
{
"name": "",
"highlight": 1
}
],
"诱因": [
{
"name": "",
"highlight": 1
}
],
"检查": [
{
"name": "",
"highlight": 1
}
],
"检验": [
{
"name": "",
"highlight": 1
}
],
"家族史": [
{
"name": "",
"highlight": 1
}
],
"个人史": [
{
"name": "",
"highlight": 1
}
]
}
]
}
```
鉴别诊断推荐API¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-ddx)"
```json
{
"method": "cdss-ddx",
"id": ["疑似诊断推荐API结果中的kgid"], // 医生已下达诊断时id字段可省略，将医生下达的诊断放在"emr"中即可
"emr": {} // emr格式同疑似诊断推荐API
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"诊断": "支气管哮喘", // request中id对应的诊断名称
"鉴别诊断": [
{
"name": "", // 鉴别诊断名称
"kgid": "", // CDSS内部鉴别诊断id
"reason": "", // 推荐理由
"hospital_code": "" // 医院鉴别诊断编码
}
]
}
]
}
```
治疗方案推荐功能¶
治疗方案推荐API¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-treat)"
```json
{
"method": "cdss-treat",
"id": ["疑似诊断推荐API结果中的kgid"], // 医生已下达诊断时id字段可省略，将医生下达的诊断放在"emr"中即可
"emr": {} // emr格式同疑似诊断推荐API
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"fields": ["检查", "检验", "药物", "手术", "量表"], // 推荐类型有序列表
"检查": [
{
"name": "", // 检查项目名称
"kgid": "", // CDSS内部检查项目id
"type": "检查", // 推荐类型，冗余字段
"reason": "", // 推荐理由
"selected": 0, // 勾选状态
"hospital_code": "" // 医院检查项目编码
}
],
"检验": [
{
"name": "", // 检验项目名称
"kgid": "", // CDSS内部检验项目id
"type": "检验", // 推荐类型，冗余字段
"reason": "", // 推荐理由
"selected": 0, // 勾选状态
"hospital_code": "" // 医院检验项目编码
}
],
"药物": [
{
"name": "", // 药物名称
"kgid": "", // CDSS内部药物id
"type": "药物", // 推荐类型，冗余字段
"reason": "", // 推荐理由
"selected": 0, // 勾选状态
"hospital_code": "" // 医院药物编码
}
],
"手术": [
{
"name": "", // 手术名称
"kgid": "", // CDSS内部手术id
"type": "手术", // 推荐类型，冗余字段
"reason": "", // 推荐理由
"selected": 0, // 勾选状态
"hospital_code": "" // 医院手术编码
}
],
"量表": [
{
"name": "", // 量表名称
"kgid": "", // CDSS内部量表id
"type": "检查", // 推荐类型，冗余字段
"reason": "", // 推荐理由
"table_url": "" // 量表网页地址
}
]
}
]
}
```
知识库功能¶
知识库检索API¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-kb-search)"
```json
{
"method": "cdss-kb-search",
"query": "gxy",
"params": [
{
"type": ["疾病", "药品", "检查", "检验", "手术", "量表"]
}
]
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"name": "高血压",
"type": "疾病",
"id": "疾病ID"
},
{
"name": "阿司匹林",
"type": "药品",
"id": "药品ID"
},
{
"name": "",
"type": "量表",
"id": "量表ID",
"url": "量表网页地址"
}
]
}
```
知识库详情API¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-kb-detail-new)"
```json
{
"method": "cdss-kb-detail-new",
// id来源1: 知识库检索API结果中的id
// id来源2: 治疗方案推荐API结果中的检查/检验/手术的kgid
// id来源3: 疑似诊断推荐API结果中的疾病的kgid
"id": [""]
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"name": "高血压",
"type": "疾病",
"url": "疾病知识网页地址"
},
{
"name": "阿司匹林",
"type": "药品",
"url": "药品说明书网页地址"
}
]
}
```
药品说明书API（通过国药准字号获取药品说明书）¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-kb-detail-cfda)"
```json
{
"method": "cdss-kb-detail-cfda",
"cfdaid": "国药准字号"
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"name": "阿司匹林",
"type": "药品",
"url": "药品说明书网页地址"
}
]
}
```
相似病历功能¶
相似病历推荐API¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-emr-similar)"
```json
{
"method": "cdss-emr-similar",
"emr": {}, // emr格式请严格遵守《患者数据规范》中的门诊记录或入院记录
"params": [
{
"page": 1, // 翻页参数，第几页
"pageSize": 10 // 翻页参数，每页结果数量
}
]
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"id": "00003",
"date": "2018-01-12",
"诊疗类型": "门诊/住院",
"年龄": "67岁",
"性别": "男",
"科室": "呼吸内科",
"fields": [ // 展现字段有序列表，根据病历类型动态调整
"主诉",
"现病史",
"初步诊断/入院诊断/确诊诊断/出院诊断"
],
"主诉": "",
"现病史": "",
"出院诊断": "",
"检索诊断": "" // 最后确诊的主要诊断，可以用作标题展现
}
],
"extra": {
"totalNum": 100 // 符合条件的病历结果总数，用于计算翻页总页数
}
}
```
病历检索API¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-emr-search)"
```json
{
"method": "cdss-emr-search",
"query": "咳嗽，胸闷3个月",
"params": [
{
"page": 1, // 翻页参数，第几页
"pageSize": 10, // 翻页参数，每页结果数量
"date": ["2015-01-01", "2018-12-01"], // 指定时间范围检索病历
"age": ["20", "50"], // 指定年龄范围检索病历
"department": "呼吸内科", // 指定科室检索病历
"sex": "女" // 指定性别检索病历
}
]
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"id": "00003",
"date": "2018-01-12",
"cdr_url": "",
"诊疗类型": "门诊/住院",
"年龄": "67岁",
"性别": "男",
"科室": "呼吸内科",
"fields": [ // 展现字段有序列表，根据病历类型动态调整
"主诉",
"现病史"
],
"主诉": "",
"现病史": "",
"检索诊断": "" // 最后确诊的主要诊断，可以用作标题展现
}
],
"extra": {
"totalNum": 100 // 符合条件的病历结果总数，用于计算翻页总页数
}
}
```
病历详情API¶
- API Protocol:
HTTP - HTTP Server:
http://01cdss.baidu.com - Request Path:
/cdss/standard/api/v1 - Request Headers:
Authorization: 按照文档生成的签名《API接口认证指南》 - Request Method:
POST - Content-Type:
application/json; charset=utf-8 - Request Body
??? note "请点击箭头查看内容 (method = cdss-detail-emr)"
```json
{
"method": "cdss-detail-emr",
"id": ["相似病历推荐API和病历检索API结果中的id"]
}
```
- Response
??? note "请点击箭头查看内容"
```json
{
"code": 0,
"message": "",
"result": [
{
"id": "00003",
"诊疗类型": "门诊/住院",
"年龄": "67岁",
"性别": "男",
"科室": "呼吸内科",
"emr": [
{
"type": "入院记录",
"date": "2018-01-12",
"fields": [ // 展现字段有序列表，根据病历类型动态调整
"主诉",
"现病史",
"体格检查"
],
"主诉": "",
"现病史": "",
"体格检查": ""
}
]
}
]
}
```
错误码定义¶
| code | 错误类别 | 含义 |
|---|---|---|
| 0 | 正常 | 正常 |
| 1xxxx | 语法错误 | 请求URI错误、参数缺失、参数格式错误 |
| 2xxxx | 权限错误 | 鉴权失败、流量超过限制等 |
| 3xxxx | 网络错误 | 某个网络服务出现连接失败、请求超时等 |
| 4xxxx | 内部错误 | 内部异常、数据异常等 |
| code | 含义 |
|---|---|
| 0 | 正常（返回结果可能为空） |
| 10100 | method不存在 |
| 10200 | 请求参数异常，请仔细对照文档检查请求数据格式 |
| 20100 | license过期，请联系灵医智惠CDSS商务人员重新申请 |
| 20200 | 权限异常，无权访问该资源 |
| 20300 | 异常流量 |
| 30100 | 服务连接异常，一般是某个依赖服务连接失败 |
| 30200 | 服务超时，请重试或者减少单次检索的数据量 |
| 40100 | 服务数据异常，内部错误 |
| 40200 | 代码抛异常 |
| 40300 | 未知异常 |
| 40400 | 初始化异常，启动失败 |
| 40500 | 配置异常，请检查配置文件 |
| 40600 | 不支持的资源 |
注意事项¶
1.code不为0时表示接口异常，对接时可做好日志记录，无需在系统中弹出错误信息，影响就诊流程。 2.调用CDSS系统时，无论是否请求成功，做好异常处理（设置请求超时时间，建议3秒），保证医院就诊业务正常运行。