Official Aqua-io API library client for PHP. Currently covers Aqua.io's ICD-9 and ICD-10 APIs.
To use the Aqua.io API, you need to have proper API credentials, which you can get for free by signing up.
You may also want to read up on the API documentation.
This library is generated by alpaca
Make sure you have composer installed.
Add the following to your composer.json
{
"require": {
"aquaio/aqua-io": "*"
}
}
Update your dependencies
$ php composer.phar update
This package follows the
PSR-4
convention names for its classes, which means you can easily integrate these classes loading in your own autoloader.
Works with [ 5.4 / 5.5 ]
<?php
// This file is generated by Composer
require_once 'vendor/autoload.php';
// Then we instantiate a client (as shown below)
$auth = array('client_id' => '09a8b7', 'client_secret' => '1a2b3');
$client = new AquaIo\Client($auth, $clientOptions);
$token = $client->accessToken()->retrieve()->body['access_token']
$client = new AquaIo\Client($token, $clientOptions);
The following options are available while instantiating a client:
- base: Base url for the api
- user_agent: Default user-agent for all requests
- headers: Default headers for all requests
- request_type: Default format of the request body
All the callbacks provided to an api call will receive the response as shown below
$response = $client->klass('args')->method('args', $methodOptions);
$response->code;
// >>> 200
$response->headers;
// >>> array('x-server' => 'apache')
When the response sent by server is json, it is decoded into an array
$response->body;
// >>> array('user' => 'pksunkara')
The following options are available while calling a method of an api:
- headers: Headers for the request
- query: Query parameters for the url
- body: Body of the request
- request_type: Format of the request body
Returns an ICD-9 code.
$icd9 = $client->icd9();
Returns all top-level ICD-9 codes. Useful for helping a user navigate down the ICD-9 hierarchy to find a code.
$response = $icd9->topLevelCodes($options);
Returns a single code matching the name, if any exists. Replace periods with hypens (e.g. '066-4' for '066.4')
The following arguments are required:
- code_name: name of code
$response = $icd9->singleCode("066-4", $options);
Returns all codes whose name contains the search string.
The following arguments are required:
- query: the search query string
$response = $icd9->searchByName("082-2", $options);
Returns all codes whose description contains the search string.
The following arguments are required:
- query: the search query string
$response = $icd9->searchByDescription("eastern equine", $options);
Returns all codes whose name or description contains the search string.
The following arguments are required:
- query: the search query string
$response = $icd9->searchByNameOrDescription("west nile", $options);
Returns an ICD-10 code.
$icd10 = $client->icd10();
Returns all top-level ICD-10 codes. Useful for helping a user navigate down the ICD-10 hierarchy to find a code.
$response = $icd10->topLevelCodes($options);
Returns a single code matching the name, if any exists. Replace periods with hypens (e.g. 'R50-9' for 'R50.9')
The following arguments are required:
- code_name: name of code
$response = $icd10->singleCode("R50-9", $options);
Returns all codes whose name contains the search string.
The following arguments are required:
- query: the search query string
$response = $icd10->searchByName("b05", $options);
Returns all codes whose description contains the search string.
The following arguments are required:
- query: the search query string
$response = $icd10->searchByDescription("mumps", $options);
Returns all codes whose name or description contains the search string.
The following arguments are required:
- query: the search query string
$response = $icd10->searchByNameOrDescription("rubella", $options);
Here is a list of Contributors
MIT
Report here.
Michael Carroll at Aqua.io
@aqua_io
This library initially generated by alpaca.