湖北健康卡应用平台接口文档1.4

1、居民健康卡卡管接口居民健康卡综合管理系统接口文档武汉中科信科技有限公司（中国绿线）2012年6月1·调用说明1.1 本文档的接口以请求报文/响应报文的方式交互1.2 请求报文在加密前和响应报文在解密后为标准xml格式1.3 请求报文请按本文档要求的格式构造XML，然后Base64加密传入1.4以Base64解密得到的响应报文可得到对应的XML格式的数据1.5 调用协议：Web Service1.6 字符集：UTF-81.7 调用地址：未定2·符号说明缩略语名称用法说明D纯数字D8,88位数字，如20120315A纯字母DA6,206-20位字母和数字的组合S字母和数字以外的

2、所有可打印字符AS6,66位字母和其它可打印字符的组合，不允许出现数字Z任意可打印字符Z,10001, Z=d+A+S2,示例表示0-1000个长度的字符串X十六进制字符即（0-9，a-f）X3,8可与S组合，不可与D，A组合b二进制数据b独立使用，不参与组合M必选O可选3·接口说明3.1·获取健康卡用户信息接口名称：PatientInfoQuery接口描述：根据健康卡号获取对应的持卡人信息方法声明：public String PatientInfoQuery(string inputstring)请求报文结构：字段名称节点路径格式可为空说明健康卡卡号(身份证号)Reque

3、st/IdNoDA18,18M18位，由数字和字母组成的身份证号码医疗机构编号Request/HospitalIdD5,10M5-10位纯数字，由应用平台统一分配的编号入参报文：<Request><IdNo></IdNo><HospitalId></HospitalId></Request>响应报文结构：字段名称节点路径格式可为空说明健康卡卡号(身份证号)Response/IdNoDA18,18M18位，由数字和字母组成的身份证号码患者编号Response/PatientIdDA0,40M0-40位数字和字母，由医疗机构为

4、该患者分配。持卡人姓名Response/NameZ2,20M2到20位任意可打印字符持卡人姓名拼音Response/NamePhoneticA2,20M2到20位纯字母持卡人性别Response/SexZ2,2M汉字男：女持卡人出生日期Response/DateOfBirthZ10,10M时间格式yyyy-MM-dd持卡人出生地Response/BirthPlaceZ0,40O出生地或地址持卡人国际Response/CitizenShipA2,3O2到3位字母，代表国籍持卡人民族Response/NationZ4,20O持卡人所属民族的汉字名称返回结果主键Response/ReturnKeyD

5、1,1M0：接收失败1：接收成功返回结果说明Response/ReturnValueZ2,20M对返回结果进行说明 出参报文：<Response><ReturnKey></ReturnKey><ReturnValue></ReturnValue><IdNo></IdNo><PatientId></PatientId><Name></Name><NamePhonetic></NamePhonetic><Sex></Sex&g

6、t;<DateOfBirth></DateOfBirth><BirthPlace></BirthPlace><CitizenShip></CitizenShip><Nation></Nation></Response>3.2·健康卡签约接口接口名称：contractCard接口描述：健康卡首次到某医疗机构刷卡时，与该机构签约用接口方法声明：Public String contractCard(String inputstring)请求报文结构：字段名称节点路径格式可为空说明患者

7、编号Request/PatientIdDA0,40M0-40位数字和字母，由医疗机构为该患者分配。健康卡卡号(身份证号)Request/IdNoDA18,18M18位，由数字和字母组成的身份证号码医疗机构编号Request/HospitalIdD5,10M5-10位纯数字，由应用平台统一分配的编号入参报文：<Request><PatientId></PatientId ><IdNo></IdNo><HospitalId></HospitalId></Request>响应报文结构：字段名称节点路径格式

8、可为空说明返回结果主键Response/ReturnKeyD1,1M0：签约失败1：签约成功返回结果说明Response/ReturnValueZ2,20M对返回结果进行说明出参报文：<Response><ReturnKey></ReturnKey><ReturnValue></ReturnValue></Response>3.3·健康卡签约验证接口接口名称：verifyContract接口描述：健康卡首次到某医疗机构刷卡时，与该机构签约用接口方法声明：Public String verifyContract (

9、String inputstring)请求报文结构：字段名称节点路径格式可为空说明健康卡卡号(身份证号)Request/IdNoDA18,18M18位，由数字和字母组成的身份证号码医疗机构编号Request/HospitalIdD5,10M5-10位纯数字，由应用平台统一分配的编号入参报文：<Request><IdNo></IdNo><HospitalId></HospitalId></Request>响应报文结构：字段名称节点路径格式可为空说明返回结果主键Response/ReturnKeyD1,1M0：验证通过1：未签

10、约2：无效卡（挂失，未激活不存在的卡片）返回结果说明Response/ReturnValueZ2,20M对返回结果进行说明（如已经挂失）出参报文：<Response><ReturnKey></ReturnKey><ReturnValue></ReturnValue></Response>3.4·健康卡使用记录上传接口接口名称：recordPayment接口描述：健康卡首次到某医疗机构刷卡时，与该机构签约用接口方法声明：Public String recordPayment (String inputstring)

11、请求报文结构：字段名称节点路径格式可为空说明医疗机构编号Request/HospitalIdD5,10M5-10位纯数字，由应用平台统一分配的编号患者编号Request/PatientIdDA0,40M0-40位数字和字母，由医疗机构为该患者分配。健康卡卡号(身份证号)Request/IdNoDA18,18M18位，由数字和字母组成的身份证号码开户行Request/BankZ0,40O0-40位可打印字符银行账号Request/BankAccountDA1,30M0-30位字母和数字组成开单科室Request/BillingdepartmentsZ0,40O0-40位可打印字符执行科室Requ

12、est/ExecutiondepartmentsZ0,40O0-40位可打印字符缴费项目Request/PaymentItemZ4,40M患者刷卡缴费项目名称，汉字缴费金额Request/AmountZ0,20M带小数点后两位的金额数字刷卡时间Request/PaymentTimeD14,14M14位纯数字，时间格式yyyyMMddhhmmss终端编号Request/TerminalidDA1,40M刷卡终端编号入参报文： <Request><ListItem><HospitalId></HospitalId><PatientId>&

13、lt;/PatientId><IdNo></IdNo><Bank></Bank><BankAccount></BankAccount><Billingdepartments></Billingdepartments><Executiondepartments></Executiondepartments><PaymentItem></PaymentItem><Amount></Amount><PaymentTime&

14、gt;</PaymentTime><Terminalid></Terminalid></ListItem><ListItem></ListItem> </Request>响应报文结构：字段名称节点路径格式可为空说明返回结果主键Response/ReturnKeyD1,1M0：上传成功1：上传失败返回结果说明Response/ReturnValueZ2,20M对返回结果进行说明（如已经挂失）出参报文：<Response><ReturnKey></ReturnKey><Re

15、turnValue></ReturnValue></Response>3.5·健康卡激活接口接口名称：activateCard接口描述：健康卡首次到某医疗机构刷卡时，与该机构签约用接口方法声明：Public String activateCard (String inputstring)请求报文结构：字段名称节点路径格式可为空说明健康卡卡号(身份证号)Request/IdNoDA18,18M18位，由数字和字母组成的身份证号码持卡人身份证号码Request/IdentityCardIdDA18,18M18位，由数字和字母组成的身份证号码第二证件类型Req

16、uest/DocumentTypeDA1,10O第二证件的证件类型编号。1-10位数字和字母组成第二证件号码Request/IdentificationIdDA0,40O第二证件的证件证件号码。0-40位数字和字母组成健康档案编号Request/HealthRecordIdDA0,40O健康档案的编号，由0-40位数字和字母组成。新农合证（卡）号Request/NewAgriculturalCardIdDA0,40O0-40位数字和字母组成的证件号码持卡人姓名Request/CardholderNameZ2,20M持卡人姓名，汉字持卡人姓名拼音Request/CardholderNamePin

17、YinA1,20M持卡人姓名拼音。由纯字母组成持卡人出生日期Request/DateBirthD14,14M14位纯数字，格式yyyyMMddhhmmss持卡人性别Request/GenderD1,1M1位纯数字表示性别。0-女。1-男持卡人民族编号Request/NationalIdDA0,10M由字母和数字组成的民族编号婚姻状况代码Request/MaritalStatusCodeD1,1M1位数字。0- 未婚。1-已婚。2-离异文化程度代码Request/EducationalLevelIdDA0,10M0-10位数字和字母组成。职业代码Request/OccupationalGroup

18、sldDA0,10M0-10位数字和字母组成。地址类别代码Request/AddressCategoryDA0,10M0-10位数字和字母组成。地址-省Request/ProvinceCodeD0,10M0-10位数字组成的编号。地址-市Request/CityCodeD0,10M0-10位数字组成的编号。地址-县（区）Request/CountyCodeD0,10M0-10位数字组成的编号。地址-县镇（街道）Request/TownshipCodeD0,10O0-10位数字组成的编号。地址-村（居委会）Request/VillageCodeD0,10O0-10位数字组成的编号。医疗费用支付方

19、式Request/PaymentNoDA0,10M0-10位数字和字母组成。本人电话Request/SelfPhoneD8-16O8-14位全数字（手机）联系人姓名Request/ContactNameZ4,20M4-20位可打印字符联系人关系Request/ContactRelationsZ0,20M0-20位可打印字符联系人电话Request/ContactPhoneD8-16M8-14位全数字芯片序列号Request/ChipSerialIdDA0,40M0-40位字母和数字组成安全码Request/SecurityCodeDA0,40M0-20位字母和数字组成卡的类别Request/C

20、ardCategoriesDA1,10M0-10位字母和数字组成发卡机构代码Request/CardIssuersCodeDA1,20M0-20位字母和数字组成发卡机构名称Request/CardIssuersNameZ0,40M0-40位可打印字符发卡时间Request/IssuingTimeD14,14M14位纯数字，格式yyyyMMddhhmmss卡有效期Request/CardValidityD14,14M14位纯数字，格式yyyyMMddhhmmss开户行Request/BankZ0,40M0-40位可打印字符银行账号Request/BankAccountDA1,20M0-20位字母

21、和数字组成操作员Request/OperatorZ0,20M0-20位可打印字符入参报文：<Request><IdNo></IdNo><IdentityCardId></IdentityCardId><DocumentType></DocumentType><IdentificationId></IdentificationId><HealthRecordId></HealthRecordId><NewAgriculturalCardId></N

22、ewAgriculturalCardId><CardholderName></CardholderName><CardholderNamePinYin></CardholderNamePinYin><DateBirth></DateBirth><Gender></Gender><NationalId></NationalId><MaritalStatusCode></MaritalStatusCode><EducationalLevelId

23、></EducationalLevelId><OccupationalGroupsld></OccupationalGroupsld><AddressCategory></AddressCategory><ProvinceCode></ProvinceCode><CityCode></CityCode><CountyCode></CountyCode><TownshipCode></TownshipCode><VillageCode></VillageCode><PaymentNo></PaymentNo><SelfPhone></SelfPhone&g