Redox

Connect your own Redox organization by saving either an OAuth API key (recommended: your PEM-encoded private key, its pair registered with Redox as a public key/JWKS -- used to self-sign JWT client assertions) or a legacy API key (client id + secret, Data Model API only -- not supported by FHIR), after checking the credentials actually work. Find/create these under the Redox dashboard's Developer page > Authentication tab. Set destination_slug + environment_type too if you'll use FHIR methods.

Disconnect one Redox organization. Nothing in Redox is changed; the saved API key/private key is deleted here.

List the connected Redox organizations.

List the environments (Development/Staging/Production) configured in your Redox organization.

Read one Redox environment in full.

List the API sources configured in a Redox environment -- the systems authorized to send data INTO Redox.

Read one Redox source in full.

List the destination endpoints configured in a Redox environment -- the systems that RECEIVE data from Redox.

Read one Redox destination and its attached auth credential id.

Create a new destination endpoint in a Redox environment. Requires an engineer role in that environment.

Update selected fields of an existing Redox destination. Only given fields change.

Permanently delete a Redox destination. Cannot be undone -- any source subscription routing to it will stop delivering.

List the auth credentials (the secrets used to authenticate TO your sources/destinations, not your own Redox API key) configured in an environment.

Read one auth credential's metadata (never its secret value).

Create a new auth credential in an environment -- a secret your sources/destinations use to authenticate. The exact fields required depend on the auth type; pass them as a JSON object string in settings_json.

Permanently delete an auth credential. Any source/destination using it will stop authenticating once this is gone.

List the auth strategies (supported authentication schemes, e.g. Basic, OAuth2, API key) an environment's sources/destinations can use.

Search Redox exchange log METADATA (not the message payloads themselves) in an environment -- filter by date range, source, destination, and status to find specific transactions.

Search Redox exchange log PAYLOADS (the actual message content that was sent) in an environment. Contains PHI -- use only when necessary for troubleshooting a specific transaction.

List every Redox Data Model API data model and its supported event types (e.g. PatientAdmin/NewPatient, Order/New, Results/New) -- use this to know which model+event to pass to send_data_model_message.

Send a message through the Redox Data Model API (legacy, pre-FHIR) -- e.g. push a new Order, a Results message, a PatientAdmin event. Requires an existing source subscription configured in the Redox dashboard for this data model + event type. Pass the full message body as a JSON object string in message_json (must include Meta.DataModel and Meta.EventType matching what you declare here).

Query for data through the Redox Data Model API (e.g. PatientSearch/Query, Clinical Summary query). Requires an existing destination subscription for the query event type. Pass the query body as a JSON object string in query_json.

Read one FHIR resource by type and id (e.g. Patient/123, Appointment/456) from a Redox FHIR destination. Requires an OAuth (not legacy) connection.

Search FHIR resources of one type (e.g. Patient, Appointment, Observation, Condition, MedicationRequest) against a Redox FHIR destination, with search parameters as query_json (a JSON object of FHIR search params, e.g. {"family": "Smith"}).

Create (writeback) a new FHIR resource on a Redox FHIR destination -- e.g. write a new Appointment, DocumentReference, or ServiceRequest back to the source EHR. Pass the full FHIR resource body as a JSON object string in resource_json.

Update an existing FHIR resource by type+id on a Redox FHIR destination. Pass the full updated FHIR resource body as a JSON object string in resource_json.

Invoke a named FHIR operation (e.g. $match, $everything, a custom Redox operation) against a resource type or specific instance on a Redox FHIR destination. Pass the operation body as a JSON object string in params_json (may be empty).

Create SEVERAL destinations in one call, by explicit name+endpoint pairs. Continues past per-item failures and reports a mixed result.

Permanently delete SEVERAL destinations in one call, by explicit ids. Continues past per-item failures and reports a mixed result. Cannot be undone.

Build one aggregated health report across an environment: every source and destination, which destinations lack an auth credential (a common misconfiguration), which sources/destinations are disabled, and overall counts.