Orchestrate SDK

The Orchestrate SDK is a TypeScript and JavaScript library for interacting with the Orchestrate API at https://api.careevolutionapi.com.

Full documentation of the API is available at https://rosetta-api.docs.careevolution.com/.

Installation

TypeScript:

npm install @careevolution/orchestrate

Python:

pip install orchestrate-api

Usage

TypeScript:

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

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

Python:

from orchestrate import OrchestrateApi

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

Configuration

The SDK supports environment variables for configuring HTTP behavior. These can be used for local development, CI, or shared runtime configuration.

For the primary OrchestrateApi clients in both TypeScript and Python:

Environment variable	Purpose	Default
ORCHESTRATE_API_KEY	Sets the API key sent as the x-api-key header.	Not set
ORCHESTRATE_BASE_URL	Overrides the base URL for Orchestrate API requests.	https://api.careevolutionapi.com
ORCHESTRATE_TIMEOUT_MS	Sets the request timeout in milliseconds.	120000
ORCHESTRATE_ADDITIONAL_HEADERS	Adds extra headers for every request. The value must be a JSON object of string header names to string values.	Not set

Environment variables used by the identity clients:

Environment variable	Purpose
ORCHESTRATE_IDENTITY_URL	Base URL for IdentityApi. Required unless the URL is passed directly when creating the client.
ORCHESTRATE_IDENTITY_API_KEY	API key sent as the x-api-key header for IdentityApi.
ORCHESTRATE_IDENTITY_METRICS_KEY	Metrics key sent as the Authorization header for IdentityApi. A value with or without the Basic prefix is accepted.
ORCHESTRATE_IDENTITY_LOCAL_HASHING_URL	Base URL for LocalHashingApi. Required unless the URL is passed directly when creating the client.

Configuration Precedence

When the same setting is provided in more than one place, the SDK resolves it in this order:

1. Explicit constructor parameters
2. The matching environment variable
3. The SDK default, when one exists

For example, passing api_key or timeout_ms in Python, or apiKey or timeoutMs in TypeScript, overrides the corresponding environment variable.

ORCHESTRATE_ADDITIONAL_HEADERS is additive. It is merged into the request headers before the SDK applies its standard Accept, Content-Type, authentication, and metrics headers, so the SDK-managed headers take precedence if the same header name is supplied in multiple places.

Examples

TypeScript:

export ORCHESTRATE_API_KEY="your-api-key"
export ORCHESTRATE_TIMEOUT_MS="30000"
export ORCHESTRATE_ADDITIONAL_HEADERS='{"x-correlation-id":"demo-run"}'

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

const orchestrate = new OrchestrateApi();

Python:

export ORCHESTRATE_API_KEY="your-api-key"
export ORCHESTRATE_TIMEOUT_MS="30000"
export ORCHESTRATE_ADDITIONAL_HEADERS='{"x-correlation-id":"demo-run"}'

from orchestrate import OrchestrateApi

api = OrchestrateApi()