# Extensions

Extensions are Redox's way of creating additional customization for customers. For example, an EHR may collect information specific to one application on check-in. Rather than adding a new field for this, Redox creates an extension. All extensions are available for public consumption in this extensions library.

Redox Extensions are [FHIR® Extensions](http://hl7.org/fhir/extensibility.html). When extensions are used in Redox Data Models, they are only applied to certain properties. A complete list of Redox Data Model schemas and the properties that an Extension applies to can be found in the "Context". In general, the `Extensions` property will not be present if no extensions are in use.

## Accident Code

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/accident-code`  
Status: Draft

Code for the related accident.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/accident-code",
  "coding": {
    "code": "AA",
    "display": "Auto Accident"
  }
}
```

## Accident Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/accident-date`  
Status: Draft

The date of the accident in ISO 8601 format.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |
| PatientAdmin | * | `Visit` |
| Scheduling | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/accident-date",
  "dateTime": "2019-07-12"
}
```

## Accident State

Type: `string`  
URL: `https://api.redoxengine.com/extensions/accident-state`  
Status: Draft

The state where the accident occurred.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/accident-state",
  "string": "AZ"
}
```

## Additional Identifier

Type: `identifier`  
URL: `https://api.redoxengine.com/extensions/additional-identifier`  
Status: Draft

An additional identifier for this concept.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit` |
| Scheduling | * | `Visit` |
| Results | * | `Visit` |
| Results | * | `Orders[]` |
| Order | * | `Visit` |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Flowsheet | * | `Visit` |
| Flowsheet | * | `Observations[]` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse, QueryResponse | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/additional-identifier",
  "identifier": {
    "use": null,
    "type": "VISITID",
    "system": null,
    "value": "7469576167",
    "period": null,
    "assigner": null
  }
}
```

## Additional Identifiers

Type: `identifiers`  
URL: `https://api.redoxengine.com/extensions/additional-identifiers`  
Status: Draft

Additional identifiers for this concept.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| SSO | * | `Visit` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse | `Medications[]` |
| Medications | New, Update, Cancel | `Order` |
| Medications | New, Update, Cancel | `Order.Pharmacy` |
| PatientAdmin | * | `Patient.PCP` |
| PatientAdmin | * | `Visit.AdmittingProvider` |
| PatientAdmin | * | `Visit.ReferringProvider` |
| PatientAdmin | * | `Visit.ConsultingProvider` |
| PatientAdmin | * | `Visit.AttendingProvider` |
| Scheduling | * | `Visit.AttendingProvider` |
| Scheduling | * | `Visit.ReferringProvider` |
| Scheduling | * | `Visit.ConsultingProvider` |
| Scheduling | * | `Visit.VisitProvider` |
| SurgicalScheduling | * | `Visit.AttendingProvider` |
| PatientAdmin | * | `Meta` |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/additional-identifiers",
  "identifiers": [
    {
      "use": null,
      "type": "VISITID",
      "system": null,
      "value": "7469576167",
      "period": null,
      "assigner": null
    },
    {
      "use": null,
      "type": "Other ID",
      "system": null,
      "value": "123456789",
      "period": null,
      "assigner": null
    }
  ]
}
```

## Additional Information

Type: `string`  
URL: `https://api.redoxengine.com/extensions/additional-information`  
Status: Draft

A section to capture additional information.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Inventory | * | `Items[]` |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[]` |
| PatientAdmin | * | `Visit.Insurances[]` |
| PatientAdmin | * | `Patient.Insurances[]` |
| PatientAdmin | * | `Patient.Contacts[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/additional-information",
  "string": "Please include additional context."
}
```

## Additional Phone Numbers

Type: `additionalPhones`  
URL: `https://api.redoxengine.com/extensions/additional-phones`  
Status: Draft

Any additional phone numbers a patient or location may have.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Demographics.PhoneNumber` |
| PatientAdmin | * | `Patient.Guarantor.PhoneNumber` |
| PatientAdmin | * | `Patient.Contacts[].PhoneNumber` |
| PatientAdmin | NewPatient, PatientUpdate | `Patient.Insurances[].Insured` |
| PatientAdmin | Arrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdate | `Visit.Insurances[].Insured` |
| Scheduling | * | `Patient.Demographics.PhoneNumber` |
| Scheduling | * | `Visit.Location` |
| Order | * | `Patient.Demographics.PhoneNumber` |

```json
{
  "url": "https://api.redoxengine.com/extensions/additional-phones",
  "additionalPhones": {
    "home": [
      "+16088675309",
      "+16088675308"
    ],
    "office": [
      "+16088675309"
    ],
    "mobile": [
      "+16088675307",
      "+16088675306"
    ]
  }
}
```

## Additional Patient Contacts Phone Numbers

Type: `additionalPhones`  
URL: `https://api.redoxengine.com/extensions/additional-phones-contacts`  
Status: Draft

Any additional phone numbers the patient's contacts may have.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Contacts[].PhoneNumber` |
| Scheduling | * | `Patient.Contacts[].PhoneNumber` |

```json
{
  "url": "https://api.redoxengine.com/extensions/additional-phones-contacts",
  "additionalPhones": {
    "home": [
      "+16088675309",
      "+16088675308"
    ],
    "office": [
      "+16088675309"
    ],
    "mobile": [
      "+16088675307",
      "+16088675306"
    ]
  }
}
```

## Additional Provider Information

Type: `participants`  
URL: `https://api.redoxengine.com/extensions/additional-provider-info`  
Status: Draft

Support for additional provider information (ex. Billing provider info)

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | Transaction | `Transactions[]` |
| Flowsheet | * | `Visit` |
| PatientAdmin | * | `Visit` |
| Media | New, Replace, Delete | `Media` |

```json
{
  "url": "https://api.redoxengine.com/extensions/additional-provider-info",
  "participants": [
    {
      "id": "123456",
      "idType": "NPI",
      "person": {
        "name": {
          "given": [
            "Pat"
          ],
          "family": "Granite"
        }
      },
      "credentials": [
        "MD"
      ],
      "addr": {
        "line": [
          "123 Anywhere Street"
        ],
        "city": "Madison",
        "state": "WI",
        "postalCode": "53711"
      },
      "telecom": [
        {
          "use": "WP",
          "value": "tel:+1-555-555-1234"
        }
      ],
      "organization": {
        "facility": "Good Health Clinics",
        "dept": "Clinic"
      }
    }
  ]
}
```

## Additional Patient Race Values

Type: `stringArray`  
URL: `https://api.redoxengine.com/extensions/additional-races`  
Status: Active, Value set, Foundation

Any additional race values associated to the patient.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Demographics` |
| PatientSearch | * | `Patient.Demographics` |
| Order | * | `Patient.Demographics` |
| Results | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/additional-races",
  "stringArray": [
    "White",
    "Black or African American"
  ]
}
```

## Address

Type: `address`  
URL: `https://api.redoxengine.com/extensions/address`  
Status: Draft

Address details.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit.Location` |
| Order | * | `Visit.Location` |
| Results | * | `Patient.Demographics` |
| PatientAdmin | * | `Visit.Location` |
| Claim | SubmissionBatch | `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Visit.Location` |

```json
{
  "url": "https://api.redoxengine.com/extensions/address",
  "address": {
    "use": "work",
    "type": "physical",
    "text": "297 Main Street, Oregon, WI 53575",
    "line": [
      "297 Main Street"
    ],
    "city": "Oregon",
    "state": "WI",
    "postalCode": "53575"
  }
}
```

## Adjuster Information

Type: `participants`  
URL: `https://api.redoxengine.com/extensions/adjuster-info`  
Status: Draft

Demographic information for the claim adjuster

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit.Insurances[]` |
| PatientAdmin | * | `Patient.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/adjuster-info",
  "participants": [
    {
      "person": {
        "name": {
          "given": [
            "Timothy"
          ],
          "family": "Johnson"
        }
      },
      "addr": {
        "line": [
          "123 Anywhere Street"
        ],
        "city": "Madison",
        "state": "WI",
        "postalCode": "53711"
      },
      "phone": "+16085559876"
    }
  ]
}
```

## Admission Method

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/admission-method`  
Status: Draft

How the patient was taken to the healthcare facility.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/admission-method",
  "codeableConcept": {
    "coding": "A",
    "text": "Ambulance"
  }
}
```

## Admission Source

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/admission-source`  
Status: Draft

The location of the patient prior to the admission at the healthcare facility.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/admission-source",
  "codeableConcept": {
    "coding": "emd",
    "text": "From Accident / Emergency Department"
  }
}
```

## Admission Type

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/admission-type`  
Status: Draft

How the patient was admitted to the hospital.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit` |
| Medications | * | `Visit` |
| SurgicalScheduling | * | `Visit` |
| Scheduling | * | `Visit` |
| Results | New, NewUnsolicited | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/admission-type",
  "codeableConcept": {
    "coding": "T",
    "text": "Trauma"
  }
}
```

## Age

Type: `string`  
URL: `https://api.redoxengine.com/extensions/age`  
Status: Active, Foundation

Generic field for passing age

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Patient.Demographics` |
| Flowsheet | * | `Patient.Demographics` |
| Medications | * | `Patient.Demographics` |
| Notes | New, Replace, Delete | `Patient.Demographics` |
| Order | New, Update, Cancel, GroupedOrders | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse | `Patient.Demographics` |
| Results | New, NewUnsolicited | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| SurgicalScheduling | * | `Patient.Demographics` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/age",
  "string": "34"
}
```

## Alternative Code

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/alternate-code`  
Status: Active

The alternative product code.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Vaccination | * | `Vaccinations[].Product` |
| Inventory | * | `Items[]` |
| Financial | * | `Transactions[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/alternate-code",
  "coding": {
    "system": "NDC",
    "code": "1234-67048-00",
    "display": "Covid-19 Vaccine Name"
  }
}
```

## Alternative Quantity

Type: `quantity`  
URL: `https://api.redoxengine.com/extensions/alternate-quantity`  
Status: Active

An alternative representation of the same physical quantity.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Results[].Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `FunctionalStatus.Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `HealthConcerns[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `SocialHistory.Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `VitalSigns[].Observations[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/alternate-quantity",
  "quantity": {
    "value": 4.2,
    "unit": "10*3/uL"
  }
}
```

## Alternative Name

Type: `string`  
URL: `https://api.redoxengine.com/extensions/alternative-name`  
Status: Draft

An alternative name to this object

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Medications | New, Update, Cancel | `Order.Medication.Product` |
| Medications | Administration | `Administrations[].Medication.Product` |

```json
{
  "url": "https://api.redoxengine.com/extensions/alternative-name",
  "string": "Albuterol Sulfate"
}
```

## Appointment Status

Type: `string`  
URL: `https://api.redoxengine.com/extensions/appointment-status`  
Status: Draft

Status identifying the lifecycle stage of the appointment.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Referral | New, Modify, Cancel | `Referral.Procedures[]` |
| Order | New, Update, Cancel, GroupedOrders | `Visit` |
| Results | New, NewUnsolicited | `Visit` |
| PatientAdmin | PreAdmit, VisitUpdate | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/appointment-status",
  "string": "Scheduled"
}
```

## Assignment of Benefits

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/assignment-of-benefits`  
Status: Draft

An indicator if the person has completed the assignment of benefits.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/assignment-of-benefits",
  "boolean": true
}
```

## Attending Provider ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/attending-provider-id`  
Status: Draft

The ID of the attending provider.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| SSO | Sign-on | `Visit` |
| Financial | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/attending-provider-id",
  "string": "8675309"
}
```

## Attending Provider Name

Type: `humanName`  
URL: `https://api.redoxengine.com/extensions/attending-provider-name`  
Status: Draft

The preferred name of the attending provider.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/attending-provider-name",
  "humanName": {
    "use": "usual",
    "text": "Billy",
    "given": [
      "Billy"
    ]
  }
}
```

## Author Id

Type: `string`  
URL: `https://api.redoxengine.com/extensions/author-id`  
Status: Draft

The id number of the author.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/author-id",
  "string": "7236481726"
}
```

## Author Name

Type: `humanName`  
URL: `https://api.redoxengine.com/extensions/author-name`  
Status: Draft

The preferred name of the author.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/author-name",
  "humanName": {
    "use": "usual",
    "text": "Billy",
    "given": [
      "Billy"
    ]
  }
}
```

## Authorization Effective Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/authorization-effective-date`  
Status: Draft

The authorization's start datetime of a referral

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit.Insurances[]` |
| Financial | * | `Visit.Insurances[]` |
| Financial | * | `Visit.Transactions[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/authorization-effective-date",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Authorization Expiration Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/authorization-expiration-date`  
Status: Draft

The authorization's expiration datetime of a referral

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit.Insurances[]` |
| Financial | * | `Visit.Insurances[]` |
| Financial | * | `Visit.Transactions[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/authorization-expiration-date",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Authorization Number

Type: `string`  
URL: `https://api.redoxengine.com/extensions/authorization-number`  
Status: Draft

The identifier for the referral authorization

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit.Insurances[]` |
| Financial | * | `Visit.Insurances[]` |
| Financial | * | `Visit.Transactions[]` |
| Order | * | `Visit.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/authorization number",
  "string": "X8675309"
}
```

## Authorized Payor

Type: `string`  
URL: `https://api.redoxengine.com/extensions/authorized-payor`  
Status: Draft

The authorized payor.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/authorized-payor",
  "string": "AET01"
}
```

## Authored Reimbursement Limit

Type: `integer`  
URL: `https://api.redoxengine.com/extensions/authorized-reimbursement-limit`  
Status: Draft

The maximum amount authorized for reimbursement for a referral

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/authorized-reimbursement-limit",
  "integer": 1200
}
```

## Authorization Required

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/auth-required`  
Status: Draft

An indicator if authorization is required.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Medications | * | `Order.Medication` |

```json
{
  "url": "https://api.redoxengine.com/extensions/auth-required",
  "boolean": true
}
```

## Authored Treatment Count

Type: `integer`  
URL: `https://api.redoxengine.com/extensions/authorized-treatment-count`  
Status: Draft

The count of authorized treatments from a referral

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit.Insurances[]` |
| Financial | * | `Visit.Insurances[]` |
| Financial | * | `Visit.Transactions[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/authorized-treatment-count",
  "integer": 3
}
```

## Assigning Authority

Type: `string`  
URL: `https://api.redoxengine.com/extensions/assigning-authority`  
Status: Draft

The assigning authority for the sending or receiving organization, most often an OID.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientSearch | * | `Meta` |
| Clinical Summary | * | `Meta` |
| Scheduling | * | `Patient.Identifiers[]` |
| PatientAdmin | * | `Patient.Identifiers[]` |
| PatientAdmin | NewPatient, PatientUpdate, PatientMerge | `Meta` |
| Media | * | `Patient.Identifiers[]` |
| PatientSearch | * | `Patient.Identifiers[]` |
| Results | * | `Patient.Identifiers[]` |
| Order | * | `Patient.Identifiers[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/assigning-authority",
  "string": "2.16.3387.2837.12345.4567"
}
```

## Balance Amount

Type: `decimal`  
URL: `https://api.redoxengine.com/extensions/balance-amount`  
Status: Draft

The current balance amount of an account.  For example, a patient's current balance with an organization.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Financial | * | `Visit` |
| Financial | * | `Patient` |
| Financial | * | `Transactions[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/balance-amount",
  "decimal": 12.75
}
```

## Bed Status

Type: `string`  
URL: `https://api.redoxengine.com/extensions/bed-status`  
Status: Draft

Indicates the status of the bed.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | VisitUpdate, PreAdmit, Registration | `Visit.Location` |

```json
{
  "url": "https://api.redoxengine.com/extensions/bed-status",
  "string": "Unoccupied"
}
```

## Billed Status

Type: `string`  
URL: `https://api.redoxengine.com/extensions/billed-status`  
Status: Draft

Status identifying the lifecycle stage of a billed account/transaction.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |
| PatientAdmin | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/billed-status",
  "string": "billable"
}
```

## Billing Code

Type: `stringArray`  
URL: `https://api.redoxengine.com/extensions/billing-code`  
Status: Draft

Code for the related claim for reimbursement.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/billing-code",
  "stringArray": [
    "11^20220223",
    "29^20220223",
    "24^20220223"
  ]
}
```

## Patient Birth Sex

Type: `string`  
URL: `https://api.redoxengine.com/extensions/birth-sex`  
Status: Active, Value set, Foundation

The patient's sex assigned at birth.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | * | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientEducation | * | `Patient.Demographics` |
| Results | * | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/birth-sex",
  "string": "Male"
}
```

## Body Site

Type: `string`  
URL: `https://api.redoxengine.com/extensions/body-site`  
Status: Draft

Free text field to capture where in the body the implant was placed

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Inventory | * | `Items[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/body-site",
  "string": "Chest"
}
```

## Body Site Modifier

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/body-site-modifier`  
Status: Active

The modifier to the body site.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order.Specimen` |
| Order | GroupedOrders, QueryResponse | `Orders[].Specimen` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[].Results[].Specimen` |

```json
{
  "url": "https://api.redoxengine.com/extensions/body-site-modifier",
  "coding": {
    "system": "SCT",
    "code": "419161000",
    "display": "Unilateral left"
  }
}
```

## Case Description

Type: `string`  
URL: `https://api.redoxengine.com/extensions/case-description`  
Status: Draft

A description of the case

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |
| PatientAdmin | * | `Patient.Insurances[]` |
| PatientAdmin | * | `Visit.Insurances[]` |
| Scheduling | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/case-description",
  "string": "This case is regarding Mr. John Doe and his affinity to UFOs"
}
```

## Case ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/case-id`  
Status: Draft

The identifier for the case.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | Transaction | `Visit` |
| Inventory | Deplete | `Visit` |
| PatientAdmin | * | `Patient.Insurances[]` |
| PatientAdmin | * | `Visit.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/case-id",
  "string": "121342"
}
```

## Check-in Date & Time

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/check-in-date-time`  
Status: Draft

The check-in date and time of a visit in ISO 8601 format.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit` |
| PatientAdmin | VisitUpdate, Registration | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/check-in-date-time",
  "dateTime": "2018-01-13T10:33:12.000Z"
}
```

## Check-in Description

Type: `string`  
URL: `https://api.redoxengine.com/extensions/check-in-description`  
Status: Draft

The check-in description of a visit.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit` |
| PatientAdmin | VisitUpdate, Registration | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/check-in-description",
  "description": "Visit 15834512 was checked in"
}
```

## Claim Number

Type: `string`  
URL: `https://api.redoxengine.com/extensions/claim-number`  
Status: Draft

The insurance claim number.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Insurances[]` |
| PatientAdmin | * | `Visit.Insurances[]` |
| Financial | Transaction | `Transactions[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/claim-number",
  "string": "1236537"
}
```

## Confidential

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/confidential`  
Status: Draft

Flag indicating if the information is confidential.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Results | * | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/confidential",
  "boolean": true
}
```

## Confirmation Status

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/confirmation-status`  
Status: Draft

Flag indicating if the visit is confirmed.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit` |
| Scheduling | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/confirmation-status",
  "boolean": true
}
```

## Consent

Type: `consent`  
URL: `https://api.redoxengine.com/extensions/consent`  
Status: Active

A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| Referral | New, Modify, Cancel | `Patient` |
| SurgicalScheduling | * | `Patient` |
| Scheduling | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/consent",
  "consent": [
    {
      "id": "2.16.840.1.113883.3.1",
      "status": "active",
      "type": [
        {
          "coding": [
            {
              "code": "SMS",
              "display": "Short Message Service"
            }
          ],
          "text": "Communication via text."
        }
      ],
      "dateTime": "2022-12-01",
      "performer": {
        "name": {
          "given": [
            "Pat"
          ],
          "family": "Granite"
        },
        "relationship": "self"
      }
    },
    {
      "id": "2.16.840.1.113883.4.6",
      "status": "rejected",
      "type": [
        {
          "coding": [
            {
              "code": "IDSCL",
              "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
              "display": "information disclosure"
            }
          ],
          "text": "The Text"
        }
      ],
      "dateTime": "2022-01-02",
      "performer": {
        "name": {
          "given": [
            "Pat"
          ],
          "family": "Granite"
        },
        "relationship": "self"
      }
    }
  ]
}
```

## Copay

Type: `decimal`  
URL: `https://api.redoxengine.com/extensions/copay`  
Status: Draft

The out-of-pocket amount owed/paid by an insured for covered services.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Medications | * | `Order.Medication` |
| PatientAdmin | * | `Visit.Insurances[]` |
| PatientAdmin | * | `Patient.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/copay",
  "decimal": 50
}
```

## Copay Collected

Type: `decimal`  
URL: `https://api.redoxengine.com/extensions/copay-collected`  
Status: Draft

The out-of-pocket amount that has been paid by an insured for covered services.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Medications | * | `Order.Medication` |
| PatientAdmin | * | `Visit.Insurances[]` |
| PatientAdmin | * | `Patient.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/copay-collected",
  "decimal": 50
}
```

## Medication Date Identifier

Type: `identifier`  
URL: `https://api.redoxengine.com/extensions/medication-date-identifier`  
Status: Draft

Used to capture Medication date (as string) for a specific identifier, along with the identifier.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | * | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/medication-date-identifier",
  "identifier": {
    "use": null,
    "type": "ORDER",
    "system": null,
    "value": "08/04/2020",
    "period": null,
    "assigner": "REDOX USER, PA"
  }
}
```

## Device ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/device-id`  
Status: Draft

The unique identifier to be able to identify the device

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Results | * | `Orders[].Results[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/device-id",
  "string": "3987257"
}
```

## Diet Tray Instructions

Type: `identifier`  
URL: `https://api.redoxengine.com/extensions/diet-tray-instructions`  
Status: Draft

Diet Tray Instructions

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/diet-tray-instructions",
  "identifier": {
    "use": "218:BRK",
    "type": "GUEST TRAY",
    "system": null,
    "value": "Instructions for tray",
    "period": "2021-05-01^2021-05-31",
    "assigner": ""
  }
}
```

## Dietary Instructions

Type: `stringArray`  
URL: `https://api.redoxengine.com/extensions/dietary-instructions`  
Status: Draft

Dietary orders, supplements, and preferences

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/dietary-instructions",
  "stringArray": [
    "'VEGAN^Replaced with new diet order – Restrictions:  * beveragemodifiers656368: No free water'"
  ]
}
```

## Discharge Date & Time

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/discharge-date-time`  
Status: Draft

The discharge date and time of a visit in ISO 8601 format.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Notes | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/discharge-date-time",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Discharge Reason

Type: `string`  
URL: `https://api.redoxengine.com/extensions/discharge-reason`  
Status: Draft

The reason a patient is being discharged.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/discharge-reason",
  "string": "Transfer to home care"
}
```

## Delegation of Authority

Type: `references`  
URL: `https://api.redoxengine.com/extensions/doa`  
Status: Draft

Allows references to other Organization resources in the directory from which this Organization receives its Delegation of Authority. For Principal organizations, this contains an array of references to authorized Delegate organizations.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientSearch | * | `Meta` |
| PatientAdmin | NewPatient, PatientUpdate, PatientMerge | `Meta` |
| Clinical Summary | * | `Meta` |
| Organization | * | `Organizations[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/doa",
  "references": [
    {
      "reference": "Organization/2.16.840.1.113883.3.9999.123.456",
      "display": "Delegate Organization 1",
      "identifier": {
        "system": "http://www.hl7.org/oid/",
        "value": "2.16.840.1.113883.3.9999.123.456"
      }
    },
    {
      "reference": "Organization/2.16.840.1.113883.3.9999.789.012",
      "display": "Delegate Organization 2",
      "identifier": {
        "system": "http://www.hl7.org/oid/",
        "value": "2.16.840.1.113883.3.9999.789.012"
      }
    },
    {
      "reference": "Organization/2.16.840.1.113883.3.9999.345.678"
    },
    {
      "reference": "Organization/2.16.840.1.113883.3.9999.901.234",
      "display": "Delegate Organization 4"
    },
    {
      "reference": "Organization/2.16.840.1.113883.3.9999.567.890",
      "identifier": {
        "system": "http://www.hl7.org/oid/",
        "value": "2.16.840.1.113883.3.9999.567.890"
      }
    }
  ]
}
```

## Do Not Resuscitate

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/do-not-resuscitate`  
Status: Draft

The Patient's Advance Directives on DNR

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/do-not-resuscitate",
  "coding": {
    "system": "2.16.840.1.113883.6.96",
    "version": "",
    "code": "304253006",
    "display": "Do not resuscitate",
    "userSelected": ""
  }
}
```

## Document Search Types

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/document-search-types`  
Status: Draft

Additional types of documents to search for

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | DocumentQuery, DocumentGet | `Document` |

```json
{
  "url": "https://api.redoxengine.com/extensions/document-search-types",
  "codeableConcept": {
    "coding": [
      {
        "system": "urn:redox:document_kind",
        "code": "Notes"
      }
    ]
  }
}
```

## Document Submission Method

Type: `string`  
URL: `https://api.redoxengine.com/extensions/document-submission-method`  
Status: Draft

The method in which a document (i.e., admin documents, clinical documents, encounter documents, imaging/diagnostic results, lab results, physician authorizations, signed orders, etc) is submitted.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | * | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/document-submission-method",
  "string": "FAX"
}
```

## Donor Relation

Type: `string`  
URL: `https://api.redoxengine.com/extensions/donor-relation`  
Status: Draft

The relationship to the donor

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order.ClinicalInfo[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/donor-relation",
  "string": "Father"
}
```

## Donor Type

Type: `string`  
URL: `https://api.redoxengine.com/extensions/donor-type`  
Status: Draft

The type of donor

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order.ClinicalInfo[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/donor-type",
  "string": "Individual donor"
}
```

## Duration

Type: `string`  
URL: `https://api.redoxengine.com/extensions/duration`  
Status: Draft

This component indicates how long the service should continue after it is started.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Financial | Transaction | `Transactions[].Procedure` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/duration",
  "string": "INDEF"
}
```

## Echoed Status

Type: `string`  
URL: `https://api.redoxengine.com/extensions/echoed-status`  
Status: Draft

An additional status to support a status outside of Redox normalized status's.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Research | SubjectUpdate | `Enrollment` |

```json
{
  "url": "https://api.redoxengine.com/extensions/echoed-status",
  "string": "Taken"
}
```

## Email Address

Type: `stringArray`  
URL: `https://api.redoxengine.com/extensions/email-address`  
Status: Draft

Generic Email address.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| SSO | Sign-on | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/email-address",
  "stringArray": [
    "user@gmail.com"
  ]
}
```

## Employment Flag

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/employment-flag`  
Status: Draft

Indicates whether or not the patient is employed. Use Occupation Title extension to indicate the specific role. If patient has multiple occupations, use multiple Contacts.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Contacts[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/employment-flag",
  "boolean": true
}
```

## Employment Status

Type: `string`  
URL: `https://api.redoxengine.com/extensions/employment-status`  
Status: Draft, Value set

Indicates the employment status of the patient

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/employment-status",
  "string": "Full time"
}
```

## Encompassing Encounter Location

Type: `encompassingEncounterLocation`  
URL: `https://api.redoxengine.com/extensions/encompassing-encounter-location`  
Status: Draft

The contents of a CDA encompassingEncounter's location/healthCareFacility element.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | VisitPush, VisitQueryResponse | `Header.Document.Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/encompassing-encounter-location",
  "encompassingEncounterLocation": {
    "id": [
      "1.2.840.114350.1.13.123.3.7.2.686980;100090000"
    ],
    "code": [
      {
        "code": "1234",
        "codeSystem": "1.2.3.4",
        "displayName": "Sample",
        "originalText": "Outpatient Clinic"
      }
    ],
    "addr": {
      "use": "WP",
      "line": [
        "123 Anywhere Street"
      ],
      "city": "Madison",
      "state": "WI",
      "postalCode": "53711"
    },
    "telecom": [
      {
        "use": "WP",
        "value": "tel:+1-555-555-1234"
      }
    ],
    "name": "Hometown Clinic",
    "serviceOrganization": {
      "id": [
        "2.16.840.1.113883.4.2;41-1234567",
        "2.16.840.1.113883.4.6;354354667"
      ],
      "industryCode": [
        {
          "code": "1234",
          "codeSystem": "1.2.3.4",
          "originalText": "Outpatient Pharmacy"
        }
      ],
      "name": "Hometown Clinics LLC",
      "addr": {
        "use": "WP",
        "line": [
          "123 Anywhere Street"
        ],
        "city": "Madison",
        "state": "WI",
        "postalCode": "53711"
      },
      "telecom": [
        {
          "use": "WP",
          "value": "tel:+1-555-555-1234"
        }
      ],
      "parentOrganization": {
        "name": "Hometown Clinics of America",
        "addr": {},
        "telecom": [],
        "id": [],
        "industryCode": []
      }
    }
  }
}
```

## End Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/end-date`  
Status: Draft

The end Date/Time of the given concept.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[]` |
| PatientAdmin | Arrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdate | `Visit.AdditionalStaff[]` |
| Scheduling | New | `Visit` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Procedures.Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Procedures.Procedures[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Procedures.Services[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `MedicalEquipment[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Orders[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Encounters[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Procedures[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Supplies[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/end-date",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Entered By

Type: `string`  
URL: `https://api.redoxengine.com/extensions/entered-by`  
Status: Draft

The person that entered the information into the system.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Vaccination | * | `Vaccinations[].Order` |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | * | `Orders[]` |
| PatientAdmin | * | `Visit.Insurances[]` |
| PatientAdmin | * | `Patient.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/entered-by",
  "string": "Winkle, Suzzie"
}
```

## Entry ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/entry-id`  
Status: Draft

Unique ID for the clinical observation for use in a CDA entry

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | VisitPush, VisitQueryResponse | `AdmissionDiagnosis[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `AdvanceDirectives[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Allergies[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `Assessment.Diagnoses[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `DischargeDiagnosis[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `DischargeMedications[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Encounters[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Encounters[].Diagnosis[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `FamilyHistory[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `FunctionalStatus.Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `FunctionalStatus.Supplies[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Goals[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Goals[].Milestones[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `Header.Document.Visit` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `HealthConcerns[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Immunizations[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `Instructions[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Insurances[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `MedicalEquipment[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `MedicationsAdministered[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Medications[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `NoteSections[].Notes[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.MedicationAdministration[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Orders[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Procedures[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Services[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Supplies[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Problems[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Procedures.Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Procedures.Procedures[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Procedures.Services[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `ReasonForVisit[],` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `ResolvedProblems[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Results[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Results[].Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `SocialHistory.Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `SocialHistory.Pregnancy[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `SocialHistory.TobaccoUse[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `VitalSigns[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `VitalSigns[].Observations[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/entry-id",
  "string": "3987257"
}
```

## Event Code

Type: `string`  
URL: `https://api.redoxengine.com/extensions/event-code`  
Status: Draft

The code or description representing EventType

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Meta` |
| Order | * | `Meta` |
| Flowsheet | * | `Meta` |
| Results | * | `Meta` |
| Media | * | `Meta` |
| Medications | * | `Meta` |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/event-code",
  "string": "Transfer an Outpatient-to Inpatient"
}
```

## Expected Arrival Date & Time

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/expected-arrival-date-time`  
Status: Draft

The expected arrival date and time of a visit in ISO 8601 format.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit` |
| PatientAdmin | Registration | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/expected-arrival-date-time",
  "dateTime": "2018-01-13T10:33:12"
}
```

## Expected Reimbursement

Type: `decimal`  
URL: `https://api.redoxengine.com/extensions/expected-reimbursement`  
Status: Draft

The amount that is expected to be reimbursed. This may differ from the charged amount.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Claim | Submission | `Claims[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/expected-reimbursement",
  "decimal": 12.75
}
```

## Expiration Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/expiration-date`  
Status: Draft

The expiration date in ISO 8601 format.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Media | * | `Media` |

```json
{
  "url": "https://api.redoxengine.com/extensions/expiration-date",
  "dateTime": "2019-06-05T10:33:12.000Z"
}
```

## Extended Addresses

Type: `addresses`  
URL: `https://api.redoxengine.com/extensions/extended-addresses`  
Status: Draft

Support for multiple patient addresses.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Header.Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/extended-addresses",
  "addresses": [
    {
      "use": "H",
      "period": {
        "start": "2015-01-01",
        "end": "2018-12-31"
      },
      "line": [
        "123 Main Street"
      ],
      "city": "Madison",
      "state": "WI",
      "postalCode": "53711"
    },
    {
      "use": "HP",
      "period": {
        "start": "2019-01-01",
        "end": "2020-12-31"
      },
      "line": [
        "123 Anywhere Street"
      ],
      "city": "Madison",
      "state": "WI",
      "postalCode": "53703"
    }
  ]
}
```

## Extended Languages

Type: `languages`  
URL: `https://api.redoxengine.com/extensions/extended-languages`  
Status: Active, Foundation

Support for multiple patient languages.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Header.Patient.Demographics` |
| Financial | * | `Patient.Demographics` |
| Flowsheet | * | `Patient.Demographics` |
| Medications | * | `Patient.Demographics` |
| Notes | New, Replace, Delete | `Patient.Demographics` |
| Order | New, Update, Cancel, GroupedOrders | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse | `Patient.Demographics` |
| Results | New, NewUnsolicited | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| SurgicalScheduling | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/extended-languages",
  "languages": [
    {
      "preference": true,
      "code": "en"
    },
    {
      "preference": false,
      "code": "ita"
    }
  ]
}
```

## Extended Names

Type: `names`  
URL: `https://api.redoxengine.com/extensions/extended-names`  
Status: Draft

Support for multiple patient names.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Header.Patient.Demographics` |
| Order | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/extended-names",
  "names": [
    {
      "use": "L",
      "given": [
        "Timothy"
      ],
      "family": "Bixby"
    },
    {
      "use": "P",
      "given": [
        "Tim"
      ],
      "family": "Bixby"
    }
  ]
}
```

## Fax Number

Type: `string`  
URL: `https://api.redoxengine.com/extensions/fax-number`  
Status: Draft

The fax number.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Header.Patient.Demographics.PhoneNumber` |
| PatientAdmin | * | `Visit.AttendingProvider.PhoneNumber` |
| PatientAdmin | * | `Visit.ConsultingProvider.PhoneNumber` |
| PatientAdmin | * | `Visit.ReferringProvider.PhoneNumber` |
| Scheduling | * | `Visit.AttendingProvider.PhoneNumber` |
| Scheduling | * | `Visit.ConsultingProvider.PhoneNumber` |
| Scheduling | * | `Visit.ReferringProvider.PhoneNumber` |
| Provider | * | `Providers[].Roles[].Locations[].PhoneNumber` |
| Order | New, Update, Cancel | `Order.Provider.PhoneNumber` |
| Order | GroupedOrders | `Orders[].Provider.PhoneNumber` |
| Order | New, Update, Cancel | `Order.ResultCopyProviders[].PhoneNumber` |
| Order | GroupedOrders | `Orders[].ResultCopyProviders[].PhoneNumber` |

```json
{
  "url": "https://api.redoxengine.com/extensions/fax-number",
  "string": "+16088675309"
}
```

## File Contents

Type: `string`  
URL: `https://api.redoxengine.com/extensions/file-contents`  
Status: Draft

Redox BLOB URI

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Patient` |
| Financial | * | `Transactions[]` |
| Order | New, Update, Cancel | `Order` |
| Order | New, Update, Cancel | `Order.ClinicalInfo[]` |
| Order | GroupedOrders | `Orders[]` |
| Order | GroupedOrders | `Orders[].ClinicalInfo[]` |
| Referral | * | `Referral` |
| Flowsheet | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/file-contents",
  "string": "<...base 64 file contents...>"
}
```

## Filename

Type: `string`  
URL: `https://api.redoxengine.com/extensions/filename`  
Status: Draft

Filename of the documents

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | VisitPush, PatientQueryResponse | `Header.Document` |
| Clinical Summary | DocumentQueryResponse | `Documents[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/filename",
  "string": "TestFile.pdf"
}
```

## Frequency

Type: `string`  
URL: `https://api.redoxengine.com/extensions/frequency`  
Status: Draft

The frequency of occurrence for this concept.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/frequency",
  "string": "3 times a day"
}
```

## Patient Gender Identity

Type: `string`  
URL: `https://api.redoxengine.com/extensions/gender-identity`  
Status: Active, Value set, Foundation

The patient's gender identity.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | * | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientEducation | * | `Patient.Demographics` |
| Results | * | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/gender-identity",
  "string": "transgender male"
}
```

## HCO Source ID

Type: `identifier`  
URL: `https://api.redoxengine.com/extensions/header-source-id`  
Status: Draft

HCO Source ID

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, VisitPush | `Header` |

```json
{
  "url": "https://api.redoxengine.com/extensions/header-source-id",
  "identifier": {
    "value": "5657ece9-f886-4866-94ba-bb4f12f6232b"
  }
}
```

## Hospital Service

Type: `string`  
URL: `https://api.redoxengine.com/extensions/hospital-service`  
Status: Draft

The hospital service covering the patient.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit` |
| Order | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/hospital-service",
  "string": "Pulmonary"
}
```

## Implant Laterality

Type: `string`  
URL: `https://api.redoxengine.com/extensions/implant-laterality`  
Status: Draft

Indication of which side of the body the implant was placed.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Inventory | * | `Items[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/implant-laterality",
  "string": "Left"
}
```

## Implant Tissue

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/implant-tissue`  
Status: Draft

Indication of whether the implant is tissue along with any associated tissue preparation details

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Inventory | * | `Items[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/implant-tissue",
  "codeableConcept": {
    "coding": "Yes",
    "text": "Tissue was prepped"
  }
}
```

## Implant Verification

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/implant-verification`  
Status: Draft

An indicator if the impant was verified with surgeon.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Inventory | * | `Items[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/implant-verification",
  "boolean": true
}
```

## Indication

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/indication`  
Status: Draft

Refers to the use of the medication/drug for treating a particular disease.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse | `Medications[]` |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/indication",
  "coding": {
    "system": "2.16.840.1.113883.6.90",
    "code": "J18.1",
    "display": "Lobar pneumonia"
  }
}
```

## Injury Site

Type: `string`  
URL: `https://api.redoxengine.com/extensions/injury-site`  
Status: Draft

Free text field to capture the location of injury

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit` |
| PatientAdmin | * | `Visit` |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/injury-site",
  "string": "Knee"
}
```

## Insured Group Employer

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/insured-employer`  
Status: Draft

An indicator on the insured group employer ID and Name.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Insurances[]` |
| PatientAdmin | * | `Visit.Insurances[]` |
| Financial | * | `Visit.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/insured-employer",
  "codeableConcept": {
    "coding": "12435",
    "text": "Redox"
  }
}
```

## Insurance ID

Type: `identifier`  
URL: `https://api.redoxengine.com/extensions/insurance-id`  
Status: Draft

The unique identifier EHRs assign to the unique combination of insurance plan and patient.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | Arrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdate | `Visit.Insurances[]` |
| PatientAdmin | NewPatient, PatientUpdate | `Patient.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/insurance-id",
  "identifier": {
    "use": null,
    "type": "EHR INSURANCE ID",
    "system": null,
    "value": "8675309",
    "period": null,
    "assigner": null
  }
}
```

## Insurance Payer

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/insurance-payer`  
Status: Draft

Payer information for insurance coverage

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Vaccination | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/insurance-payer",
  "coding": {
    "code": "BC",
    "display": "Blue Cross"
  }
}
```

## Insurance Plan

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/insurance-plan`  
Status: Draft

Plan information for insurance coverage

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Vaccination | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/insurance-plan",
  "coding": {
    "code": "100G",
    "display": "Gold Plan"
  }
}
```

## Insurance Priority

Type: `string`  
URL: `https://api.redoxengine.com/extensions/insurance-priority`  
Status: Draft

If the insurance works in conjunction with other insurance plans, this field contains priority sequence. Values are: 1, 2, 3, etc

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | Arrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdate | `Visit.Insurances[]` |
| PatientAdmin | NewPatient, PatientUpdate | `Patient.Insurances[]` |
| Order | * | `Visit.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/insurance-priority",
  "string": "1"
}
```

## Insurance Type

Type: `string`  
URL: `https://api.redoxengine.com/extensions/insurance-type`  
Status: Draft, Value set

Plan type for insurance coverage

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Vaccination | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/insurance-type",
  "string": "Commercial"
}
```

## Insurance Verification Date

Type: `date`  
URL: `https://api.redoxengine.com/extensions/insurance-verification`  
Status: Draft

Verification date for insurance coverage

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Vaccination | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/insurance-verification",
  "date": "2021-09-03"
}
```

## Insurance Verified

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/insurance-verified`  
Status: Draft

An indicator to send if the insurance has been verified

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | Arrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdate | `Visit.Insurances[]` |
| PatientAdmin | NewPatient, PatientUpdate | `Patient.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/insurance-verified",
  "boolean": true
}
```

## Item Expiration Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/item-expiration-date`  
Status: Draft

The item's expiration datetime

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Inventory | * | `Items[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/item-expiration-date",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Is Active

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/is-active`  
Status: Draft

An indicator if the specific element is active

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | * | `Medications[]` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Contacts[]` |
| PatientAdmin | * | `Visit.Insurances[]` |
| PatientAdmin | * | `Patient.Insurances[]` |
| Scheduling | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/is-active",
  "boolean": true
}
```

## Kno2 From Address

Type: `string`  
URL: `https://api.redoxengine.com/extensions/kno2-from-address`  
Status: Draft

The Kno2 "fromAddress" (Document Source) a message was sent from — an address or document source owned by the sending account. Used to search for messages by the originating Kno2 address.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Notes | * | `Meta` |
| Flowsheet | * | `Meta` |
| Media | * | `Meta` |
| FHIR.Patient | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/kno2-from-address",
  "string": "c4dc1474-64a4-47c2-a3c7-d63b9c3cd42e_12_pcc_notes@fusion.messaging.kno2fy.com"
}
```

## Kno2 To Address

Type: `string`  
URL: `https://api.redoxengine.com/extensions/kno2-to-address`  
Status: Draft

The Kno2 "toAddress" (Destination) a message was sent to — a Kno2 Address, Direct Address, or Fax Number. May be a delimited value when the message is sent to multiple recipients. Used to search for messages by the destination address.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Notes | * | `Meta` |
| Flowsheet | * | `Meta` |
| Media | * | `Meta` |
| FHIR.Patient | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/kno2-to-address",
  "string": "c4dc1474-64a4-47c2-a3c7-d63b9c3cd42e_12_pcc_notes@fusion.messaging.kno2fy.com"
}
```

## Location ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/location-id`  
Status: Draft

The ID of the location.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit.Location` |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/location-id",
  "string": "R2D2-C3P0"
}
```

## Medication Filled Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/medication-filled-date`  
Status: Draft

The filled date of a medication.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | * | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/medication-filled-date",
  "dateTime": "2018-01-13T10:33:12.000Z"
}
```

## Message Control ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/message-control-id`  
Status: Draft

The message control ID for this message.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Meta` |
| Scheduling | * | `Meta` |
| Flowsheet | * | `Meta` |
| Results | * | `Meta` |
| Media | * | `Meta` |
| Medications | * | `Meta` |
| Order | * | `Meta` |
| PatientSearch | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/message-control-id",
  "string": "A123456789"
}
```

## Mother's Maiden Name

Type: `string`  
URL: `https://api.redoxengine.com/extensions/mother-maiden-name`  
Status: Draft

The patient's mother's maiden name.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/mother-maiden-name",
  "string": "2018-01-13T10:33:12"
}
```

## Multiple Birth Indicator

Type: `string`  
URL: `https://api.redoxengine.com/extensions/multiple-birth-indicator`  
Status: Draft

Indicates whether the patient was part of a multiple birth.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/multiple-birth-indicator",
  "string": "Y"
}
```

## NDC Quantity

Type: `integer`  
URL: `https://api.redoxengine.com/extensions/ndc-quantity`  
Status: Draft

National Drug Code (NDC) product package size.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Transactions[]` |
| Inventory | * | `Items[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/ndc-quantity",
  "integer": 10
}
```

## NDC Units Measure

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/ndc-units-measure`  
Status: Draft

Units of measurements to use when billing with the National Drug Code (NDC) information

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Transactions[]` |
| Inventory | * | `Items[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/ndc-units-measure",
  "coding": {
    "code": "GR",
    "display": "Gram"
  }
}
```

## Needs Interpreter

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/needs-interpeter`  
Status: Draft

A flag indicating whether or not the patient needs an interpreter.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| Scheduling | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/needs-interpreter",
  "boolean": true
}
```

## Network

Type: `string`  
URL: `https://api.redoxengine.com/extensions/network`  
Status: Draft

Network the organization returning the document participates in, such as CommonWell or TEFCA.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | DocumentQueryResponse | `Documents[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/network",
  "string": "CommonWell"
}
```

## Occupation Title

Type: `string`  
URL: `https://api.redoxengine.com/extensions/occupation-title`  
Status: Draft

The title of the patient's occupation.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Contacts[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/occupation-title",
  "string": "Integration Engineer"
}
```

## Onset Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/onset-date`  
Status: Draft

Estimated or actual date or date-time the condition began.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |
| PatientAdmin | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/onset-date",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Order Control Code Reason

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/order-control-code-reason`  
Status: Draft

The explanation of the reason for the order event.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | * | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/order-control-code-reason",
  "codeableConcept": {
    "coding": "Patient Request",
    "text": "Patient indicated that they will go to a different site"
  }
}
```

## Order End Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/order-end-date`  
Status: Draft

The date/time that the order ended.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | Transaction | `Transactions[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/order-end-date",
  "dateTime": "2023-06-02T09:53:00.000Z"
}
```

## Order Start Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/order-start-date`  
Status: Draft

The date/time that the order started.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | Transaction | `Transactions[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/order-start-date",
  "dateTime": "2023-06-01T12:21:00.000Z"
}
```

## Ordered Date & Time

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/ordered-date-time`  
Status: Draft

The date and time of an order or action was issued in ISO 8601 format.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Results | * | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/ordered-date-time",
  "dateTime": "2020-04-13T10:33:12.000Z"
}
```

## Ordering Facility Address

Type: `address`  
URL: `https://api.redoxengine.com/extensions/ordering-facility-address`  
Status: Draft

Ordering facility's address

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Results | * | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/ordering-facility-address",
  "address": {
    "use": "work",
    "type": "physical",
    "text": "7620 Ash Street, Madison, WI 53711",
    "line": "7620 Ash Street",
    "city": "Madison",
    "state": "WI",
    "postalCode": "53711"
  }
}
```

## Ordering Facility Name

Type: `string`  
URL: `https://api.redoxengine.com/extensions/ordering-facility-name`  
Status: Draft

The name of the facility this order was placed in.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Results | * | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/ordering-facility-name",
  "string": "Urgent Care Facility"
}
```

## Ordering Facility Phone

Type: `string`  
URL: `https://api.redoxengine.com/extensions/ordering-facility-phone`  
Status: Draft

The ordering facility's phone number.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Results | * | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/ordering-facility-phone",
  "string": "+16085552536"
}
```

## Organization ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/organization-id`  
Status: Draft

An identifier for the sending or receiving organization, most often an OID.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientSearch | * | `Meta` |
| PatientAdmin | * | `Meta` |
| Clinical Summary | * | `Meta` |
| Results | * | `Meta` |
| Flowsheet | * | `Meta` |
| Media | * | `Meta` |
| Medications | * | `Meta` |
| Order | * | `Meta` |
| Vaccination | * | `Vaccinations[].Order` |

```json
{
  "url": "https://api.redoxengine.com/extensions/organization-id",
  "string": "2.16.3387.2837.12345"
}
```

## Organization Name

Type: `string`  
URL: `https://api.redoxengine.com/extensions/organization-name`  
Status: Draft

The name of the organization that the requesting user belongs to.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientSearch | * | `Meta` |
| PatientAdmin | * | `Meta` |
| Clinical Summary | * | `Meta` |
| Flowsheet | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/organization-name",
  "string": "RES General Hospital"
}
```

## Participants

Type: `participants`  
URL: `https://api.redoxengine.com/extensions/participants`  
Status: Draft

An array of objects corresponding to the fields of a CDA `<author>`, `<informant>`, `<performer>`, or `<participant>` element. Some authors may only contain an `id` property because their details are found elsewhere in the document.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Header` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Header.Document` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Header.Document.Visit` |
| Clinical Summary | VisitPush, VisitQueryResponse | `AdmissionDiagnosis[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `AdvanceDirectives[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Allergies[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `Assessment.Diagnoses[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `DischargeDiagnosis[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `DischargeMedications[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Encounters[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Encounters[].Diagnosis[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `FamilyHistory[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `FunctionalStatus.Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `FunctionalStatus.Supplies[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Goals[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Goals[].Milestones[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `Header.Document.Visit` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `HealthConcerns[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Immunizations[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `Instructions[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Insurances[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `MedicalEquipment[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `MedicationsAdministered[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Medications[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `NoteSections[].Notes[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.MedicationAdministration[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Orders[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Procedures[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Services[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `PlanOfCare.Supplies[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Problems[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Procedures.Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Procedures.Procedures[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Procedures.Services[]` |
| Clinical Summary | VisitPush, VisitQueryResponse | `ReasonForVisit[],` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `ResolvedProblems[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Results[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Results[].Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `SocialHistory.Observations[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `SocialHistory.Pregnancy[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `SocialHistory.TobaccoUse[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `VitalSigns[]` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `VitalSigns[].Observations[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/participants",
  "participants": [
    {
      "typeCode": "AUT",
      "classCode": "ASSIGNED",
      "id": [
        "2.16.840.1.113883.4.6;12345678"
      ],
      "time": "2022-03-24T19:44:01.765Z",
      "addr": {
        "line": [
          "123 Anywhere Street"
        ],
        "city": "Madison",
        "state": "WI",
        "postalCode": "53711"
      },
      "telecom": [
        {
          "use": "WP",
          "value": "tel:+1-555-555-1234"
        }
      ],
      "code": [
        {
          "code": "1234",
          "system": "1.2.3.4",
          "displayName": "Sample",
          "originalText": "The Text"
        }
      ],
      "person": {
        "name": {
          "given": [
            "Pat"
          ],
          "family": "Granite"
        }
      },
      "organization": {
        "id": [
          "d90f68da-a771-4234-bbaa-229c55eb04ae"
        ],
        "name": "Good Health Clinics",
        "addr": {
          "line": [
            "725 Healthcare Way"
          ],
          "city": "Madison",
          "state": "WI",
          "postalCode": "53711"
        },
        "telecom": [
          {
            "use": "WP",
            "value": "tel:+1-555-555-7777"
          }
        ]
      }
    }
  ]
}
```

## Patient Contact's DOB

Type: `string`  
URL: `https://api.redoxengine.com/extensions/patient-contact-dob`  
Status: Draft

The patient contact's date of birth. In [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Contacts[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-contact-dob",
  "string": "2019-01-01"
}
```

## Patient Contact's ID

Type: `identifier`  
URL: `https://api.redoxengine.com/extensions/patient-contact-id`  
Status: Draft

The patient contact's ID

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Contacts[]` |
| Scheduling | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-contact-id",
  "identifier": {
    "use": null,
    "type": "PERSONID",
    "system": null,
    "value": "8675309",
    "period": null,
    "assigner": null
  }
}
```

## Patient Ethnicity

Type: `string`  
URL: `https://api.redoxengine.com/extensions/patient-ethnicity`  
Status: Active, Foundation

The Patient's Ethnicity.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Patient.Demographics` |
| Flowsheet | * | `Patient.Demographics` |
| Medications | * | `Patient.Demographics` |
| Notes | New, Replace, Delete | `Patient.Demographics` |
| Order | New, Update, Cancel, GroupedOrders | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse | `Patient.Demographics` |
| Results | New, NewUnsolicited | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| SurgicalScheduling | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-ethnicity",
  "string": "Ashkenazi"
}
```

## Patient Height

Type: `quantity`  
URL: `https://api.redoxengine.com/extensions/patient-height`  
Status: Active, Foundation

The patient's height as recorded during the current visit. Normally this data would be an observation.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Patient.Demographics` |
| Flowsheet | * | `Patient.Demographics` |
| Medications | * | `Patient.Demographics` |
| Notes | New, Replace, Delete | `Patient.Demographics` |
| Order | New, Update, Cancel, GroupedOrders | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse | `Patient.Demographics` |
| Results | New, NewUnsolicited | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| SurgicalScheduling | * | `Patient.Demographics` |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-height",
  "quantity": {
    "value": 60,
    "unit": "[in_i]",
    "system": "http://unitsofmeasure.org"
  }
}
```

## Patient Military Service

Type: `string`  
URL: `https://api.redoxengine.com/extensions/patient-military-service`  
Status: Active, Foundation

The patient's current military status. One of: not-indicated, no-military-service, veteran, active-duty, active-reserve, inactive-reserve

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Patient.Demographics` |
| Flowsheet | * | `Patient.Demographics` |
| Medications | * | `Patient.Demographics` |
| Notes | New, Replace, Delete | `Patient.Demographics` |
| Order | New, Update, Cancel, GroupedOrders | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse | `Patient.Demographics` |
| Results | New, NewUnsolicited | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| SurgicalScheduling | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-military-service",
  "string": "active-duty"
}
```

## Patient's Mother's ID

Type: `identifier`  
URL: `https://api.redoxengine.com/extensions/patient-mother-id`  
Status: Draft

The patient's mother's ID

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-mother-id",
  "identifier": {
    "use": null,
    "type": "PERSONID",
    "system": null,
    "value": "8675309",
    "period": null,
    "assigner": null
  }
}
```

## Patient Near Pupil Distance

Type: `quantity`  
URL: `https://api.redoxengine.com/extensions/patient-near-pupil-distance`  
Status: Draft

The patient's near pupil distance as recorded during the current visit.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-near-pupil-distance",
  "quantity": {
    "value": 57,
    "unit": "mm",
    "system": "http://unitsofmeasure.org"
  }
}
```

## Patient Portal Status

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/patient-portal-status`  
Status: Draft

A flag indicating whether or not the patient has signed up for the patient portal.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Scheduling | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-portal-status",
  "boolean": true
}
```

## Patient Portal Indicator

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/patient-portal-indicator`  
Status: Draft

An indicator on the patient's enrollment in a patient portal.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Scheduling | * | `Patient` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse | `Header.Patient` |
| Results | New, NewUnsolicited | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-portal-indicator",
  "codeableConcept": {
    "coding": "",
    "text": "Active"
  }
}
```

## Patient Privacy Indicator

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/patient-privacy-indicator`  
Status: Draft

A value that represents the patient's privacy for a given visit

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit` |
| Scheduling | * | `Visit` |
| Notes | New, Replace, Delete | `Note` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-privacy-indicator",
  "codeableConcept": {
    "coding": "STF",
    "text": "Staff Member"
  }
}
```

## Patient Responsibility

Type: `decimal`  
URL: `https://api.redoxengine.com/extensions/patient-responsibility`  
Status: Draft

The patient's financial responsibility for a particular visit or service.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit.Insurances[]` |
| PatientAdmin | * | `Patient.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-responsibility",
  "decimal": 1995.06
}
```

## Patient Service Level

Type: `string`  
URL: `https://api.redoxengine.com/extensions/patient-service-level`  
Status: Draft

The level of service that the patient can access within an organization.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| PatientSearch | Response | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-service-level",
  "string": "Patient has full access to all services"
}
```

## Patient Pupil Distance

Type: `quantity`  
URL: `https://api.redoxengine.com/extensions/patient-pupil-distance`  
Status: Draft

The patient's pupil distance as recorded during the current visit.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-pupil-distance",
  "quantity": {
    "value": 60,
    "unit": "mm",
    "system": "http://unitsofmeasure.org"
  }
}
```

## Patient Weight

Type: `quantity`  
URL: `https://api.redoxengine.com/extensions/patient-weight`  
Status: Active, Foundation

The patient's weight as recorded during the current visit.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Patient.Demographics` |
| Flowsheet | * | `Patient.Demographics` |
| Medications | * | `Patient.Demographics` |
| Notes | New, Replace, Delete | `Patient.Demographics` |
| Order | New, Update, Cancel, GroupedOrders | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse | `Patient.Demographics` |
| Results | New, NewUnsolicited | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| SurgicalScheduling | * | `Patient.Demographics` |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/patient-weight",
  "quantity": {
    "value": 120,
    "unit": "[lb_av]",
    "system": "http://unitsofmeasure.org"
  }
}
```

## Payment Info

Type: `paymentInfo`  
URL: `https://api.redoxengine.com/extensions/payment-info`  
Status: Draft

Information related to payment for a claim.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Claim | SubmissionBatch | `Transactions[].Submissions[].Subscribers[].Patients[].Claims[]` |
| Claim | SubmissionBatch | `Transactions[].Submissions[].Subscribers[].Patients[].Claims[].Services[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/payment-info",
  "paymentInfo": {
    "amountPaid": 150,
    "datePaid": "2023-10-15"
  }
}
```

## Performer ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/performer-id`  
Status: Draft

The identifier for the performing physician of the procedure.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Inventory | * | `Items[]` |
| Order | New, Update, Cancel | `Order.Procedure` |
| Order | GroupedOrders | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/performer-id",
  "string": "121342"
}
```

## Preferred Name

Type: `humanName`  
URL: `https://api.redoxengine.com/extensions/preferred-name`  
Status: Active, Foundation

The preferred name of the person.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Patient.Demographics` |
| Flowsheet | * | `Patient.Demographics` |
| Medications | * | `Patient.Demographics` |
| Notes | New, Replace, Delete | `Patient.Demographics` |
| Order | New, Update, Cancel, GroupedOrders | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| PatientSearch | Query, Response | `Patient.Demographics` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse | `Patient.Demographics` |
| Results | New, NewUnsolicited | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| SurgicalScheduling | * | `Patient.Demographics` |
| Clinical Summary | PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse | `Header.Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/preferred-name",
  "humanName": {
    "use": "usual",
    "text": "Billy",
    "given": [
      "Billy"
    ]
  }
}
```

## Preferred Communication

Type: `string`  
URL: `https://api.redoxengine.com/extensions/preferred-communication`  
Status: Draft

The preferred communication of the person.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | * | `Patient.Demographics` |
| PatientAdmin | * | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| Results | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/preferred-communication",
  "string": "email"
}
```

## Pregnancy Status

Type: `string`  
URL: `https://api.redoxengine.com/extensions/pregnancy-status`  
Status: Draft, Value set

Indicates the patient's current pregnancy status.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Results | New, NewUnsolicited | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/pregnancy-status",
  "string": "Not pregnant"
}
```

## Present On Admission

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/present-on-admission`  
Status: Draft

Flag indicating the item was present upon the patient's admission.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Diagnoses[]` |
| Financial | Transaction | `Transactions[].Diagnoses[]` |
| Financial | AccountUpdate | `Visit.Diagnoses[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/present-on-admission",
  "boolean": false
}
```

## Pricing Methodology

Type: `string`  
URL: `https://api.redoxengine.com/extensions/pricing-methodology`  
Status: Draft

Codes or descriptions about how the claim was repriced

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Claim | Submission | `Claims[].Lines[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/pricing-methodology",
  "string": "13"
}
```

## Primary Pharmacy Address

Type: `address`  
URL: `https://api.redoxengine.com/extensions/primary-pharmacy-address`  
Status: Draft

The address of the primary preferred pharmacy.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| Scheduling | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/primary-pharmacy-address",
  "address": {
    "use": "work",
    "type": "physical",
    "text": "7620 Ash Street, Madison, WI 53711",
    "line": [
      "7620 Ash Street"
    ],
    "city": "Madison",
    "state": "WI",
    "postalCode": "53711"
  }
}
```

## Primary Pharmacy ID

Type: `identifier`  
URL: `https://api.redoxengine.com/extensions/primary-pharmacy-id`  
Status: Draft

The ID of the primary preferred pharmacy.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| Scheduling | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/primary-pharmacy-id",
  "identifier": {
    "use": null,
    "type": "NCPDP",
    "system": null,
    "value": "5755167",
    "period": null,
    "assigner": null
  }
}
```

## Primary Pharmacy Name

Type: `string`  
URL: `https://api.redoxengine.com/extensions/primary-pharmacy-name`  
Status: Draft

The name of the primary preferred pharmacy.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| Scheduling | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/primary-pharmacy-name",
  "string": "My City's Local Pharmacy"
}
```

## Primary Pharmacy Phone

Type: `string`  
URL: `https://api.redoxengine.com/extensions/primary-pharmacy-phone`  
Status: Draft

The phone number of the primary preferred pharmacy.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| Scheduling | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/primary-pharmacy-phone",
  "string": "+16085559876"
}
```

## Privacy Notice

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/privacy-notice`  
Status: Draft

An indicator if the person has acknowledged the receipt of the privacy notice.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/privacy-notice",
  "boolean": true
}
```

## Procedure Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/procedure-date`  
Status: Draft

The date of the procedure attached to the item.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Inventory | * | `Items[]` |
| Referral | New, Modify, Cancel | `Referral.Procedures[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/procedure-date",
  "dateTime": "2019-07-12"
}
```

## Procedure History

Type: `procedureHistory`  
URL: `https://api.redoxengine.com/extensions/procedure-history`  
Status: Draft

An array of historical procedures performed on the patient, mirroring the CDA Shared Procedures fields including Code, DateTime, Status, TargetSite, and Comments.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/procedure-history",
  "procedureHistory": [
    {
      "Code": "168731009",
      "CodeSystem": "2.16.840.1.113883.6.96",
      "CodeSystemName": "SNOMED CT",
      "Name": "Chest X-Ray",
      "DateTime": "2012-08-07",
      "Status": "completed",
      "TargetSite": {
        "Code": "181608004",
        "CodeSystem": "2.16.840.1.113883.6.96",
        "CodeSystemName": "SNOMED CT",
        "Name": "Entire chest wall (body structure)"
      },
      "Comments": [
        {
          "Text": "Routine chest x-ray performed without complications."
        }
      ]
    }
  ]
}
```

## Pronoun

Type: `string`  
URL: `https://api.redoxengine.com/extensions/pronoun`  
Status: Active, Foundation

The pronoun name of the person.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| Order | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/pronoun",
  "string": "They/Them"
}
```

## Purpose of Use

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/purpose-of-use`  
Status: Draft

Coded reason for making a request for patient information.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientSearch | * | `Meta` |
| PatientAdmin | NewPatient, PatientUpdate, PatientMerge | `Meta` |
| Clinical Summary | * | `Meta` |
| Organization | * | `Organizations[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/purpose-of-use",
  "coding": {
    "system": "2.16.840.1.113883.3.18.7.1",
    "code": "TREATMENT",
    "display": "Treatment"
  }
}
```

## Raw Query Data

Type: `stringArray`  
URL: `https://api.redoxengine.com/extensions/raw-query-data`  
Status: Draft

Raw data returned from a query to provide additional information if required.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| SSO | * | `Meta` |
| PatientSearch | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/raw-query-data",
  "stringArray": [
    "{\"resourceType\": \"Patient\", ...}"
  ]
}
```

## Readmission

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/readmission`  
Status: Draft

Flag indicating if this visit was a readmission.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/readmission",
  "boolean": false
}
```

## Reference  Number

Type: `string`  
URL: `https://api.redoxengine.com/extensions/reference-number`  
Status: Draft

The transactional reference number, such as check number.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | Transaction | `Transactions[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/reference-number",
  "string": "abc-8675309"
}
```

## Referral

Type: `referral`  
URL: `https://api.redoxengine.com/extensions/referral`  
Status: Draft

Additional information about the referral

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit.Transactions[]` |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/referral",
  "referral": {
    "effectiveDate": "2021-01-13T17:27:00.000Z",
    "expirationDate": "2022-01-13T17:27:00.000Z",
    "number": "1239762",
    "days": "30"
  }
}
```

## Referral Id

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/referral-id`  
Status: Draft

The Health System ID of the referral

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit` |
| SSO | Sign-on | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/referral-id",
  "coding": {
    "code": "4356789876",
    "display": ""
  }
}
```

## Referring Provider ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/referring-provider-id`  
Status: Draft

The ID of the referring provider

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |
| Media | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/referring-provider-id",
  "string": "4356789876"
}
```

## Referring Provider Name

Type: `humanName`  
URL: `https://api.redoxengine.com/extensions/referring-provider-name`  
Status: Draft

The preferred name of the referring provider.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | * | `Visit` |
| Media | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/referring-provider-name",
  "humanName": {
    "use": "usual",
    "text": "Billy",
    "given": [
      "Billy"
    ]
  }
}
```

## Refill Amount

Type: `integer`  
URL: `https://api.redoxengine.com/extensions/refills-amount`  
Status: Draft

The maximum refills authorized for this specific medication

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/refills-amount",
  "integer": 3
}
```

## Rejection Reason

Type: `string`  
URL: `https://api.redoxengine.com/extensions/reject-reason`  
Status: Draft

Code or description of the rejection.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Claim | Submission | `Claims[].Lines[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/reject-reason",
  "string": "131"
}
```

## Balance Amount

Type: `decimal`  
URL: `https://api.redoxengine.com/extensions/reprice-amount`  
Status: Draft

The repriced allowed amount.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Claim | Submission | `Claims[].Lines[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/reprice-amount",
  "decimal": 13.75
}
```

## Resource Description

Type: `string`  
URL: `https://api.redoxengine.com/extensions/resource-description`  
Status: Draft

The description of the visit resource group, most often defined as department name.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/resource-description",
  "string": "Gastroenterology"
}
```

## Resource Identifier

Type: `string`  
URL: `https://api.redoxengine.com/extensions/resource-id`  
Status: Draft

The identifier of the visit resource group, most often defined as department id.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/resource-id",
  "string": "18761"
}
```

## Related Group ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/related-group-id`  
Status: Draft

ID to group separate observation components

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Flowsheet | * | `Observations[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/related-group-id",
  "string": "46"
}
```

## Release of Billing Information

Type: `boolean`  
URL: `https://api.redoxengine.com/extensions/release-of-billing-information`  
Status: Draft

An indicator if the person has authorized the release of billing information.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |

```json
{
  "url": "https://api.redoxengine.com/extensions/release-of-billing-information",
  "boolean": true
}
```

## Role

Type: `string`  
URL: `https://api.redoxengine.com/extensions/role`  
Status: Draft

The role of an individual or physician

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Financial | Transaction | `Transactions[].Performers[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/role",
  "string": "Resident"
}
```

## Scheduling User

Type: `string`  
URL: `https://api.redoxengine.com/extensions/scheduling-user`  
Status: Draft

The user who scheduled or modified this scheduled visit.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/scheduling-user",
  "string": "rdxengine01"
}
```

## Secondary Pharmacy Name

Type: `string`  
URL: `https://api.redoxengine.com/extensions/secondary-pharmacy-name`  
Status: Draft

The name of the secondary preferred pharmacy.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| Scheduling | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse | `Medications[]` |
| Medications | New, Update, Cancel | `Order.Medication` |

```json
{
  "url": "https://api.redoxengine.com/extensions/secondary-pharmacy-name",
  "string": "My Neighboring City's Local Pharmacy"
}
```

## Secondary Pharmacy Address

Type: `address`  
URL: `https://api.redoxengine.com/extensions/secondary-pharmacy-address`  
Status: Draft

The address of the secondary preferred pharmacy.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| Scheduling | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse | `Medications[]` |
| Medications | New, Update, Cancel | `Order.Medication` |

```json
{
  "url": "https://api.redoxengine.com/extensions/secondary-pharmacy-address",
  "address": {
    "use": "work",
    "type": "physical",
    "text": "297 Main Street, Oregon, WI 53575",
    "line": [
      "297 Main Street"
    ],
    "city": "Oregon",
    "state": "WI",
    "postalCode": "53575"
  }
}
```

## Secondary Pharmacy Phone

Type: `string`  
URL: `https://api.redoxengine.com/extensions/secondary-pharmacy-phone`  
Status: Draft

The phone number of the secondary preferred pharmacy.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient` |
| Scheduling | * | `Patient` |
| PatientSearch | Response | `Patient` |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse | `Medications[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/secondary-pharmacy-phone",
  "string": "+16085552536"
}
```

## Sender Organization ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/sender-organization-id`  
Status: Draft

An identifier for the sender organization, most often an OID.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientSearch | * | `Meta` |
| PatientAdmin | NewPatient, PatientUpdate, PatientMerge | `Meta` |
| Clinical Summary | * | `Meta` |
| Order | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/sender-organization-id",
  "string": "2.16.3387.2837.12345"
}
```

## Sending Application

Type: `string`  
URL: `https://api.redoxengine.com/extensions/sending-application`  
Status: Draft

The name that identifies the sending application among all other applications within the network enterprise.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Meta` |
| Flowsheet | * | `Meta` |
| Results | * | `Meta` |
| Media | * | `Meta` |
| Medications | * | `Meta` |
| Order | * | `Meta` |
| Scheduling | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/sending-application",
  "string": "Redox"
}
```

## Quantity

Type: `string`  
URL: `https://api.redoxengine.com/extensions/service-quantity`  
Status: Draft

This component specifies the quantity of the service that should be provided at each service interval.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/service-quantity",
  "string": "2"
}
```

## Sequence

Type: `string`  
URL: `https://api.redoxengine.com/extensions/sequence`  
Status: Draft

The order sequencing conditions.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/sequence",
  "string": "1^8365828^^^3"
}
```

## Patient Sexual Orientation

Type: `string`  
URL: `https://api.redoxengine.com/extensions/sexual-orientation`  
Status: Active, Value set, Foundation

The patient's sexual orientation.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| Referral | New, Modify, Cancel, AuthReview, AuthResponse | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/sexual-orientation",
  "string": "Lesbian, gay or homosexual"
}
```

## Signed Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/signed-date`  
Status: Draft

The signed date in ISO 8601 format.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, VisitPush | `Header.Document` |

```json
{
  "url": "https://api.redoxengine.com/extensions/signed-date",
  "dateTime": "2020-05-10"
}
```

## Start Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/start-date`  
Status: Draft

The Start Date/Time of the given concept.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[]` |
| PatientAdmin | Arrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdate | `Visit.AdditionalStaff[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/start-date",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Specialty

Type: `string`  
URL: `https://api.redoxengine.com/extensions/specialty`  
Status: Draft

Generic field for passing specialty

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Research | Study | `Study` |

```json
{
  "url": "https://api.redoxengine.com/extensions/specialty",
  "string": "Gastroenterology"
}
```

## Specimen Action Code

Type: `string`  
URL: `https://api.redoxengine.com/extensions/specimen-action-code`  
Status: Draft

The action to be taken with respect to the specimens for this order

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Results | * | `Orders[]` |
| Order | New, Update, Cancel | `Order.Specimen` |
| Order | GroupedOrders | `Orders[].Specimen` |

```json
{
  "url": "https://api.redoxengine.com/extensions/specimen-action-code",
  "string": "A"
}
```

## Specimen Received Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/specimen-received-date`  
Status: Draft

The date/time in which the specimen was received

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Results | * | `Orders[]` |
| Order | New, Cancel, Update | `Order` |
| Order | GroupedOrders | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/specimen-received-date",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Suffix

Type: `string`  
URL: `https://api.redoxengine.com/extensions/suffix`  
Status: Draft

Generic field for passing suffix

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Demographics` |
| Scheduling | * | `Patient.Demographics` |
| Order | * | `Patient.Demographics` |

```json
{
  "url": "https://api.redoxengine.com/extensions/suffix",
  "string": "Jr"
}
```

## Timeout

Type: `integer`  
URL: `https://api.redoxengine.com/extensions/timeout`  
Status: Draft

The length of time the connection should stay active. If timeout is not specified, timeout defaults to 0.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | NewPatient | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/timeout",
  "integer": 10
}
```

## Time Zone

Type: `string`  
URL: `https://api.redoxengine.com/extensions/timezone`  
Status: Draft

The intended time zone of the message.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Media | * | `Meta` |
| Clinical Summary | * | `Meta` |
| Scheduling | * | `Meta` |
| PatientAdmin | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/timezone",
  "string": "UTC"
}
```

## Text Telephone

Type: `string`  
URL: `https://api.redoxengine.com/extensions/text-telephone`  
Status: Draft

The TTY (text-telephone) number.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientAdmin | * | `Patient.Demographics.PhoneNumber` |
| Scheduling | * | `Patient.Demographics.PhoneNumber` |

```json
{
  "url": "https://api.redoxengine.com/extensions/text-telephone",
  "string": "+16085552536"
}
```

## Total Cost

Type: `decimal`  
URL: `https://api.redoxengine.com/extensions/total-cost`  
Status: Draft

The total cost of the service.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Claim | Submission | `Claims[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/total-cost",
  "decimal": 1456.8
}
```

## Total Occurrences

Type: `string`  
URL: `https://api.redoxengine.com/extensions/total-occurrences`  
Status: Draft

A section to capture additional information.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order` |
| Order | GroupedOrders | `Orders[]` |
| Results | New, NewUnsolicited, QueryResponse | `Orders[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/total-occurrences",
  "string": "2"
}
```

## Total Payments

Type: `decimal`  
URL: `https://api.redoxengine.com/extensions/total-payments`  
Status: Draft

Total amount paid towards the claim

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Claim | Submission | `Claims[]` |
| PatientAdmin | * | `Visit.Insurances[]` |
| PatientAdmin | * | `Patient.Insurances[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/total-payments",
  "decimal": 3401.75
}
```

## Transplant Date

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/transplant-date`  
Status: Draft

The transplant Date/Time.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Order | New, Update, Cancel | `Order.ClinicalInfo[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/transplant-date",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Updated By User

Type: `string`  
URL: `https://api.redoxengine.com/extensions/updated-by-user`  
Status: Draft

The user who modified an event (ex. scheduled visit).

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Scheduling | * | `Visit` |
| SurgicalScheduling | * | `Visit` |

```json
{
  "url": "https://api.redoxengine.com/extensions/updated-by-user",
  "string": "rdxengine01"
}
```

## Use

Type: `string`  
URL: `https://api.redoxengine.com/extensions/use`  
Status: Draft

Identifies the purpose of an identifier, name, phone number, or address. Akin to any use field in a FHIR DataType.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientSearch | Response | `Patient.Identifiers[]` |
| PatientSearch | Response | `PotentialMatches.Identifiers[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/use",
  "string": "secondary"
}
```

## User ID

Type: `string`  
URL: `https://api.redoxengine.com/extensions/user-id`  
Status: Draft

The identify of the user (name or ID) making the request.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientSearch | * | `Meta` |
| Clinical Summary | * | `Meta` |
| PatientAdmin | * | `Meta` |
| Flowsheet | * | `Meta` |
| Results | * | `Meta` |
| Media | * | `Meta` |
| Medications | * | `Meta` |
| Order | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/user-id",
  "string": "Redox"
}
```

## User Role

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/user-role`  
Status: Draft

Structural Role refer to [ASTM E1986-98 (2005)] and its OID representation.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| PatientSearch | * | `Meta` |
| PatientAdmin | NewPatient, PatientUpdate, PatientMerge | `Meta` |
| Clinical Summary | * | `Meta` |

```json
{
  "url": "https://api.redoxengine.com/extensions/user-role",
  "coding": {
    "system": "2.16.840.1.113883.6.96",
    "code": "112247003",
    "display": "Medical Doctor"
  }
}
```

## Value (Coded Entry)

Type: `coding`  
URL: `https://api.redoxengine.com/extensions/value-codedentry`  
Status: Draft

The coded entry representation of a result or observation value.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Flowsheet | * | `Observations[]` |
| Results | * | `Orders[].Results[]` |
| Vaccination | * | `Vaccinations[].ClinicalInfo[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/value-codedentry",
  "coding": {
    "system": "Local",
    "code": "POS",
    "display": "Positive"
  }
}
```

## Value (DateTime)

Type: `dateTime`  
URL: `https://api.redoxengine.com/extensions/value-datetime`  
Status: Draft

The datetime representation of a result or observation value.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse, VisitQueryResponse, DocumentQuery, DocumentQueryResponse, DocumentGet | `Results[]` |
| Flowsheet | * | `Observations[]` |
| Results | * | `Orders[].Results[]` |
| Vaccination | * | `Vaccinations[].ClinicalInfo[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/value-datetime",
  "dateTime": "2018-01-13T17:27:00.000Z"
}
```

## Wait Time

Type: `codeableConcept`  
URL: `https://api.redoxengine.com/extensions/wait-time`  
Status: Draft

The amount of time spent in waiting area.

### Available in

| Data model | Event types | Field |
| --- | --- | --- |
| Clinical Summary | PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse | `Encounters[]` |

```json
{
  "url": "https://api.redoxengine.com/extensions/wait-time",
  "codeableConcept": {
    "coding": "",
    "text": "30 minutes"
  }
}
```
