Akute Health API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

• https://api.staging.akutehealth.com/v1

• https://api.akutehealth.com/v1

Authentication

• API Key (APIKeyHeader)
  • Parameter Name: X-API-Key, in: header.
• Webhook Signature (SignatureHeader)
  • Parameter Name: x-akute-signature, in: header. Akute generates signatures using a hash-based message authentication code (HMAC) with SHA-256.

Webhook Signatures

Step 1: Extract the timestamp and signatures from the header

x-akute-signature:
t=1492774577,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd

Split the header, using the , character as the separator, to get a list of elements. Then split each element, using the = character as the separator, to get a prefix and value pair.

The value for the prefix 't' corresponds to the timestamp, and the prefix 'v1' corresponds to the signature

Before you can verify signatures, you need to retrieve your endpoint’s secret from your Settings->Notification, and clicking on a webhook's secret reveal.

Step 2: Prepare the signed_payload string

${timestamp}.${JSON.stringify(request.body)}

The signed_payload string is created by concatenating:

• The timestamp (as a string)
• The character .
• The actual JSON payload (i.e., the request body)

Step 3: Determine the expected signature

function parseHeader(header) {
  if (typeof header !== "string") {
    return null;
  }

  return header.split(",").reduce(
    (accum, item) => {
      const kv = item.split("=");

      if (kv[0] === "t") {
        accum.timestamp = kv[1];
      }
      if (kv[0] === "v1") {
        accum.signature = kv[1];
      }

      return accum;
    },
    {
      timestamp: -1,
      signature: ""
    }
  );
}
const headerDetails = parseHeader(request.headers["x-akute-signature"]);

Compute an HMAC with the SHA256 hash function. Use the Akute webhook secret as the key, and use the payload string as the message.

Step 4: Compare the signatures

const unfoldedSignature = crypto
    .createHmac('sha256', secret)
    .update(`${headerDetails.timestamp}.${JSON.stringify(request.body)}`, 'utf8')
    .digest('hex');

const isValid = unfoldedSignature === headerDetails.signature;

Compare the signature (or signatures) in the header to the expected signature.

For an equality match, compute the difference between the current timestamp and the received timestamp, then decide if the difference is within your tolerance.

To protect against timing attacks, use constant-time string comparison to compare the expected signature to each of the received signatures.

v1

post_patients

Code samples

# You can also use wget
curl -X POST https://api.staging.akutehealth.com/v1/patients \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: API_KEY'

POST https://api.staging.akutehealth.com/v1/patients HTTP/1.1
Host: api.staging.akutehealth.com
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "status": "active",
  "external_id": "string",
  "date_of_birth": "2019-08-24",
  "sex": "male",
  "address_line_1": "string",
  "address_line_2": "string",
  "address_city": "New York",
  "address_state": "NY",
  "address_zipcode": "10001",
  "email": "user@example.com",
  "primary_phone_number": "4937384432",
  "primary_phone_type": "mobile",
  "appointment_state": "NJ",
  "properties": [
    {
      "name": "membership",
      "values": ["One-time"]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-API-Key':'API_KEY'
};

fetch('https://api.staging.akutehealth.com/v1/patients',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'X-API-Key' => 'API_KEY'
}

result = RestClient.post 'https://api.staging.akutehealth.com/v1/patients',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-API-Key': 'API_KEY'
}

r = requests.post('https://api.staging.akutehealth.com/v1/patients', headers = headers)

print(r.json())

 'application/json',
    'Accept' => 'application/json',
    'X-API-Key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.staging.akutehealth.com/v1/patients', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.staging.akutehealth.com/v1/patients");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "X-API-Key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.staging.akutehealth.com/v1/patients", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /patients

Create a new patient

Body parameter

{
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "status": "active",
  "external_id": "string",
  "date_of_birth": "2019-08-24",
  "sex": "male",
  "address_line_1": "string",
  "address_line_2": "string",
  "address_city": "New York",
  "address_state": "NY",
  "address_zipcode": "10001",
  "email": "user@example.com",
  "primary_phone_number": "4937384432",
  "primary_phone_type": "mobile",
  "appointment_state": "NJ",
  "properties": [
    {
      "name": "membership",
      "values": ["One-time"]
    }
  ]
}

Parameters

Enumerated Values

Example responses

201 Response

{
  "id": "string"
}

Responses

Response Schema

Status Code 201

Status Code 400

Status Code 409

Status Code 500

Response Headers

put_patients

Code samples

# You can also use wget
curl -X PUT https://api.staging.akutehealth.com/v1/patients/:id \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: API_KEY'

PUT https://api.staging.akutehealth.com/v1/patients/:id HTTP/1.1
Host: api.staging.akutehealth.com
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "status": "active",
  "external_id": "string",
  "date_of_birth": "2019-08-24",
  "sex": "male",
  "address_line_1": "string",
  "address_line_2": "string",
  "address_city": "New York",
  "address_state": "NY",
  "address_zipcode": "10001",
  "email": "user@example.com",
  "primary_phone_number": "4937384432",
  "primary_phone_type": "mobile",
  "appointment_state": "NJ",
  "properties": [
    {
      "name": "membership",
      "values": ["One-time"]
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-API-Key':'API_KEY'
};

fetch('https://api.staging.akutehealth.com/v1/patients/:id',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'X-API-Key' => 'API_KEY'
}

result = RestClient.post 'https://api.staging.akutehealth.com/v1/patients/:id',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-API-Key': 'API_KEY'
}

r = requests.post('https://api.staging.akutehealth.com/v1/patients/:id', headers = headers)

print(r.json())

 'application/json',
    'Accept' => 'application/json',
    'X-API-Key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://api.staging.akutehealth.com/v1/patients/:id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.staging.akutehealth.com/v1/patients/:id");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "X-API-Key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.staging.akutehealth.com/v1/patients/:id", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /patients/:id

Update patient

Body parameter

{
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "status": "active",
  "external_id": "string",
  "date_of_birth": "2019-08-24",
  "sex": "male",
  "address_line_1": "string",
  "address_line_2": "string",
  "address_city": "New York",
  "address_state": "NY",
  "address_zipcode": "10001",
  "email": "user@example.com",
  "primary_phone_number": "4937384432",
  "primary_phone_type": "mobile",
  "appointment_state": "NJ",
  "properties": [
    {
      "name": "membership",
      "values": ["One-time"]
    }
  ]
}

Parameters

Enumerated Values

Example responses

200 Response

{
  "id": "string"
}

Responses

Response Schema

Status Code 200

Status Code 400

Status Code 404

Status Code 500

get_patients

Code samples

# You can also use wget
curl -X GET https://api.staging.akutehealth.com/v1/patients \
  -H 'Accept: application/json' \
  -H 'X-API-Key: API_KEY'

GET https://api.staging.akutehealth.com/v1/patients HTTP/1.1
Host: api.staging.akutehealth.com
Accept: application/json

const headers = {
  Accept: "application/json",
  "X-API-Key": "API_KEY"
};

fetch("https://api.staging.akutehealth.com/v1/patients", {
  method: "GET",

  headers: headers
})
  .then(function(res) {
    return res.json();
  })
  .then(function(body) {
    console.log(body);
  });

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'X-API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.staging.akutehealth.com/v1/patients',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'X-API-Key': 'API_KEY'
}

r = requests.get('https://api.staging.akutehealth.com/v1/patients', headers = headers)

print(r.json())

 'application/json',
    'X-API-Key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.staging.akutehealth.com/v1/patients', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.staging.akutehealth.com/v1/patients");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "X-API-Key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.staging.akutehealth.com/v1/patients", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /patients

Get patient by akute id in path or other parameter as query

Parameters

Example responses

Responses

Response Schema

post_tasks

Code samples

# You can also use wget
curl -X POST https://api.staging.akutehealth.com/v1/tasks \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: API_KEY'

POST https://api.staging.akutehealth.com/v1/tasks HTTP/1.1
Host: api.staging.akutehealth.com
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "task": "string",
  "description": "string",
  "due_date": "2019-08-24",
  "owner_id": "string",
  "patient_id": "string",
  "external_patient_id": "string",
  "priority": "p1",
  "status": "not-started",
  "date_created": "2019-08-24T14:15:22Z",
  "tags": [
    "string"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-API-Key':'API_KEY'
};

fetch('https://api.staging.akutehealth.com/v1/tasks',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'X-API-Key' => 'API_KEY'
}

result = RestClient.post 'https://api.staging.akutehealth.com/v1/tasks',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-API-Key': 'API_KEY'
}

r = requests.post('https://api.staging.akutehealth.com/v1/tasks', headers = headers)

print(r.json())

 'application/json',
    'Accept' => 'application/json',
    'X-API-Key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.staging.akutehealth.com/v1/tasks', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.staging.akutehealth.com/v1/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "X-API-Key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.staging.akutehealth.com/v1/tasks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /tasks

Create new task

Body parameter

{
  "task": "string",
  "description": "string",
  "due_date": "2019-08-24",
  "owner_id": "string",
  "patient_id": "string",
  "external_patient_id": "string",
  "priority": "p1",
  "status": "not-started",
  "date_created": "2019-08-24T14:15:22Z",
  "tags": ["string"]
}

Parameters

Enumerated Values

Example responses

201 Response

{
  "id": "string"
}

Responses

Response Schema

Status Code 201

get_tasks

Code samples

# You can also use wget
curl -X GET https://api.staging.akutehealth.com/v1/tasks \
  -H 'Accept: application/json' \
  -H 'X-API-Key: API_KEY'

GET https://api.staging.akutehealth.com/v1/tasks HTTP/1.1
Host: api.staging.akutehealth.com
Accept: application/json

const headers = {
  Accept: "application/json",
  "X-API-Key": "API_KEY"
};

fetch("https://api.staging.akutehealth.com/v1/tasks", {
  method: "GET",

  headers: headers
})
  .then(function(res) {
    return res.json();
  })
  .then(function(body) {
    console.log(body);
  });

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'X-API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.staging.akutehealth.com/v1/tasks',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'X-API-Key': 'API_KEY'
}

r = requests.get('https://api.staging.akutehealth.com/v1/tasks', headers = headers)

print(r.json())

 'application/json',
    'X-API-Key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.staging.akutehealth.com/v1/tasks', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.staging.akutehealth.com/v1/tasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "X-API-Key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.staging.akutehealth.com/v1/tasks", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /tasks

Get task by id

Parameters

Example responses

Responses

Response Schema

webhook_tasks

Get a webhook on all task creates & updates.

Get a webhook on all task creates & updates.

See demo video here

post_insurance

Code samples

# You can also use wget
curl -X POST https://api.staging.akutehealth.com/v1/insurance \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: API_KEY'

POST https://api.staging.akutehealth.com/v1/insurance HTTP/1.1
Host: api.staging.akutehealth.com
Content-Type: application/json
Accept: application/json

const inputBody = '{
  "id": "string",
  "member_id": "string",
  "status": "active",
  "patient_id": "string",
  "external_patient_id": "string",
  "type": "rx",
  "hdhp": true,
  "order": 1,
  "rx_bin": "string",
  "rx_pcn": "string",
  "rx_id": "string",
  "rx_group": "string",
  "payor": "string",
  "pbm": "string",
  "phone_number": "stringstri",
  "relationship_to_subscriber": "self",
  "group_id": "string",
  "group_name": "string",
  "payor_id": "string",
  "subscriber_patient_id": "string",
  "subscriber_external_patient_id": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'X-API-Key':'API_KEY'
};

fetch('https://api.staging.akutehealth.com/v1/insurance',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'X-API-Key' => 'API_KEY'
}

result = RestClient.post 'https://api.staging.akutehealth.com/v1/insurance',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-API-Key': 'API_KEY'
}

r = requests.post('https://api.staging.akutehealth.com/v1/insurance', headers = headers)

print(r.json())

 'application/json',
    'Accept' => 'application/json',
    'X-API-Key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.staging.akutehealth.com/v1/insurance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.staging.akutehealth.com/v1/insurance");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "X-API-Key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.staging.akutehealth.com/v1/insurance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /insurance

Create new insurance policy

Body parameter

{
  "id": "string",
  "member_id": "string",
  "status": "active",
  "patient_id": "string",
  "external_patient_id": "string",
  "type": "rx",
  "hdhp": true,
  "order": 1,
  "rx_bin": "string",
  "rx_pcn": "string",
  "rx_id": "string",
  "rx_group": "string",
  "payor": "string",
  "pbm": "string",
  "phone_number": "stringstri",
  "relationship_to_subscriber": "self",
  "group_id": "string",
  "group_name": "string",
  "payor_id": "string",
  "subscriber_patient_id": "string",
  "subscriber_external_patient_id": "string"
}

Parameters

Enumerated Values

Example responses

201 Response

{
  "rx_id": "string",
  "medical_id": "string"
}

Responses

Response Schema

Status Code 201

Status Code 400

Status Code 500

get_insurance

Code samples

# You can also use wget
curl -X GET https://api.staging.akutehealth.com/v1/insurance?patient_id=string \
  -H 'Accept: application/json' \
  -H 'X-API-Key: API_KEY'

GET https://api.staging.akutehealth.com/v1/insurance?patient_id=string HTTP/1.1
Host: api.staging.akutehealth.com
Accept: application/json

const headers = {
  Accept: "application/json",
  "X-API-Key": "API_KEY"
};

fetch("https://api.staging.akutehealth.com/v1/insurance?patient_id=string", {
  method: "GET",

  headers: headers
})
  .then(function(res) {
    return res.json();
  })
  .then(function(body) {
    console.log(body);
  });

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'X-API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.staging.akutehealth.com/v1/insurance',
  params: {
  'patient_id' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'X-API-Key': 'API_KEY'
}

r = requests.get('https://api.staging.akutehealth.com/v1/insurance', params={
  'patient_id': 'string'
}, headers = headers)

print(r.json())

 'application/json',
    'X-API-Key' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.staging.akutehealth.com/v1/insurance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://api.staging.akutehealth.com/v1/insurance?patient_id=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "X-API-Key": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.staging.akutehealth.com/v1/insurance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /insurance

Get insurance policy

Parameters

Example responses

400 Response

{
  "statusCode": 0,
  "error": "string"
}

Responses

Response Schema

Status Code 400

Status Code 500

get_medications

See medication history for a patient.

See medication history for a patient.

GET /medications

Get medications

Parameters

Example responses

200 Response

[
  {
    "display_name": "string",
    "generic_name": "string",
    "ndc": "string",
    "otc": "string",
    "rx_cui": "string",
    "date_added": "string",
    "effective_date": "YYYY-MM-DD",
    "fill_date": "string",
    "directions": "string",
    "quantity": "string",
    "dispense_unit_description": "string",
    "refills": "string",
    "days_supply": "number",
    "substitutions_allowed": "boolean",
    "strength": "string",
    "rx_status": "string",
    "status": "string",
    "is_rx_renewal": "boolean",
    "date_inactive": "Date (timestamp) when marked as complete or discontinued",
    "pharmacy_notes": "string",
    "inactive_comment": "string",
    "schedule": "string",
    "patient_id": "string",
    "patient_external_id": "string",
    "prescriber_id": "string",
    "prescriber_npi": "string",
    "prescriber_name": "string",
    "pharmacy_id": "number",
    "dosespot_medication_id": "number",
    "prescription_id": "number - The PrescriberOrderNumber included in the Surescripts XML"
  }
]

400 Response

{
  "statusCode": 0,
  "error": "string"
}

Responses

Enumerated Values

Response Schema

Status Code 400

Status Code 500

webhook_medications

Get a webhook when a medication is received by a pharmacy.

Get a webhook when a medication is received by a pharmacy.

See demo video here

get_pharmacy

Search for pharmacies and get ID to match with medications.

Search for pharmacies and get ID to match with medications.

GET /pharmacy

Get pharmacy

Parameters

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "address_line_1": "string",
    "address_line_2": "string",
    "address_city": "string",
    "address_state": "string",
    "address_zipcode": "string",
    "primary_phone_number": "string",
    "primary_fax_number": "string",
    "pharmacy_specialties": ["array"]
  }
]

400 Response

{
  "statusCode": 0,
  "error": "string"
}

Responses

Response Schema

Status Code 400

Status Code 500

post_pharmacy

Set pharmacy list for patient and/or default patient pharmacy

Set pharmacy list for patient and/or default patient pharmacy

POST /pharmacy

Add pharmacy to patient pharmacy list

Body parameter

{
  "patient_id": "string",
  "external_patient_id": "string",
  "pharmacy_id": "string",
  "set_as_primary": "boolean"
}

Parameters

Example responses

200 Response

Responses

Response Schema

Status Code 400

Status Code 500

get_users

Get user information by id or search to get IDs for set of users

GET /users

Get user information by id or search to get IDs for set of users

Parameters

Example responses

Response type will be an array if searching for users, and a single object if including user ID in the URL path

200 Response

[
  {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "dob": "string",
    "npi": "string",
    "dea": "string",
    "licenses": [
      {
        "number": "string",
        "state": "NY",
        "expiration_date": "YYYY-MM-DD"
      }
    ]
  }
]

400 Response

{
  "statusCode": 0,
  "error": "string"
}

Responses

Response Schema

Status Code 400

Status Code 500

get_observations

See observation history for a patient.

See observation history for a patient.

GET /observations

Get observations

Parameters

Example responses

200 Response

[
  {
    "id": "string",
    "name": "string",
    "category": "String. The type of observation.",
    "status": "String. Status of the observation.",
    "patient_id": "string",
    "date": "YYYY-MM-DDThh:mm:ss.xxxZ",
    "value": "string",
    "value_type": "String. Type of value. E.g. string if value is a string or quantity if value is an integer or float.",
    "unit": "String. Display name for unit of measurement of value.",
    "unit_code": "String. Code for unit of measurement of value. Ensures certainty on the exact unit type and can be used to perform calculations on value.",
    "reference_range_low": "The low value for a normal reference range determined by the facility",
    "reference_range_high": "The high value for a normal reference range determined by the facility",
    "interpretation": "Interpretation provided by the facility performing the observation"
  }
]

200 Response in :id path query case

{
  "id": "string",
  "category": "laboratory",
  "status": "final",
  "patient_id": "string",
  "date": "YYYY-MM-DDThh:mm:ss.xxxZ",
  "name": "string",
  "value": "string",
  "value_type": "string",
  "unit": "string",
  "unit_code": "string",
  "reference_range_low": "number",
  "reference_range_high": "number",
  "interpretation": "string"
}

400 Response

{
  "statusCode": 0,
  "error": "string"
}

Responses

Enumerated Values

Response Schema

Status Code 400

Status Code 404

Status Code 500

get_availability

Get avaialbility of Clinician. We run calculations for you, so you only get available & open slots. Great for building your own patient self-scheduling tool. Ask for documentation.

Get avaialbility of Clinician. We run calculations for you, so you only get available & open slots. Great for building your own patient self-scheduling tool. Ask for documentation.

custom_widgets

Add custom dynamic html widgets into the sidebar of a patient's chart. Can be used to show custom data to the provider to ensure they do not need to use several apps to find all the relevant information.

Add custom dynamic html widgets into the sidebar of a patient's chart. Can be used to show custom data to the provider to ensure they do not need to use several apps to find all the relevant information. https://help.akutehealth.com/article/9-custom-sidebar-apps-guide

post/put/get_problem_list

Coming 2022

post/put_appointments

Coming 2022

post/put_labs

Coming 2022

post/put/get_allergies

Coming 2022

post/put/get_procedures

Coming 2022

post/put/get_conversations

Coming 2022