README

官方 Aqua-io API 库客户端，用于 PHP。目前涵盖了 Aqua.io 的 ICD-9 和 ICD-10 API。

入门指南

要使用 Aqua.io API，您需要适当的 API 凭证，您可以通过 注册 免费获取。

您还可以阅读有关 API 文档 的信息。

此库由 alpaca 生成

安装

请确保您已安装 composer。

将以下内容添加到您的 composer.json 中

{
    "require": {
        "aquaio/aqua-io": "*"
    }
}

更新您的依赖项

$ php composer.phar update

此包遵循其类的 PSR-4 命名约定，这意味着您可以轻松地将这些类加载到您自己的自动加载器中。

版本

支持 [ 5.4 / 5.5 ]

用法

<?php

// This file is generated by Composer
require_once 'vendor/autoload.php';

// Then we instantiate a client (as shown below)

构建客户端

使用您的 aqua.io 凭证获取访问令牌

$auth = array('client_id' => '09a8b7', 'client_secret' => '1a2b3');

$client = new AquaIo\Client($auth, $clientOptions);

$token = $client->accessToken()->retrieve()->body['access_token']

所有其他 API 调用都需要访问令牌

$client = new AquaIo\Client($token, $clientOptions);

客户端选项

实例化客户端时，以下选项可用

• base: API 的基本 URL
• user_agent: 所有请求的默认用户代理
• headers: 所有请求的默认头信息
• request_type: 请求体的默认格式

响应信息

提供给 API 调用的所有回调都将接收以下所示的响应

$response = $client->klass('args')->method('args', $methodOptions);

$response->code;
// >>> 200

$response->headers;
// >>> array('x-server' => 'apache')

JSON 响应

当服务器发送的响应为 json 时，它被解码为一个数组

$response->body;
// >>> array('user' => 'pksunkara')

方法选项

调用 API 方法时，以下选项可用

• headers: 请求的头信息
• query: URL 的查询参数
• body: 请求体
• request_type: 请求体的格式

ICD-9 API

返回一个 ICD-9 代码。

$icd9 = $client->icd9();

所有顶级代码 (GET codes/v1/icd9)

返回所有顶级 ICD-9 代码。有助于用户在 ICD-9 层次结构中导航以找到代码。

$response = $icd9->topLevelCodes($options);

检索单个代码。 (GET codes/v1/icd9/:code_name)

返回匹配名称的单个代码（如果存在）。将点替换为短横线（例如，'066-4' 对于 '066.4'）

以下参数是必需的

• code_name: 代码名称

$response = $icd9->singleCode("066-4", $options);

通过名称搜索代码。 (GET codes/v1/icd9?q[name_cont]=:query)

返回包含搜索字符串的所有代码。

以下参数是必需的

• 查询: 搜索查询字符串

$response = $icd9->searchByName("082-2", $options);

通过描述搜索代码。 (GET codes/v1/icd9?q[description_cont]=:query)

返回包含搜索字符串的所有代码。

以下参数是必需的

• 查询: 搜索查询字符串

$response = $icd9->searchByDescription("eastern equine", $options);

通过名称或描述搜索代码。 (GET codes/v1/icd9?q[name_or_description_cont]=:query)

返回名称或描述包含搜索字符串的所有代码。

以下参数是必需的

• 查询: 搜索查询字符串

$response = $icd9->searchByNameOrDescription("west nile", $options);

ICD-10 API

返回一个 ICD-10 代码。

$icd10 = $client->icd10();

所有顶级代码 (GET codes/v1/icd10)

返回所有顶级 ICD-10 代码。有助于用户在 ICD-10 层次结构中导航以找到代码。

$response = $icd10->topLevelCodes($options);

检索单个代码。 (GET codes/v1/icd10/:code_name)

返回匹配名称的单个代码（如果存在）。将点替换为短横线（例如，'R50-9' 对于 'R50.9'）

以下参数是必需的

• code_name: 代码名称

$response = $icd10->singleCode("R50-9", $options);

通过名称搜索代码。 (GET codes/v1/icd10?q[name_cont]=:query)

返回包含搜索字符串的所有代码。

以下参数是必需的

• 查询: 搜索查询字符串

$response = $icd10->searchByName("b05", $options);

通过描述搜索代码。 (GET codes/v1/icd10?q[description_cont]=:query)

返回包含搜索字符串的所有代码。

以下参数是必需的

• 查询: 搜索查询字符串

$response = $icd10->searchByDescription("mumps", $options);

通过名称或描述搜索代码。（GET codes/v1/icd10?q[name_or_description_cont]=:query）

返回名称或描述包含搜索字符串的所有代码。

以下参数是必需的

• 查询: 搜索查询字符串

$response = $icd10->searchByNameOrDescription("rubella", $options);

贡献者

以下是贡献者列表。

待办事项

许可证

MIT

错误报告

在此报告。

联系

Aqua.io的Michael Carroll

michael@aqua.io

@aqua_io

此库最初由alpaca生成。