跳到主要内容

Kareo帮助中心

开始:Kareo SOAP api

  1. 最后一次更新
  2. 保存为PDF
更新:09/08/2021
观点:40543

Kareo SOAP api与第三方应用程序交互，使开发人员能够构建访问Kareo数据和功能的程序。该指南旨在帮助开发人员创建与Kareo应用程序的集成。

Kareo SOAP API常见问题

对最常见的Kareo SOAP api问题和系统集成模式的回答。

问题 回答
我可以在哪里下载技术指南? API技术指南
为了使用API，我是否需要更改Kareo客户机中的任何设置? 是，系统管理员需要生成Kareo客户关键并设置适当的安全权限，以便开始使用Kareo SOAP API。作为一项附加的安全措施，Kareo SOAP API需要使用客户密钥(除了登录凭证之外)来访问您的数据。
您能检查一下我的代码，看看我哪里做错了吗? 由于有许多不同的编程语言可用，并且不熟悉每个工程师的个人代码，我们不为调试集成器的代码提供技术支持。

我们只能在Kareo端通过API web服务提供支持。
你有如何使用PHP, c++等与Kareo API交互的例子吗? 有太多不同的编程语言可供我们提供每种语言的示例。我们希望集成商能够选择最适合他们的设计和需要的语言。

然而，这里有一个PHP示例:

<？php
尝试{
$user = '**您的KAREO用户名在这里**';
$password = '**您的KAREO密码在这里**';
$customerKey = '**您的KAREO customerKey这里**';

wsdl美元= 'https://webservice.kareo.com/service...vices.svc?wsdl”;
$client =新SoapClient($wsdl);

$request = array (
'RequestHeader' => array('User' => $ User， 'Password' => $ Password， 'CustomerKey' => $ CustomerKey)，
'Filter' => array('FromLastModifiedDate' => '3/4/2012')，
'Fields' => array('PatientFullName' => 'true')
）;

$params = array('request' => $request);
= $ $响应客户端> GetPatients (params) - > GetPatientsResult;

foreach($响应- >患者> PatientData &美元值)
｛
打印(美元价值- > PatientFullName。' < br / > ');
｝
} catch(异常$err) {
打印“错误:”。呃- > getMessage ();
｝
? >
Kareo有将新的/更新的数据推送到外部系统的机制吗? 不，Kareo不会自动将信息推送到外部系统。
Kareo是否支持HL7消息传递接口? 不，我们目前不支持HL7消息传递。
如何让事务的请求和响应xml接受API支持? 在互联网上有许多工具可以监视和捕获您的计算机的网络流量。

最流行的web调试工具之一是提琴手．
如果我需要向Kareo查询新的/更新的信息，可以接受的轮询频率是多少? 如果您正在轮询Kareo API，我们建议5到15分钟的间隔是拉取刷新数据的好设置。

我们还建议使用最后修改的参数来缩小返回数据的范围。
DOB以什么格式存储? YYYY-MM-DD
为了请求Kareo对API相关问题的工程支持，我需要做些什么? 请为出现错误的事务提取请求和响应xml。

提交您的查询通过支持的票并将请求和响应xml包含在描述表单的字段。

注意:Kareo只能通过Kareo端的API提供支持。
我可以在API接口上执行什么类型的函数? Kareo API提供了许多不同的函数来与Kareo系统数据进行交互。

这些包括:
  1. 从Kareo中不同类型的记录中检索数据:
    • 任命(单一)
    • 任命(散装)
    • 指控
    • 遇到细节
    • 病人(单)
    • 患者(散装)
    • 支付
    • 实践
    • 程序代码
    • 供应商
    • 服务位置
    • 交易
  2. 创建不同类型的记录到Kareo:
    • 创建预约
    • 创建患者
    • 创建遇到
    • 创建付款
  3. 在Kareo中更新患者记录
  4. 删除约会
Kareo API支持什么类型的集成? Kareo的API是一种基于soap的web服务。

使用Kareo SOAP api的系统集成模式

一、外部ID使用

对于我们通过公共api公开的许多实体，我们提供了带有'ExternalId'后缀的字段名，这是可选字段，集成器可以使用它来填充由自己的系统生成的标识符。例如，Patient将有一个名为“PatientExternalId”的字段，或者InsurancePolicy将有一个InsuracePolicyExternalId。

为了消除歧义，相同的例子，如Patients也有一个PatientId，而InsurancePolicy有一个InsurancePolicyId，它将保存Kareo为这些实体生成的id。

integrator可以使用ExternalId字段方便查询或获取数据Kareo的api，使用他们想要与Kareo集成的系统的本地id。这减轻了集成商扩展记录以为每个实体维护Kareo ID的需要。

通过我们的api可用的所有GET端点都允许您通过外部ID获取或筛选，而不是对这些实体使用Kareo标识符。

2将患者数据迁移到Kareo

如果您只是为了利用Kareo计费模块而集成Kareo，则不需要将所有患者初始加载到Kareo中。您可以做的是设计与Kareo的集成，以便在需要为某个特定患者计费时发送患者信息。

如何?

  • 病人创建工作流：
    • 每当在外部系统中创建一个新的病人时，您可以立即调用Kareo api上的createppatient方法，以确保病人也在Kareo中创建。
      • 案例1:你正在使用外部ID字段:
        • 在创建患者时，请确保填充ExternalID字段。
      • 案例2:你没有使用外部ID字段:
        • 在创建患者时，请确保使用Kareo的患者Id更新自己的患者记录。
  • 提交超级账单时创建病人
    • 案例1:你正在使用外部ID字段:
      1. 检查是否已经在Kareo中创建了患者。如果是，提交Superbill/Encounter。如果不是……
      2. 使用适当的ExternalId创建患者，然后提交Superbill/Encounter
    • 案例2:你没有使用外部ID字段:
      1. 检查您的患者记录是否分配了Kareo患者ID。如果是，请提交Superbill/遇到Kareo患者Id。如果不是……
      2. 创建患者，使用Kareo患者ID更新您自己的记录，然后提交Superbill/遇到Kareo患者ID。

3同步/检索在Kareo中所做的患者更改

Kareo没有连接到Web Hooks来发送Kareo内部用户所做的患者人口统计数据更改。如果您预期用户从Kareo内部对患者记录进行更改，那么您很可能希望确保这些更改也在您集成的系统中进行。

为了从Kareo客户机内部检索所做的更改，可以使用GetPatients(复数)API方法。这个方法将允许你指定FromLastModfiiedDate和/或ToLastModifiedDate;该呼叫的响应包含在这些日期范围内更新过的所有患者记录。

一般来说，我们建议您的系统每5到10分钟检索一次患者的更改，以确保记录保持最新。


对Kareo API还有其他问题吗?请提交一个票寻求支持。

注意:Kareo只能通过Kareo端的API提供支持。请将请求和响应xml粘贴到描述支持表格的字段。

开始:Kareo SOAP api