Skip to main content

Orchestrate SDK

The Orchestrate SDK provides TypeScript, Python, and C# clients 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

C#:

dotnet add package CareEvolution.Orchestrate

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")

C#

using CareEvolution.Orchestrate;

var api = new OrchestrateApi(new OrchestrateClientOptions
{
    ApiKey = "your-api-key",
});

await api.Terminology.ClassifyConditionAsync(new ClassifyConditionRequest
{
    Code = "119981000146107",
    System = "SNOMED",
});

Additionally, C# also supports dependency injection with IOrchestrateApi and OrchestrateApi registered in the service collection.

using CareEvolution.Orchestrate;
using Microsoft.Extensions.DependencyInjection;

var services = new ServiceCollection();
services.AddOrchestrateApi();

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 TypeScript, Python, and C#:

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, apiKey or timeoutMs in TypeScript, or ApiKey or TimeoutMs in C# 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 Example

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 Example

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()

C# Example

With environment values as above or DI configuration:

using Microsoft.Extensions.DependencyInjection;
using CareEvolution.Orchestrate;

var services = new ServiceCollection();
services.AddOrchestrateApi(options =>
{
    options.ApiKey = "your-api-key";
    options.TimeoutMs = 30000;
});

Metadata

Release files for orchestrate-api 4.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for orchestrate-api 4.2.0
File Size Uploaded
orchestrate_api-4.2.0.tar.gz 22.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for orchestrate-api 4.2.0
File Interpreter ABI Platform
orchestrate_api-4.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 52.1 kB

Release files / orchestrate_api-4.2.0.tar.gz

Download URL orchestrate_api-4.2.0.tar.gz
Size 22.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0868b86f30b14eedcdf663a0cd514875357f8d3508c51c6f0d3a036c8cf58023
BLAKE2b-256 checksum
How to use checksums
bb69c8f160b8f0d5610578f521b8a2fd298f32ec9bfc3ee3db847ced5f0a7eb7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via poetry/2.4.2 CPython/3.14.7 Linux/6.17.0-1022-azure

Release files / orchestrate_api-4.2.0-py3-none-any.whl

Download URL orchestrate_api-4.2.0-py3-none-any.whl
Size 29.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1b52e39b9b4d4be1d03d283f16a8a40674a47fb666b477f894e83ab2b235f8e7
BLAKE2b-256 checksum
How to use checksums
fa27cfbc01a626f1ae2633d13e09c194da148cc0c709fd48f7e3eb7f0312211c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via poetry/2.4.2 CPython/3.14.7 Linux/6.17.0-1022-azure

Release history Release notifications | RSS feed

4.3.0

2 release files

4.2.2

2 release files

4.2.1

2 release files

This release

4.2.0 This release

2 release files

4.1.0

2 release files

4.0.0

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.0

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page