灵医智惠CDSS高级版-病案质控API开发指南v2—异步（终末质控）API¶

异步接口一般是提交数据量非常大时，通过异步任务管理机制提交任务，然后轮询查询任务状态，当任务执行成功后，再通过任务获取接口获得执行结果。通常用于终末质控，

产品功能	API	URL	method	使用使用场景	涉及单据
异步（病案质控）API	创建任务API	/cdss/fqc/job/create/v2	cdss-reminder-record-async	全病案的终末质控场景	《数据Schema规范》的全部病历单据
	查询任务状态API	/cdss/fqc/job/status/v2
	获取任务结果API	/cdss/fqc/job/result/v2

异步（终末质控）API功能¶

创建任务API¶

Warning

01cdss.baidu.com仅用于开发、测试和联调，禁止用于真实线上/线下诊疗服务。
临床真实环境请使用医院内网私有化部署的正式服务。

API Protocol: HTTP
HTTP Server: http://01cdss.baidu.com
Request Path: /cdss/fqc/job/create/v2
Request Headers: Authorization: 按照文档生成的签名 《API接口认证指南》
Request Method: POST
Content-Type: application/json; charset=utf-8
Request Body (emr格式参考文档《病案数据Schema规范》)

{
  "method": "cdss-reminder-record-async",
  "emr": {},
  "params": [
    {
      "id_list": ["0xxxx"]
    }
  ] // 可选参数, id_list指定执行的质控能力ID
}

Response

{
  "code": 0,           // code=0: job创建成功
  "jobid": "1234"      // 任务ID，用于查询任务状态和获取任务结果
}

查询任务状态API¶

API Protocol: HTTP
HTTP Server: http://01cdss.baidu.com
Request Path: /cdss/fqc/job/status/v2
Request Headers: Authorization: 按照文档生成的签名 《API接口认证指南》
Request Method: POST
Content-Type: application/json; charset=utf-8
Request Body (emr格式参考文档《病案数据Schema规范》)

{
  "jobid": "1234"
}

Response

{
  "code": 0,    // code=0: job查询成功，具体状态见status
                // code=10200: job查询失败，jobid不存在
  // status="prep": 任务排队等待执行中
  // status="running": 任务正在执行中
  // status="succeeded": 任务执行成功，请调用获取任务结果API
  // status="failed": 任务执行失败，一般是内部服务错误
  // status="killed": 任务被删除，暂时不支持删除任务，请忽略
  "status": "prep/running/succeeded/failed/killed"
}

获取任务结果API¶

API Protocol: HTTP
HTTP Server: http://01cdss.baidu.com
Request Path: /cdss/fqc/job/result/v2
Request Headers: Authorization: 按照文档生成的签名 《API接口认证指南》
Request Method: POST
Content-Type: application/json; charset=utf-8
Request Body (emr格式参考文档《病案数据Schema规范》)

{
  "jobid": "1234"
}

Response

{
  "code": 0,          // code=0：job任务执行完成且无异常
                      // code=10200: jobid不存在，或者任务还未执行完成
  "status": "prep/running/succeeded/failed/killed",
  "message": "",
  "result": [
    {
       "msg_tag": "", // 提醒消息唯一标识
      "level": "notice/warning/error",    // 提醒级别
      "type": "文书",    // 提醒类型
      "defect_type": "编码质控/内涵质控/形式质控", // 缺陷大类
      "message": "入院记录入院时间不存在",    // 提醒详细内容
      "rule_id": "xxx",                    // 质控项id
      "rule_name": "入院记录存在缺项",        // 质控点名称
      "rule_type": "入院记录存在缺项",       // 缺陷类型
      "score": -1, // 扣分值
      "doc_name": "入院记录",  // 主要单据
      "doc_id": "xxxx"  // 主要单据的记录ID
    }
  ]
}

错误码定义¶

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	不支持的资源