Getting Started

Learn how to use the Orchestrate SDK in your project.

Contents

Installation
Quickstart
SDK Methods

Installation

You can download the latest Orchestrate SDK from popular package managers: NPM (for TypeScript and JavaScript) and PIP for Python.

JavaScript
Python

    Installing SDK in Your NPM Project 
    
    npm install @careevolution/orchestrate --save
      npm install @careevolution/orchestrate --save

    Installing SDK in Your Python Project 
    
    pip install orchestrate-api
      pip install orchestrate-api

Once installed, you can then import the SDK in your code for easy reference:

JavaScript
Python

    Referencing the SDK in JavaScript 
    
    import { OrchestrateApi } from '@careevolution/orchestrate';
      import { OrchestrateApi } from '@careevolution/orchestrate';

    Referencing the SDK in Python 
    
    from orchestrate import OrchestrateApi
      from orchestrate import OrchestrateApi

If you wish to see the underlying code, you can find it in GitHub.

Quickstart

Before you can use the Orchestrate SDK, you need to create an account in the Developer Portal and get your personal API key.

Just paste your API key into the string in the examples below and give it a try.

JavaScript
Python

    JavaScript Quickstart 
    
  

    import { OrchestrateApi } from '@careevolution/orchestrate';

const orchestrate = new OrchestrateApi({apiKey: "your-api-key"});
const result = await orchestrate.terminology.classifyCondition({
  code: "119981000146107",
  system: "SNOMED",
});
console.log(result);
  import { OrchestrateApi } from '@careevolution/orchestrate';

const orchestrate = new OrchestrateApi({apiKey: "your-api-key"});
const result = await orchestrate.terminology.classifyCondition({
  code: "119981000146107",
  system: "SNOMED",
});
console.log(result);

    Sample Output 
    
  

    {
  behavioral: false,
  substance: false,
  socialDeterminant: false,
  covid19Condition: 'Confirmed',
  ...
}
  {
  behavioral: false,
  substance: false,
  socialDeterminant: false,
  covid19Condition: 'Confirmed',
  ...
}

    Python Quickstart 
    
    from orchestrate import OrchestrateApi

api = OrchestrateApi(api_key="your-api-key")
print(api.terminology.classify_condition(code="119981000146107", system="SNOMED"));
  from orchestrate import OrchestrateApi

api = OrchestrateApi(api_key="your-api-key")
print(api.terminology.classify_condition(code="119981000146107", system="SNOMED"));

    Sample Output 
    
  

    { 
  'behavioral': False, 
  'substance': False, 
  'socialDeterminant': False, 
  'covid19Condition': 
  'Confirmed', 
  ... 
}
  { 
  'behavioral': False, 
  'substance': False, 
  'socialDeterminant': False, 
  'covid19Condition': 
  'Confirmed', 
  ... 
}

Tip
The examples above use the API key in a plain string to get you up and running quickly. In real code, it is better to store your API key in an environment variable, or use a utility like dotenv (JS / Python). These will keep your API key secure and avoid accidentally committing it to source control.

SDK Methods

The SDK contains methods corresponding to individual API operations. For details, see SDK Methods