Table of Contents

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
    DataModelEvent TypesField
    FinancialTransactionVisit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/accident-code",
       "coding": {
          "code": "AA",
          "display": "Auto Accident"
       }
    }
  • Accident Date

    dateTime

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

    Draft

    The date of the accident in ISO 8601 format.

    Available in
    DataModelEvent TypesField
    FinancialTransactionVisit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/accident-date",
       "dateTime": "2019-07-12"
    }
  • Accident State

    string

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

    Draft

    The state where the accident occurred.

    Available in
    DataModelEvent TypesField
    FinancialTransactionVisit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/accident-state",
       "string": "AZ"
    }
  • Additional Identifier

    identifier

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

    Draft

    An additional identifier for this concept.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit
    Scheduling*Visit
    Results*Visit
    Flowsheet*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/additional-identifier",
       "identifier": {
          "use": null,
          "type": "VISITID",
          "system": null,
          "value": "7469576167",
          "period": null,
          "assigner": null
       }
    }
  • Additional Information

    string

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

    Draft

    A section to capturue additional information.

    Available in
    DataModelEvent TypesField
    Inventory*Items[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/additional-information",
       "string": "Please include additional context."
    }
  • Additional Phone Numbers

    additionalPhones

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

    Draft

    Any additional phone numbers a patient or location may have.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics.PhoneNumber
    Scheduling*Patient.Demographics.PhoneNumber
    Scheduling*Visit.Location
    Example
    {
       "url": "https://api.redoxengine.com/extensions/additional-phones",
       "additionalPhones": {
          "home": [
             "+16088675309",
             "+16088675308"
          ],
          "office": [
             "+16088675309"
          ],
          "mobile": [
             "+16088675307",
             "+16088675306"
          ]
       }
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Patient.Contacts[].PhoneNumber
    Scheduling*Patient.Contacts[].PhoneNumber
    Example
    {
       "url": "https://api.redoxengine.com/extensions/additional-phones-contacts",
       "additionalPhones": {
          "home": [
             "+16088675309",
             "+16088675308"
          ],
          "office": [
             "+16088675309"
          ],
          "mobile": [
             "+16088675307",
             "+16088675306"
          ]
       }
    }
  • Additional Patient Race Values

    stringArray

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

    Draft

    Any additional race values associated to the patient.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    PatientSearch*Patient.Demographics
    Order*Patient.Demographics
    Results*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/additional-races",
       "stringArray": [
          "White",
          "Black or African American"
       ]
    }
  • Address

    address

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

    Draft

    Address details.

    Available in
    DataModelEvent TypesField
    Scheduling*Visit.Location
    Results*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/address",
       "address": {
          "use": "work",
          "type": "physical",
          "text": "297 Main Street, Oregon, WI 53575",
          "line": [
             "297 Main Street"
          ],
          "city": "Oregon",
          "state": "WI",
          "postalCode": "53575"
       }
    }
  • Admission Method

    codeableConcept

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

    Draft

    How the patient was taken to the healthcare facility.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/admission-method",
       "codeableConcept": {
          "coding": "A",
          "text": "Ambulance"
       }
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/admission-source",
       "codeableConcept": {
          "coding": "emd",
          "text": "From Accident / Emergency Department"
       }
    }
  • Admission Type

    codeableConcept

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

    Draft

    How the patient was admitted to the hospital.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit
    Medications*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/admission-type",
       "codeableConcept": {
          "coding": "T",
          "text": "Trauma"
       }
    }
  • Age

    string

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

    Draft

    Generic field for passing age

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    Medications*Patient.Demographics
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponsePatient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/age",
       "string": "34"
    }
  • Alternative Code

    coding

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

    Active

    The alternative product code.

    Available in
    DataModelEvent TypesField
    Vaccination*Vaccinations[].Product
    Inventory*Items[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/alternate-code",
       "coding": {
          "system": "NDC",
          "code": "1234-67048-00",
          "display": "Covid-19 Vaccine Name"
       }
    }
  • Appointment Status

    string

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

    Draft

    Status identifying the lifecycle stage of the appointment.

    Available in
    DataModelEvent TypesField
    ReferralNew, Modify, CancelProcedures[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/appointment-status",
       "string": "Scheduled"
    }
  • Attending Provider ID

    string

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

    Draft

    The ID of the attending provider.

    Available in
    DataModelEvent TypesField
    SSOSign-onVisit
    Financial*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/attending-provider-id",
       "string": "8675309"
    }
  • Attending Provider Name

    humanName

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

    Draft

    The preferred name of the attending provider.

    Available in
    DataModelEvent TypesField
    Financial*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/attending-provider-name",
       "humanName": {
          "use": "usual",
          "text": "Billy",
          "given": [
             "Billy"
          ]
       }
    }
  • Authorization Effective Date

    dateTime

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

    Draft

    The authorization's start datetime of a referral

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit.Insurances[]
    Financial*Visit.Insurances[]
    Financial*Visit.Transactions[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/authorization-effective-date",
       "dateTime": "2018-01-13T17:27:00.000Z"
    }
  • Authorization Expiration Date

    dateTime

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

    Draft

    The authorization's expiration datetime of a referral

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit.Insurances[]
    Financial*Visit.Insurances[]
    Financial*Visit.Transactions[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/authorization-expiration-date",
       "dateTime": "2018-01-13T17:27:00.000Z"
    }
  • Authorization Number

    string

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

    Draft

    The identifier for the referral authorization

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit.Insurances[]
    Financial*Visit.Insurances[]
    Financial*Visit.Transactions[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/authorization number",
       "string": "X8675309"
    }
  • Authorized Payor

    string

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

    Draft

    The authorized payor.

    Available in
    DataModelEvent TypesField
    Financial*Visit.Insurances[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/authorized-payor",
       "string": "AET01"
    }
  • Authored Reimbursement Limit

    integer

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

    Draft

    The maximum amount authorized for reimbursement for a referral

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit.Insurances[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/authorized-reimbursement-limit",
       "integer": 1200
    }
  • Authorization Required

    boolean

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

    Draft

    An indicator if authorization is required.

    Available in
    DataModelEvent TypesField
    Medications*Order.Medication
    Example
    {
       "url": "https://api.redoxengine.com/extensions/auth-required",
       "boolean": true
    }
  • Authored Treatment Count

    integer

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

    Draft

    The count of authorized treatments from a referral

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit.Insurances[]
    Financial*Visit.Insurances[]
    Financial*Visit.Transactions[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/authorized-treatment-count",
       "integer": 3
    }
  • 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
    DataModelEvent TypesField
    PatientSearch*Meta
    Clinical Summary*Meta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/assigning-authority",
       "string": "2.16.3387.2837.12345.4567"
    }
  • Billed Status

    string

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

    Draft

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

    Available in
    DataModelEvent TypesField
    Financial*Visit
    PatientAdmin*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/billed-status",
       "string": "billable"
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Financial*Visit
    Financial*Patient
    Financial*Transactions[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/balance-amount",
       "decimal": 12.75
    }
  • 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
    DataModelEvent TypesField
    Inventory*Items[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/body-site",
       "string": "Chest"
    }
  • Case Description

    string

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

    Draft

    A description of the case

    Available in
    DataModelEvent TypesField
    Financial*Visit
    PatientAdmin*Patient.Insurances[]
    PatientAdmin*Visit.Insurances[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/case-description",
       "string": "This case is regarding Mr. John Doe and his affinity to UFOs"
    }
  • Case ID

    string

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

    Draft

    The identifier for the case.

    Available in
    DataModelEvent TypesField
    FinancialTransactionVisit
    InventoryDepleteVisit
    PatientAdmin*Patient.Insurances[]
    PatientAdmin*Visit.Insurances[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/case-id",
       "string": "121342"
    }
  • 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
    DataModelEvent TypesField
    Scheduling*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/check-in-date-time",
       "dateTime": "2018-01-13T10:33:12.000Z"
    }
  • Confirmation Status

    boolean

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

    Draft

    Flag indicating if the visit is confirmed.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit
    Scheduling*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/confirmation-status",
       "boolean": true
    }
  • Copay

    decimal

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

    Draft

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

    Available in
    DataModelEvent TypesField
    Medications*Order.Medication
    Example
    {
       "url": "https://api.redoxengine.com/extensions/copay",
       "decimal": 50
    }
  • 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
    DataModelEvent TypesField
    Clinical Summary*Medications[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/medication-date-identifier",
       "identifier": {
          "use": null,
          "type": "ORDER",
          "system": null,
          "value": "08/04/2020",
          "period": null,
          "assigner": "REDOX USER, PA"
       }
    }
  • Device ID

    string

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

    Draft

    The unique identifier to be able to identify the device

    Available in
    DataModelEvent TypesField
    Results*Orders[].Results[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/device-id",
       "string": "3987257"
    }
  • Diet Tray Instructions

    identifier

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

    Draft

    Diet Tray Instructions

    Available in
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder
    OrderGroupedOrdersOrders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/diet-tray-instructions",
       "identifier": {
          "use": "218:BRK",
          "type": "GUEST TRAY",
          "system": null,
          "value": "Instructions for tray",
          "period": "2021-05-01^2021-05-31",
          "assigner": ""
       }
    }
  • Dietary Instructions

    stringArray

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

    Draft

    Dietary orders, supplements, and preferences

    Available in
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder
    OrderGroupedOrdersOrders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/dietary-instructions",
       "stringArray": [
          "'VEGAN^Replaced with new diet order – Restrictions:  * beveragemodifiers656368: No free water'"
       ]
    }
  • 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
    DataModelEvent TypesField
    Notes*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/discharge-date-time",
       "dateTime": "2018-01-13T17:27:00.000Z"
    }
  • Do Not Resuscitate

    coding

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

    Draft

    The Patient's Advance Directives on DNR

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/do-not-resuscitate",
       "coding": {
          "system": "2.16.840.1.113883.6.96",
          "version": "",
          "code": "304253006",
          "display": "Do not resuscitate",
          "userSelected": ""
       }
    }
  • Donor Relation

    string

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

    Draft

    The relationship to the donor

    Available in
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder.ClinicalInfo[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/donor-relation",
       "string": "Father"
    }
  • Donor Type

    string

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

    Draft

    The type of donor

    Available in
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder.ClinicalInfo[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/donor-type",
       "string": "Individual donor"
    }
  • Duration

    string

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

    Draft

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

    Available in
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder
    OrderGroupedOrdersOrders[]
    FinancialTransactionTransactions[].Procedure
    Example
    {
       "url": "https://api.redoxengine.com/extensions/duration",
       "string": "INDEF"
    }
  • 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
    DataModelEvent TypesField
    ResearchSubjectUpdateEnrollment
    Example
    {
       "url": "https://api.redoxengine.com/extensions/echoed-status",
       "string": "Taken"
    }
  • Email Address

    stringArray

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

    Draft

    Generic Email address.

    Available in
    DataModelEvent TypesField
    SSOSign-onPatient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/email-address",
       "stringArray": [
          "[email protected]"
       ]
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Patient.Contacts[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/employment-flag",
       "boolean": true
    }
  • End Date

    dateTime

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

    Draft

    The end Date/Time of the given concept.

    Available in
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder
    OrderGroupedOrdersOrders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/end-date",
       "dateTime": "2018-01-13T17:27:00.000Z"
    }
  • Entered By

    string

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

    Draft

    The person that entered the information into the system.

    Available in
    DataModelEvent TypesField
    Vaccination*Vaccinations[].Order
    Example
    {
       "url": "https://api.redoxengine.com/extensions/entered-by",
       "string": "Winkle, Suzzie"
    }
  • 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
    DataModelEvent TypesField
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseMedications[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseMedicationAdministration[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseProblems[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseImmunizations[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseAllergies[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseEncounters[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseProcedures[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseResults[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseResults[].Observations[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseVitalSigns[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseVitalSigns[].Observations[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseSocialHistory.Observations[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseMedicalEquipment[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseInsurances[]
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseEncounters[].Diagnosis[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/entry-id",
       "string": "3987257"
    }
  • Event Code

    string

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

    Draft

    The code or description representing EventType

    Available in
    DataModelEvent TypesField
    PatientAdmin*Meta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/event-code",
       "string": "Transfer an Outpatient-to Inpatient"
    }
  • 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
    DataModelEvent TypesField
    Scheduling*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/expected-arrival-date-time",
       "dateTime": "2018-01-13T10:33:12"
    }
  • 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
    DataModelEvent TypesField
    ClaimSubmissionClaims[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/expected-reimbursement",
       "decimal": 12.75
    }
  • Expiration Date

    dateTime

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

    Draft

    The expiration date in ISO 8601 format.

    Available in
    DataModelEvent TypesField
    Media*Media
    Example
    {
       "url": "https://api.redoxengine.com/extensions/expiration-date",
       "dateTime": "2019-06-05T10:33:12.000Z"
    }
  • Fax Number

    string

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

    Draft

    The fax number.

    Available in
    DataModelEvent TypesField
    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
    Example
    {
       "url": "https://api.redoxengine.com/extensions/fax-number",
       "string": "+16088675309"
    }
  • File Contents

    string

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

    Draft

    Redox BLOB URI

    Available in
    DataModelEvent TypesField
    Financial*Patient
    Financial*Transactions[]
    OrderNew, Update, CancelOrder
    OrderGroupedOrdersOrders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/file-contents",
       "string": "<...base 64 file contents...>"
    }
  • Frequency

    string

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

    Draft

    The frequency of occurence for this concept.

    Available in
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder
    OrderGroupedOrdersOrders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/frequency",
       "string": "3 times a day"
    }
  • Patient Gender Identity

    string

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

    Draft

    The patient's gender identity. Referenced in Gender Identity

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/gender-identity",
       "string": "transgender male"
    }
  • HCO Source ID

    identifier

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

    Draft

    HCO Source ID

    Available in
    DataModelEvent TypesField
    Clinical SummaryPatientPushHeader
    Example
    {
       "url": "https://api.redoxengine.com/extensions/file-contents",
       "identifier": {
          "value": "5657ece9-f886-4866-94ba-bb4f12f6232b"
       }
    }
  • Hospital Service

    string

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

    Draft

    The hospital service covering the patient.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit
    Order*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/hospital-service",
       "string": "Pulmonary"
    }
  • Implant Laterality

    string

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

    Draft

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

    Available in
    DataModelEvent TypesField
    Inventory*Items[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/implant-laterality",
       "string": "Left"
    }
  • 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
    DataModelEvent TypesField
    Inventory*Items[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/implant-tissue",
       "codeableConcept": {
          "coding": "Yes",
          "text": "Tissue was prepped"
       }
    }
  • Implant Verification

    boolean

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

    Draft

    An indicator if the impant was verified with surgeon.

    Available in
    DataModelEvent TypesField
    Inventory*Items[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/implant-verification",
       "boolean": true
    }
  • Insured Group Employer

    codeableConcept

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

    Draft

    An indicator on the insured group employer ID and Name.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Insurances[]
    PatientAdmin*Visit.Insurances[]
    Financial*Visit.Insurances[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/insured-employer",
       "codeableConcept": {
          "coding": "12435",
          "text": "Redox"
       }
    }
  • 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
    DataModelEvent TypesField
    PatientAdminArrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdateVisit.Insurances[]
    PatientAdminNewPatient, PatientUpdatePatient.Insurances[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/insurance-id",
       "identifier": {
          "use": null,
          "type": "EHR INSURANCE ID",
          "system": null,
          "value": "8675309",
          "period": null,
          "assigner": null
       }
    }
  • 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
    DataModelEvent TypesField
    PatientAdminArrival, Cancel, Discharge, PreAdmit, Registration, Transfer, VisitUpdateVisit.Insurances[]
    PatientAdminNewPatient, PatientUpdatePatient.Insurances[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/insurance-priority",
       "string": "1"
    }
  • Item Expiration Date

    dateTime

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

    Draft

    The item's expiration datetime

    Available in
    DataModelEvent TypesField
    Inventory*Items[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/item-expiration-date",
       "dateTime": "2018-01-13T17:27:00.000Z"
    }
  • Is Active

    boolean

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

    Draft

    An indicator if the specific element is active

    Available in
    DataModelEvent TypesField
    Clinical Summary*Medications[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/is-active",
       "boolean": true
    }
  • Location ID

    string

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

    Draft

    The ID of the location.

    Available in
    DataModelEvent TypesField
    Scheduling*Visit.Location
    PatientAdmin*Patient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/location-id",
       "string": "R2D2-C3P0"
    }
  • Medication Filled Date

    dateTime

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

    Draft

    The filled date of a medication.

    Available in
    DataModelEvent TypesField
    Clinical Summary*Medications[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/medication-filled-date",
       "dateTime": "2018-01-13T10:33:12.000Z"
    }
  • Mother's Maiden Name

    string

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

    Draft

    The patient's mother's maiden name.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/mother-maiden-name",
       "string": "2018-01-13T10:33:12"
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/multiple-birth-indicator",
       "string": "Y"
    }
  • NDC Quantity

    integer

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

    Draft

    National Drug Code (NDC) product package size.

    Available in
    DataModelEvent TypesField
    Financial*Transactions[]
    Inventory*Items[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/ndc-quantity",
       "integer": 10
    }
  • 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
    DataModelEvent TypesField
    Financial*Transactions[]
    Inventory*Items[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/ndc-units-measure",
       "coding": {
          "code": "GR",
          "display": "Gram"
       }
    }
  • Needs Interpreter

    boolean

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

    Draft

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

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    Scheduling*Patient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/needs-interpreter",
       "boolean": true
    }
  • Occupation Title

    string

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

    Draft

    The title of the patient's occupation.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Contacts[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/occupation-title",
       "string": "Integration Engineer"
    }
  • Onset Date

    dateTime

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

    Draft

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

    Available in
    DataModelEvent TypesField
    Financial*Visit
    PatientAdmin*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/onset-date",
       "dateTime": "2018-01-13T17:27:00.000Z"
    }
  • 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
    DataModelEvent TypesField
    Results*Orders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/ordered-date-time",
       "dateTime": "2020-04-13T10:33:12.000Z"
    }
  • Ordering Facility Address

    address

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

    Draft

    Ordering facility's address

    Available in
    DataModelEvent TypesField
    Results*Orders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/ordering-facility-address",
       "address": {
          "use": "work",
          "type": "physical",
          "text": "7620 Ash Street, Madison, WI 53711",
          "line": "7620 Ash Street",
          "city": "Madison",
          "state": "WI",
          "postalCode": "53711"
       }
    }
  • Ordering Facility Name

    string

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

    Draft

    The name of the facility this order was placed in.

    Available in
    DataModelEvent TypesField
    Results*Orders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/ordering-facility-name",
       "string": "Urgent Care Facility"
    }
  • Ordering Facility Phone

    string

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

    Draft

    The ordering facility's phone number.

    Available in
    DataModelEvent TypesField
    Results*Orders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/ordering-facility-phone",
       "string": "+16085552536"
    }
  • 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
    DataModelEvent TypesField
    PatientSearch*Meta
    Clinical Summary*Meta
    Results*Meta
    Vaccination*Vaccinations[].Order
    Example
    {
       "url": "https://api.redoxengine.com/extensions/organization-id",
       "string": "2.16.3387.2837.12345"
    }
  • Organization Name

    string

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

    Draft

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

    Available in
    DataModelEvent TypesField
    PatientSearch*Meta
    PatientAdmin*Meta
    Clinical Summary*Meta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/organization-name",
       "string": "RES General Hospital"
    }
  • 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

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Contacts[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-contact-dob",
       "string": "2019-01-01"
    }
  • Patient Contact's ID

    identifier

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

    Draft

    The patient contact's ID

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Contacts[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-contact-id",
       "identifier": {
          "use": null,
          "type": "PERSONID",
          "system": null,
          "value": "8675309",
          "period": null,
          "assigner": null
       }
    }
  • Patient Ethnicity

    string

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

    Draft

    The Patient's Ethnicity.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    PatientSearchResponsePatient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-ethnicity",
       "string": "Ashkenazi"
    }
  • Patient Height

    quantity

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

    Active

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

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-height",
       "quantity": {
          "value": 60,
          "unit": "[in_i]",
          "system": "http://unitsofmeasure.org"
       }
    }
  • Patient Military Service

    string

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

    Draft

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

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-military-service",
       "string": "active-duty"
    }
  • Patient's Mother's ID

    identifier

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

    Draft

    The patient's mother's ID

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-mother-id",
       "identifier": {
          "use": null,
          "type": "PERSONID",
          "system": null,
          "value": "8675309",
          "period": null,
          "assigner": null
       }
    }
  • Patient Near Pupil Distance

    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
    DataModelEvent TypesField
    PatientAdmin*Patient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-near-pupil-distance",
       "quantity": {
          "value": 57,
          "unit": "mm",
          "system": "http://unitsofmeasure.org"
       }
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Scheduling*Patient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-portal-status",
       "boolean": true
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Scheduling*Patient
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, VisitQueryResponsePatient
    ResultsNew, NewUnsolicitedPatient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-portal-indicator",
       "codeableConcept": {
          "coding": "",
          "text": "Active"
       }
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Visit
    Scheduling*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-privacy-indicator",
       "codeableConcept": {
          "coding": "STF",
          "text": "Staff Member"
       }
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-service-level",
       "string": "Patient has full access to all services"
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Patient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-pupil-distance",
       "quantity": {
          "value": 60,
          "unit": "mm",
          "system": "http://unitsofmeasure.org"
       }
    }
  • Patient Weight

    quantity

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

    Active

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

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    Example
    {
       "url": "https://api.redoxengine.com/extensions/patient-weight",
       "quantity": {
          "value": 120,
          "unit": "[lb_av]",
          "system": "http://unitsofmeasure.org"
       }
    }
  • Performer ID

    string

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

    Draft

    The identifier for the performing physician of the procedure.

    Available in
    DataModelEvent TypesField
    Inventory*Items[]
    OrderNew, Update, CancelOrder.Procedure
    OrderGroupedOrdersOrders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/performer-id",
       "string": "121342"
    }
  • Preferred Name

    humanName

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

    Draft

    The preferred name of the person.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    Scheduling*Patient.Demographics
    Order*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/preferred-name",
       "humanName": {
          "use": "usual",
          "text": "Billy",
          "given": [
             "Billy"
          ]
       }
    }
  • Preferred Communication

    string

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

    Draft

    The preferred communication of the person.

    Available in
    DataModelEvent TypesField
    Order*Patient.Demographics
    PatientAdmin*Patient.Demographics
    Scheduling*Patient.Demographics
    Results*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/preferred-communication",
       "string": "email"
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Patient.Diagnoses[]
    FinancialTransactionTransactions[].Diagnoses[]
    FinancialAccountUpdateVisit.Diagnoses[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/present-on-admission",
       "boolean": false
    }
  • Pricing Methodology

    string

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

    Draft

    Codes or descriptions about how the claim was repriced

    Available in
    DataModelEvent TypesField
    ClaimSubmissionClaims[].Lines[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/pricing-methodology",
       "string": "13"
    }
  • Primary Pharmacy Address

    address

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

    Draft

    The address of the primary preferred pharmacy.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseMedications[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/primary-pharmacy-address",
       "address": {
          "use": "work",
          "type": "physical",
          "text": "7620 Ash Street, Madison, WI 53711",
          "line": [
             "7620 Ash Street"
          ],
          "city": "Madison",
          "state": "WI",
          "postalCode": "53711"
       }
    }
  • Primary Pharmacy Name

    string

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

    Draft

    The name of the primary preferred pharmacy.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseMedications[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/primary-pharmacy-name",
       "string": "My City's Local Pharmacy"
    }
  • Primary Pharmacy Phone

    string

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

    Draft

    The phone number of the primary preferred pharmacy.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseMedications[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/primary-pharmacy-phone",
       "string": "+16085559876"
    }
  • Procedure Date

    dateTime

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

    Draft

    The date of the procedure attached to the item.

    Available in
    DataModelEvent TypesField
    Inventory*Items[]
    ReferralNew, Modify, CancelProcedures[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/procedure-date",
       "dateTime": "2019-07-12"
    }
  • Purpose of Use

    coding

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

    Draft

    Coded reason for making a request for patient information.

    Available in
    DataModelEvent TypesField
    PatientSearch*Meta
    Clinical Summary*Meta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/purpose-of-use",
       "coding": {
          "system": "2.16.840.1.113883.3.18.7.1",
          "code": "TREATMENT",
          "display": "Treatment"
       }
    }
  • Readmission

    boolean

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

    Draft

    Flag indicating if this visit was a readmission.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/readmission",
       "boolean": false
    }
  • Reference Number

    string

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

    Draft

    The transactional reference number, such as check number.

    Available in
    DataModelEvent TypesField
    FinancialTransactionTransactions[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/reference-number",
       "string": "abc-8675309"
    }
  • Referral

    referral

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

    Draft

    Additional information about the referral

    Available in
    DataModelEvent TypesField
    Financial*Visit.Transactions[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/referral",
       "referral": {
          "effectiveDate": "2021-01-13T17:27:00.000Z",
          "expirationDate": "2022-01-13T17:27:00.000Z",
          "number": "1239762",
          "days": "30"
       }
    }
  • Referral Id

    coding

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

    Draft

    The Health System ID of the referral

    Available in
    DataModelEvent TypesField
    Scheduling*Visit
    SSOSign-onVisit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/referral-id",
       "coding": {
          "code": "4356789876",
          "display": ""
       }
    }
  • Referring Provider ID

    string

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

    Draft

    The ID of the referring provider

    Available in
    DataModelEvent TypesField
    Financial*Visit
    Media*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/referring-provider-id",
       "string": "4356789876"
    }
  • Referring Provider Name

    humanName

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

    Draft

    The preferred name of the referring provider.

    Available in
    DataModelEvent TypesField
    Financial*Visit
    Media*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/referring-provider-name",
       "humanName": {
          "use": "usual",
          "text": "Billy",
          "given": [
             "Billy"
          ]
       }
    }
  • Rejection Reason

    string

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

    Draft

    Code or description of the rejection.

    Available in
    DataModelEvent TypesField
    ClaimSubmissionClaims[].Lines[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/reject-reason",
       "string": "131"
    }
  • Balance Amount

    decimal

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

    Draft

    The repriced allowed amount.

    Available in
    DataModelEvent TypesField
    ClaimSubmissionClaims[].Lines[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/reprice-amount",
       "decimal": 13.75
    }
  • 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
    DataModelEvent TypesField
    Scheduling*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/resource-description",
       "string": "Gastroenterology"
    }
  • 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
    DataModelEvent TypesField
    Scheduling*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/resource-id",
       "string": "18761"
    }
  • Role

    string

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

    Draft

    The role of an individual or physician

    Available in
    DataModelEvent TypesField
    FinancialTransactionTransactions[].Performers[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/role",
       "string": "Resident"
    }
  • Scheduling User

    string

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

    Draft

    The user who scheduled or modified this scheduled visit.

    Available in
    DataModelEvent TypesField
    Scheduling*Visit
    Example
    {
       "url": "https://api.redoxengine.com/extensions/scheduling-user",
       "string": "rdxengine01"
    }
  • Secondary Pharmacy Name

    string

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

    Draft

    The name of the secondary preferred pharmacy.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseMedications[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/secondary-pharmacy-name",
       "string": "My Neighboring City's Local Pharmacy"
    }
  • Secondary Pharmacy Address

    address

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

    Draft

    The address of the secondary preferred pharmacy.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseMedications[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/secondary-pharmacy-address",
       "address": {
          "use": "work",
          "type": "physical",
          "text": "297 Main Street, Oregon, WI 53575",
          "line": [
             "297 Main Street"
          ],
          "city": "Oregon",
          "state": "WI",
          "postalCode": "53575"
       }
    }
  • Secondary Pharmacy Phone

    string

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

    Draft

    The phone number of the secondary preferred pharmacy.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient
    PatientSearchResponsePatient
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponseMedications[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/secondary-pharmacy-phone",
       "string": "+16085552536"
    }
  • 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
    DataModelEvent TypesField
    PatientSearch*Meta
    Clinical Summary*Meta
    Order*Meta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/sender-organization-id",
       "string": "2.16.3387.2837.12345"
    }
  • 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
    DataModelEvent TypesField
    PatientAdmin*Meta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/sending-application",
       "string": "Redox"
    }
  • 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
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder
    OrderGroupedOrdersOrders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/service-quantity",
       "string": "2"
    }
  • Patient Sexual Orientation

    string

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

    Draft

    The patient's sexual orientation. Referenced in Sexual Orientation

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/sexual-orientation",
       "string": "Lesbian, gay or homosexual"
    }
  • Start Date

    dateTime

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

    Draft

    The Start Date/Time of the given concept.

    Available in
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder
    OrderGroupedOrdersOrders[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/start-date",
       "dateTime": "2018-01-13T17:27:00.000Z"
    }
  • Suffix

    string

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

    Draft

    Generic field for passing suffix

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics
    Scheduling*Patient.Demographics
    Example
    {
       "url": "https://api.redoxengine.com/extensions/suffix",
       "string": "Jr"
    }
  • 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
    DataModelEvent TypesField
    PatientAdminNewPatientMeta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/timeout",
       "integer": 10
    }
  • Time Zone

    string

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

    Draft

    The intended time zone of the message.

    Available in
    DataModelEvent TypesField
    Media*Meta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/timezone",
       "string": "UTC"
    }
  • Text Telephone

    string

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

    Draft

    The TTY (text-telephone) number.

    Available in
    DataModelEvent TypesField
    PatientAdmin*Patient.Demographics.PhoneNumber
    Scheduling*Patient.Demographics.PhoneNumber
    Example
    {
       "url": "https://api.redoxengine.com/extensions/text-telephone",
       "string": "+16085552536"
    }
  • Total Cost

    decimal

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

    Draft

    The total cost of the service.

    Available in
    DataModelEvent TypesField
    ClaimSubmissionClaims[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/total-cost",
       "decimal": 1456.8
    }
  • Total Payments

    decimal

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

    Draft

    Total amount paid towards the claim

    Available in
    DataModelEvent TypesField
    ClaimSubmissionClaims[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/total-payments",
       "decimal": 3401.75
    }
  • Transplant Date

    dateTime

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

    Draft

    The transplate Date/Time.

    Available in
    DataModelEvent TypesField
    OrderNew, Update, CancelOrder.ClinicalInfo[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/transplant-date",
       "dateTime": "2018-01-13T17:27:00.000Z"
    }
  • User ID

    string

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

    Draft

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

    Available in
    DataModelEvent TypesField
    PatientSearch*Meta
    Clinical Summary*Meta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/user-id",
       "string": "Redox"
    }
  • 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
    DataModelEvent TypesField
    PatientSearch*Meta
    Clinical Summary*Meta
    Example
    {
       "url": "https://api.redoxengine.com/extensions/user-role",
       "coding": {
          "system": "2.16.840.1.113883.6.96",
          "code": "112247003",
          "display": "Medical Doctor"
       }
    }
  • Value (Coded Entry)

    coding

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

    Draft

    The coded entry representation of a result or observation value.

    Available in
    DataModelEvent TypesField
    Flowsheet*Observations[]
    Results*Orders[].Results[]
    Vaccination*Vaccinations[].ClinicalInfo[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/value-codedentry",
       "coding": {
          "system": "Local",
          "code": "POS",
          "display": "Positive"
       }
    }
  • Value (DateTime)

    dateTime

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

    Draft

    The datetime representation of a result or observation value.

    Available in
    DataModelEvent TypesField
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, DocumentGetResponse, VisitQueryResponse, DocumentQuery, DocumentQueryResponse, DocumentGetResults[]
    Flowsheet*Observations[]
    Results*Orders[].Results[]
    Vaccination*Vaccinations[].ClinicalInfo[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/value-datetime",
       "dateTime": "2018-01-13T17:27:00.000Z"
    }
  • Wait Time

    codeableConcept

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

    Draft

    The amount of time spent in waiting area.

    Available in
    DataModelEvent TypesField
    Clinical SummaryPatientPush, VisitPush, PatientQueryResponse, VisitQueryResponseEncounters[]
    Example
    {
       "url": "https://api.redoxengine.com/extensions/wait-time",
       "codeableConcept": {
          "coding": "",
          "text": "30 minutes"
       }
    }