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;
});

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

orchestrate_api-4.2.1.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

orchestrate_api-4.2.1-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file orchestrate_api-4.2.1.tar.gz.

File metadata

  • Download URL: orchestrate_api-4.2.1.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: poetry/2.4.2 CPython/3.14.7 Linux/6.17.0-1022-azure

File hashes

Hashes for orchestrate_api-4.2.1.tar.gz
Algorithm Hash digest
SHA256 ac072013092c5bee2560def128ba87c4a351d0c62685a291c8adaa5ad4772961
MD5 0d4879227f4e8c1f7a19016d91018d4c
BLAKE2b-256 3a9af22fbf9de48431e6f46feddb6ba1686f62650b976e75fd567c28479d5a75

See more details on using hashes here.

File details

Details for the file orchestrate_api-4.2.1-py3-none-any.whl.

File metadata

  • Download URL: orchestrate_api-4.2.1-py3-none-any.whl
  • Upload date:
  • Size: 29.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: poetry/2.4.2 CPython/3.14.7 Linux/6.17.0-1022-azure

File hashes

Hashes for orchestrate_api-4.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e54736ac688d19556343acbf4b7d8d1ba2c11ecc81b61294d416b7f47ae8ab82
MD5 1e5bbf87f4e6edea7c863c9a101e3eb9
BLAKE2b-256 13e9211de96d7bdd7bc3d81312f3397e89321b58054b680d10825efa8b8cb71a

See more details on using hashes here.

Release history Release notifications | RSS feed

4.2.2

2 files

This release

4.2.1 This release

2 files

4.2.0

2 files

4.1.0

2 files

4.0.0

2 files

3.3.0

2 files

3.2.0

2 files

3.1.0

2 files

3.0.0

2 files

2.7.1

2 files

2.7.0

2 files

2.6.0

2 files

2.5.0

2 files

2.4.0

2 files

2.3.0

2 files

2.2.1

2 files

2.2.0

2 files

2.1.0

2 files

2.0.1

2 files

2.0.0

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 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