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
DraftCode for the related accident.
Available in
DataModel Event Types Field Financial * Visit
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
DraftThe date of the accident in ISO 8601 format.
Available in
DataModel Event Types Field Financial * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/accident-date", "dateTime": "2019-07-12" }
Accident State
string
https://api.redoxengine.com/extensions/accident-state
DraftThe state where the accident occurred.
Available in
DataModel Event Types Field Financial * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/accident-state", "string": "AZ" }
Additional Identifier
identifier
https://api.redoxengine.com/extensions/additional-identifier
DraftAn additional identifier for this concept.
Available in
DataModel Event Types Field PatientAdmin * Visit
Scheduling * Visit
Results * Visit
Order * Visit
Flowsheet * Visit
Flowsheet * Observations[]
Referral New, Modify, Cancel, AuthReview, AuthResponse, QueryResponse Visit
Example
{ "url": "https://api.redoxengine.com/extensions/additional-identifier", "identifier": { "use": null, "type": "VISITID", "system": null, "value": "7469576167", "period": null, "assigner": null } }
Additional Identifiers
identifiers
https://api.redoxengine.com/extensions/additional-identifiers
DraftAdditional identifiers for this concept.
Available in
DataModel Event Types Field SSO * Visit
Clinical Summary PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse Medications[]
Example
{ "url": "https://api.redoxengine.com/extensions/additional-identifiers", "identifiers": [ { "use": null, "type": "VISITID", "system": null, "value": "7469576167", "period": null, "assigner": null }, { "use": null, "type": "Other ID", "system": null, "value": "123456789", "period": null, "assigner": null } ] }
Additional Information
string
https://api.redoxengine.com/extensions/additional-information
DraftA 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
{ "url": "https://api.redoxengine.com/extensions/additional-information", "string": "Please include additional context." }
Additional Phone Numbers
additionalPhones
https://api.redoxengine.com/extensions/additional-phones
DraftAny 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
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
DraftAny additional phone numbers the patient's contacts may have.
Available in
DataModel Event Types Field 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 Provider Information
participants
https://api.redoxengine.com/extensions/additional-provider-info
DraftSupport for additional provider information (ex. Billing provider info)
Available in
DataModel Event Types Field Financial Transaction Transactions[]
Example
{ "url": "https://api.redoxengine.com/extensions/additional-provider-info", "participants": [ { "id": "123456", "idType": "NPI", "person": { "name": { "given": [ "Pat" ], "family": "Granite" } }, "credentials": [ "MD" ], "addr": { "line": [ "123 Anywhere Street" ], "city": "Madison", "state": "WI", "postalCode": "53711" }, "telecom": [ { "use": "WP", "value": "tel:+1-555-555-1234" } ], "organization": { "facility": "Good Health Clinics", "dept": "Clinic" } } ] }
Additional Patient Race Values
stringArray
https://api.redoxengine.com/extensions/additional-races
ActiveValueSetFoundationAny additional race values associated to the patient.
-
Additional values may be added by Redox in the future.
Available in
DataModel Event Types Field 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
DraftAddress details.
Available in
DataModel Event Types Field Scheduling * Visit.Location
Order * Visit.Location
Results * Patient.Demographics
PatientAdmin * Visit.Location
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
DraftHow the patient was taken to the healthcare facility.
Available in
DataModel Event Types Field 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
DraftThe location of the patient prior to the admission at the healthcare facility.
Available in
DataModel Event Types Field 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
DraftHow the patient was admitted to the hospital.
Available in
DataModel Event Types Field 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
ActiveFoundationGeneric 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
{ "url": "https://api.redoxengine.com/extensions/age", "string": "34" }
Alternative Code
coding
https://api.redoxengine.com/extensions/alternate-code
ActiveThe alternative product code.
Available in
DataModel Event Types Field Vaccination * Vaccinations[].Product
Inventory * Items[]
Financial * Transactions[]
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
DraftStatus identifying the lifecycle stage of the appointment.
Available in
DataModel Event Types Field Referral New, Modify, Cancel Referral.Procedures[]
Order New, Update, Cancel Visit
Results New, NewUnsolicited Visit
Example
{ "url": "https://api.redoxengine.com/extensions/appointment-status", "string": "Scheduled" }
Assignment of Benefits
boolean
https://api.redoxengine.com/extensions/assignment-of-benefits
DraftAn indicator if the person has completed the assignment of benefits.
Available in
DataModel Event Types Field PatientAdmin * Patient
Example
{ "url": "https://api.redoxengine.com/extensions/assignment-of-benefits", "boolean": true }
Attending Provider ID
string
https://api.redoxengine.com/extensions/attending-provider-id
DraftThe ID of the attending provider.
Available in
DataModel Event Types Field SSO Sign-on Visit
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
DraftThe preferred name of the attending provider.
Available in
DataModel Event Types Field Financial * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/attending-provider-name", "humanName": { "use": "usual", "text": "Billy", "given": [ "Billy" ] } }
Author Id
string
https://api.redoxengine.com/extensions/author-id
DraftThe id number of the author.
Available in
DataModel Event Types Field Clinical Summary PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse Medications[]
Example
{ "url": "https://api.redoxengine.com/extensions/author-id", "string": "7236481726" }
Author Name
humanName
https://api.redoxengine.com/extensions/author-name
DraftThe preferred name of the author.
Available in
DataModel Event Types Field Clinical Summary PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse Medications[]
Example
{ "url": "https://api.redoxengine.com/extensions/author-name", "humanName": { "use": "usual", "text": "Billy", "given": [ "Billy" ] } }
Authorization Effective Date
dateTime
https://api.redoxengine.com/extensions/authorization-effective-date
DraftThe authorization's start datetime of a referral
Available in
DataModel Event Types Field 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
DraftThe authorization's expiration datetime of a referral
Available in
DataModel Event Types Field 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
DraftThe identifier for the referral authorization
Available in
DataModel Event Types Field 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
DraftThe authorized payor.
Available in
DataModel Event Types Field 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
DraftThe maximum amount authorized for reimbursement for a referral
Available in
DataModel Event Types Field 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
DraftAn indicator if authorization is required.
Available in
DataModel Event Types Field 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
DraftThe count of authorized treatments from a referral
Available in
DataModel Event Types Field 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
DraftThe 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[]
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
DraftStatus identifying the lifecycle stage of a billed account/transaction.
Available in
DataModel Event Types Field Financial * Visit
PatientAdmin * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/billed-status", "string": "billable" }
Billing Code
stringArray
https://api.redoxengine.com/extensions/billing-code
DraftCode for the related claim for reimbursement.
Available in
DataModel Event Types Field Financial * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/billing-code", "stringArray": [ "11^20220223", "29^20220223", "24^20220223" ] }
Balance Amount
decimal
https://api.redoxengine.com/extensions/balance-amount
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/balance-amount", "decimal": 12.75 }
Body Site
string
https://api.redoxengine.com/extensions/body-site
DraftFree text field to capture where in the body the implant was placed
Available in
DataModel Event Types Field Inventory * Items[]
Example
{ "url": "https://api.redoxengine.com/extensions/body-site", "string": "Chest" }
Body Site Modifier
coding
https://api.redoxengine.com/extensions/body-site-modifier
ActiveThe 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
{ "url": "https://api.redoxengine.com/extensions/body-site-modifier", "coding": { "system": "SCT", "code": "419161000", "display": "Unilateral left" } }
Case Description
string
https://api.redoxengine.com/extensions/case-description
DraftA description of the case
Available in
DataModel Event Types Field 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
DraftThe identifier for the case.
Available in
DataModel Event Types Field Financial Transaction Visit
Inventory Deplete Visit
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
DraftThe check-in date and time of a visit in ISO 8601 format.
Available in
DataModel Event Types Field Scheduling * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/check-in-date-time", "dateTime": "2018-01-13T10:33:12.000Z" }
Confidential
boolean
https://api.redoxengine.com/extensions/confidential
DraftFlag indicating if the information is confidential.
Available in
DataModel Event Types Field Results * Orders[]
Example
{ "url": "https://api.redoxengine.com/extensions/confidential", "boolean": true }
Confirmation Status
boolean
https://api.redoxengine.com/extensions/confirmation-status
DraftFlag indicating if the visit is confirmed.
Available in
DataModel Event Types Field PatientAdmin * Visit
Scheduling * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/confirmation-status", "boolean": true }
Consent
consent
https://api.redoxengine.com/extensions/consent
ActiveA 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
{ "url": "https://api.redoxengine.com/extensions/consent", "consent": [ { "id": "2.16.840.1.113883.3.1", "status": "active", "type": [ { "coding": [ { "code": "SMS", "display": "Short Message Service" } ], "text": "Communication via text." } ], "dateTime": "2022-12-01", "performer": { "name": { "given": [ "Pat" ], "family": "Granite" }, "relationship": "self" } }, { "id": "2.16.840.1.113883.4.6", "status": "rejected", "type": [ { "coding": [ { "code": "IDSCL", "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "display": "information disclosure" } ], "text": "The Text" } ], "dateTime": "2022-01-02", "performer": { "name": { "given": [ "Pat" ], "family": "Granite" }, "relationship": "self" } } ] }
Copay
decimal
https://api.redoxengine.com/extensions/copay
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/copay", "decimal": 50 }
Copay Collected
decimal
https://api.redoxengine.com/extensions/copay-collected
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/copay-collected", "decimal": 50 }
Medication Date Identifier
identifier
https://api.redoxengine.com/extensions/medication-date-identifier
DraftUsed to capture Medication date (as string) for a specific identifier, along with the identifier.
Available in
DataModel Event Types Field 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
DraftThe unique identifier to be able to identify the device
Available in
DataModel Event Types Field 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
DraftDiet Tray Instructions
Available in
DataModel Event Types Field Order New, Update, Cancel Order
Order GroupedOrders Orders[]
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
DraftDietary orders, supplements, and preferences
Available in
DataModel Event Types Field Order New, Update, Cancel Order
Order GroupedOrders Orders[]
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
DraftThe discharge date and time of a visit in ISO 8601 format.
Available in
DataModel Event Types Field Notes * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/discharge-date-time", "dateTime": "2018-01-13T17:27:00.000Z" }
Discharge Reason
string
https://api.redoxengine.com/extensions/discharge-reason
DraftThe reason a patient is being discharged.
Available in
DataModel Event Types Field PatientAdmin * Patient
Example
{ "url": "https://api.redoxengine.com/extensions/discharge-reason", "string": "Transfer to home care" }
Do Not Resuscitate
coding
https://api.redoxengine.com/extensions/do-not-resuscitate
DraftThe Patient's Advance Directives on DNR
Available in
DataModel Event Types Field 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": "" } }
Document Search Types
codeableConcept
https://api.redoxengine.com/extensions/document-search-types
DraftAdditional types of documents to search for
Available in
DataModel Event Types Field Clinical Summary DocumentQuery, DocumentGet Document
Example
{ "url": "https://api.redoxengine.com/extensions/document-search-types", "codeableConcept": { "coding": [ { "system": "urn:redox:document_kind", "code": "Notes" } ] } }
Document Submission Method
string
https://api.redoxengine.com/extensions/document-submission-method
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/document-submission-method", "string": "FAX" }
Donor Relation
string
https://api.redoxengine.com/extensions/donor-relation
DraftThe relationship to the donor
Available in
DataModel Event Types Field Order New, Update, Cancel Order.ClinicalInfo[]
Example
{ "url": "https://api.redoxengine.com/extensions/donor-relation", "string": "Father" }
Donor Type
string
https://api.redoxengine.com/extensions/donor-type
DraftThe type of donor
Available in
DataModel Event Types Field Order New, Update, Cancel Order.ClinicalInfo[]
Example
{ "url": "https://api.redoxengine.com/extensions/donor-type", "string": "Individual donor" }
Duration
string
https://api.redoxengine.com/extensions/duration
DraftThis 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
{ "url": "https://api.redoxengine.com/extensions/duration", "string": "INDEF" }
Echoed Status
string
https://api.redoxengine.com/extensions/echoed-status
DraftAn additional status to support a status outside of Redox normalized status's.
Available in
DataModel Event Types Field Research SubjectUpdate Enrollment
Example
{ "url": "https://api.redoxengine.com/extensions/echoed-status", "string": "Taken" }
Email Address
stringArray
https://api.redoxengine.com/extensions/email-address
DraftGeneric Email address.
Available in
DataModel Event Types Field SSO Sign-on Patient.Demographics
Example
{ "url": "https://api.redoxengine.com/extensions/email-address", "stringArray": [ "[email protected]" ] }
Employment Flag
boolean
https://api.redoxengine.com/extensions/employment-flag
DraftIndicates 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
{ "url": "https://api.redoxengine.com/extensions/employment-flag", "boolean": true }
Employment Status
string
https://api.redoxengine.com/extensions/employment-status
DraftValueSetIndicates the employment status of the patient
-
Additional values may be added by Redox in the future.
Available in
DataModel Event Types Field PatientAdmin * Patient.Demographics
Example
{ "url": "https://api.redoxengine.com/extensions/employment-status", "string": "Full time" }
-
Encompassing Encounter Location
encompassingEncounterLocation
https://api.redoxengine.com/extensions/encompassing-encounter-location
DraftThe contents of a CDA encompassingEncounter's location/healthCareFacility element.
Available in
DataModel Event Types Field Clinical Summary VisitPush, VisitQueryResponse Header.Document.Visit
Example
{ "url": "https://api.redoxengine.com/extensions/encompassing-encounter-location", "encompassingEncounterLocation": { "id": [ "1.2.840.114350.1.13.123.3.7.2.686980;100090000" ], "code": [ { "code": "1234", "codeSystem": "1.2.3.4", "displayName": "Sample", "originalText": "Outpatient Clinic" } ], "addr": { "use": "WP", "line": [ "123 Anywhere Street" ], "city": "Madison", "state": "WI", "postalCode": "53711" }, "telecom": [ { "use": "WP", "value": "tel:+1-555-555-1234" } ], "name": "Hometown Clinic", "serviceOrganization": { "id": [ "2.16.840.1.113883.4.2;41-1234567", "2.16.840.1.113883.4.6;354354667" ], "industryCode": [ { "code": "1234", "codeSystem": "1.2.3.4", "originalText": "Outpatient Pharmacy" } ], "name": "Hometown Clinics LLC", "addr": { "use": "WP", "line": [ "123 Anywhere Street" ], "city": "Madison", "state": "WI", "postalCode": "53711" }, "telecom": [ { "use": "WP", "value": "tel:+1-555-555-1234" } ], "parentOrganization": { "name": "Hometown Clinics of America", "addr": {}, "telecom": [], "id": [], "industryCode": [] } } } }
End Date
dateTime
https://api.redoxengine.com/extensions/end-date
DraftThe 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
{ "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
DraftThe 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[]
Example
{ "url": "https://api.redoxengine.com/extensions/entered-by", "string": "Winkle, Suzzie" }
Entry ID
string
https://api.redoxengine.com/extensions/entry-id
DraftUnique 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
{ "url": "https://api.redoxengine.com/extensions/entry-id", "string": "3987257" }
Event Code
string
https://api.redoxengine.com/extensions/event-code
DraftThe code or description representing EventType
Available in
DataModel Event Types Field PatientAdmin * Meta
Order New, Update, Cancel Order
Order GroupedOrders Orders[]
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
DraftThe expected arrival date and time of a visit in ISO 8601 format.
Available in
DataModel Event Types Field Scheduling * Visit
PatientAdmin Registration 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
DraftThe amount that is expected to be reimbursed. This may differ from the charged amount.
Available in
DataModel Event Types Field Claim Submission Claims[]
Example
{ "url": "https://api.redoxengine.com/extensions/expected-reimbursement", "decimal": 12.75 }
Expiration Date
dateTime
https://api.redoxengine.com/extensions/expiration-date
DraftThe expiration date in ISO 8601 format.
Available in
DataModel Event Types Field Media * Media
Example
{ "url": "https://api.redoxengine.com/extensions/expiration-date", "dateTime": "2019-06-05T10:33:12.000Z" }
Extended Addresses
addresses
https://api.redoxengine.com/extensions/extended-addresses
DraftSupport for multiple patient addresses.
Available in
DataModel Event Types Field Clinical Summary PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse Header.Patient.Demographics
Example
{ "url": "https://api.redoxengine.com/extensions/extended-addresses", "addresses": [ { "use": "H", "period": { "start": "2015-01-01", "end": "2018-12-31" }, "line": [ "123 Main Street" ], "city": "Madison", "state": "WI", "postalCode": "53711" }, { "use": "HP", "period": { "start": "2019-01-01", "end": "2020-12-31" }, "line": [ "123 Anywhere Street" ], "city": "Madison", "state": "WI", "postalCode": "53703" } ] }
Extended Languages
languages
https://api.redoxengine.com/extensions/extended-languages
ActiveFoundationSupport 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
{ "url": "https://api.redoxengine.com/extensions/extended-languages", "languages": [ { "preference": true, "code": "en" }, { "preference": false, "code": "ita" } ] }
Extended Names
names
https://api.redoxengine.com/extensions/extended-names
DraftSupport for multiple patient names.
Available in
DataModel Event Types Field Clinical Summary PatientPush, PatientQueryResponse, VisitPush, VisitQueryResponse Header.Patient.Demographics
Example
{ "url": "https://api.redoxengine.com/extensions/extended-names", "names": [ { "use": "L", "given": [ "Timothy" ], "family": "Bixby" }, { "use": "P", "given": [ "Tim" ], "family": "Bixby" } ] }
Fax Number
string
https://api.redoxengine.com/extensions/fax-number
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/fax-number", "string": "+16088675309" }
File Contents
string
https://api.redoxengine.com/extensions/file-contents
DraftRedox BLOB URI
Available in
DataModel Event Types Field Financial * Patient
Financial * Transactions[]
Order New, Update, Cancel Order
Order GroupedOrders Orders[]
Referral * Referral
Flowsheet * Patient
Example
{ "url": "https://api.redoxengine.com/extensions/file-contents", "string": "<...base 64 file contents...>" }
Filename
string
https://api.redoxengine.com/extensions/filename
DraftFilename of the documents
Available in
DataModel Event Types Field Clinical Summary VisitPush, PatientQueryResponse Header.Document
Clinical Summary DocumentQueryResponse Documents[]
Example
{ "url": "https://api.redoxengine.com/extensions/filename", "string": "TestFile.pdf" }
Frequency
string
https://api.redoxengine.com/extensions/frequency
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/frequency", "string": "3 times a day" }
Patient Gender Identity
string
https://api.redoxengine.com/extensions/gender-identity
ActiveValueSetFoundationThe patient's gender identity.
-
Additional values may be added by Redox in the future.
Available in
DataModel Event Types Field PatientAdmin * Patient.Demographics
Scheduling * 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
DraftHCO Source ID
Available in
DataModel Event Types Field Clinical Summary PatientPush, VisitPush Header
Example
{ "url": "https://api.redoxengine.com/extensions/header-source-id", "identifier": { "value": "5657ece9-f886-4866-94ba-bb4f12f6232b" } }
Hospital Service
string
https://api.redoxengine.com/extensions/hospital-service
DraftThe hospital service covering the patient.
Available in
DataModel Event Types Field 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
DraftIndication of which side of the body the implant was placed.
Available in
DataModel Event Types Field Inventory * Items[]
Example
{ "url": "https://api.redoxengine.com/extensions/implant-laterality", "string": "Left" }
Implant Tissue
codeableConcept
https://api.redoxengine.com/extensions/implant-tissue
DraftIndication of whether the implant is tissue along with any associated tissue preparation details
Available in
DataModel Event Types Field 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
DraftAn indicator if the impant was verified with surgeon.
Available in
DataModel Event Types Field Inventory * Items[]
Example
{ "url": "https://api.redoxengine.com/extensions/implant-verification", "boolean": true }
Indication
coding
https://api.redoxengine.com/extensions/indication
DraftRefers 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
{ "url": "https://api.redoxengine.com/extensions/indication", "coding": { "system": "2.16.840.1.113883.6.90", "code": "J18.1", "display": "Lobar pneumonia" } }
Insured Group Employer
codeableConcept
https://api.redoxengine.com/extensions/insured-employer
DraftAn 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
{ "url": "https://api.redoxengine.com/extensions/insured-employer", "codeableConcept": { "coding": "12435", "text": "Redox" } }
Insurance ID
identifier
https://api.redoxengine.com/extensions/insurance-id
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/insurance-id", "identifier": { "use": null, "type": "EHR INSURANCE ID", "system": null, "value": "8675309", "period": null, "assigner": null } }
Insurance Payer
coding
https://api.redoxengine.com/extensions/insurance-payer
DraftPayer information for insurance coverage
Available in
DataModel Event Types Field Vaccination * Patient
Example
{ "url": "https://api.redoxengine.com/extensions/insurance-payer", "coding": { "code": "BC", "display": "Blue Cross" } }
Insurance Plan
coding
https://api.redoxengine.com/extensions/insurance-plan
DraftPlan information for insurance coverage
Available in
DataModel Event Types Field Vaccination * Patient
Example
{ "url": "https://api.redoxengine.com/extensions/insurance-plan", "coding": { "code": "100G", "display": "Gold Plan" } }
Insurance Priority
string
https://api.redoxengine.com/extensions/insurance-priority
DraftIf 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[]
Example
{ "url": "https://api.redoxengine.com/extensions/insurance-priority", "string": "1" }
Insurance Type
string
https://api.redoxengine.com/extensions/insurance-type
DraftValueSetPlan type for insurance coverage
-
Additional values may be added by Redox in the future.
Available in
DataModel Event Types Field Vaccination * Patient
Example
{ "url": "https://api.redoxengine.com/extensions/insurance-type", "string": "Commercial" }
-
Insurance Verification Date
date
https://api.redoxengine.com/extensions/insurance-verification
DraftVerification date for insurance coverage
Available in
DataModel Event Types Field Vaccination * Patient
Example
{ "url": "https://api.redoxengine.com/extensions/insurance-verification", "date": "2021-09-03" }
Insurance Verified
boolean
https://api.redoxengine.com/extensions/insurance-verified
DraftAn 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
{ "url": "https://api.redoxengine.com/extensions/insurance-verified", "boolean": true }
Item Expiration Date
dateTime
https://api.redoxengine.com/extensions/item-expiration-date
DraftThe item's expiration datetime
Available in
DataModel Event Types Field 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
DraftAn 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
{ "url": "https://api.redoxengine.com/extensions/is-active", "boolean": true }
Location ID
string
https://api.redoxengine.com/extensions/location-id
DraftThe ID of the location.
Available in
DataModel Event Types Field 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
DraftThe filled date of a medication.
Available in
DataModel Event Types Field Clinical Summary * Medications[]
Example
{ "url": "https://api.redoxengine.com/extensions/medication-filled-date", "dateTime": "2018-01-13T10:33:12.000Z" }
Message Control ID
string
https://api.redoxengine.com/extensions/message-control-id
DraftThe message control ID for this message.
Available in
DataModel Event Types Field PatientAdmin * Meta
Scheduling * Meta
Flowsheet * Meta
Example
{ "url": "https://api.redoxengine.com/extensions/message-control-id", "string": "A123456789" }
Mother's Maiden Name
string
https://api.redoxengine.com/extensions/mother-maiden-name
DraftThe patient's mother's maiden name.
Available in
DataModel Event Types Field 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
DraftIndicates whether the patient was part of a multiple birth.
Available in
DataModel Event Types Field 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
DraftNational Drug Code (NDC) product package size.
Available in
DataModel Event Types Field 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
DraftUnits of measurements to use when billing with the National Drug Code (NDC) information
Available in
DataModel Event Types Field 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
DraftA flag indicating whether or not the patient needs an interpreter.
Available in
DataModel Event Types Field 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
DraftThe title of the patient's occupation.
Available in
DataModel Event Types Field 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
DraftEstimated or actual date or date-time the condition began.
Available in
DataModel Event Types Field Financial * Visit
PatientAdmin * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/onset-date", "dateTime": "2018-01-13T17:27:00.000Z" }
Order Control Code Reason
codeableConcept
https://api.redoxengine.com/extensions/order-control-code-reason
DraftThe explanation of the reason for the order event.
Available in
DataModel Event Types Field Order New, Update, Cancel Order
Order GroupedOrders Orders[]
Example
{ "url": "https://api.redoxengine.com/extensions/order-control-code-reason", "codeableConcept": { "coding": "Patient Request", "text": "Patient indicated that they will go to a different site" } }
Ordered Date & Time
dateTime
https://api.redoxengine.com/extensions/ordered-date-time
DraftThe date and time of an order or action was issued in ISO 8601 format.
Available in
DataModel Event Types Field 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
DraftOrdering facility's address
Available in
DataModel Event Types Field 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
DraftThe name of the facility this order was placed in.
Available in
DataModel Event Types Field 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
DraftThe ordering facility's phone number.
Available in
DataModel Event Types Field Results * Orders[]
Example
{ "url": "https://api.redoxengine.com/extensions/ordering-facility-phone", "string": "+16085552536" }
Organization ID
string
https://api.redoxengine.com/extensions/organization-id
DraftAn identifier for the sending or receiving organization, most often an OID.
Available in
DataModel Event Types Field 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
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/organization-name", "string": "RES General Hospital" }
Participants
participants
https://api.redoxengine.com/extensions/participants
DraftAn array of objects corresponding to the fields of a CDA
<author>
,<informant>
,<performer>
, or<participant>
element. Some authors may only contain anid
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
{ "url": "https://api.redoxengine.com/extensions/participants", "participants": [ { "typeCode": "AUT", "classCode": "ASSIGNED", "id": [ "2.16.840.1.113883.4.6;12345678" ], "time": "2022-03-24T19:44:01.765Z", "addr": { "line": [ "123 Anywhere Street" ], "city": "Madison", "state": "WI", "postalCode": "53711" }, "telecom": [ { "use": "WP", "value": "tel:+1-555-555-1234" } ], "code": [ { "code": "1234", "system": "1.2.3.4", "displayName": "Sample", "originalText": "The Text" } ], "person": { "name": { "given": [ "Pat" ], "family": "Granite" } }, "organization": { "id": [ "d90f68da-a771-4234-bbaa-229c55eb04ae" ], "name": "Good Health Clinics", "addr": { "line": [ "725 Healthcare Way" ], "city": "Madison", "state": "WI", "postalCode": "53711" }, "telecom": [ { "use": "WP", "value": "tel:+1-555-555-7777" } ] } } ] }
Patient Contact's DOB
string
https://api.redoxengine.com/extensions/patient-contact-dob
DraftThe patient contact's date of birth. In ISO 8601 format
Available in
DataModel Event Types Field 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
DraftThe patient contact's ID
Available in
DataModel Event Types Field PatientAdmin * Patient.Contacts[]
Scheduling * Visit
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
ActiveFoundationThe 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
{ "url": "https://api.redoxengine.com/extensions/patient-ethnicity", "string": "Ashkenazi" }
Patient Height
quantity
https://api.redoxengine.com/extensions/patient-height
ActiveFoundationThe 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
{ "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
ActiveFoundationThe 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
{ "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
DraftThe patient's mother's ID
Available in
DataModel Event Types Field 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
DraftThe patient's near pupil distance as recorded during the current visit.
Available in
DataModel Event Types Field 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
DraftA 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
{ "url": "https://api.redoxengine.com/extensions/patient-portal-status", "boolean": true }
Patient Portal Indicator
codeableConcept
https://api.redoxengine.com/extensions/patient-portal-indicator
DraftAn 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
{ "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
DraftA 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
{ "url": "https://api.redoxengine.com/extensions/patient-privacy-indicator", "codeableConcept": { "coding": "STF", "text": "Staff Member" } }
Patient Responsibility
decimal
https://api.redoxengine.com/extensions/patient-responsibility
DraftThe patient's financial responsibility for a particular visit or service.
Available in
DataModel Event Types Field PatientAdmin * Visit.Insurances[]
PatientAdmin * Patient.Insurances[]
Example
{ "url": "https://api.redoxengine.com/extensions/patient-responsibility", "decimal": 1995.06 }
Patient Service Level
string
https://api.redoxengine.com/extensions/patient-service-level
DraftThe level of service that the patient can access within an organization.
Available in
DataModel Event Types Field PatientAdmin * Patient
PatientSearch Response Patient
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
DraftThe patient's pupil distance as recorded during the current visit.
Available in
DataModel Event Types Field 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
ActiveFoundationThe 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
{ "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
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/performer-id", "string": "121342" }
Preferred Name
humanName
https://api.redoxengine.com/extensions/preferred-name
ActiveFoundationThe 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
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
DraftThe preferred communication of the person.
Available in
DataModel Event Types Field 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
DraftFlag 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
{ "url": "https://api.redoxengine.com/extensions/present-on-admission", "boolean": false }
Pricing Methodology
string
https://api.redoxengine.com/extensions/pricing-methodology
DraftCodes or descriptions about how the claim was repriced
Available in
DataModel Event Types Field Claim Submission Claims[].Lines[]
Example
{ "url": "https://api.redoxengine.com/extensions/pricing-methodology", "string": "13" }
Primary Pharmacy Address
address
https://api.redoxengine.com/extensions/primary-pharmacy-address
DraftThe 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
{ "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
DraftThe 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
{ "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
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/primary-pharmacy-phone", "string": "+16085559876" }
Privacy Notice
boolean
https://api.redoxengine.com/extensions/privacy-notice
DraftAn indicator if the person has acknowledged the receipt of the privacy notice.
Available in
DataModel Event Types Field PatientAdmin * Patient
Example
{ "url": "https://api.redoxengine.com/extensions/privacy-notice", "boolean": true }
Procedure Date
dateTime
https://api.redoxengine.com/extensions/procedure-date
DraftThe date of the procedure attached to the item.
Available in
DataModel Event Types Field Inventory * Items[]
Referral New, Modify, Cancel Referral.Procedures[]
Example
{ "url": "https://api.redoxengine.com/extensions/procedure-date", "dateTime": "2019-07-12" }
Pronoun
string
https://api.redoxengine.com/extensions/pronoun
ActiveFoundationThe pronoun name of the person.
Available in
DataModel Event Types Field PatientAdmin * Patient.Demographics
Scheduling * Patient.Demographics
Order * Patient.Demographics
Example
{ "url": "https://api.redoxengine.com/extensions/pronoun", "string": "They/Them" }
Purpose of Use
coding
https://api.redoxengine.com/extensions/purpose-of-use
DraftCoded reason for making a request for patient information.
Available in
DataModel Event Types Field 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" } }
Raw Query Data
stringArray
https://api.redoxengine.com/extensions/raw-query-data
DraftRaw data returned from a query to provide additional information if required.
Available in
DataModel Event Types Field SSO * Meta
Example
{ "url": "https://api.redoxengine.com/extensions/raw-query-data", "stringArray": [ "{\"resourceType\": \"Patient\", ...}" ] }
Readmission
boolean
https://api.redoxengine.com/extensions/readmission
DraftFlag indicating if this visit was a readmission.
Available in
DataModel Event Types Field PatientAdmin * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/readmission", "boolean": false }
Reference Number
string
https://api.redoxengine.com/extensions/reference-number
DraftThe transactional reference number, such as check number.
Available in
DataModel Event Types Field Financial Transaction Transactions[]
Example
{ "url": "https://api.redoxengine.com/extensions/reference-number", "string": "abc-8675309" }
Referral
referral
https://api.redoxengine.com/extensions/referral
DraftAdditional information about the referral
Available in
DataModel Event Types Field Financial * Visit.Transactions[]
Order New, Update, Cancel Order
Order GroupedOrders Orders[]
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
DraftThe Health System ID of the referral
Available in
DataModel Event Types Field Scheduling * Visit
SSO Sign-on Visit
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
DraftThe ID of the referring provider
Available in
DataModel Event Types Field 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
DraftThe preferred name of the referring provider.
Available in
DataModel Event Types Field Financial * Visit
Media * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/referring-provider-name", "humanName": { "use": "usual", "text": "Billy", "given": [ "Billy" ] } }
Refill Amount
integer
https://api.redoxengine.com/extensions/refills-amount
DraftThe maximum refills authorized for this specific medication
Available in
DataModel Event Types Field Clinical Summary PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse Medications[]
Example
{ "url": "https://api.redoxengine.com/extensions/refills-amount", "integer": 3 }
Rejection Reason
string
https://api.redoxengine.com/extensions/reject-reason
DraftCode or description of the rejection.
Available in
DataModel Event Types Field Claim Submission Claims[].Lines[]
Example
{ "url": "https://api.redoxengine.com/extensions/reject-reason", "string": "131" }
Balance Amount
decimal
https://api.redoxengine.com/extensions/reprice-amount
DraftThe repriced allowed amount.
Available in
DataModel Event Types Field Claim Submission Claims[].Lines[]
Example
{ "url": "https://api.redoxengine.com/extensions/reprice-amount", "decimal": 13.75 }
Resource Description
string
https://api.redoxengine.com/extensions/resource-description
DraftThe description of the visit resource group, most often defined as department name.
Available in
DataModel Event Types Field Scheduling * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/resource-description", "string": "Gastroenterology" }
Resource Identifier
string
https://api.redoxengine.com/extensions/resource-id
DraftThe identifier of the visit resource group, most often defined as department id.
Available in
DataModel Event Types Field Scheduling * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/resource-id", "string": "18761" }
Release of Billing Information
boolean
https://api.redoxengine.com/extensions/release-of-billing-information
DraftAn indicator if the person has authorized the release of billing information.
Available in
DataModel Event Types Field PatientAdmin * Patient
Example
{ "url": "https://api.redoxengine.com/extensions/release-of-billing-information", "boolean": true }
Role
string
https://api.redoxengine.com/extensions/role
DraftThe role of an individual or physician
Available in
DataModel Event Types Field Financial Transaction Transactions[].Performers[]
Example
{ "url": "https://api.redoxengine.com/extensions/role", "string": "Resident" }
Scheduling User
string
https://api.redoxengine.com/extensions/scheduling-user
DraftThe user who scheduled or modified this scheduled visit.
Available in
DataModel Event Types Field 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
DraftThe 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[]
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
DraftThe 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[]
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
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/secondary-pharmacy-phone", "string": "+16085552536" }
Sender Organization ID
string
https://api.redoxengine.com/extensions/sender-organization-id
DraftAn identifier for the sender organization, most often an OID.
Available in
DataModel Event Types Field 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
DraftThe name that identifies the sending application among all other applications within the network enterprise.
Available in
DataModel Event Types Field PatientAdmin * Meta
Example
{ "url": "https://api.redoxengine.com/extensions/sending-application", "string": "Redox" }
Quantity
string
https://api.redoxengine.com/extensions/service-quantity
DraftThis 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
{ "url": "https://api.redoxengine.com/extensions/service-quantity", "string": "2" }
Sequence
string
https://api.redoxengine.com/extensions/sequence
DraftThe order sequencing conditions.
Available in
DataModel Event Types Field Order New, Update, Cancel Order
Order GroupedOrders Orders[]
Results New, NewUnsolicited, QueryResponse Orders[]
Example
{ "url": "https://api.redoxengine.com/extensions/sequence", "string": "1^8365828^^^3" }
Patient Sexual Orientation
string
https://api.redoxengine.com/extensions/sexual-orientation
ActiveValueSetFoundationThe patient's sexual orientation.
-
Additional values may be added by Redox in the future.
Available in
DataModel Event Types Field PatientAdmin * Patient.Demographics
Scheduling * Patient.Demographics
Example
{ "url": "https://api.redoxengine.com/extensions/sexual-orientation", "string": "Lesbian, gay or homosexual" }
-
Signed Date
dateTime
https://api.redoxengine.com/extensions/signed-date
DraftThe signed date in ISO 8601 format.
Available in
DataModel Event Types Field Clinical Summary PatientPush, VisitPush Header.Document
Example
{ "url": "https://api.redoxengine.com/extensions/signed-date", "dateTime": "2020-05-10" }
Start Date
dateTime
https://api.redoxengine.com/extensions/start-date
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/start-date", "dateTime": "2018-01-13T17:27:00.000Z" }
Specialty
string
https://api.redoxengine.com/extensions/specialty
DraftGeneric field for passing specialty
Available in
DataModel Event Types Field Research Study Study
Example
{ "url": "https://api.redoxengine.com/extensions/specialty", "string": "Gastroenterology" }
Specimen Received Date
dateTime
https://api.redoxengine.com/extensions/specimen-received-date
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/specimen-received-date", "dateTime": "2018-01-13T17:27:00.000Z" }
Suffix
string
https://api.redoxengine.com/extensions/suffix
DraftGeneric field for passing suffix
Available in
DataModel Event Types Field PatientAdmin * Patient.Demographics
Scheduling * Patient.Demographics
Order * Patient.Demographics
Example
{ "url": "https://api.redoxengine.com/extensions/suffix", "string": "Jr" }
Timeout
integer
https://api.redoxengine.com/extensions/timeout
DraftThe 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
{ "url": "https://api.redoxengine.com/extensions/timeout", "integer": 10 }
Time Zone
string
https://api.redoxengine.com/extensions/timezone
DraftThe intended time zone of the message.
Available in
DataModel Event Types Field Media * Meta
Clinical Summary * Meta
Scheduling * Meta
PatientAdmin * Meta
Example
{ "url": "https://api.redoxengine.com/extensions/timezone", "string": "UTC" }
Text Telephone
string
https://api.redoxengine.com/extensions/text-telephone
DraftThe TTY (text-telephone) number.
Available in
DataModel Event Types Field 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
DraftThe total cost of the service.
Available in
DataModel Event Types Field Claim Submission Claims[]
Example
{ "url": "https://api.redoxengine.com/extensions/total-cost", "decimal": 1456.8 }
Total Occurrences
string
https://api.redoxengine.com/extensions/total-occurrences
DraftA 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
{ "url": "https://api.redoxengine.com/extensions/total-occurrences", "string": "2" }
Total Payments
decimal
https://api.redoxengine.com/extensions/total-payments
DraftTotal amount paid towards the claim
Available in
DataModel Event Types Field Claim Submission Claims[]
PatientAdmin * Visit.Insurances[]
PatientAdmin * Patient.Insurances[]
Example
{ "url": "https://api.redoxengine.com/extensions/total-payments", "decimal": 3401.75 }
Transplant Date
dateTime
https://api.redoxengine.com/extensions/transplant-date
DraftThe transplant Date/Time.
Available in
DataModel Event Types Field Order New, Update, Cancel Order.ClinicalInfo[]
Example
{ "url": "https://api.redoxengine.com/extensions/transplant-date", "dateTime": "2018-01-13T17:27:00.000Z" }
Updated By User
string
https://api.redoxengine.com/extensions/updated-by-user
DraftThe user who modified an event (ex. scheduled visit).
Available in
DataModel Event Types Field Scheduling * Visit
Example
{ "url": "https://api.redoxengine.com/extensions/updated-by-user", "string": "rdxengine01" }
Use
string
https://api.redoxengine.com/extensions/use
DraftIdentifies 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
{ "url": "https://api.redoxengine.com/extensions/use", "string": "secondary" }
User ID
string
https://api.redoxengine.com/extensions/user-id
DraftThe identify of the user (name or ID) making the request.
Available in
DataModel Event Types Field PatientSearch * Meta
Clinical Summary * Meta
PatientAdmin * Meta
Example
{ "url": "https://api.redoxengine.com/extensions/user-id", "string": "Redox" }
User Role
coding
https://api.redoxengine.com/extensions/user-role
DraftStructural Role refer to [ASTM E1986-98 (2005)] and its OID representation.
Available in
DataModel Event Types Field 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
DraftThe coded entry representation of a result or observation value.
Available in
DataModel Event Types Field 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
DraftThe 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
{ "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
DraftThe amount of time spent in waiting area.
Available in
DataModel Event Types Field Clinical Summary PatientPush, VisitPush, PatientQueryResponse, VisitQueryResponse Encounters[]
Example
{ "url": "https://api.redoxengine.com/extensions/wait-time", "codeableConcept": { "coding": "", "text": "30 minutes" } }