> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/redox.md).

# Redox

Send clinical data and FHIR appointment messages through configured Redox connections.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication               |
| --------- | ---------------------------- |
| Redox     | OAuth with a PEM private key |

### Redox

Connect to Redox with an OAuth API key for configured healthcare data exchange.

#### Set up in Redox

1. Create an OAuth API key in Redox for the required environment and region. Record the client ID and key ID.
2. Register the public key with Redox and retain the corresponding PEM private key for StackAI.
3. Record the source ID if your integration sends requests for a specific Redox source.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Redox**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                             |
| ------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Region        | Optional / as applicable | Redox data-processing region associated with this OAuth API key.                                                                                                          |
| Client ID     | Yes                      | Client ID for the Redox OAuth API key. [Provider instructions](https://developer.redoxengine.com/api-reference/redox-data-model-api/authenticate-an-oauth-api-key/).      |
| Key ID        | Yes                      | Key ID assigned to the Redox OAuth API key. [Provider instructions](https://developer.redoxengine.com/api-reference/redox-data-model-api/authenticate-an-oauth-api-key/). |
| Private key   | Yes                      | PEM private key paired with the Redox OAuth API key.                                                                                                                      |
| Source ID     | Optional / as applicable | Optional Redox source ID required by multi-source API requests.                                                                                                           |

**Provider documentation:** [Setup reference](https://developer.redoxengine.com/api-reference/redox-data-model-api/authenticate-an-oauth-api-key/).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Redox** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Create order

Submit a new lab or medication order to a connected EHR.

#### Inputs

| Field                 | Type            | Required | Description                                                                               |
| --------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------- |
| Destination ID        | string          | Yes      | Redox destination that receives the order.                                                |
| Patient ID            | string          | Yes      | Patient identifier recognized by the destination EHR.                                     |
| Patient ID type       | string          | Yes      | Identifier type used by the destination EHR. Default: MRN.                                |
| Order ID              | string          | Yes      | Unique identifier for this order.                                                         |
| Procedure code        | string          | No       | Site-mapped code for the requested lab, medication, or procedure.                         |
| Procedure code set    | string          | No       | Code system used by the procedure code.                                                   |
| Procedure description | string          | No       | Human-readable name of the requested procedure.                                           |
| Ordering provider NPI | string          | No       | National Provider Identifier for the ordering clinician.                                  |
| Ordering provider ID  | string          | No       | Destination-specific identifier for the ordering clinician.                               |
| Provider first name   | string          | No       | Ordering clinician's first name.                                                          |
| Provider last name    | string          | No       | Ordering clinician's last name.                                                           |
| Priority              | select (string) | No       | Clinical priority for the order. Available values: Routine, ASAP, STAT. Default: Routine. |
| Order date and time   | datetime        | No       | When the order was placed.                                                                |
| Order notes           | textarea        | No       | Comma-separated notes to include with the order.                                          |
| Test message          | boolean         | No       | Mark the Redox message as test traffic. Default: false.                                   |

#### Outputs

| Field          | Type     | Description                                         |
| -------------- | -------- | --------------------------------------------------- |
| Accepted       | boolean  | Whether Redox durably queued the order message.     |
| Redox log IDs  | textarea | Safe Redox log identifiers for support and tracing. |
| Redox trace ID | string   | Redox trace identifier for support.                 |

### Retrieve clinical results

Query a connected EHR for lab and diagnostic results.

#### Inputs

| Field              | Type     | Required | Description                                                |
| ------------------ | -------- | -------- | ---------------------------------------------------------- |
| Destination ID     | string   | Yes      | Redox destination to query.                                |
| Patient ID         | string   | No       | Patient identifier to filter results.                      |
| Patient ID type    | string   | No       | Identifier type used by the destination EHR. Default: MRN. |
| Completed after    | datetime | No       | Only include results completed at or after this time.      |
| Completed before   | datetime | No       | Only include results completed at or before this time.     |
| Updated after      | datetime | No       | Only include results updated at or after this time.        |
| Updated before     | datetime | No       | Only include results updated at or before this time.       |
| Order IDs          | textarea | No       | Comma-separated order identifiers to retrieve.             |
| Result statuses    | textarea | No       | Comma-separated result statuses to include.                |
| Procedure code     | string   | No       | Procedure code to filter results.                          |
| Procedure code set | string   | No       | Code system used by the procedure filter.                  |
| Department         | string   | No       | Destination department identifier or name filter.          |

#### Outputs

| Field              | Type          | Description                                              |
| ------------------ | ------------- | -------------------------------------------------------- |
| Orders and results | object\_array | Typed clinical orders and their results.                 |
| Incomplete results | boolean       | Whether Redox reports that more matching data may exist. |
| Redox log IDs      | textarea      | Safe Redox log identifiers for support and tracing.      |

### Schedule appointment via FHIR

Create an appointment in a connected EHR through Redox FHIR.

#### Inputs

| Field                   | Type            | Required | Description                                                                                                                      |
| ----------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Destination slug        | string          | Yes      | Redox FHIR destination for the target EHR.                                                                                       |
| Environment             | select (string) | Yes      | Redox environment that should receive the appointment. Available values: Development, Staging, Production. Default: Development. |
| Source endpoint         | string          | Yes      | FHIR source URI assigned to your Redox implementation.                                                                           |
| Patient reference       | string          | Yes      | FHIR reference for the patient receiving the appointment.                                                                        |
| Practitioner reference  | string          | Yes      | FHIR reference for the scheduled clinician.                                                                                      |
| Location reference      | string          | Yes      | FHIR reference for the appointment location.                                                                                     |
| Slot reference          | string          | Yes      | FHIR reference for the slot to book.                                                                                             |
| Appointment type code   | string          | Yes      | Destination-supported code for the visit type.                                                                                   |
| Appointment type system | string          | Yes      | Code-system URI for the appointment type.                                                                                        |
| Duration in minutes     | integer         | Yes      | Length of the appointment. Minimum: 1.                                                                                           |
| Appointment status      | select (string) | No       | Initial FHIR appointment status. Available values: Proposed, Pending, Booked. Default: proposed.                                 |
| Reason code             | string          | No       | Clinical or administrative reason for the appointment.                                                                           |
| Reason code system      | string          | No       | Code-system URI for the appointment reason.                                                                                      |

#### Outputs

| Field          | Type     | Description                                         |
| -------------- | -------- | --------------------------------------------------- |
| Accepted       | boolean  | Whether Redox accepted the appointment message.     |
| Redox log IDs  | textarea | Safe Redox log identifiers for support and tracing. |
| Redox trace ID | string   | Redox trace identifier for support.                 |

### Push clinical summary

Write a structured clinical summary into a patient's EHR chart.

#### Inputs

| Field                 | Type     | Required | Description                                                   |
| --------------------- | -------- | -------- | ------------------------------------------------------------- |
| Destination ID        | string   | Yes      | Redox destination that receives the summary.                  |
| Document ID           | string   | Yes      | Unique identifier for this clinical summary document.         |
| Patient ID            | string   | Yes      | Patient identifier recognized by the destination EHR.         |
| Patient ID type       | string   | Yes      | Identifier type used by the destination EHR. Default: MRN.    |
| Patient first name    | string   | No       | Patient's first name for document context.                    |
| Patient last name     | string   | No       | Patient's last name for document context.                     |
| Patient date of birth | date     | No       | Patient's date of birth for document context.                 |
| Author ID             | string   | No       | Identifier for the clinician or system authoring the summary. |
| Author ID type        | string   | No       | Identifier type used for the document author.                 |
| Author first name     | string   | No       | Document author's first name.                                 |
| Author last name      | string   | No       | Document author's last name.                                  |
| Visit number          | string   | No       | Encounter or visit identifier linked to the summary.          |
| Visit number type     | string   | No       | Identifier type used for the visit number.                    |
| Medications JSON      | textarea | No       | Structured medications to include in the summary.             |
| Test message          | boolean  | No       | Mark the Redox message as test traffic. Default: false.       |

#### Outputs

| Field          | Type     | Description                                         |
| -------------- | -------- | --------------------------------------------------- |
| Accepted       | boolean  | Whether Redox durably queued the summary message.   |
| Redox log IDs  | textarea | Safe Redox log identifiers for support and tracing. |
| Redox trace ID | string   | Redox trace identifier for support.                 |

### Send patient query

Search a connected EHR for patients by identifier or demographics.

#### Inputs

| Field              | Type    | Required | Description                                                                                         |
| ------------------ | ------- | -------- | --------------------------------------------------------------------------------------------------- |
| Destination ID     | string  | Yes      | Redox destination to search.                                                                        |
| Patient ID         | string  | No       | Exact patient identifier to search for.                                                             |
| Patient ID type    | string  | No       | Identifier type used by the destination EHR. Default: MRN.                                          |
| First name         | string  | No       | Patient's legal first name.                                                                         |
| Middle name        | string  | No       | Patient's middle name.                                                                              |
| Last name          | string  | No       | Patient's legal last name.                                                                          |
| Date of birth      | date    | No       | Patient's date of birth.                                                                            |
| Administrative sex | select  | No       | Administrative sex recorded by the destination EHR. Available values: Female, Male, Other, Unknown. |
| Test message       | boolean | No       | Mark the Redox query as test traffic. Default: false.                                               |

#### Outputs

| Field              | Type          | Description                                         |
| ------------------ | ------------- | --------------------------------------------------- |
| Patients           | object\_array | Typed matching patient records.                     |
| Incomplete results | boolean       | Whether Redox reports that more matches may exist.  |
| Redox log IDs      | textarea      | Safe Redox log identifiers for support and tracing. |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/redox.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
