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:

Explicit constructor parameters
The matching environment variable
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.3.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.3.0
File	Size	Uploaded	Provenance
orchestrate_api-4.3.0.tar.gz	23.1 kB	Oct 13, 2026	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for orchestrate-api 4.3.0
File	Interpreter	ABI	Platform	Reset
orchestrate_api-4.3.0-py3-none-any.whl 29.9 kB Oct 13, 2026 Without provenance	Python 3	none	any	Details

Total release size: 53.0 kB

Release files / orchestrate_api-4.3.0.tar.gz

Download URL	orchestrate_api-4.3.0.tar.gz
Size	23.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`c9400052e41417df3f9d571e7ce41124811b19f4ffb8e2c02d763ecad0ba18a2`
BLAKE2b-256 checksum How to use checksums	`91eaf6b32fe0f55573c105197233ec030603d5e992c5a1070e9e23ebe0383ae2`
Upload date	Oct 13, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`poetry/2.5.1 CPython/3.14.8 Linux/6.17.0-1022-azure`

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

Download URL	orchestrate_api-4.3.0-py3-none-any.whl
Size	29.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`18548d67db697ee6e759df52d481000b6c737741da897b14c7ce74a875e6b827`
BLAKE2b-256 checksum How to use checksums	`15fb722febc6cefd320edeeb9a58614ae06b98a94178324bd007644e64a24705`
Upload date	Oct 13, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`poetry/2.5.1 CPython/3.14.8 Linux/6.17.0-1022-azure`

Security for orchestrate-api 4.3.0

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.