Using the API

This API is a REST-based interface, which means that applications make requests by accessing specific URLs using HTTP. One of the hallmarks of REST is that the API calls are stateless, meaning each request is a single, self-contained operation.

The API does not persist data, so the typical REST “CRUD” (create-read-update-delete) model does not apply. All operations are transient requests to analyze or transform the provided data.

Base URL

The base endpoint for the Orchestrate APIs is:

https://api.careevolutionapi.com

For example:

https://api.careevolutionapi.com/terminology/v1/classify/condition

In the API reference, the base URL is usually omitted for brevity, and only the bolded part given.

Required Headers

Every API call requires the following fields in the HTTP request header:

Field Required Value Description
x-api-key YOUR_API_KEY Contains your API key, obtained from the Developer Portal. See API Keys for details.
content-type See Data Formats. Defines the format of the sent data.
accept See Data Formats. Defines the desired output format.

Data Formats

Most data sent to and received from the API will be in JSON format, so both the content-type and accept headers will be application/json.

A few operations can accept or return content in other formats, such as application/xml, application/x-ndjson, or even text/plain. These are noted in their respective API details.

Authorization

No additional authorization is required beyond the API key header (see required headers).

REST Basics

This section gives a brief introduction to REST APIs in general, and discusses how that model applies to this API.

Resources and URLs

In the API, REST resources are services. These services are organized into collections: terminology, convert, and insight. Versioning is built into the URLs.

For example, the URL terminology/v1 is the root for all “version 1” terminology-based services, with resources like terminology/v1/standardize/condition and terminology/v1/classify/medication.

Segments

Some segments of the API URLs begin with a : to indicate that they are variables conveying information about the specific resource you wish to access. For example, the URL /convert/v1/cdatofhirr4/:patientID lets you specify a patient identifier.

HTTP Verbs

Every API call uses a specific HTTP verb, which tells the system what kind of action you want to take with the resource. Different verbs are supported for each resource; consult the API documentation for details. Requests to analyze or perform a transformation on the provided data generally use the POST verb.

Parameters

Many API calls use query parameters and/or request body data to send data to the server. For example, a POST to the /terminology/v1/standardize/condition API might contain the body data:

{
  "code": "A000",
  "system": "ICD-10-CM"
}

Be sure to specify the content type in your requests.

Error Handling

The response header for each request contains a status code indicating whether the request was successful. Common status codes you will encounter are:

Code Description
200 Success The request was successful.
400 Bad Request There was a problem with your request parameters.
403 Forbidden Check your API key (see Required Headers).
429 Too Many Requests You have exceeded the API usage limits. See Rate Limits for details.
500 Internal Server Error There was an unknown issue processing the request. Check the response body for details, and contact us if you need help determining the problem.

Operation Outcomes

In addition to the HTTP status codes, many of the FHIR-based APIs will include an OperationOutcome resource in their output. An OperationOutcome is a collection of issue elements detailing what was parsed from the input, as well as any problems with the conversion. The issue severity, code, and details elements will describe the specifics of the issue and its location within the input data. The issue code will be one of the following values from the FHIR IssueType list:

  • Information - Informative only; requires no follow up or action. For example: the number of conditions parsed from the input.
  • Warning - Likely requires no follow up; flags conversions where portions of the input may be disregarded or ignored. For example: a duplicate data element was found and ignored.
  • Error - Likely requires follow up; flags lossy conversions or assumptions made to generate the output. For example: a required field was missing so a default value was assumed, or an element was not parseable and removed from the output.
  • Fatal - The input data is not usable as given. For example: the XML or JSON is malformed.

For example:

Sample Output
{
  "resource": {
    "resourceType": "OperationOutcome",
    "issue": [
      {
        "severity": "warning",
        "code": "processing",
        "details": {
          "text": "Labs: Missing description in the reference dictionary for #labgroup_3. Line Number - 662, XPath - ClinicalDocument/component/structuredBody/component/section/entry/organizer/code/originalText/reference"
        }
      },
      {
        "severity": "information",
        "code": "informational",
        "details": {
          "text": "Processed 2 entries from Encounters section."
        }
      },
      ... (additional issues if applicable)
    ]
  }
}

When using the development sandbox, issues from the OperationOutcome will automatically be highlighted in the alert area for easy reference.

Rate Limits

The API has a rate limiting feature to preserve stability for all customers. Users who send too many API requests within a short timeframe will receive a 429: Too Many Requests error.

The API limits you to a number of requests per month. The specific number depends on your account tier. You can check your limit and usage in the Developer Portal.

If you find you need a higher rate limit, contact us to discuss upgrading your account.