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, we create an extension. All extensions are available for public consumption on this page.

Redox Extensions are FHIR® Extensions. When extensions are used in Redox Data Models, they are only applied to certain properties. A complete list of Redox Data Models and 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

coding

https://api.redoxengine.com/extensions/accident-code

Draft

Code for the related accident.

Available in

DataModel	Event Types	Field
Financial	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/accident-code",
3
  "coding": {
4
    "code": "AA",
5
    "display": "Auto Accident"
6
  }
7
}

Accident Date

dateTime

https://api.redoxengine.com/extensions/accident-date

Draft

The date of the accident in ISO 8601 format.

Available in

DataModel	Event Types	Field
Financial	*	`Visit`
PatientAdmin	*	`Visit`
Scheduling	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/accident-date",
3
  "dateTime": "2019-07-12"
4
}

Accident State

string

https://api.redoxengine.com/extensions/accident-state

Draft

The state where the accident occurred.

Available in

DataModel	Event Types	Field
Financial	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/accident-state",
3
  "string": "AZ"
4
}

Additional Identifier

identifier

https://api.redoxengine.com/extensions/additional-identifier

Draft

An additional identifier for this concept.

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/additional-identifier",
3
  "identifier": {
4
    "use": null,
5
    "type": "VISITID",
6
    "system": null,
7
    "value": "7469576167",
8
    "period": null,
9
    "assigner": null
10
  }
11
}

Additional Identifiers

identifiers

https://api.redoxengine.com/extensions/additional-identifiers

Draft

Additional identifiers for this concept.

Available in

DataModel	Event Types	Field
SSO	*	`Visit`
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse	`Medications[]`
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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/additional-identifiers",
3
  "identifiers": [
4
    {
5
      "use": null,
6
      "type": "VISITID",
7
      "system": null,
8
      "value": "7469576167",
9
      "period": null,
10
      "assigner": null
11
    },
12
    {
13
      "use": null,
14
      "type": "Other ID",
15
      "system": null,
16
      "value": "123456789",
17
      "period": null,
18
      "assigner": null
19
    }
20
  ]
21
}

Additional Information

string

https://api.redoxengine.com/extensions/additional-information

Draft

A section to capture additional information.

Available in

DataModel	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[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/additional-information",
3
  "string": "Please include additional context."
4
}

Additional Phone Numbers

additionalPhones

https://api.redoxengine.com/extensions/additional-phones

Draft

Any additional phone numbers a patient or location may have.

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/additional-phones",
3
  "additionalPhones": {
4
    "home": [
5
      "+16088675309",
6
      "+16088675308"
7
    ],
8
    "office": [
9
      "+16088675309"
10
    ],
11
    "mobile": [
12
      "+16088675307",
13
      "+16088675306"
14
    ]
15
  }
16
}

Additional Patient Contacts Phone Numbers

additionalPhones

https://api.redoxengine.com/extensions/additional-phones-contacts

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Contacts[].PhoneNumber`
Scheduling	*	`Patient.Contacts[].PhoneNumber`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/additional-phones-contacts",
3
  "additionalPhones": {
4
    "home": [
5
      "+16088675309",
6
      "+16088675308"
7
    ],
8
    "office": [
9
      "+16088675309"
10
    ],
11
    "mobile": [
12
      "+16088675307",
13
      "+16088675306"
14
    ]
15
  }
16
}

Additional Provider Information

participants

https://api.redoxengine.com/extensions/additional-provider-info

Draft

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

Available in

DataModel	Event Types	Field
Financial	Transaction	`Transactions[]`
Flowsheet	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/additional-provider-info",
3
  "participants": [
4
    {
5
      "id": "123456",
6
      "idType": "NPI",
7
      "person": {
8
        "name": {
9
          "given": [
10
            "Pat"
11
          ],
12
          "family": "Granite"
13
        }
14
      },
15
      "credentials": [
16
        "MD"
17
      ],
18
      "addr": {
19
        "line": [
20
          "123 Anywhere Street"
21
        ],
22
        "city": "Madison",
23
        "state": "WI",
24
        "postalCode": "53711"
25
      },
26
      "telecom": [
27
        {
28
          "use": "WP",
29
          "value": "tel:+1-555-555-1234"
30
        }
31
      ],
32
      "organization": {
33
        "facility": "Good Health Clinics",
34
        "dept": "Clinic"
35
      }
36
    }
37
  ]
38
}

Additional Patient Race Values

stringArray

https://api.redoxengine.com/extensions/additional-races

Active

ValueSet

Foundation

Any additional race values associated to the patient.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Demographics`
PatientSearch	*	`Patient.Demographics`
Order	*	`Patient.Demographics`
Results	*	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/additional-races",
3
  "stringArray": [
4
    "White",
5
    "Black or African American"
6
  ]
7
}

Address

address

https://api.redoxengine.com/extensions/address

Draft

Address details.

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit.Location`
Order	*	`Visit.Location`
Results	*	`Patient.Demographics`
PatientAdmin	*	`Visit.Location`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/address",
3
  "address": {
4
    "use": "work",
5
    "type": "physical",
6
    "text": "297 Main Street, Oregon, WI 53575",
7
    "line": [
8
      "297 Main Street"
9
    ],
10
    "city": "Oregon",
11
    "state": "WI",
12
    "postalCode": "53575"
13
  }
14
}

Adjuster Information

participants

https://api.redoxengine.com/extensions/adjuster-info

Draft

Demographic information for the claim adjuster

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit.Insurances[]`
PatientAdmin	*	`Patient.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/adjuster-info",
3
  "participants": [
4
    {
5
      "person": {
6
        "name": {
7
          "given": [
8
            "Timothy"
9
          ],
10
          "family": "Johnson"
11
        }
12
      },
13
      "addr": {
14
        "line": [
15
          "123 Anywhere Street"
16
        ],
17
        "city": "Madison",
18
        "state": "WI",
19
        "postalCode": "53711"
20
      },
21
      "phone": "+16085559876"
22
    }
23
  ]
24
}

Admission Method

codeableConcept

https://api.redoxengine.com/extensions/admission-method

Draft

How the patient was taken to the healthcare facility.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/admission-method",
3
  "codeableConcept": {
4
    "coding": "A",
5
    "text": "Ambulance"
6
  }
7
}

Admission Source

codeableConcept

https://api.redoxengine.com/extensions/admission-source

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/admission-source",
3
  "codeableConcept": {
4
    "coding": "emd",
5
    "text": "From Accident / Emergency Department"
6
  }
7
}

Admission Type

codeableConcept

https://api.redoxengine.com/extensions/admission-type

Draft

How the patient was admitted to the hospital.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit`
Medications	*	`Visit`
SurgicalScheduling	*	`Visit`
Scheduling	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/admission-type",
3
  "codeableConcept": {
4
    "coding": "T",
5
    "text": "Trauma"
6
  }
7
}

Age

string

https://api.redoxengine.com/extensions/age

Active

Foundation

Generic field for passing age

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/age",
3
  "string": "34"
4
}

Alternative Code

coding

https://api.redoxengine.com/extensions/alternate-code

Active

The alternative product code.

Available in

DataModel	Event Types	Field
Vaccination	*	`Vaccinations[].Product`
Inventory	*	`Items[]`
Financial	*	`Transactions[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/alternate-code",
3
  "coding": {
4
    "system": "NDC",
5
    "code": "1234-67048-00",
6
    "display": "Covid-19 Vaccine Name"
7
  }
8
}

Alternative Quantity

quantity

https://api.redoxengine.com/extensions/alternate-quantity

Active

An alternative representation of the same physical quantity.

Available in

DataModel	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[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/alternate-quantity",
3
  "quantity": {
4
    "value": 4.2,
5
    "unit": "10*3/uL"
6
  }
7
}

Alternative Name

string

https://api.redoxengine.com/extensions/alternative-name

Draft

An alternative name to this object

Available in

DataModel	Event Types	Field
Medications	New, Update, Cancel	`Order.Medication.Product`
Medications	Administration	`Administrations[].Medication.Product`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/alternative-name",
3
  "string": "Albuterol Sulfate"
4
}

Appointment Status

string

https://api.redoxengine.com/extensions/appointment-status

Draft

Status identifying the lifecycle stage of the appointment.

Available in

DataModel	Event Types	Field
Referral	New, Modify, Cancel	`Referral.Procedures[]`
Order	New, Update, Cancel, GroupedOrders	`Visit`
Results	New, NewUnsolicited	`Visit`
PatientAdmin	PreAdmit, VisitUpdate	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/appointment-status",
3
  "string": "Scheduled"
4
}

Assignment of Benefits

boolean

https://api.redoxengine.com/extensions/assignment-of-benefits

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/assignment-of-benefits",
3
  "boolean": true
4
}

Attending Provider ID

string

https://api.redoxengine.com/extensions/attending-provider-id

Draft

The ID of the attending provider.

Available in

DataModel	Event Types	Field
SSO	Sign-on	`Visit`
Financial	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/attending-provider-id",
3
  "string": "8675309"
4
}

Attending Provider Name

humanName

https://api.redoxengine.com/extensions/attending-provider-name

Draft

The preferred name of the attending provider.

Available in

DataModel	Event Types	Field
Financial	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/attending-provider-name",
3
  "humanName": {
4
    "use": "usual",
5
    "text": "Billy",
6
    "given": [
7
      "Billy"
8
    ]
9
  }
10
}

Author Id

string

https://api.redoxengine.com/extensions/author-id

Draft

The id number of the author.

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse	`Medications[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/author-id",
3
  "string": "7236481726"
4
}

Author Name

humanName

https://api.redoxengine.com/extensions/author-name

Draft

The preferred name of the author.

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse	`Medications[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/author-name",
3
  "humanName": {
4
    "use": "usual",
5
    "text": "Billy",
6
    "given": [
7
      "Billy"
8
    ]
9
  }
10
}

Authorization Effective Date

dateTime

https://api.redoxengine.com/extensions/authorization-effective-date

Draft

The authorization's start datetime of a referral

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit.Insurances[]`
Financial	*	`Visit.Insurances[]`
Financial	*	`Visit.Transactions[]`

Example

json

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

Authorization Expiration Date

dateTime

https://api.redoxengine.com/extensions/authorization-expiration-date

Draft

The authorization's expiration datetime of a referral

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit.Insurances[]`
Financial	*	`Visit.Insurances[]`
Financial	*	`Visit.Transactions[]`

Example

json

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

Authorization Number

string

https://api.redoxengine.com/extensions/authorization-number

Draft

The identifier for the referral authorization

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit.Insurances[]`
Financial	*	`Visit.Insurances[]`
Financial	*	`Visit.Transactions[]`
Order	*	`Visit.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/authorization number",
3
  "string": "X8675309"
4
}

Authorized Payor

string

https://api.redoxengine.com/extensions/authorized-payor

Draft

The authorized payor.

Available in

DataModel	Event Types	Field
Financial	*	`Visit.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/authorized-payor",
3
  "string": "AET01"
4
}

Authored Reimbursement Limit

integer

https://api.redoxengine.com/extensions/authorized-reimbursement-limit

Draft

The maximum amount authorized for reimbursement for a referral

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/authorized-reimbursement-limit",
3
  "integer": 1200
4
}

Authorization Required

boolean

https://api.redoxengine.com/extensions/auth-required

Draft

An indicator if authorization is required.

Available in

DataModel	Event Types	Field
Medications	*	`Order.Medication`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/auth-required",
3
  "boolean": true
4
}

Authored Treatment Count

integer

https://api.redoxengine.com/extensions/authorized-treatment-count

Draft

The count of authorized treatments from a referral

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit.Insurances[]`
Financial	*	`Visit.Insurances[]`
Financial	*	`Visit.Transactions[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/authorized-treatment-count",
3
  "integer": 3
4
}

Assessments

assessments

https://api.redoxengine.com/extensions/assessments

Draft

An array of objects corresponding to the fields in our R^JSON SocialHistory.Observations array. This extension is used to send SocialHistory sub-assessments to Redox DataModel.

Available in

DataModel	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[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/assessments",
3
  "assessments": [
4
    {
5
      "Code": "X-SDOH-SDC-95001",
6
      "Name": "AHC Utilities",
7
      "Units": null,
8
      "EndDate": null,
9
      "AltCodes": [],
10
      "Comments": [],
11
      "StartDate": "2024-08-21",
12
      "ValueText": null,
13
      "CodeSystem": "1.2.840.114350.1.72.1.8.1",
14
      "Extensions": {
15
        "entry-id": {
16
          "url": "https://api.redoxengine.com/extensions/entry-id",
17
          "string": "1.2.840.114350.1.13.213.2.7.1.83687972^1234-1234-Z1234"
18
        },
19
        "assessments": {
20
          "url": "https://api.redoxengine.com/extensions/assessments",
21
          "assessments": [
22
            {
23
              "Code": "96779-4",
24
              "Name": "In the past 12 months has the electric, gas, oil, or water company threatened to shut off services in your home?",
25
              "Units": null,
26
              "Value": {
27
                "Code": "LA32-8",
28
                "Name": "No",
29
                "AltCodes": [],
30
                "CodeSystem": "2.16.840.1.113883.6.1",
31
                "CodeSystemName": "LOINC"
32
              },
33
              "EndDate": null,
34
              "AltCodes": [],
35
              "Comments": [],
36
              "StartDate": null,
37
              "ValueText": "No",
38
              "CodeSystem": "2.16.840.1.113883.6.1",
39
              "Extensions": {
40
                "entry-id": {
41
                  "url": "https://api.redoxengine.com/extensions/entry-id",
42
                  "string": "1.2.840.114350.1.13.213.2.7.1.83687972^cer1234-1234-1234-Z1234"
43
                },
44
                "participants": {
45
                  "url": "https://api.redoxengine.com/extensions/participants",
46
                  "participants": [
47
                    {
48
                      "id": [
49
                        "1.2.840.114350.1.13.213.2.7.1.1133^263259556",
50
                        "1.2.840.114350.1.13.213.2.7.2.836982^1038509"
51
                      ],
52
                      "addr": [
53
                        {
54
                          "city": null,
55
                          "line": [],
56
                          "state": null,
57
                          "period": {
58
                            "end": null,
59
                            "start": null
60
                          },
61
                          "country": null,
62
                          "district": null,
63
                          "postalCode": null
64
                        }
65
                      ],
66
                      "code": [],
67
                      "time": "2024-08-21T16:10:48-07:00",
68
                      "device": {
69
                        "code": [],
70
                        "softwareName": null,
71
                        "manufacturerModelName": null
72
                      },
73
                      "person": {
74
                        "name": [
75
                          {
76
                            "use": "L",
77
                            "given": [
78
                              "Test"
79
                            ],
80
                            "family": "Test Test",
81
                            "prefix": [],
82
                            "suffix": []
83
                          }
84
                        ]
85
                      },
86
                      "telecom": [
87
                        {}
88
                      ],
89
                      "highTime": null,
90
                      "typeCode": "AUT",
91
                      "classCode": "ASSIGNED",
92
                      "functionCode": [],
93
                      "organization": {
94
                        "id": [
95
                          "1.2.840.114350.1.13.213.2.7.2.688879^7600"
96
                        ],
97
                        "addr": [
98
                          {
99
                            "use": "WP",
100
                            "city": "Portland",
101
                            "line": [
102
                              "1 St."
103
                            ],
104
                            "state": "OR",
105
                            "period": {
106
                              "end": null,
107
                              "start": null
108
                            },
109
                            "country": "USA",
110
                            "district": null,
111
                            "postalCode": "97209"
112
                          }
113
                        ],
114
                        "name": "Health System",
115
                        "telecom": []
116
                      }
117
                    }
118
                  ]
119
                }
120
              },
121
              "CodeSystemName": "LOINC"
122
            },
123
            {
124
              "Code": "X-SDOH-DOMAIN-ID",
125
              "Name": "Domain ID",
126
              "Units": null,
127
              "Value": {
128
                "Code": "X-SDOH-DOMAIN-23",
129
                "Name": "Utilities",
130
                "AltCodes": [],
131
                "CodeSystem": "1.2.840.114350.1.72.1.8.1",
132
                "CodeSystemName": "Epic.Sdoh"
133
              },
134
              "EndDate": null,
135
              "AltCodes": [],
136
              "Comments": [],
137
              "StartDate": null,
138
              "ValueText": "Utilities",
139
              "CodeSystem": "1.2.840.114350.1.72.1.8.1",
140
              "CodeSystemName": "Epic.Sdoh"
141
            }
142
          ]
143
        },
144
        "participants": {
145
          "url": "https://api.redoxengine.com/extensions/participants",
146
          "participants": [
147
            {
148
              "id": [
149
                "1.2.840.114350.1.13.213.2.7.1.1133^263259556",
150
                "1.2.840.114350.1.13.213.2.7.2.836982^1038509"
151
              ],
152
              "addr": [
153
                {
154
                  "city": null,
155
                  "line": [],
156
                  "state": null,
157
                  "period": {
158
                    "end": null,
159
                    "start": null
160
                  },
161
                  "country": null,
162
                  "district": null,
163
                  "postalCode": null
164
                }
165
              ],
166
              "code": [],
167
              "time": "2024-08-21T16:10:48-07:00",
168
              "device": {
169
                "code": [],
170
                "softwareName": null,
171
                "manufacturerModelName": null
172
              },
173
              "person": {
174
                "name": [
175
                  {
176
                    "use": "L",
177
                    "given": [
178
                      "Test"
179
                    ],
180
                    "family": "Test Test",
181
                    "prefix": [],
182
                    "suffix": []
183
                  }
184
                ]
185
              },
186
              "telecom": [
187
                {}
188
              ],
189
              "highTime": null,
190
              "typeCode": "AUT",
191
              "classCode": "ASSIGNED",
192
              "functionCode": [],
193
              "organization": {
194
                "id": [
195
                  "1.2.840.114350.1.13.213.2.7.2.688879^7600"
196
                ],
197
                "addr": [
198
                  {
199
                    "use": "WP",
200
                    "city": "Portland",
201
                    "line": [
202
                      "1 St."
203
                    ],
204
                    "state": "OR",
205
                    "period": {
206
                      "end": null,
207
                      "start": null
208
                    },
209
                    "country": "USA",
210
                    "district": null,
211
                    "postalCode": "97209"
212
                  }
213
                ],
214
                "name": "HealthSystem",
215
                "telecom": []
216
              }
217
            }
218
          ]
219
        }
220
      },
221
      "CodeSystemName": "Epic.Sdoh"
222
    }
223
  ]
224
}

Assigning Authority

string

https://api.redoxengine.com/extensions/assigning-authority

Draft

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

Available in

DataModel	Event Types	Field
PatientSearch	*	`Meta`
Clinical Summary	*	`Meta`
Scheduling	*	`Patient.Identifiers[]`
PatientAdmin	*	`Patient.Identifiers[]`
Media	*	`Patient.Identifiers[]`
PatientSearch	*	`Patient.Identifiers[]`
Results	*	`Patient.Identifiers[]`
Order	*	`Patient.Identifiers[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/assigning-authority",
3
  "string": "2.16.3387.2837.12345.4567"
4
}

Balance Amount

decimal

https://api.redoxengine.com/extensions/balance-amount

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
PatientSearch	Response	`Patient`
Financial	*	`Visit`
Financial	*	`Patient`
Financial	*	`Transactions[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/balance-amount",
3
  "decimal": 12.75
4
}

Bed Status

string

https://api.redoxengine.com/extensions/bed-status

Draft

Indicates the status of the bed.

Available in

DataModel	Event Types	Field
PatientAdmin	VisitUpdate, PreAdmit, Registration	`Visit.Location`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/bed-status",
3
  "string": "Unoccupied"
4
}

Billed Status

string

https://api.redoxengine.com/extensions/billed-status

Draft

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

Available in

DataModel	Event Types	Field
Financial	*	`Visit`
PatientAdmin	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/billed-status",
3
  "string": "billable"
4
}

Billing Code

stringArray

https://api.redoxengine.com/extensions/billing-code

Draft

Code for the related claim for reimbursement.

Available in

DataModel	Event Types	Field
Financial	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/billing-code",
3
  "stringArray": [
4
    "11^20220223",
5
    "29^20220223",
6
    "24^20220223"
7
  ]
8
}

Patient Birth Sex

string

https://api.redoxengine.com/extensions/birth-sex

Active

ValueSet

Foundation

The patient's sex assigned at birth.

Available in

DataModel	Event Types	Field
Order	*	`Patient.Demographics`
PatientAdmin	*	`Patient.Demographics`
PatientEducation	*	`Patient.Demographics`
Results	*	`Patient.Demographics`
Scheduling	*	`Patient.Demographics`
PatientSearch	Query, Response	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/birth-sex",
3
  "string": "Male"
4
}

Body Site

string

https://api.redoxengine.com/extensions/body-site

Draft

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

Available in

DataModel	Event Types	Field
Inventory	*	`Items[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/body-site",
3
  "string": "Chest"
4
}

Body Site Modifier

coding

https://api.redoxengine.com/extensions/body-site-modifier

Active

The modifier to the body site.

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order.Specimen`
Order	GroupedOrders, QueryResponse	`Orders[].Specimen`
Results	New, NewUnsolicited, QueryResponse	`Orders[].Results[].Specimen`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/body-site-modifier",
3
  "coding": {
4
    "system": "SCT",
5
    "code": "419161000",
6
    "display": "Unilateral left"
7
  }
8
}

Case Description

string

https://api.redoxengine.com/extensions/case-description

Draft

A description of the case

Available in

DataModel	Event Types	Field
Financial	*	`Visit`
PatientAdmin	*	`Patient.Insurances[]`
PatientAdmin	*	`Visit.Insurances[]`

Example

json

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

Case ID

string

https://api.redoxengine.com/extensions/case-id

Draft

The identifier for the case.

Available in

DataModel	Event Types	Field
Financial	Transaction	`Visit`
Inventory	Deplete	`Visit`
PatientAdmin	*	`Patient.Insurances[]`
PatientAdmin	*	`Visit.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/case-id",
3
  "string": "121342"
4
}

Check-in Date & Time

dateTime

https://api.redoxengine.com/extensions/check-in-date-time

Draft

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

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit`
PatientAdmin	VisitUpdate, Registration	`Visit`

Example

json

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

Check-in Description

string

https://api.redoxengine.com/extensions/check-in-description

Draft

The check-in description of a visit.

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit`
PatientAdmin	VisitUpdate, Registration	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/check-in-description",
3
  "description": "Visit 15834512 was checked in"
4
}

Claim Number

string

https://api.redoxengine.com/extensions/claim-number

Draft

The insurance claim number.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Insurances[]`
PatientAdmin	*	`Visit.Insurances[]`
Financial	Transaction	`Transactions[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/claim-number",
3
  "string": "1236537"
4
}

Confidential

boolean

https://api.redoxengine.com/extensions/confidential

Draft

Flag indicating if the information is confidential.

Available in

DataModel	Event Types	Field
Results	*	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/confidential",
3
  "boolean": true
4
}

Confirmation Status

boolean

https://api.redoxengine.com/extensions/confirmation-status

Draft

Flag indicating if the visit is confirmed.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit`
Scheduling	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/confirmation-status",
3
  "boolean": true
4
}

Consent

consent

https://api.redoxengine.com/extensions/consent

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

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
Referral	New, Modify, Cancel	`Patient`
SurgicalScheduling	*	`Patient`
Scheduling	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/consent",
3
  "consent": [
4
    {
5
      "id": "2.16.840.1.113883.3.1",
6
      "status": "active",
7
      "type": [
8
        {
9
          "coding": [
10
            {
11
              "code": "SMS",
12
              "display": "Short Message Service"
13
            }
14
          ],
15
          "text": "Communication via text."
16
        }
17
      ],
18
      "dateTime": "2022-12-01",
19
      "performer": {
20
        "name": {
21
          "given": [
22
            "Pat"
23
          ],
24
          "family": "Granite"
25
        },
26
        "relationship": "self"
27
      }
28
    },
29
    {
30
      "id": "2.16.840.1.113883.4.6",
31
      "status": "rejected",
32
      "type": [
33
        {
34
          "coding": [
35
            {
36
              "code": "IDSCL",
37
              "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
38
              "display": "information disclosure"
39
            }
40
          ],
41
          "text": "The Text"
42
        }
43
      ],
44
      "dateTime": "2022-01-02",
45
      "performer": {
46
        "name": {
47
          "given": [
48
            "Pat"
49
          ],
50
          "family": "Granite"
51
        },
52
        "relationship": "self"
53
      }
54
    }
55
  ]
56
}

Copay

decimal

https://api.redoxengine.com/extensions/copay

Draft

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

Available in

DataModel	Event Types	Field
Medications	*	`Order.Medication`
PatientAdmin	*	`Visit.Insurances[]`
PatientAdmin	*	`Patient.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/copay",
3
  "decimal": 50
4
}

Copay Collected

decimal

https://api.redoxengine.com/extensions/copay-collected

Draft

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

Available in

DataModel	Event Types	Field
Medications	*	`Order.Medication`
PatientAdmin	*	`Visit.Insurances[]`
PatientAdmin	*	`Patient.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/copay-collected",
3
  "decimal": 50
4
}

Medication Date Identifier

identifier

https://api.redoxengine.com/extensions/medication-date-identifier

Draft

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

Available in

DataModel	Event Types	Field
Clinical Summary	*	`Medications[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/medication-date-identifier",
3
  "identifier": {
4
    "use": null,
5
    "type": "ORDER",
6
    "system": null,
7
    "value": "08/04/2020",
8
    "period": null,
9
    "assigner": "REDOX USER, PA"
10
  }
11
}

Device ID

string

https://api.redoxengine.com/extensions/device-id

Draft

The unique identifier to be able to identify the device

Available in

DataModel	Event Types	Field
Results	*	`Orders[].Results[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/device-id",
3
  "string": "3987257"
4
}

Diet Tray Instructions

identifier

https://api.redoxengine.com/extensions/diet-tray-instructions

Draft

Diet Tray Instructions

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/diet-tray-instructions",
3
  "identifier": {
4
    "use": "218:BRK",
5
    "type": "GUEST TRAY",
6
    "system": null,
7
    "value": "Instructions for tray",
8
    "period": "2021-05-01^2021-05-31",
9
    "assigner": ""
10
  }
11
}

Dietary Instructions

stringArray

https://api.redoxengine.com/extensions/dietary-instructions

Draft

Dietary orders, supplements, and preferences

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`

Example

json

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

Discharge Date & Time

dateTime

https://api.redoxengine.com/extensions/discharge-date-time

Draft

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

Available in

DataModel	Event Types	Field
Notes	*	`Visit`

Example

json

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

Discharge Reason

string

https://api.redoxengine.com/extensions/discharge-reason

Draft

The reason a patient is being discharged.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/discharge-reason",
3
  "string": "Transfer to home care"
4
}

Do Not Resuscitate

coding

https://api.redoxengine.com/extensions/do-not-resuscitate

Draft

The Patient's Advance Directives on DNR

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/do-not-resuscitate",
3
  "coding": {
4
    "system": "2.16.840.1.113883.6.96",
5
    "version": "",
6
    "code": "304253006",
7
    "display": "Do not resuscitate",
8
    "userSelected": ""
9
  }
10
}

Document Search Types

codeableConcept

https://api.redoxengine.com/extensions/document-search-types

Draft

Additional types of documents to search for

Available in

DataModel	Event Types	Field
Clinical Summary	DocumentQuery, DocumentGet	`Document`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/document-search-types",
3
  "codeableConcept": {
4
    "coding": [
5
      {
6
        "system": "urn:redox:document_kind",
7
        "code": "Notes"
8
      }
9
    ]
10
  }
11
}

Document Submission Method

string

https://api.redoxengine.com/extensions/document-submission-method

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

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`
Results	*	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/document-submission-method",
3
  "string": "FAX"
4
}

Donor Relation

string

https://api.redoxengine.com/extensions/donor-relation

Draft

The relationship to the donor

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order.ClinicalInfo[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/donor-relation",
3
  "string": "Father"
4
}

Donor Type

string

https://api.redoxengine.com/extensions/donor-type

Draft

The type of donor

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order.ClinicalInfo[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/donor-type",
3
  "string": "Individual donor"
4
}

Duration

string

https://api.redoxengine.com/extensions/duration

Draft

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

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`
Financial	Transaction	`Transactions[].Procedure`
Results	New, NewUnsolicited, QueryResponse	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/duration",
3
  "string": "INDEF"
4
}

Echoed Status

string

https://api.redoxengine.com/extensions/echoed-status

Draft

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

Available in

DataModel	Event Types	Field
Research	SubjectUpdate	`Enrollment`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/echoed-status",
3
  "string": "Taken"
4
}

Email Address

stringArray

https://api.redoxengine.com/extensions/email-address

Draft

Generic Email address.

Available in

DataModel	Event Types	Field
SSO	Sign-on	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/email-address",
3
  "stringArray": [
4
    "user@gmail.com"
5
  ]
6
}

Employment Flag

boolean

https://api.redoxengine.com/extensions/employment-flag

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

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Contacts[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/employment-flag",
3
  "boolean": true
4
}

Employment Status

string

https://api.redoxengine.com/extensions/employment-status

Draft

ValueSet

Indicates the employment status of the patient

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/employment-status",
3
  "string": "Full time"
4
}

Encompassing Encounter Location

encompassingEncounterLocation

https://api.redoxengine.com/extensions/encompassing-encounter-location

Draft

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

Available in

DataModel	Event Types	Field
Clinical Summary	VisitPush, VisitQueryResponse	`Header.Document.Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/encompassing-encounter-location",
3
  "encompassingEncounterLocation": {
4
    "id": [
5
      "1.2.840.114350.1.13.123.3.7.2.686980;100090000"
6
    ],
7
    "code": [
8
      {
9
        "code": "1234",
10
        "codeSystem": "1.2.3.4",
11
        "displayName": "Sample",
12
        "originalText": "Outpatient Clinic"
13
      }
14
    ],
15
    "addr": {
16
      "use": "WP",
17
      "line": [
18
        "123 Anywhere Street"
19
      ],
20
      "city": "Madison",
21
      "state": "WI",
22
      "postalCode": "53711"
23
    },
24
    "telecom": [
25
      {
26
        "use": "WP",
27
        "value": "tel:+1-555-555-1234"
28
      }
29
    ],
30
    "name": "Hometown Clinic",
31
    "serviceOrganization": {
32
      "id": [
33
        "2.16.840.1.113883.4.2;41-1234567",
34
        "2.16.840.1.113883.4.6;354354667"
35
      ],
36
      "industryCode": [
37
        {
38
          "code": "1234",
39
          "codeSystem": "1.2.3.4",
40
          "originalText": "Outpatient Pharmacy"
41
        }
42
      ],
43
      "name": "Hometown Clinics LLC",
44
      "addr": {
45
        "use": "WP",
46
        "line": [
47
          "123 Anywhere Street"
48
        ],
49
        "city": "Madison",
50
        "state": "WI",
51
        "postalCode": "53711"
52
      },
53
      "telecom": [
54
        {
55
          "use": "WP",
56
          "value": "tel:+1-555-555-1234"
57
        }
58
      ],
59
      "parentOrganization": {
60
        "name": "Hometown Clinics of America",
61
        "addr": {},
62
        "telecom": [],
63
        "id": [],
64
        "industryCode": []
65
      }
66
    }
67
  }
68
}

End Date

dateTime

https://api.redoxengine.com/extensions/end-date

Draft

The end Date/Time of the given concept.

Available in

DataModel	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[]`

Example

json

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

Entered By

string

https://api.redoxengine.com/extensions/entered-by

Draft

The person that entered the information into the system.

Available in

DataModel	Event Types	Field
Vaccination	*	`Vaccinations[].Order`
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`
Results	*	`Orders[]`
PatientAdmin	*	`Visit.Insurances[]`
PatientAdmin	*	`Patient.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/entered-by",
3
  "string": "Winkle, Suzzie"
4
}

Entry ID

string

https://api.redoxengine.com/extensions/entry-id

Draft

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

Available in

DataModel	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[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/entry-id",
3
  "string": "3987257"
4
}

Event Code

string

https://api.redoxengine.com/extensions/event-code

Draft

The code or description representing EventType

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Meta`
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/event-code",
3
  "string": "Transfer an Outpatient-to Inpatient"
4
}

Expected Arrival Date & Time

dateTime

https://api.redoxengine.com/extensions/expected-arrival-date-time

Draft

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

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit`
PatientAdmin	Registration	`Visit`

Example

json

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

Expected Reimbursement

decimal

https://api.redoxengine.com/extensions/expected-reimbursement

Draft

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

Available in

DataModel	Event Types	Field
Claim	Submission	`Claims[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/expected-reimbursement",
3
  "decimal": 12.75
4
}

Expiration Date

dateTime

https://api.redoxengine.com/extensions/expiration-date

Draft

The expiration date in ISO 8601 format.

Available in

DataModel	Event Types	Field
Media	*	`Media`

Example

json

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

Extended Addresses

addresses

https://api.redoxengine.com/extensions/extended-addresses

Draft

Support for multiple patient addresses.

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse	`Header.Patient.Demographics`
PatientSearch	Query, Response	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/extended-addresses",
3
  "addresses": [
4
    {
5
      "use": "H",
6
      "period": {
7
        "start": "2015-01-01",
8
        "end": "2018-12-31"
9
      },
10
      "line": [
11
        "123 Main Street"
12
      ],
13
      "city": "Madison",
14
      "state": "WI",
15
      "postalCode": "53711"
16
    },
17
    {
18
      "use": "HP",
19
      "period": {
20
        "start": "2019-01-01",
21
        "end": "2020-12-31"
22
      },
23
      "line": [
24
        "123 Anywhere Street"
25
      ],
26
      "city": "Madison",
27
      "state": "WI",
28
      "postalCode": "53703"
29
    }
30
  ]
31
}

Extended Languages

languages

https://api.redoxengine.com/extensions/extended-languages

Active

Foundation

Support for multiple patient languages.

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/extended-languages",
3
  "languages": [
4
    {
5
      "preference": true,
6
      "code": "en"
7
    },
8
    {
9
      "preference": false,
10
      "code": "ita"
11
    }
12
  ]
13
}

Extended Names

names

https://api.redoxengine.com/extensions/extended-names

Draft

Support for multiple patient names.

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse	`Header.Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/extended-names",
3
  "names": [
4
    {
5
      "use": "L",
6
      "given": [
7
        "Timothy"
8
      ],
9
      "family": "Bixby"
10
    },
11
    {
12
      "use": "P",
13
      "given": [
14
        "Tim"
15
      ],
16
      "family": "Bixby"
17
    }
18
  ]
19
}

Fax Number

string

https://api.redoxengine.com/extensions/fax-number

Draft

The fax number.

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/fax-number",
3
  "string": "+16088675309"
4
}

File Contents

string

https://api.redoxengine.com/extensions/file-contents

Draft

Redox BLOB URI

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/file-contents",
3
  "string": "<...base 64 file contents...>"
4
}

Filename

string

https://api.redoxengine.com/extensions/filename

Draft

Filename of the documents

Available in

DataModel	Event Types	Field
Clinical Summary	VisitPush, PatientQueryResponse	`Header.Document`
Clinical Summary	DocumentQueryResponse	`Documents[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/filename",
3
  "string": "TestFile.pdf"
4
}

Frequency

string

https://api.redoxengine.com/extensions/frequency

Draft

The frequency of occurrence for this concept.

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`
Results	New, NewUnsolicited, QueryResponse	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/frequency",
3
  "string": "3 times a day"
4
}

Patient Gender Identity

string

https://api.redoxengine.com/extensions/gender-identity

Active

ValueSet

Foundation

The patient's gender identity.

Available in

DataModel	Event Types	Field
Order	*	`Patient.Demographics`
PatientAdmin	*	`Patient.Demographics`
PatientEducation	*	`Patient.Demographics`
Results	*	`Patient.Demographics`
Scheduling	*	`Patient.Demographics`
PatientSearch	Query, Response	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/gender-identity",
3
  "string": "transgender male"
4
}

HCO Source ID

identifier

https://api.redoxengine.com/extensions/header-source-id

Draft

HCO Source ID

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, VisitPush	`Header`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/header-source-id",
3
  "identifier": {
4
    "value": "5657ece9-f886-4866-94ba-bb4f12f6232b"
5
  }
6
}

Hospital Service

string

https://api.redoxengine.com/extensions/hospital-service

Draft

The hospital service covering the patient.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit`
Order	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/hospital-service",
3
  "string": "Pulmonary"
4
}

Implant Laterality

string

https://api.redoxengine.com/extensions/implant-laterality

Draft

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

Available in

DataModel	Event Types	Field
Inventory	*	`Items[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/implant-laterality",
3
  "string": "Left"
4
}

Implant Tissue

codeableConcept

https://api.redoxengine.com/extensions/implant-tissue

Draft

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

Available in

DataModel	Event Types	Field
Inventory	*	`Items[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/implant-tissue",
3
  "codeableConcept": {
4
    "coding": "Yes",
5
    "text": "Tissue was prepped"
6
  }
7
}

Implant Verification

boolean

https://api.redoxengine.com/extensions/implant-verification

Draft

An indicator if the impant was verified with surgeon.

Available in

DataModel	Event Types	Field
Inventory	*	`Items[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/implant-verification",
3
  "boolean": true
4
}

Indication

coding

https://api.redoxengine.com/extensions/indication

Draft

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

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse	`Medications[]`
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`
Results	New, NewUnsolicited, QueryResponse	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/indication",
3
  "coding": {
4
    "system": "2.16.840.1.113883.6.90",
5
    "code": "J18.1",
6
    "display": "Lobar pneumonia"
7
  }
8
}

Injury Site

string

https://api.redoxengine.com/extensions/injury-site

Draft

Free text field to capture the location of injury

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit`
PatientAdmin	*	`Visit`
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/injury-site",
3
  "string": "Knee"
4
}

Insured Group Employer

codeableConcept

https://api.redoxengine.com/extensions/insured-employer

Draft

An indicator on the insured group employer ID and Name.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Insurances[]`
PatientAdmin	*	`Visit.Insurances[]`
Financial	*	`Visit.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/insured-employer",
3
  "codeableConcept": {
4
    "coding": "12435",
5
    "text": "Redox"
6
  }
7
}

Insurance ID

identifier

https://api.redoxengine.com/extensions/insurance-id

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	Arrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdate	`Visit.Insurances[]`
PatientAdmin	NewPatient, PatientUpdate	`Patient.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/insurance-id",
3
  "identifier": {
4
    "use": null,
5
    "type": "EHR INSURANCE ID",
6
    "system": null,
7
    "value": "8675309",
8
    "period": null,
9
    "assigner": null
10
  }
11
}

Insurance Payer

coding

https://api.redoxengine.com/extensions/insurance-payer

Draft

Payer information for insurance coverage

Available in

DataModel	Event Types	Field
Vaccination	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/insurance-payer",
3
  "coding": {
4
    "code": "BC",
5
    "display": "Blue Cross"
6
  }
7
}

Insurance Plan

coding

https://api.redoxengine.com/extensions/insurance-plan

Draft

Plan information for insurance coverage

Available in

DataModel	Event Types	Field
Vaccination	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/insurance-plan",
3
  "coding": {
4
    "code": "100G",
5
    "display": "Gold Plan"
6
  }
7
}

Insurance Priority

string

https://api.redoxengine.com/extensions/insurance-priority

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	Arrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdate	`Visit.Insurances[]`
PatientAdmin	NewPatient, PatientUpdate	`Patient.Insurances[]`
Order	*	`Visit.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/insurance-priority",
3
  "string": "1"
4
}

Insurance Type

string

https://api.redoxengine.com/extensions/insurance-type

Draft

ValueSet

Plan type for insurance coverage

Available in

DataModel	Event Types	Field
Vaccination	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/insurance-type",
3
  "string": "Commercial"
4
}

Insurance Verification Date

date

https://api.redoxengine.com/extensions/insurance-verification

Draft

Verification date for insurance coverage

Available in

DataModel	Event Types	Field
Vaccination	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/insurance-verification",
3
  "date": "2021-09-03"
4
}

Insurance Verified

boolean

https://api.redoxengine.com/extensions/insurance-verified

Draft

An indicator to send if the insurance has been verified

Available in

DataModel	Event Types	Field
PatientAdmin	Arrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdate	`Visit.Insurances[]`
PatientAdmin	NewPatient, PatientUpdate	`Patient.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/insurance-verified",
3
  "boolean": true
4
}

Item Expiration Date

dateTime

https://api.redoxengine.com/extensions/item-expiration-date

Draft

The item's expiration datetime

Available in

DataModel	Event Types	Field
Inventory	*	`Items[]`

Example

json

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

Is Active

boolean

https://api.redoxengine.com/extensions/is-active

Draft

An indicator if the specific element is active

Available in

DataModel	Event Types	Field
Clinical Summary	*	`Medications[]`
PatientAdmin	*	`Patient.Demographics`
PatientAdmin	*	`Patient.Contacts[]`
PatientAdmin	*	`Visit.Insurances[]`
PatientAdmin	*	`Patient.Insurances[]`
Scheduling	*	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/is-active",
3
  "boolean": true
4
}

Location ID

string

https://api.redoxengine.com/extensions/location-id

Draft

The ID of the location.

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit.Location`
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/location-id",
3
  "string": "R2D2-C3P0"
4
}

Medication Filled Date

dateTime

https://api.redoxengine.com/extensions/medication-filled-date

Draft

The filled date of a medication.

Available in

DataModel	Event Types	Field
Clinical Summary	*	`Medications[]`

Example

json

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

Message Control ID

string

https://api.redoxengine.com/extensions/message-control-id

Draft

The message control ID for this message.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Meta`
Scheduling	*	`Meta`
Flowsheet	*	`Meta`
PatientSearch	*	`Meta`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/message-control-id",
3
  "string": "A123456789"
4
}

Mother's Maiden Name

string

https://api.redoxengine.com/extensions/mother-maiden-name

Draft

The patient's mother's maiden name.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Demographics`

Example

json

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

Multiple Birth Indicator

string

https://api.redoxengine.com/extensions/multiple-birth-indicator

Draft

Indicates whether the patient was part of a multiple birth.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/multiple-birth-indicator",
3
  "string": "Y"
4
}

NDC Quantity

integer

https://api.redoxengine.com/extensions/ndc-quantity

Draft

National Drug Code (NDC) product package size.

Available in

DataModel	Event Types	Field
Financial	*	`Transactions[]`
Inventory	*	`Items[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/ndc-quantity",
3
  "integer": 10
4
}

NDC Units Measure

coding

https://api.redoxengine.com/extensions/ndc-units-measure

Draft

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

Available in

DataModel	Event Types	Field
Financial	*	`Transactions[]`
Inventory	*	`Items[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/ndc-units-measure",
3
  "coding": {
4
    "code": "GR",
5
    "display": "Gram"
6
  }
7
}

Needs Interpreter

boolean

https://api.redoxengine.com/extensions/needs-interpeter

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
Scheduling	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/needs-interpreter",
3
  "boolean": true
4
}

Occupation Title

string

https://api.redoxengine.com/extensions/occupation-title

Draft

The title of the patient's occupation.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Contacts[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/occupation-title",
3
  "string": "Integration Engineer"
4
}

Onset Date

dateTime

https://api.redoxengine.com/extensions/onset-date

Draft

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

Available in

DataModel	Event Types	Field
Financial	*	`Visit`
PatientAdmin	*	`Visit`

Example

json

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

Order Control Code Reason

codeableConcept

https://api.redoxengine.com/extensions/order-control-code-reason

Draft

The explanation of the reason for the order event.

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`
Results	*	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/order-control-code-reason",
3
  "codeableConcept": {
4
    "coding": "Patient Request",
5
    "text": "Patient indicated that they will go to a different site"
6
  }
7
}

Order End Date

dateTime

https://api.redoxengine.com/extensions/order-end-date

Draft

The date/time that the order ended.

Available in

DataModel	Event Types	Field
Financial	Transaction	`Transactions[]`

Example

json

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

Order Start Date

dateTime

https://api.redoxengine.com/extensions/order-start-date

Draft

The date/time that the order started.

Available in

DataModel	Event Types	Field
Financial	Transaction	`Transactions[]`

Example

json

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

Ordered Date & Time

dateTime

https://api.redoxengine.com/extensions/ordered-date-time

Draft

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

Available in

DataModel	Event Types	Field
Results	*	`Orders[]`

Example

json

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

Ordering Facility Address

address

https://api.redoxengine.com/extensions/ordering-facility-address

Draft

Ordering facility's address

Available in

DataModel	Event Types	Field
Results	*	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/ordering-facility-address",
3
  "address": {
4
    "use": "work",
5
    "type": "physical",
6
    "text": "7620 Ash Street, Madison, WI 53711",
7
    "line": "7620 Ash Street",
8
    "city": "Madison",
9
    "state": "WI",
10
    "postalCode": "53711"
11
  }
12
}

Ordering Facility Name

string

https://api.redoxengine.com/extensions/ordering-facility-name

Draft

The name of the facility this order was placed in.

Available in

DataModel	Event Types	Field
Results	*	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/ordering-facility-name",
3
  "string": "Urgent Care Facility"
4
}

Ordering Facility Phone

string

https://api.redoxengine.com/extensions/ordering-facility-phone

Draft

The ordering facility's phone number.

Available in

DataModel	Event Types	Field
Results	*	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/ordering-facility-phone",
3
  "string": "+16085552536"
4
}

Organization ID

string

https://api.redoxengine.com/extensions/organization-id

Draft

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

Available in

DataModel	Event Types	Field
PatientSearch	*	`Meta`
Clinical Summary	*	`Meta`
Results	*	`Meta`
Order	*	`Meta`
Vaccination	*	`Vaccinations[].Order`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/organization-id",
3
  "string": "2.16.3387.2837.12345"
4
}

Organization Name

string

https://api.redoxengine.com/extensions/organization-name

Draft

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

Available in

DataModel	Event Types	Field
PatientSearch	*	`Meta`
PatientAdmin	*	`Meta`
Clinical Summary	*	`Meta`
Flowsheet	*	`Meta`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/organization-name",
3
  "string": "RES General Hospital"
4
}

Participants

participants

https://api.redoxengine.com/extensions/participants

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

DataModel	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[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/participants",
3
  "participants": [
4
    {
5
      "typeCode": "AUT",
6
      "classCode": "ASSIGNED",
7
      "id": [
8
        "2.16.840.1.113883.4.6;12345678"
9
      ],
10
      "time": "2022-03-24T19:44:01.765Z",
11
      "addr": {
12
        "line": [
13
          "123 Anywhere Street"
14
        ],
15
        "city": "Madison",
16
        "state": "WI",
17
        "postalCode": "53711"
18
      },
19
      "telecom": [
20
        {
21
          "use": "WP",
22
          "value": "tel:+1-555-555-1234"
23
        }
24
      ],
25
      "code": [
26
        {
27
          "code": "1234",
28
          "system": "1.2.3.4",
29
          "displayName": "Sample",
30
          "originalText": "The Text"
31
        }
32
      ],
33
      "person": {
34
        "name": {
35
          "given": [
36
            "Pat"
37
          ],
38
          "family": "Granite"
39
        }
40
      },
41
      "organization": {
42
        "id": [
43
          "d90f68da-a771-4234-bbaa-229c55eb04ae"
44
        ],
45
        "name": "Good Health Clinics",
46
        "addr": {
47
          "line": [
48
            "725 Healthcare Way"
49
          ],
50
          "city": "Madison",
51
          "state": "WI",
52
          "postalCode": "53711"
53
        },
54
        "telecom": [
55
          {
56
            "use": "WP",
57
            "value": "tel:+1-555-555-7777"
58
          }
59
        ]
60
      }
61
    }
62
  ]
63
}

Patient Contact's DOB

string

https://api.redoxengine.com/extensions/patient-contact-dob

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Contacts[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-contact-dob",
3
  "string": "2019-01-01"
4
}

Patient Contact's ID

identifier

https://api.redoxengine.com/extensions/patient-contact-id

Draft

The patient contact's ID

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Contacts[]`
Scheduling	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-contact-id",
3
  "identifier": {
4
    "use": null,
5
    "type": "PERSONID",
6
    "system": null,
7
    "value": "8675309",
8
    "period": null,
9
    "assigner": null
10
  }
11
}

Patient Ethnicity

string

https://api.redoxengine.com/extensions/patient-ethnicity

Active

Foundation

The Patient's Ethnicity.

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-ethnicity",
3
  "string": "Ashkenazi"
4
}

Patient Height

quantity

https://api.redoxengine.com/extensions/patient-height

Active

Foundation

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

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-height",
3
  "quantity": {
4
    "value": 60,
5
    "unit": "[in_i]",
6
    "system": "http://unitsofmeasure.org"
7
  }
8
}

Patient Military Service

string

https://api.redoxengine.com/extensions/patient-military-service

Active

Foundation

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

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-military-service",
3
  "string": "active-duty"
4
}

Patient's Mother's ID

identifier

https://api.redoxengine.com/extensions/patient-mother-id

Draft

The patient's mother's ID

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-mother-id",
3
  "identifier": {
4
    "use": null,
5
    "type": "PERSONID",
6
    "system": null,
7
    "value": "8675309",
8
    "period": null,
9
    "assigner": null
10
  }
11
}

Patient Near Pupil Distance

quantity

https://api.redoxengine.com/extensions/patient-near-pupil-distance

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-near-pupil-distance",
3
  "quantity": {
4
    "value": 57,
5
    "unit": "mm",
6
    "system": "http://unitsofmeasure.org"
7
  }
8
}

Patient Portal Status

boolean

https://api.redoxengine.com/extensions/patient-portal-status

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
PatientSearch	Response	`Patient`
Scheduling	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-portal-status",
3
  "boolean": true
4
}

Patient Portal Indicator

codeableConcept

https://api.redoxengine.com/extensions/patient-portal-indicator

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
PatientSearch	Response	`Patient`
Scheduling	*	`Patient`
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse	`Header.Patient`
Results	New, NewUnsolicited	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-portal-indicator",
3
  "codeableConcept": {
4
    "coding": "",
5
    "text": "Active"
6
  }
7
}

Patient Privacy Indicator

codeableConcept

https://api.redoxengine.com/extensions/patient-privacy-indicator

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit`
Scheduling	*	`Visit`
Notes	New, Replace, Delete	`Note`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-privacy-indicator",
3
  "codeableConcept": {
4
    "coding": "STF",
5
    "text": "Staff Member"
6
  }
7
}

Patient Responsibility

decimal

https://api.redoxengine.com/extensions/patient-responsibility

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit.Insurances[]`
PatientAdmin	*	`Patient.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-responsibility",
3
  "decimal": 1995.06
4
}

Patient Service Level

string

https://api.redoxengine.com/extensions/patient-service-level

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
PatientSearch	Response	`Patient`

Example

json

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

Patient Pupil Distance

quantity

https://api.redoxengine.com/extensions/patient-pupil-distance

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-pupil-distance",
3
  "quantity": {
4
    "value": 60,
5
    "unit": "mm",
6
    "system": "http://unitsofmeasure.org"
7
  }
8
}

Patient Weight

quantity

https://api.redoxengine.com/extensions/patient-weight

Active

Foundation

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

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/patient-weight",
3
  "quantity": {
4
    "value": 120,
5
    "unit": "[lb_av]",
6
    "system": "http://unitsofmeasure.org"
7
  }
8
}

Performer ID

string

https://api.redoxengine.com/extensions/performer-id

Draft

The identifier for the performing physician of the procedure.

Available in

DataModel	Event Types	Field
Inventory	*	`Items[]`
Order	New, Update, Cancel	`Order.Procedure`
Order	GroupedOrders	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/performer-id",
3
  "string": "121342"
4
}

Preferred Name

humanName

https://api.redoxengine.com/extensions/preferred-name

Active

Foundation

The preferred name of the person.

Available in

DataModel	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`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/preferred-name",
3
  "humanName": {
4
    "use": "usual",
5
    "text": "Billy",
6
    "given": [
7
      "Billy"
8
    ]
9
  }
10
}

Preferred Communication

string

https://api.redoxengine.com/extensions/preferred-communication

Draft

The preferred communication of the person.

Available in

DataModel	Event Types	Field
Order	*	`Patient.Demographics`
PatientAdmin	*	`Patient.Demographics`
Scheduling	*	`Patient.Demographics`
Results	*	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/preferred-communication",
3
  "string": "email"
4
}

Pregnancy Status

string

https://api.redoxengine.com/extensions/pregnancy-status

Draft

ValueSet

Indicates the patient's current pregnancy status.

Available in

DataModel	Event Types	Field
Results	New, NewUnsolicited	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/pregnancy-status",
3
  "string": "Not pregnant"
4
}

Present On Admission

boolean

https://api.redoxengine.com/extensions/present-on-admission

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Diagnoses[]`
Financial	Transaction	`Transactions[].Diagnoses[]`
Financial	AccountUpdate	`Visit.Diagnoses[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/present-on-admission",
3
  "boolean": false
4
}

Pricing Methodology

string

https://api.redoxengine.com/extensions/pricing-methodology

Draft

Codes or descriptions about how the claim was repriced

Available in

DataModel	Event Types	Field
Claim	Submission	`Claims[].Lines[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/pricing-methodology",
3
  "string": "13"
4
}

Primary Pharmacy Address

address

https://api.redoxengine.com/extensions/primary-pharmacy-address

Draft

The address of the primary preferred pharmacy.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
Scheduling	*	`Patient`
PatientSearch	Response	`Patient`
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse	`Medications[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/primary-pharmacy-address",
3
  "address": {
4
    "use": "work",
5
    "type": "physical",
6
    "text": "7620 Ash Street, Madison, WI 53711",
7
    "line": [
8
      "7620 Ash Street"
9
    ],
10
    "city": "Madison",
11
    "state": "WI",
12
    "postalCode": "53711"
13
  }
14
}

Primary Pharmacy Name

string

https://api.redoxengine.com/extensions/primary-pharmacy-name

Draft

The name of the primary preferred pharmacy.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
Scheduling	*	`Patient`
PatientSearch	Response	`Patient`
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse	`Medications[]`

Example

json

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

Primary Pharmacy Phone

string

https://api.redoxengine.com/extensions/primary-pharmacy-phone

Draft

The phone number of the primary preferred pharmacy.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
Scheduling	*	`Patient`
PatientSearch	Response	`Patient`
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse	`Medications[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/primary-pharmacy-phone",
3
  "string": "+16085559876"
4
}

Privacy Notice

boolean

https://api.redoxengine.com/extensions/privacy-notice

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/privacy-notice",
3
  "boolean": true
4
}

Procedure Date

dateTime

https://api.redoxengine.com/extensions/procedure-date

Draft

The date of the procedure attached to the item.

Available in

DataModel	Event Types	Field
Inventory	*	`Items[]`
Referral	New, Modify, Cancel	`Referral.Procedures[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/procedure-date",
3
  "dateTime": "2019-07-12"
4
}

Pronoun

string

https://api.redoxengine.com/extensions/pronoun

Active

Foundation

The pronoun name of the person.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Demographics`
Scheduling	*	`Patient.Demographics`
Order	*	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/pronoun",
3
  "string": "They/Them"
4
}

Purpose of Use

coding

https://api.redoxengine.com/extensions/purpose-of-use

Draft

Coded reason for making a request for patient information.

Available in

DataModel	Event Types	Field
PatientSearch	*	`Meta`
Clinical Summary	*	`Meta`
Organization	*	`Organizations[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/purpose-of-use",
3
  "coding": {
4
    "system": "2.16.840.1.113883.3.18.7.1",
5
    "code": "TREATMENT",
6
    "display": "Treatment"
7
  }
8
}

Raw Query Data

stringArray

https://api.redoxengine.com/extensions/raw-query-data

Draft

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

Available in

DataModel	Event Types	Field
SSO	*	`Meta`
PatientSearch	*	`Meta`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/raw-query-data",
3
  "stringArray": [
4
    "{\"resourceType\": \"Patient\", ...}"
5
  ]
6
}

Readmission

boolean

https://api.redoxengine.com/extensions/readmission

Draft

Flag indicating if this visit was a readmission.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/readmission",
3
  "boolean": false
4
}

Reference Number

string

https://api.redoxengine.com/extensions/reference-number

Draft

The transactional reference number, such as check number.

Available in

DataModel	Event Types	Field
Financial	Transaction	`Transactions[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/reference-number",
3
  "string": "abc-8675309"
4
}

Referral Id

coding

https://api.redoxengine.com/extensions/referral-id

Draft

The Health System ID of the referral

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit`
SSO	Sign-on	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/referral-id",
3
  "coding": {
4
    "code": "4356789876",
5
    "display": ""
6
  }
7
}

Referring Provider ID

string

https://api.redoxengine.com/extensions/referring-provider-id

Draft

The ID of the referring provider

Available in

DataModel	Event Types	Field
Financial	*	`Visit`
Media	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/referring-provider-id",
3
  "string": "4356789876"
4
}

Referring Provider Name

humanName

https://api.redoxengine.com/extensions/referring-provider-name

Draft

The preferred name of the referring provider.

Available in

DataModel	Event Types	Field
Financial	*	`Visit`
Media	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/referring-provider-name",
3
  "humanName": {
4
    "use": "usual",
5
    "text": "Billy",
6
    "given": [
7
      "Billy"
8
    ]
9
  }
10
}

Refill Amount

integer

https://api.redoxengine.com/extensions/refills-amount

Draft

The maximum refills authorized for this specific medication

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse	`Medications[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/refills-amount",
3
  "integer": 3
4
}

Rejection Reason

string

https://api.redoxengine.com/extensions/reject-reason

Draft

Code or description of the rejection.

Available in

DataModel	Event Types	Field
Claim	Submission	`Claims[].Lines[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/reject-reason",
3
  "string": "131"
4
}

Balance Amount

decimal

https://api.redoxengine.com/extensions/reprice-amount

Draft

The repriced allowed amount.

Available in

DataModel	Event Types	Field
Claim	Submission	`Claims[].Lines[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/reprice-amount",
3
  "decimal": 13.75
4
}

Resource Description

string

https://api.redoxengine.com/extensions/resource-description

Draft

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

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/resource-description",
3
  "string": "Gastroenterology"
4
}

Resource Identifier

string

https://api.redoxengine.com/extensions/resource-id

Draft

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

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/resource-id",
3
  "string": "18761"
4
}

Related Group ID

string

https://api.redoxengine.com/extensions/related-group-id

Draft

ID to group separate observation components

Available in

DataModel	Event Types	Field
Flowsheet	*	`Observations[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/related-group-id",
3
  "string": "46"
4
}

Release of Billing Information

boolean

https://api.redoxengine.com/extensions/release-of-billing-information

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/release-of-billing-information",
3
  "boolean": true
4
}

Role

string

https://api.redoxengine.com/extensions/role

Draft

The role of an individual or physician

Available in

DataModel	Event Types	Field
Financial	Transaction	`Transactions[].Performers[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/role",
3
  "string": "Resident"
4
}

Scheduling User

string

https://api.redoxengine.com/extensions/scheduling-user

Draft

The user who scheduled or modified this scheduled visit.

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/scheduling-user",
3
  "string": "rdxengine01"
4
}

Secondary Pharmacy Name

string

https://api.redoxengine.com/extensions/secondary-pharmacy-name

Draft

The name of the secondary preferred pharmacy.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
Scheduling	*	`Patient`
PatientSearch	Response	`Patient`
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse	`Medications[]`
Medications	New, Update, Cancel	`Order.Medication`

Example

json

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

Secondary Pharmacy Address

address

https://api.redoxengine.com/extensions/secondary-pharmacy-address

Draft

The address of the secondary preferred pharmacy.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
Scheduling	*	`Patient`
PatientSearch	Response	`Patient`
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse	`Medications[]`
Medications	New, Update, Cancel	`Order.Medication`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/secondary-pharmacy-address",
3
  "address": {
4
    "use": "work",
5
    "type": "physical",
6
    "text": "297 Main Street, Oregon, WI 53575",
7
    "line": [
8
      "297 Main Street"
9
    ],
10
    "city": "Oregon",
11
    "state": "WI",
12
    "postalCode": "53575"
13
  }
14
}

Secondary Pharmacy Phone

string

https://api.redoxengine.com/extensions/secondary-pharmacy-phone

Draft

The phone number of the secondary preferred pharmacy.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient`
Scheduling	*	`Patient`
PatientSearch	Response	`Patient`
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse	`Medications[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/secondary-pharmacy-phone",
3
  "string": "+16085552536"
4
}

Sender Organization ID

string

https://api.redoxengine.com/extensions/sender-organization-id

Draft

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

Available in

DataModel	Event Types	Field
PatientSearch	*	`Meta`
Clinical Summary	*	`Meta`
Order	*	`Meta`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/sender-organization-id",
3
  "string": "2.16.3387.2837.12345"
4
}

Sending Application

string

https://api.redoxengine.com/extensions/sending-application

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Meta`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/sending-application",
3
  "string": "Redox"
4
}

Quantity

string

https://api.redoxengine.com/extensions/service-quantity

Draft

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

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`
Results	New, NewUnsolicited, QueryResponse	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/service-quantity",
3
  "string": "2"
4
}

Sequence

string

https://api.redoxengine.com/extensions/sequence

Draft

The order sequencing conditions.

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`
Results	New, NewUnsolicited, QueryResponse	`Orders[]`

Example

json

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

Patient Sexual Orientation

string

https://api.redoxengine.com/extensions/sexual-orientation

Active

ValueSet

Foundation

The patient's sexual orientation.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Demographics`
Scheduling	*	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/sexual-orientation",
3
  "string": "Lesbian, gay or homosexual"
4
}

Signed Date

dateTime

https://api.redoxengine.com/extensions/signed-date

Draft

The signed date in ISO 8601 format.

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, VisitPush	`Header.Document`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/signed-date",
3
  "dateTime": "2020-05-10"
4
}

Start Date

dateTime

https://api.redoxengine.com/extensions/start-date

Draft

The Start Date/Time of the given concept.

Available in

DataModel	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[]`

Example

json

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

Specialty

string

https://api.redoxengine.com/extensions/specialty

Draft

Generic field for passing specialty

Available in

DataModel	Event Types	Field
Research	Study	`Study`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/specialty",
3
  "string": "Gastroenterology"
4
}

Specimen Action Code

string

https://api.redoxengine.com/extensions/specimen-action-code

Draft

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

Available in

DataModel	Event Types	Field
Results	*	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/specimen-action-code",
3
  "string": "A"
4
}

Specimen Received Date

dateTime

https://api.redoxengine.com/extensions/specimen-received-date

Draft

The date/time in which the specimen was received

Available in

DataModel	Event Types	Field
Results	*	`Orders[]`
Order	New, Cancel, Update	`Order`
Order	GroupedOrders	`Orders[]`

Example

json

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

Suffix

string

https://api.redoxengine.com/extensions/suffix

Draft

Generic field for passing suffix

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Demographics`
Scheduling	*	`Patient.Demographics`
Order	*	`Patient.Demographics`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/suffix",
3
  "string": "Jr"
4
}

Timeout

integer

https://api.redoxengine.com/extensions/timeout

Draft

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

Available in

DataModel	Event Types	Field
PatientAdmin	NewPatient	`Meta`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/timeout",
3
  "integer": 10
4
}

Time Zone

string

https://api.redoxengine.com/extensions/timezone

Draft

The intended time zone of the message.

Available in

DataModel	Event Types	Field
Media	*	`Meta`
Clinical Summary	*	`Meta`
Scheduling	*	`Meta`
PatientAdmin	*	`Meta`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/timezone",
3
  "string": "UTC"
4
}

Text Telephone

string

https://api.redoxengine.com/extensions/text-telephone

Draft

The TTY (text-telephone) number.

Available in

DataModel	Event Types	Field
PatientAdmin	*	`Patient.Demographics.PhoneNumber`
Scheduling	*	`Patient.Demographics.PhoneNumber`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/text-telephone",
3
  "string": "+16085552536"
4
}

Total Cost

decimal

https://api.redoxengine.com/extensions/total-cost

Draft

The total cost of the service.

Available in

DataModel	Event Types	Field
Claim	Submission	`Claims[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/total-cost",
3
  "decimal": 1456.8
4
}

Total Occurrences

string

https://api.redoxengine.com/extensions/total-occurrences

Draft

A section to capture additional information.

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order`
Order	GroupedOrders	`Orders[]`
Results	New, NewUnsolicited, QueryResponse	`Orders[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/total-occurrences",
3
  "string": "2"
4
}

Total Payments

decimal

https://api.redoxengine.com/extensions/total-payments

Draft

Total amount paid towards the claim

Available in

DataModel	Event Types	Field
Claim	Submission	`Claims[]`
PatientAdmin	*	`Visit.Insurances[]`
PatientAdmin	*	`Patient.Insurances[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/total-payments",
3
  "decimal": 3401.75
4
}

Transplant Date

dateTime

https://api.redoxengine.com/extensions/transplant-date

Draft

The transplant Date/Time.

Available in

DataModel	Event Types	Field
Order	New, Update, Cancel	`Order.ClinicalInfo[]`

Example

json

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

Updated By User

string

https://api.redoxengine.com/extensions/updated-by-user

Draft

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

Available in

DataModel	Event Types	Field
Scheduling	*	`Visit`
SurgicalScheduling	*	`Visit`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/updated-by-user",
3
  "string": "rdxengine01"
4
}

Use

string

https://api.redoxengine.com/extensions/use

Draft

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

Available in

DataModel	Event Types	Field
PatientSearch	Response	`Patient.Identifiers[]`
PatientSearch	Response	`PotentialMatches.Identifiers[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/use",
3
  "string": "secondary"
4
}

User ID

string

https://api.redoxengine.com/extensions/user-id

Draft

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

Available in

DataModel	Event Types	Field
PatientSearch	*	`Meta`
Clinical Summary	*	`Meta`
PatientAdmin	*	`Meta`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/user-id",
3
  "string": "Redox"
4
}

User Role

coding

https://api.redoxengine.com/extensions/user-role

Draft

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

Available in

DataModel	Event Types	Field
PatientSearch	*	`Meta`
Clinical Summary	*	`Meta`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/user-role",
3
  "coding": {
4
    "system": "2.16.840.1.113883.6.96",
5
    "code": "112247003",
6
    "display": "Medical Doctor"
7
  }
8
}

Value (Coded Entry)

coding

https://api.redoxengine.com/extensions/value-codedentry

Draft

The coded entry representation of a result or observation value.

Available in

DataModel	Event Types	Field
Flowsheet	*	`Observations[]`
Results	*	`Orders[].Results[]`
Vaccination	*	`Vaccinations[].ClinicalInfo[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/value-codedentry",
3
  "coding": {
4
    "system": "Local",
5
    "code": "POS",
6
    "display": "Positive"
7
  }
8
}

Value (DateTime)

dateTime

https://api.redoxengine.com/extensions/value-datetime

Draft

The datetime representation of a result or observation value.

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse, VisitQueryResponse, DocumentQuery, DocumentQueryResponse, DocumentGet	`Results[]`
Flowsheet	*	`Observations[]`
Results	*	`Orders[].Results[]`
Vaccination	*	`Vaccinations[].ClinicalInfo[]`

Example

json

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

Wait Time

codeableConcept

https://api.redoxengine.com/extensions/wait-time

Draft

The amount of time spent in waiting area.

Available in

DataModel	Event Types	Field
Clinical Summary	PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse	`Encounters[]`

Example

json

1
{
2
  "url": "https://api.redoxengine.com/extensions/wait-time",
3
  "codeableConcept": {
4
    "coding": "",
5
    "text": "30 minutes"
6
  }
7
}

Retired

Available in

DataModel	Event Types	Field

Example

json

1
null

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.