# Cerner
URL: https://docs.awellhealth.com/docs/marketplace/cerner

> For the complete documentation index, see [llms.txt](https://docs.awellhealth.com/llms.txt).



<img src="/marketplace/cerner.png" width="48" height="48" />

Cerner EMR is an electronic medical records system that helps healthcare organizations improve patient care and increase efficiency.

Category: EHR Integrations. Adds 7 actions to a care flow.

## What to configure [#what-to-configure]

Set these once, on the extension in Awell Studio. An action fails at run time if a
required setting is missing.

| Setting       | Required | Notes                                                                         |
| ------------- | -------- | ----------------------------------------------------------------------------- |
| Client ID     | Yes      | The client ID of the Cerner app used to authenticate.                         |
| Client Secret | Yes      | The client secret of the Cerner app used to authenticate. Stored as a secret. |
| Tenant ID     | Yes      | The tenant ID associated to the organization you are connecting to.           |

## Actions [#actions]

Cerner adds these 7 actions to a care flow. Add one to a step, then fill in its inputs.

### Create document [#create-document]

Create a document in Cerner

This action can be previewed in Studio before you publish.

| Input                 | Type     | Required | Description                                    |
| --------------------- | -------- | -------- | ---------------------------------------------- |
| Patient resource ID   | `string` | Yes      | The patient’s FHIR resource ID.                |
| Encounter resource ID | `string` | Yes      | The FHIR resource ID of the related encounter. |
| Document type         | `string` | Yes      | One of: Progress Note.                         |
| Note                  | `text`   | Yes      | —                                              |

Returns:

| Data point   | Type     |
| ------------ | -------- |
| `resourceId` | `string` |

### Create patient [#create-patient]

Create a patient in Cerner

This action can be previewed in Studio before you publish.

| Input                     | Type     | Required | Description                                                   |
| ------------------------- | -------- | -------- | ------------------------------------------------------------- |
| Assigning organization ID | `string` | Yes      | The ID of the organization that is creating the patient.      |
| SSN                       | `string` | No       | The patient’s Social Security Number.                         |
| Family name               | `string` | Yes      | The patient’s family (last) name.                             |
| Given name                | `string` | Yes      | The patient's given name. May include first and middle names. |
| Birth date                | `date`   | No       | —                                                             |
| Gender                    | `string` | No       | One of: Male, Female, Other, Unknown.                         |
| Email                     | `string` | No       | —                                                             |

Returns:

| Data point   | Type     |
| ------------ | -------- |
| `resourceId` | `string` |

### Find patient by MRN [#find-patient-by-mrn]

Find patient by MRN in Cerner

This action can be previewed in Studio before you publish.

| Input                       | Type     | Required | Description |
| --------------------------- | -------- | -------- | ----------- |
| Medical Record Number (MRN) | `string` | Yes      | —           |

Returns:

| Data point   | Type     |
| ------------ | -------- |
| `resourceId` | `string` |

### Get appointment [#get-appointment]

Retrieve appointment details from Cerner

This action can be previewed in Studio before you publish.

| Input                   | Type     | Required | Description                         |
| ----------------------- | -------- | -------- | ----------------------------------- |
| Appointment resource ID | `string` | Yes      | The resource ID of the appointment. |

Returns:

| Data point                 | Type     |
| -------------------------- | -------- |
| `appointment`              | `json`   |
| `appointmentStartDateTime` | `date`   |
| `appointmentStatus`        | `string` |
| `appointmentTypeCode`      | `string` |
| `patientId`                | `string` |

### Get encounter [#get-encounter]

Retrieve encounter details from Cerner

This action can be previewed in Studio before you publish.

| Input                 | Type     | Required | Description                      |
| --------------------- | -------- | -------- | -------------------------------- |
| Encounter resource ID | `string` | Yes      | The resource ID of the encounter |

Returns:

| Data point  | Type   |
| ----------- | ------ |
| `encounter` | `json` |

### Get patient [#get-patient]

Retrieve patient details from Cerner

This action can be previewed in Studio before you publish.

| Input               | Type     | Required | Description                    |
| ------------------- | -------- | -------- | ------------------------------ |
| Patient resource ID | `string` | Yes      | The resource ID of the patient |

Returns:

| Data point | Type   |
| ---------- | ------ |
| `patient`  | `json` |

### Get patient encounters [#get-patient-encounters]

Retrieve all encounters for a patient

This action can be previewed in Studio before you publish.

| Input               | Type     | Required | Description                    |
| ------------------- | -------- | -------- | ------------------------------ |
| Patient resource ID | `string` | Yes      | The resource ID of the patient |

Returns:

| Data point   | Type   |
| ------------ | ------ |
| `encounters` | `json` |

## Setup and notes [#setup-and-notes]

Cerner EMR is an electronic medical records system that helps healthcare organizations improve patient care and increase efficiency.

### The Cerner extension [#the-cerner-extension]

The **Cerner Extension** is designed to support **Read** and **Write** integrations via [SMART Backend Services](https://docs.oracle.com/en/industries/health/millennium-platform-apis/fhir-authorization-framework/#requesting-authorization-on-behalf-of-a-system). These integrations are server-to-server (backend) and do not require direct user interaction—whether from patients or practitioners. The extension connects to \*\*Cerner's FHIR R4 API.

In addition to REST interfaces, customers using Cerner usually also have healthcare-specific interfaces, like HL7, enabling tasks such as querying patient demographics (ADR A19) or creating documents (ORU messages). Awell supports these interfaces as well.

### Setup [#setup]

To set up the Cerner Extension in Awell, you’ll need to configure the following:

* Tenant ID: the tenant ID associated to the organization you are connecting to ([more info](https://docs.oracle.com/en/industries/health/millennium-platform-apis/fhir-app-provisioning/))
* Client ID: the client ID of the Cerner app used to authenticate. ([more info](https://docs.oracle.com/en/industries/health/millennium-platform-apis/fhir-authorization-framework/#registering-an-application))
* Client secret: the client secret of the Cerner app used to authenticate ([more info](https://docs.oracle.com/en/industries/health/millennium-platform-apis/fhir-authorization-framework/#registering-a-system-account))

Important\*\*: The actions below list what scopes are required to be added to the Cerner app. Without the scopes, the actions will not work as the app will not have the necessary permissions to access the data.

#### Get patient (R4) [#get-patient-r4]

Retrieve a patient’s details using their FHIR resource ID. This action returns the full FHIR Patient resource.

Required application scopes: `system/Patient.read`

#### Create patient (R4) [#create-patient-r4]

Add a new patient to Cerner using demographic information. Required fields include:

* Assigning Organization ID
* Given name
* Family name

While optional, including additional demographic information such as email address, data of birth, etc is highly recommended to improve accuracy when matching patients in the future.

The action will return the FHIR resource ID of the created patient.

Required application scopes: `system/Patient.write`

#### Find patient by MRN (R4) [#find-patient-by-mrn-r4]

Leverages the `Patient.search` (R4) operation to find a patient by their MRN. The action will return the FHIR resource ID of the patient.

Note: the default identifier system used to look up the patient based on MRN is `urn:oid:2.16.840.1.113883.6.1000`.

Required application scopes: `system/Patient.read`

#### Get appointment (R4) [#get-appointment-r4]

Retrieve details of a specific appointment using its FHIR resource ID. The action returns the full FHIR Appointment resource.

Required application scopes: `system/Appointment.read`

#### Get patient encounters (R4) [#get-patient-encounters-r4]

Retrieve all encounters for a patient using their FHIR resource ID. The action returns all FHIR Encounter resources for the patient.

Required application scopes: `system/Encounter.read`

#### Create document (R4) [#create-document-r4]

Create a new document reference (clinical note) in Cerner. The action returns the FHIR resource ID of the created document reference.

Required application scopes: `system/DocumentReference.write`

#### Get encounter (R4) [#get-encounter-r4]

Retrieve details of a specific encounter using its FHIR resource ID. The action returns the full FHIR Encounter resource.

Required application scopes: `system/Encounter.read`

## Changelog [#changelog]

## Cerner changelog [#cerner-changelog]

## Where this page comes from [#where-this-page-comes-from]

The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at `@awell-health/awell-extensions` v2.1.159. They match what the
platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action.
Something wrong or missing? Email [support@awellhealth.com](mailto:support@awellhealth.com).
