/data/insurancedb/batch_match
1.接口描述
该API的功能批量查询医保库,返回每个查询词对应的最匹配的一条记录。
请求方式:
POST
请求URL:
https://cloudapi.deepfinch.com/data/insurancedb/batch_match
调试工具
2.请求参数
2.1 请求头域
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| X-DF-API-ID | string | 是 | API调用凭证信息,详细信息请参考API调用 |
| X-DF-API-SECRET | string | 是 | API调用凭证信息,详细信息请参考API调用 |
2.2 请求体
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| region_code | string | 是 | 统一地区编码 |
| insurance_type | string | 是 | 医保类型 |
| medical_type | string | 是 | 所属大类:西药/中成药/中草药/诊疗/耗材 |
| department | string | 是 | 医院科室 |
| query_items | array | 是 | 查询词列表 |
| visit_type | string | 否 | 就诊类型:门诊/住院/急诊 |
| hospital_code | string | 否 | 医院编码 |
| hospital_level | string | 否 | 医院等级:一级/二级/三级/未定级 |
| patient_age | int | 否 | 患者年龄,默认-1 |
其中query_items的字段如下:
| 字段 | 类型 | 必需 | 描述 |
|---|---|---|---|
| query_word | string | 是 | 查询词 |
| total_price | float | 是 | 总价 |
| unit_price | float | 否 | 单价 |
| quantity | float | 否 | 数量 |
| add_charge | boolean | 否 | 是否加收,默认false |
3.返回参数
正常响应 (200)
| 字段 | 类型 | 描述 |
|---|---|---|
| request_id | string | 本次请求的 id |
| status | string | 状态。正常为 OK ,其他值表示失败。详见错误码 |
| result | array | 查询结果列表,如果未查询到对应项,返回null |
其中result的字段如下:
| 字段 | 类型 | 描述 |
|---|---|---|
| medical_type | string | 所属大类 |
| region_code | string | 统一地区编码 |
| source | string | 所属库 |
| data | object | 数据信息 |
其中data的字段如下:
| 字段 | 类型 | 描述 |
|---|---|---|
| comment | string | 备注 |
| deduction_result | object | 扣费结果,如果扣费失败,则返回null |
| dosage_form | string | 剂型,药品类型返回此字段 |
| expiration_date | string | 暂时废弃 |
| local_name | string | 暂时废弃 |
| manufacturer | string | 生产单位,药品类型返回此字段 |
| medical_category | string | 所属大类 |
| medical_level | string | 医保等级 |
| medical_list_code | string | 医保目录代码,通过是否为空判断是否非意外用药 |
| medical_type | string | 所属大类 |
| name | string | 名称 |
| price_limit | string | 限价 |
| rule_id | string | 所属库 |
| self_pay_ratio | float | 自付比例 |
| similarity | float | 匹配度, 小数值0至1之间 |
| agreement_period | string | 协议期;备注:药品类型返回此字段 |
| payment_scope | string | 除外内容(支付范围);备注:仅诊疗类型返回此字段 |
| connotation | string | 项目内涵;备注:诊疗类型返回此字段 |
| description | string | 项目说明;备注:诊疗类型返回此字段 |
| first_type | string | 一级分类;备注:耗材类型返回此字段 |
| sencond_type | string | 二级分类;备注:耗材类型返回此字段 |
| third_type | string | 三级分类;备注:耗材类型返回此字段 |
| tags | string | 暂时废弃 |
其中deduction_result的字段如下:
| 字段 | 类型 | 描述 |
|---|---|---|
| policy | string | 政策说明 |
| expression_results | array | 扣费结果,如果扣费失败,则返回null |
其中expression_results的字段如下:
| 字段 | 类型 | 描述 |
|---|---|---|
| amount | float | 扣费金额 |
| comment | string | 注释 |
| expression | string | 表达式 |
| process | string | 计算过程描述 |
| self_pay_ratio | float | 自付比例 |
输出示例:
{
"request_id": "TID4660a7b459b34b738e461b3d3ea4d284",
"status": "OK",
"result": [
{
"data": {
"comment": "",
"deduction_result": {
"expression_results": [
{
"amount": 0,
"comment": "总价范围: (0, -], 自付比例: 0.0, 是否阶梯: N",
"expression": "30 * 0.0",
"process": "总价*0.0",
"self_pay_ratio": 0
}
],
"policy": ""
},
"dosage_form": "",
"expiration_date": "",
"local_name": "单硝酸异山梨酯片",
"manufacturer": "",
"medical_category": "西药费",
"medical_level": "甲",
"medical_list_code": "XC01DAD024A001-A3B69229",
"medical_type": "西药",
"name": "单硝酸异山梨酯片",
"price_limit": "",
"rule_id": "C0",
"self_pay_ratio": 0,
"similarity": 0.875,
"tags": ""
},
"medical_type": "西药",
"region_code": "3701",
"source": "deepfinch"
},
{
"data": {
"comment": "",
"deduction_result": {
"expression_results": [
{
"amount": 0,
"comment": "总价范围: (0, -], 自付比例: 0.0, 是否阶梯: N",
"expression": "30 * 0.0",
"process": "总价*0.0",
"self_pay_ratio": 0
}
],
"policy": ""
},
"dosage_form": "",
"expiration_date": "",
"local_name": "抗狂犬病血清",
"manufacturer": "",
"medical_category": "西药费",
"medical_level": "甲",
"medical_list_code": "XJ06AAK041B001010100743",
"medical_type": "西药",
"name": "抗狂犬病血清",
"price_limit": "",
"rule_id": "C0",
"self_pay_ratio": 0,
"similarity": 1,
"tags": ""
},
"medical_type": "西药",
"region_code": "3701",
"source": "deepfinch"
},
null
]
}
4.错误码
| 状态码 | status 字段 |
说明 |
|---|---|---|
400 |
INVALID_ARGUMENT | 请求参数错误 |
400 |
QUERY_FAILED | 查询失败 |
401 |
UNAUTHORIZED | 未授权或授权失败 |
403 |
RATE_LIMIT_EXCEEDED | 调用频率超出限额 |
404 |
NOT_FOUND | 请求路径错误 |
500 |
INTERNAL_ERROR | 服务器内部错误 |
输出示例:
{
"status": "RATE_LIMIT_EXCEEDED",
"request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}