1.7.1 接口规则
规则 | 规则描述 |
---|---|
调用方式 | 动态库 |
提交方式 | 动态库接口 |
数据格式 | 提交和返回数据均为 JSON 格式 |
字符编码 | 统一采用 GBK 字符编码 |
判断逻辑 | 先判断协议字段返回,再判断业务返回,最后判断交易状态 |
签名算法 | 请求和响应均需要签名 |
1.7.2 格式规定
1.7.2.1 日期时间格式
格式:YYYYMMDDHHMMSS。
1.7.2.2 交易金额格式约定
交易金额默认为人民币交易,接口中参数支付金额单位为【元】。对账单中的交易金额单位为【元】。
1.7.2.3 医疗机构业务流水号约定
医疗机构业务流水号由医疗机构自定义生成,并要求医疗机构业务流水号保持唯一性。建议按系统时间(YYYYMMDDHHMMSS)加 3 位随机字符串加机构编号的规则来生成流水号。
1.7.2.4 报文格式约定
请求报文和响应报文都由报文头和报文体(data)组成;以下是通用报文头的说明;具体报文体参数(data)详见各个业务接口说明。注:若业务接口无特殊说明,请求报文均需要组装报文头参数,若字段的可空属性出现 N/Y 的情况,则表明需要根据具体医院来定是否必传。
1.7.2.5 通用请求报文头参数说明
序号 | 参数名 | 参数描述 | 参数类型 | 参数长度 | 代码标识 | 是否必填 | 备注 |
---|---|---|---|---|---|---|---|
1 | orgId | 机构 ID | 字符 | 40 | N | Y | 机构代码 |
2 | transType | 交易类型 | 字符 | 40 | N | Y | 接口交易代码 |
3 | data | 接口请求参数 | 字符 | 2048 | N | Y | JSON 格式字符串 |
4 | extra | 扩展参数 | 字符 | 2048 | N | N | JSON 格式字符串 |
1.7.2.6 通用响应报文头参数说明
序号 | 参数名 | 参数描述 | 参数类型 | 参数长度 | 代码标识 | 是否必填 | 备注 |
---|---|---|---|---|---|---|---|
1 | orgId | 机构 ID | 字符 | 40 | N | Y | |
2 | code | 返回码 | 数值 | 4 | Y | Y | 接口返回值非 0 时,该出参为交易错误信息, 详见表
A.4 返回值代码表 |
3 | message | 返回信息 | 字符 | 200 | N | N | code 非 0 时有效 |
4 | data | 接口响应参数 | 字符 | 2048 | N | Y | JSON 格式字符串 |
5 | extra | 扩展参数 | 字符 | 2048 | N | N | JSON 格式字符串 |
1.7.3 动态库调用方法
1.7.3.1 动态库名称
调用的动态库名称:SSCard.dll
1.7.3.2 交易接口调用函数
函数声明 | long WINAPI NationEcTrans(char* strUrl,char* InData,char* OutData) | |||||
---|---|---|---|---|---|---|
返回类型 | 返回长整型 | |||||
参数名 | 参数类型 | 参数长度 | 是否允许空 | 参数说明 | 备注 | |
入参说明 | strUrl | 字符 | 2048 | N | 业务请求地址 | |
InData | 字符 | 2048 | N | 交易请求数据 | JSON 格式字符串 | |
参数名 | 参数类型 | 参数长度 | 是否允许空 | 参数说明 | 备注 | |
出参说明 | OutData | 字符 | 2048 | 交易返回数据 | code 为 0 时,交易成功;否则返回错误信息说明 | |
值 | 业务含义 | |||||
返回值 | 0 | 调用成功 | ||||
其他 | 错误信息 |
1.7.4 电子凭证二维码解码接口
1.7.4.1 交易对象
交易发送方:定点医药机构。
交易接收方:医保电子凭证中台。
1.7.4.2 接口描述
用于电子凭证二维码解码。
1.7.4.3 交易类型编码
ec.query
1.7.4.4 出入参说明
请求入参
请求报文头参数详见接口规则的通用请求报文头参数说明:
序号 | 参数名 | 参数描述 | 参数类型 | 参数长度 | 是否必填 | 备注 |
---|---|---|---|---|---|---|
1 | orgId | 机构 ID | 字符 | 40 | Y | 医保定点机构代码 |
2 | businessType | 用码业务类型 | 字符 | 5 | Y | 详见附录A.1 |
3 | operatorId | 收款员编号 | 字符 | 20 | Y | 收款员编号 |
4 | operatorName | 收款员姓名 | 字符 | 30 | Y | 收款员姓名 |
5 | officeId | 医保科室编号 | 字符 | 20 | Y | 医保科室编号 |
6 | officeName | 科室名称 | 字符 | 30 | Y | 科室名称 |
7 | deviceType | 设备类型 | 字符 | 30 | Y | 自助机该字段设为 SelfService,其它情况不用设置 |
响应data 出参:
序号 | 参数名 | 参数描述 | 参数类型 | 参数长度 | 是否必填 | 备注 |
---|---|---|---|---|---|---|
1 | idNo | 参保人身份证 | 字符 | 64 | Y | |
2 | idType | 证件类型 | 字符 | 64 | Y | 详见附录 A.2 |
3 | userName | 参保人姓名 | 字符 | 64 | Y | |
4 | ecToken | 令牌 | 字符 | 40 | Y | 用于业务处理验证 |
5 | insuOrg | 参保地区编码 | 字符 | 6 | Y | |
6 | ecIndexNo | 电子凭证索引号 | 字符 | 32 | N | |
7 | gender | 性别 | 字符 | 2 | N | |
8 | birthday | 出生日期 | 字符 | 10 | N | |
9 | nationality | 国籍 | 字符 | 32 | N | |
10 | 电子邮箱 | 字符 | 32 | N | ||
11 | extra | 扩展参数 | 字符 | N | 预留字段 |
1.7.4.5 请求参数示例(未加密)
入参报文:
//医院
{
"data": {
"businessType": "01101",
"deviceType": "",
"officeId": "32760",
"officeName": "外科",
"operatorId": "test001",
"operatorName": "cn",
"orgId": "H630199000"
},
"orgId": "H630199000",
"transType": "ec.query"
}
响应参数示例(未加密)
{
"code": 0,
"data": {
"ecIndexNo": "8785FE16AA83A91FBF27432682244463",
"ecToken": "3600001fgqmcalc3930c014a0a0000b203b63a",
"idNo": "630321198604153732",
"idType": "01",
"insuOrg": "630199",
"userName": "张三"
},
"message": "成功"
}
//药店
{
"data": {
"orgId": "H0000000",
"officeId": "",
"operatorName": "李保国",
"operatorId": "30562",
"deviceType": "",
"officeName": "",
"businessType": "02121"
},
"orgId": "H0000000",
"transType": "ec.query"
}
响应参数示例(未加密)
{
"code": 0,
"data": {
"authNo": null,
"bindAuthCode": null,
"birthday": null,
"chnlId": "1DBHJRS5I01E0F34A8C00000B959FA87",
"defPayChnlId": null,
"ecIndexNo": "151BF7BA157F6EC26DB5D648F717C5E5",
"ecQrCode": "1283914112600868480001000000",
"ecToken": "300000ecgvp9k75td909d24d0a000078dcca6f",
"email": null,
"gender": null,
"idNo": "360000000000",
"idType": "01",
"insuOrg": "361100",
"latlnt": null,
"nationality": null,
"showCodeType": null,
"signCntrNo": null,
"signFlag": null,
"userName": "刘某某"
},
"message": "成功",
"orgId": "H0000000"
}
1.7.5 附录
表A.1 电子凭证用码业务类型表
第一级编码 | 第一级名称 | 第二级编码 | 第二级名称 | 第二级说明 |
---|---|---|---|---|
01 | 医院 | 101 | 挂号 | 替代社保卡 (预约挂号,现场挂号,取号候诊) |
102 | 住院建档 | 替代身份证、社保卡 | ||
103 | 入院登记 | 替代社保卡 | ||
104 | 缴纳预缴金 | 替代住院押金卡 | ||
201 | 问诊 | 替代挂号条、社保卡 | ||
202 | 预约检查 | 替代检查凭条、社保卡 | ||
203 | 检查 | 替代检查凭条、社保卡 | ||
204 | 治疗 | 替代挂号条、社保卡 | ||
301 | 结算 | 替代社保卡(门诊结算,出院结算) | ||
302 | 取药 | 替代取药凭条、社保卡(门诊取药,出院带药) | ||
303 | 取报告 | 替代取报告凭条 | ||
304 | 打印票据和清单 | 替代挂号条、社保卡(打印收费清单,票据清单,结
算单,异地就医结算单) |
||
305 | 病历材料复印 | 替代身份证、社保卡(门诊和住院各类材料复印) | ||
02 | 药店 | 121 | 药店购药 | 替代社保卡 |
122 | 下载外购处方 | 替代社保卡、身份证 | ||
03 | 医疗类
APP |
131 | 医疗类APP 线上身份认证 | 替代社保卡,目前地方医保 APP 都是绑定社保卡 |
132 | 医疗类APP 线上结算 | 替代社保卡,目前地方医保 APP 都是绑定社保卡 |
例:在医院挂号,业务类型编码为:01101
A.2 证件类型代码表
证件代码 | 证件说明 |
---|---|
01 | 居民身份证(户口簿) |
02 | 中国人民解放军军官证 |
03 | 中国人民武装警察警官证 |
04 | 香港特区护照/港澳居民来往内地通行证 |
05 | 澳门特区护照/港澳居民来往内地通行证 |
06 | 台湾居民来往大陆通行证 |
07 | 外国人永久居留证 |
08 | 外国人护照 |
11 | 外国人就业证 |
12 | 外国专家证 |
13 | 外国人常驻记者证 |
14 | 台港澳人员就业证 |
15 | 回国(来华)定居专家证 |
16 | 中国护照 |
17 | 港澳台居民居住证 |
99 | 其他身份证件 |