患者主索引系统 软件系统与外部接口说明.doc

文件编号 WN YYCP 004 软件系统与外部接口说明 1 0 患者主索引系统患者主索引系统 软件系统与外部接口说明软件系统与外部接口说明 上海金仕达卫宁软件股份有限公司 20152015年6 6月 外部接口说明 XXXXXXXX公司 第 2 页 共 38 页 修订历史记录修订历史记录 日期日期版本版本说明说明作者作者 2015 6 21 0 初稿编写 景斌景斌 外部接口说明 XXXXXXXX公司 第 3 页 共 38 页 目目 录录 1 引言引言 4 1 1 编写目的 4 1 2 读者对象 4 1 3 定义 首字母缩写词和缩略语 4 1 4 参考资料 4 1 5 环境要求 4 2 概述概述 4 3 接口流程接口流程 4 3 1 HIS 4 3 1 1 挂号登记 入院登记 4 3 1 2 患者信息维护 6 3 1 3 接收通知 6 3 2 CIS 6 3 2 1 门诊医生站 6 3 2 1 1 既往病历 6 3 2 1 2 检验检查结果 7 3 2 1 3 接收通知 8 3 2 2 住院医生站 8 3 2 2 1 既往病历 8 3 2 2 2 检验检查结果 9 3 2 2 3 接收通知 10 3 2 3 医技系统 10 3 2 3 1 接收通知 10 4 接口方式接口方式 10 4 1 WEB SERVICE方式 10 4 2 页面集成方式 10 5 接口列表接口列表 11 接口列表详细参见附件EMPI WEBSERVIC接口规范 11 6 接口步骤接口步骤 11 详细介绍所涉及到的接口开发步骤及开发语言等 11 7 附录 常见问题解答附录 常见问题解答 11 外部接口说明 XXXXXXXX公司 第 4 页 共 38 页 1 1 引言引言 1 1 1 1 编写目的编写目的 1 2 1 2 编写目的编写目的 用户操作手册编写目的是明确本软件的功能 软件的作用 功能的操作 帮助用户理解及 操作本软件 1 3 1 3 读者对象读者对象 1 4 1 4 定义 首字母缩写词和缩略语定义 首字母缩写词和缩略语 EMPI 患者主索引 1 5 1 5 参考资料参考资料 无 1 6 1 6 环境要求环境要求 详见软件系统运行环境软硬件要求 2 2 概述概述 在此简明介绍接口背景 3 3 接口流程接口流程 3 1 3 1 HISHIS 3 1 1 3 1 1 挂号登记挂号登记 入院登记入院登记 外部接口说明 XXXXXXXX公司 第 5 页 共 38 页 挂号登记 入院登记 EMPI注册服务RegisterPatient 判断返回参数 EMPI界面操作 AY 注册成功 自动合并AA 1 HIS 挂号登记 与 入院登记 操作时 调用 EMPI 注册服务 EMPI 将注册 患者的信息与数据库中的患者信息进行匹配 当 EMPI 返回 AY 时 表示有相似患者 弹出集成的 EMPI 界面 对相似患 者进行合并操作 当匹配度符合自动合并匹配值时 则判定找到匹配患者 EMPI 系统对患者 信息进行自动合并 EMPI 返回 AA 当无匹配项时 EMPI 系统对患者信息进行注册操作 EMPI 返回 AA 外部接口说明 XXXXXXXX公司 第 6 页 共 38 页 挂号登记 入院登记 EMPI注册服务RegisterPatient 判断返回参数 EMPI界面操作 AY 注册成功 自动合并AA 2 HIS 挂号登记 与 入院登记 操作时 调用 EMPI 注册服务 EMPI 将注册 患者的信息与数据库中的患者信息进行匹配 当 EMPI 返回 AY 时 表示有相似患者 弹出集成的 EMPI 界面 对相似患 者进行合并操作 当匹配度符合自动合并匹配值时 则判定找到匹配患者 EMPI 系统对患者 信息进行自动合并 EMPI 返回 AA 当无匹配项时 EMPI 系统对患者信息进行注册操作 EMPI 返回 AA 3 1 2 3 1 2 患者信息维护患者信息维护 外部接口说明 XXXXXXXX公司 第 7 页 共 38 页 患者信息维护 EMPI更新服务UpdatePatient 判断返回参数 EMPI界面操作 AY 更新成功AA 1 HIS 患者信息维护 操作成功后 调用患者更新服务 EMPI 返回 AA 即 更新成功 若 EMPI 返回 AY 即更新成功 但有相似患者 弹出集成的 EMPI 界面 对相似患者进行合并操作 2 考虑到不同医院业务上的应用 需要配置相应开关 如医院不希望登记时进 行合并 拆分操作 则只做注册操作 3 当其他业务系统对患者信息进行维护后 患者信息发生变化 则 HIS 需要接 收 EMPI 的变更通知 注册 合并 拆分 进行变更同步 3 1 3 3 1 3 接收通知接收通知 当其他业务系统对患者信息进行维护后 患者信息发生变化 则 HIS 需要接 收 EMPI 的变更通知 注册 合并 拆分 进行变更同步 3 2 3 2 CISCIS 3 2 1 3 2 1 门诊医生站门诊医生站 3 2 1 1 3 2 1 1 既往病历既往病历 外部接口说明 XXXXXXXX公司 第 8 页 共 38 页 CIS门诊医生站 挂号序号 EMPI查询服务 QueryVisit 判断返回参数 CIS提醒错误信息 AE 查询成功 返回历次就诊简 要信息 AA提醒无记录NY CIS 门诊医生站根据 挂号序号 调用 EMPI 就诊查询服务 获取返回的历次 就诊登记信息 包括挂号序号 就诊时间 科室 医生等 CIS 根据就诊登记信 息查询详细的既往病历 门诊 住院 CIS 获取的历次就诊登记信息以就诊时间 和科室作为树形节点名称 默认定位到本次 界面添加 全院 门诊 住院单选框 默认选中 门诊 添加就诊记录下拉 选择框 默认选中本次 3 2 1 2 3 2 1 2 检验检查结果检验检查结果 医生站工具箱下的医技报告界面 根据当前的挂号序号调用 EMPI 服务 获取历 次的就诊登记信息 门诊和住院 CIS 根据就诊登记信息查询历次报告 门诊 住 院 界面 全院 门诊 住院单选框 默认选中 门诊 添加就诊记录下拉选 择框 默认选中本次 外部接口说明 XXXXXXXX公司 第 9 页 共 38 页 注 通过全院 门诊 住院单选框 过滤 就诊记录 3 2 1 3 3 2 1 3 接收通知接收通知 当其他业务系统对患者信息进行维护后 患者信息发生变化 则 CIS 需要接收 EMPI 的变更通知 注册 合并 拆分 进行变更同步 3 2 2 3 2 2 住院医生站住院医生站 3 2 2 1 3 2 2 1 既往病历既往病历 外部接口说明 XXXXXXXX公司 第 10 页 共 38 页 CIS门诊医生站 挂号序号 EMPI查询服务 QueryVisit 判断返回参数 CIS提醒错误信息 AE 查询成功 返回历次就诊简 要信息 AA提醒无记录NY CIS 门诊医生站根据 挂号序号 调用 EMPI 就诊查询服务 获取返回的历次 就诊登记信息 包括挂号序号 就诊时间 科室 医生等 CIS 根据就诊登记信 息查询详细的既往病历 门诊 住院 CIS 获取的历次就诊登记信息以就诊时间 和科室作为树形节点名称 默认定位到本次 界面添加 全院 门诊 住院单选框 默认选中 门诊 添加就诊记录下拉 选择框 默认选中本次 3 2 2 2 3 2 2 2 检验检查结果检验检查结果 医生站工具箱下的医技报告界面 根据当前的挂号序号调用 EMPI 服务 获取历 次的就诊登记信息 门诊和住院 CIS 根据就诊登记信息查询历次报告 门诊 住 院 界面 全院 门诊 住院单选框 默认选中 门诊 添加就诊记录下拉选 择框 默认选中本次 外部接口说明 XXXXXXXX公司 第 11 页 共 38 页 注 通过全院 门诊 住院单选框 过滤 就诊记录 3 2 2 3 3 2 2 3 接收通知接收通知 当其他业务系统对患者信息进行维护后 患者信息发生变化 则 CIS 需要接收 EMPI 的变更通知 注册 合并 拆分 进行变更同步 3 3 3 3 医技系统医技系统 3 3 1 3 3 1 接收通知接收通知 当其他业务系统对患者信息进行维护后 患者信息发生变化 则医技系统需要 接收 EMPI 的变更通知 注册 合并 拆分 对患者信息进行变更同步 4 4 接口方式接口方式 4 1 4 1 WebWeb ServiceService 方式方式 该方式是通过 Web Service 将 EMPI 的服务功能提供给目标系统 远端的 Web Service 的路径格式为 http 127 0 0 1 8095 HandlePatient asmx 其中 IP 和 Port 需要根据实际的服务器配置来决定 4 2 4 2 页面集成方式页面集成方式 该方式暂时支持合并功能 通过 URL 地址形式提供给第三方系统调用 URL 示例如下 http 172 16 0 211 14003 main html logintype 使用类型 orgid 机构代码 sysid 系统代码 userid 操作用户代码 mparas 主索引号 外部接口说明 XXXXXXXX公司 第 12 页 共 38 页 URL 参数说明 参数名称参数说明备注 logintype 使用类型 具体取值 1 合并操作 2 拆分操作 orgid 机构代码如医院代码等 sysid 系统代码最好具体到最小系统的代码 userid 操作用户代码 mparas 患者主索引号 extraparam 预留参数预留 暂时未用 5 5 接口列表接口列表 5 1 5 1 接口总览接口总览 名称函数功能类型 接口初始化测试及验 证 InitTest 主要用于测试 EMPI 是 否可用 以及对应的医疗 机构和业务系统是否在 EMPI 中登记注册 查询 患者注册 RegisterPatient 主要用于登记患者的 基本信息和就诊信息 处理 标识符查询 QueryIdentifier 主要用于查询患者的 标识符信息 查询 基本信息查询 QueryPatient 主要用于查询患者的 基本信息 查询 患者合并 MergePatient 主要用于合并患者处理 疑似患者查询 QuerySimilar 主要用于查询疑似患 者 查询 患者 ID 查询 QueryIdentifierByID 主要用于查询患者的 各类 ID 号 查询 外部接口说明 XXXXXXXX公司 第 13 页 共 38 页 患者拆分 SplitPatient 主要用于拆分患者处理 通知 SetNotice 由各业务系统提供 用于接收 EMPI 的通知 处理 5 2 5 2 接口初始化测试及验证接口初始化测试及验证 接口名称 InitTest string orgCode string sysCode 接口描述主要用于检测 EMPI 服务的可用性 以及对应的机构和系统是否已经注册 输入参数orgCode 机构代码 sysCode 系统代码 输出参数 即返回值 返回 NULL 或空值 表示成功 否则 返回错误信息 其他 5 3 5 3 患者注册患者注册 接口名称 RegisterPatient string inxml 接口描述 主要用于门诊或住院患者的注册登记 包括新增和修改患者基本信息两种 操作 输入参数string 类型的 XML 输出参数 即返回值 string 类型的 XML 其他 输入参数的 XML 说明 节点名称子节点允许空值说明 Facility 非空 发送源的医疗机构代码 即当 前系统所在的医院 院区代码 该字 段内容需要根据医院的实际情况而 定 ConfigHeader Application 非空 发送源的医疗系统代码 即当 前系统的代码 外部接口说明 XXXXXXXX公司 第 14 页 共 38 页 CardID 非空 标识符 医保卡号 患者 ID 院内卡号等 DomainCode 非空 域代码 相当于标识符类型 请参考域代码域代码 Facility 可空 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 PatientIDs Patie ntID 其中 PatientIDs PatientID 是可以重复的 表示有多个标识符 标识符和域代 码应该同时存在 GlobalPID 患者主索引号 FamilyName 非空 姓 如果是中国人 姓和名可 以都放在此字段 中间名一般为空 GivenName 名 MiddleName 中间名 MothersMaidenName 母亲姓名 DateTimeOfBirth 出生日期 格式 1935 01 02 Sex 性别代码 M 男 F 女 请参考性别代码性别代码 PrimaryLanguage 母语 MaritalStatus 婚姻状况代码 请参考婚姻状况代码婚姻状况代码 Religion 宗教信仰 SSNNumber 社会安全号 相当于身份证号 SourcePatient DriversLicenseNumber 驾驶证号 外部接口说明 XXXXXXXX公司 第 15 页 共 38 页 PatientAccountNumber C ardID 患者账号 该节点停用 建议 使用患者标识符 PatientAccountNumber D omainCode 域代码 相当于账号类型 患者账号与域代码应该同时存 在 该节点停用 建议使用患者标 识符 Ethnic 民族名称 BirthPlace 出身地 MultipleBirthIndicator 多胞胎标识 Y 是多胞胎 N 不 是多胞胎 BirthOrder 出生顺序 Nationality 国籍 PatientDeathIndicator 死亡标识 PatientDeathDateAndTim e 死亡时间 LastUpdateDateTime 最近更新时间 LastUpdateFacility 最近更新者 机构或人 Country 国家 Province 省份 City 城市 StreetAddress 街道地址 ZipCode 邮编 PatientAddresses PatientAddress Type 地址类型 B 公司 C 临时 H 家庭 请参考地址类型代码地址类型代码 外部接口说明 XXXXXXXX公司 第 16 页 共 38 页 其中 PatientAddresses PatientAddress 是可以重复的 表示有多个地址 AddressType 地址类型 B 公司 C 临时 H 家庭 请参考地址类型代码地址类型代码 EquipmentType 设备类型代码 PH 电话 FX 传真 CP 手机 请参考设备类型代码设备类型代码 CountryCode 国家代码 086 中国 AreaCode 区号 021 上海 PhoneNumber 电话号码 Extension 分机号 Email 邮箱 PatientPhones Pa tientPhone 其中 PatientPhones PatientPhone 是可以重复的 表示有多个电话 VisitNumber CardID 非空就诊号 VisitNumber DomainCode 非空域代码 相当于就诊号类型 VisitNumber Facility 可空 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 PatientClass 非空 I 入院 O 门诊 E 急诊 请参考就诊类型代码就诊类型代码 AssignedPatientLocatio n PointOfCare 医疗点 科室代码 AssignedPatientLocatio n PointOfCareName 医疗点 科室名称 PatientVisit AssignedPatientLocatio n AreaCode 病区代码 外部接口说明 XXXXXXXX公司 第 17 页 共 38 页 AssignedPatientLocatio n Areaname 病区名称 AssignedPatientLocatio n Room 病房 AssignedPatientLocatio n Bed 床位 AssignedPatientLocatio n Facility 机构 AssignedPatientLocatio n LocationStatus 位置状况 AssignedPatientLocatio n PatientLocationType 位置类型 诊所 家庭 护理 室 AssignedPatientLocatio n Building 建筑 楼号 AssignedPatientLocatio n Floor 楼层 AssignedPatientLocatio n LocationDescription 位置描述 AdmissionType 入院类型名称 例如 事故 紧急 分娩 常规等 即入院原 因 AttendingDoctor Family Name 接诊医生姓 如果是中国人 姓和名可以都放在此字段 中间名 一般为空 AttendingDoctor GivenN ame 接诊医生名 AttendingDoctor Middle Name 中间名 AttendingDoctor CardID 医生号码 AttendingDoctor Domain Code 域代码 医生号码与域代码应 该同时存在 ReferringDoctor Family Name 转诊医生姓 如果是中国人 姓和名可以都放在此字段 中间名 一般为空 ReferringDoctor GivenN ame 转诊医生名 外部接口说明 XXXXXXXX公司 第 18 页 共 38 页 ReferringDoctor Middle Name 中间名 ReferringDoctor CardID 转诊医生号码 ReferringDoctor Domain Code 域代码 医生号码与域代码应 该同时存在 ConsultingDoctor Famil yName 会诊医生姓 如果是中国人 姓和名可以都放在此字段 中间名 一般为空 ConsultingDoctor Given Name 会诊医生名 ConsultingDoctor Middl eName 中间名 ConsultingDoctor CardI D 会诊医生号码 ConsultingDoctor Domai nCode 域代码 医生号码与域代码应 该同时存在 HospitalService 医院服务名称 例如 内科服 务 手术服务 泌尿科服务 AdmittingDoctor Family Name 入院医生姓 如果是中国人 姓和名可以都放在此字段 中间名 一般为空 AdmittingDoctor GivenN ame 入院医生名 AdmittingDoctor Middle Name 中间名 AdmittingDoctor CardID 入院医生号码 AdmittingDoctor Domain Code 域代码 医生号码与域代码应 该同时存在 ReadmissionIndicator 再次入院标志 R 再次入院 其他 不是再次入院 AdmitSource 入院来源 FinancialClass 经济状况 外部接口说明 XXXXXXXX公司 第 19 页 共 38 页 DischargeDisposition 出院处置 出院原因 DischargedToLocation 出院去处 AdmitDateTime 就诊 入院 日期 格式 1935 01 02 15 36 27 DischargeDateTime 出院日期 格式 1935 01 02 15 36 27 输出参数的 XML 说明 节点名称子节点允许空值说明 ResultCode 非空 AA 成功 AE 错误 AR 拒绝 AY 成功 但有相似患者 Ack ResultDetail 非空 GUID 主索引号 或 错误的 具体内容 5 4 5 4 患者标识符查询患者标识符查询 接口名称 QueryIdentifier string inxml 接口描述主要用于查询患者指定域的标识符 输入参数string 类型的 XML 输入的各个参数的作用相当于查询条件 输出参数 即返回值 string 类型的 XML 其他 输入参数的 XML 说明 节点名称子节点允许空值说明 Facility 非空发送源的医疗机构代码 ConfigHeader Application 非空发送源的医疗系统代码 外部接口说明 XXXXXXXX公司 第 20 页 共 38 页 PatientIDs PatientID C ardID 非空查询的标识符 PatientIDs PatientID D omainCode 非空 查询的域代码 相当于标识符 类型 PatientIDs PatientID F acility 可空 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 这是查询条件 实际操作时 将根据此节点中的标识符和域代码查询目标域中的 标识符 其中 PatientIDs PatientID 是可以重复的 表示有多个标识符 标识符和 域代码应该同时存在 TargetPatientIDs Patie ntID DomainCode 可空 目标域代码 相当于标识符类 型 TargetPatientIDs Patie ntID Facility 可空 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 QueryParameter 其中 TargetPatientIDs PatientID 是可以重复的 表示有多个标识符 标识符 和域代码应该同时存在 输出参数的 XML 说明 节点名称子节点允许空值说明 ResultCode 非空 AA 成功 NF 不存在 AE 错误 AR 拒绝 Ack ResultDetail 非空错误的具体内容 GlobalPID 非空患者主索引号 PatientIDs PatientID C ardID 非空标识符 PatientIDs PatientID D omainCode 非空 域代码 相当于标识符类型的 代码 PatientIDs PatientID D omainName 非空 域名称 相当于标识符类型的 名称 TargetPatient PatientIDs PatientID F acility 可空 域代码所属的医疗机构代码 如果为空 则使用 外部接口说明 XXXXXXXX公司 第 21 页 共 38 页 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 上述的 PatientIDs PatientID 节点是可以重复的 如果有重复 则表示对应的 患者有多个标识符 SourcePatient FamilyNa me 姓 SourcePatient GivenNam e 名 SourcePatient MiddleNa me 中间名 5 5 5 5 基本信息查询基本信息查询 接口名称 QueryPatient string inxml 接口描述主要用于查询患者的基本信息 输入参数string 类型的 XML 输入的各个参数的作用相当于查询条件 输出参数 即返回值 string 类型的 XML 其他 输入参数的 XML 说明 节点名称子节点允许空值说明 Facility 非空发送源的医疗机构代码 ConfigHeader Application 非空发送源的医疗系统代码 PatientIDs PatientID C ardID 非空查询的标识符 PatientIDs PatientID D omainCode 非空 查询的域代码 相当于标识符 类型 QueryParameter PatientIDs PatientID F acility 可空 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 外部接口说明 XXXXXXXX公司 第 22 页 共 38 页 建议由此节点指定院区代码 上述是 PatientIDs PatientID 节点是可以重复的 表示有多个标识符 标识符 和域代码应该同时存在 FamilyName 姓 GivenName 名 MiddleName 中间名 MothersMaidenName 母亲姓名 DateTimeOfBirth 出生日期 格式 1935 01 02 Sex 性别代码 M 男 F 女 请参考性别代码性别代码 PatientAccountNumber C ardID 暂停使用 建议使用患者标识 符 PatientAccountNumber D omainCode 暂停使用 建议使用患者标识 符 PatientAddress Country 国家 PatientAddress Provinc e 省份 PatientAddress City 城市 PatientAddress StreetA ddress 街道地址 PatientAddress ZipCode 邮编 PatientAddress Type 地址类型 B 公司 C 临时 H 家庭 L 合法 M 邮寄 请参考地址类型代码地址类型代码 PatientPhone AddressTy pe 地址类型 B 公司 C 临时 H 家庭 L 合法 M 邮寄 请参考地址类型代码地址类型代码 外部接口说明 XXXXXXXX公司 第 23 页 共 38 页 PatientPhone Equipment Type 设备类型代码 PH 电话 FX 传真 CP 手机 请参考设备类型代码设备类型代码 PatientPhone CountryCo de 国家编号 086 中国 PatientPhone AreaCode 区号 021 上海 PatientPhone PhoneNumb er 电话号码 PatientPhone Extension 分机号 PatientPhone Email 邮箱 TargetPatientIDs Patie ntID DomainCode 查询的域代码 相当于标识符 类型 TargetPatientIDs Patie ntID Facility 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 上述是 TargetPatientIDs 节点是可以重复的 表示有多个标识符 标识符和域 代码应该同时存在 另外 所有的这些查询条件不能同时为空 输出参数的 XML 说明 节点名称子节点允许空值说明 ResultCode 非空 AA 成功 NF 不存在 AE 错误 AR 拒绝 Ack ResultDetail 非空错误的具体内容 GlobalPID 非空患者主索引号 PatientIDs PatientID C ardID 非空标识符 TargetPatients T argetPatient 此节点可以重复 如果返回多个节点 则 表示有多个患者满足查 询条件 PatientIDs PatientID D omainCode 非空 域代码 相当于标识符类型的 代码 外部接口说明 XXXXXXXX公司 第 24 页 共 38 页 PatientIDs PatientID D omainName 非空 域名称 相当于标识符类型的 名称 PatientIDs PatientID F acility 可空 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 上述的 PatientIDs PatientID 节点是可以重复的 如果有重复 则表示对应的 患者有多个标识符 FamilyN ame 姓 GivenNa me 名 MiddleN ame 中间名 Mothers MaidenName 母亲姓名 DateTim eOfBirth 出生日期 格式 1935 01 02 Sex 性别代码 M 男 F 女 请参考性别代码性别代码 Primary Language 母语 Marital Status 婚姻状况代码 请参考婚姻状况代码婚姻状况代码 Religio n 宗教信仰 SSNNumb er 社会安全号 相当于身份证号 Drivers LicenseNumbe r 驾驶证号 Patient AccountNumbe r CardID 患者账号 该节点停用 建议 使用患者标识符 SourceP atient Patient AccountNumbe r DomainCode 域代码 相当于账号类型 患者账号与域代码应该同时存 在 该节点停用 建议使用患者标 外部接口说明 XXXXXXXX公司 第 25 页 共 38 页 识符 Ethnic 民族名称 BirthPl ace 出身地 Multipl eBirthIndica tor 多胞胎标识 Y 是多胞胎 N 不 是多胞胎 BirthOr der 出生顺序 Nationa lity 国籍 Patient DeathIndicat or 死亡标识 Patient DeathDateAnd Time 死亡时间 LastUpd ateDateTime 最近更新时间 LastUpd ateFacility 最近更新者 机构或人 5 6 5 6 患者合并患者合并 接口名称 MergePatient string inxml 接口描述主要用于合并患者 输入参数string 类型的 XML 输入的各个参数的作用相当于查询条件 输出参数 即返回值 string 类型的 XML 其他 输入参数的 XML 说明 外部接口说明 XXXXXXXX公司 第 26 页 共 38 页 节点名称子节点允许空值说明 Facility 非空发送源的医疗机构代码 ConfigHeader Application 非空发送源的医疗系统代码 GlobalPID 患者主索引号 CardID 标识符 DomainCode 域代码 相当于标识符类型 Facility 不能同时 为空 如果都 有值 则以 GlobalPID 中 的主索引号为 准 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 PatientIDs Patie ntID 其中 PatientIDs PatientID 是可以重复的 表示有多个标识符 标识符和域代 码应该同时存在 FamilyName 非空 姓 如果是中国人 姓和名可 以都放在此字段 中间名一般为空 GivenName 名 MiddleName 中间名 MothersMaidenName 母亲姓名 DateTimeOfBirth 出生日期 格式 1935 01 02 Sex 性别代码 M 男 F 女 请参考性别代码性别代码 PrimaryLanguage 母语 SourcePatient MaritalStatus 婚姻状况代码 请参考婚姻状况代码婚姻状况代码 外部接口说明 XXXXXXXX公司 第 27 页 共 38 页 Religion 宗教信仰 SSNNumber 社会安全号 相当于身份证号 DriversLicenseNumber 驾驶证号 PatientAccountNumber C ardID 患者账号 该节点停用 建议 使用患者标识符 PatientAccountNumber D omainCode 域代码 相当于账号类型 患者账号与域代码应该同时存 在 该节点停用 建议使用患者标 识符 Ethnic 民族名称 BirthPlace 出身地 MultipleBirthIndicator 多胞胎标识 Y 是多胞胎 N 不 是多胞胎 BirthOrder 出生顺序 Nationality 国籍 PatientDeathIndicator 死亡标识 PatientDeathDateAndTim e 死亡时间 LastUpdateDateTime 最近更新时间 LastUpdateFacility 最近更新者 机构或人 Country 国家 Province 省份 PatientAddresses PatientAddress City 城市 外部接口说明 XXXXXXXX公司 第 28 页 共 38 页 StreetAddress 街道地址 ZipCode 邮编 Type 地址类型 B 公司 C 临时 H 家庭 L 合法 M 邮寄 请参考地址类型代码地址类型代码 其中PatientAddresses PatientAddress是可以重复的 AddressType 地址类型 B 公司 C 临时 H 家庭 L 合法 M 邮寄 请参考地址类型代码地址类型代码 EquipmentType 设备类型代码 PH 电话 FX 传真 CP 手机 请参考设备类型代码设备类型代码 CountryCode 国家代码 086 中国 AreaCode 区号 021 上海 PhoneNumber 电话号码 Extension 分机号 Email 邮箱 PatientPhones Pa tientPhone 其中PatientPhones PatientPhone是可以重复的 PriorGlobalPID 患者主索引号 CardID 标识符 DomainCode 域代码 相当于标识符类型 Facility 不能同时 为空 如果都 有值 则以 PriorGlobalP ID 中的主索引 号为准 域代码所属的医疗机构代码 PriorPatientIDs PatientID 其中 PriorPatientIDs PatientID 是可以重复的 表示有多个标识符 标识符和 域代码应该同时存在 外部接口说明 XXXXXXXX公司 第 29 页 共 38 页 FamilyName 非空 姓 如果是中国人 姓和名可 以都放在此字段 中间名一般为空 GivenName 名 PriorSourcePatie nt MiddleName 中间名 输出参数的 XML 说明 节点名称子节点允许空值说明 ResultCode 非空AA 成功 AE 错误 AR 拒绝 Ack ResultDetail 非空GUID 或 错误的具体内容 5 7 5 7 疑似患者查询疑似患者查询 接口名称 QuerySimilar string inxml 接口描述主要用于查询疑似患者 输入参数string 类型的 XML 输入的各个参数的作用相当于查询条件 输出参数 即返回值 string 类型的 XML 其他 输入参数的 XML 说明 节点名称子节点允许空值说明 Facility 非空发送源的医疗机构代码 ConfigHeader Application 非空发送源的医疗系统代码 QueryParameterGlobalPID 非空患者主索引号 外部接口说明 XXXXXXXX公司 第 30 页 共 38 页 输出参数的 XML 说明 节点名称子节点允许空值说明 ResultCode 非空 AA 成功 NF 不存在 AE 错误 AR 拒绝 Ack ResultDetail 非空错误的具体内容 GlobalPID 非空疑似患者的主索引号 SimilarGlobalPID 上述的 GlobalPID 节点是可以重复的 如果有重复 则表示存在多个疑似患者 5 8 5 8 患者患者 IDID 查询查询 接口名称 QueryIdentifierByID string inxml 接口描述根据患者 ID 查询患者的标识符及类型信息 输入参数string 类型的 XML 输入的各个参数的作用相当于查询条件 输出参数 即返回值 string 类型的 XML 其他 输入参数的 XML 说明 节点名称子节点允许空值说明 Facility 非空发送源的医疗机构代码 ConfigHeader Application 非空发送源的医疗系统代码 CardID 查询的标识符 ID QueryParameter 上述是CardID节点是可以重复的 表示可以根据多个标识符 ID 查询 输出参数的 XML 说明 外部接口说明 XXXXXXXX公司 第 31 页 共 38 页 节点名称子节点允许空值说明 ResultCode 非空 AA 成功 NF 不存在 AE 错误 AR 拒绝 Ack ResultDetail 非空错误的具体内容 GlobalPID 非空患者主索引号 CardID 非空标识符 DomainC ode 非空 域代码 相当于标识符类型的 代码 DomainN ame 非空 域名称 相当于标识符类型的 名称 Patient IDs Patient ID 该节点 是可以重复 的 如果有 重复 则表 示对应的患 者有多个标 识符 Facilit y 可空 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 FamilyN ame 姓 GivenNa me 名 TargetPatients T argetPatient 此节点可以重复 如果返回多个节点 则 表示有多个患者满足查 询条件 SourceP atient MiddleN ame 中间名 5 9 5 9 患者拆分患者拆分 接口名称 SplitPatient string inxml 接口描述拆分已经合并的患者 该接口主要与 CDR 进行交互 输入参数string 类型的 XML 输入的各个参数的作用相当于查询条件 输出参数 即返回值 string 类型的 XML 其他 BasePatient 标签 拆分后的主索引 对应于合并操作中 合并留下的主 索引号 PriorPatient 标签 拆分后的另一个主索引 对应于合并操作中 被合并 的主索引号 外部接口说明 XXXXXXXX公司 第 32 页 共 38 页 输入参数的 XML 说明 节点名称子节点允许空值说明 Facility 非空发送源的医疗机构代码 ConfigHeader Application 非空发送源的医疗系统代码 BasePatient Glob alPID 患者主索引号 CardID 标识符 DomainCode 域代码 相当于标识符类型 Facility 不能同时 为空 如果都 有值 则以 GlobalPID 中 的主索引号为 准 域代码所属的医疗机构代码 如果为空 则使用 ConfigHeader 节点中的医疗机构代 码 对于集团医院 存在多院区 建议由此节点指定院区代码 BasePatient Pati entIDs PatientID 其中BasePatient PatientIDs PatientID是可以重复的 表示有多个标识符 标识符和域代码应该同时存在 FamilyName 非空 姓 如果是中国人 姓和名可 以都放在此字段 中间名一般为空 GivenName 名 MiddleName 中间名 MothersMaidenName 母亲姓名 DateTimeOfBirth 出生日期 格式 1935 01 02 Sex 性别 M 男 F 女 请参考性别代码性别代码 PrimaryLanguage 母语 BasePatient Sour cePatient MaritalStatus 婚姻状况代码 请参考婚姻状况代码婚姻状况代码 外部接口说明 XXXXXXXX公司 第 33 页 共 38 页 Religion 宗教信仰 SSNNumber 社会安全号 相当于身份证号 DriversLicenseNumber 驾驶证号 PatientAccountNumber C ardID 患者账号 该节点停用 建议 使用患者标识符 PatientAccountNumber D omainCode 域代码 相当于账号类型 患者账号与域代码应该同时存 在 该节点停用 建议使用患者标 识符 Ethnic 民族名称 BirthPlace 出身地 MultipleBirthIndicator 多胞胎标识 Y 是多胞胎 N 不 是多胞胎 BirthOrder 出生顺序 Nationality 国籍 PatientDeathIndicator 死亡标识 PatientDeathDateAndTim e 死亡时间 LastUpdateDateTime 最近更新时间 LastUpdateFacility 最近更新者 机构或人 Country 国家 Province 省份 BasePatient Pati entAddresses Patient Address City 城市 外部接口说明 XXXXXXXX公司 第 34 页 共 38 页 StreetAddress 街道地址 ZipCode 邮编 Type 地址类型 B 公司 C 临时 H 家庭 L 合法 M 邮寄 请参考地址类型代码地址类型代码 其中BasePatient PatientAddresses PatientAddress是可以重复的 AddressType 地址类型 B 公司 C 临时 H 家庭 L 合法 M 邮寄 请参考地址类型代码地址类型代码 EquipmentType 设备类型代码 PH 电话 FX 传真 CP 手机 请参考设备类型代码设备类型代码 CountryCode 国家代码 086 中国 AreaCode 区号 021 上海 PhoneNumber 电话号码 Extension 分机号 Email 邮箱 BasePatient Pati entPhones PatientPho ne 其中BasePatient PatientPhones PatientPhone是可以重复的 PriorPatient Glo balPID 患者主索引号 CardID 标识符 DomainCode 域代码 相当于标识符类型 PriorPatient Pat ientIDs PatientID Facility 不能同时 为空 如果都 有值 则以 GlobalPID 中 的主索引号为 准 域代码所