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;
});
Release files for orchestrate-api 4.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| orchestrate_api-4.2.2.tar.gz | 22.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| orchestrate_api-4.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 52.1 kB
Release files / orchestrate_api-4.2.2.tar.gz
| Download URL | orchestrate_api-4.2.2.tar.gz |
|---|---|
| Size | 22.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6cfbc84c034134f19aa67f15f73507522df4d8412e44d449ffdad0f83b6fda5f
|
|
BLAKE2b-256 checksum How to use checksums |
f3640d39841fe0ad56d4892756145b6e9807b2281b84542641ad87ef47dd4e9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
poetry/2.4.3 CPython/3.14.7 Linux/6.17.0-1022-azure
|
Release files / orchestrate_api-4.2.2-py3-none-any.whl
| Download URL | orchestrate_api-4.2.2-py3-none-any.whl |
|---|---|
| Size | 29.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
94eb891b1938370d74490d49a5f8dd5d8496c5203f355316b1be29bbd84f7014
|
|
BLAKE2b-256 checksum How to use checksums |
fb9d814c043fbd26601646ad116649fe369b7cfbcde154359ebdc14890906fb3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
poetry/2.4.3 CPython/3.14.7 Linux/6.17.0-1022-azure
|