Results
The Results data model is used to exchange discrete clinical data with an EHR system. This is typically useful for saving a one-off value to a patient’s chart, which usually is the result of an order of some kind. This data shows up wherever results are housed in the EHR system. Some common examples of data to exchange with the Results data model are listed below:
Labs
- general lab (discrete lab values)
- microbiology (discrete, structured lab data pertaining to antibiotic sensitivities)
- pathology (result reports after reviewing pathologic images)
Diagnostic imaging
- radiology (result reports after reviewing radiologic images)
- cardiology (result reports and/or discrete data after reviewing cardiology images)
- urology (urination tests)
- pulmonology (lung function test)
- neurology (EEGs and result reports)
- obstetrics (fetal echos and result reports)
Results data can be written as discrete data (e.g., lab values), text (e.g., pathology report), or other complex formats (e.g., PDF, JPEG, Word) to the EHR system, depending on their respective capability. If you're writing back a file, check out our recommendations for sending files.
The Results data model differs from the Flowsheet data model in that results are generally a one-time outcome of an order, whereas flowsheet data is continuous. Check out the Flowsheet data model if you want to regularly measure and report the same type of discrete data.
Results messages always have an event type of New. Individual result components can have specific statuses.
Fields
Meta
Meta.DataModel
String
ReliableRequiredResults
Meta.EventType
String
ReliableRequiredNew
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source system to Redox.
Included in requests from Redox.
Meta.Message.ID
Numeric
ReliableRetiredIdentifies the numeric value of the message created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to the destination endpoint.
Included in messages from Redox.
Meta.Transmission.ID
Numeric
ReliableRetiredIdentifies the numeric value of the transmission created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstName
String
PossibleFirst name of the contact
Patient.Contacts[].MiddleName
String
PossibleMiddle name of the contact
Patient.Contacts[].LastName
String
PossibleLast name of the contact
Patient.Contacts[].Address
Object
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddress
String
PossibleStreet address
Patient.Contacts[].Address.City
String
PossibleCity
Patient.Contacts[].Address.State
String
PossibleState
Patient.Contacts[].Address.ZIP
String
PossibleZIP
Patient.Contacts[].Address.County
String
PossibleCounty
Patient.Contacts[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].PhoneNumber.Home
String
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.Office
String
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatient
String
PossibleValueSetPersonal relationship to the patient
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].EmailAddresses[]
Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]
Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Orders
Orders[].ID
String
ReliableRequiredID assigned by the ordering system
Orders[].ApplicationOrderID
String
PossibleID assigned by the application fulfilling the order
Orders[].TransactionDateTime
String
ReliableDateTime at which the order status was updated.
ISO 8601 Format
Orders[].CollectionDateTime
String
ReliableDateTime at which the specimen was collected.
ISO 8601 Format
Orders[].CompletionDateTime
String
ProbableDate and time the results were composed into a report and released.
ISO 8601 Format
Orders[].Notes[]
Array of Strings
PossibleOrder-level notes
Orders[].ResultsStatus
String
ReliableValueSetCurrent overall status of the order
-
Additional values may be added by Redox in the future.
-
Orders[].Procedure
Object
ReliableProcedure associated with the results
Orders[].Procedure.Code
String
ReliableCode for the procedure
Orders[].Procedure.Codeset
String
ReliableCode set used to identify the procedure.
CPT, HCPCS, SNOMED, or LOINC. If no code set is specified, a health system specific identifier is being used.
Orders[].Procedure.Description
String
ReliableDescription of the procedure
Orders[].Provider.NPI
String
PossibleNPI of the ordering provider
Orders[].Provider.ID
String
PossibleID of the ordering provider.
This ID is often required for Inpatient Visits.
Orders[].Provider.IDType
String
PossibleID type of the ID for the ordering provider
Orders[].Provider.FirstName
String
PossibleFirst name of the ordering provider
Orders[].Provider.LastName
String
PossibleLast name of the ordering provider
Orders[].Provider.Credentials[]
Array of Strings
PossibleList of credentials for the ordering provider.
e.g. MD, PhD
Orders[].Provider.Address
Object
PossibleProvider's address
Orders[].Provider.Address.StreetAddress
String
PossibleStreet address
Orders[].Provider.Address.City
String
PossibleCity
Orders[].Provider.Address.State
String
PossibleState
Orders[].Provider.Address.ZIP
String
PossibleZIP
Orders[].Provider.Address.County
String
PossibleCounty
Orders[].Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Provider.Location
Object
PossibleProvider's location
Orders[].Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].Provider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.Department
String
PossibleDepartment
Orders[].Provider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.Room
String
PossibleRoom.
Example: 136
Orders[].ResultCopyProviders[]
Array of Objects
PossibleArray of providers to be copied on the results.
Orders[].ResultCopyProviders[].ID
String
PossibleID of the copied provider.
This ID is often required for Inpatient Visits.
Orders[].ResultCopyProviders[].IDType
String
PossibleID type of the ID for the copied provider
Orders[].ResultCopyProviders[].FirstName
String
PossibleFirst name of the copied provider
Orders[].ResultCopyProviders[].LastName
String
PossibleLast name of the copied provider
Orders[].ResultCopyProviders[].Credentials[]
Array of Strings
PossibleList of credentials for the copied provider.
e.g. MD, PhD
Orders[].ResultCopyProviders[].Address
Object
PossibleProvider's address
Orders[].ResultCopyProviders[].Address.StreetAddress
String
PossibleStreet address
Orders[].ResultCopyProviders[].Address.City
String
PossibleCity
Orders[].ResultCopyProviders[].Address.State
String
PossibleState
Orders[].ResultCopyProviders[].Address.ZIP
String
PossibleZIP
Orders[].ResultCopyProviders[].Address.County
String
PossibleCounty
Orders[].ResultCopyProviders[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].ResultCopyProviders[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].ResultCopyProviders[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].ResultCopyProviders[].Location
Object
PossibleProvider's location
Orders[].ResultCopyProviders[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].ResultCopyProviders[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.Department
String
PossibleDepartment
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.Room
String
PossibleRoom.
Example: 136
Orders[].Status
String
ReliableValueSetRequiredCurrent status of the order
-
Additional values may be added by Redox in the future.
-
Orders[].ResponseFlag
String
ProbableSpecificity of the response requested from the receiving system.
One of the following: "Acknowledgement", "Exceptions", "Replacements", "Associated Segments", "Confirmations" . This list is in increasing specificity, and the value selected will incorporate all previous options. Derived from HL7 Table 0121. The default value is "Associated Segments".
Orders[].Priority
String
ReliableValueSetPriority of the order
-
Additional values may be added by Redox in the future.
-
Orders[].Results[]
Array of Objects
ProbableList of result components and their values
Orders[].Results[].Code
String
ProbableRequiredCode for the result component
Orders[].Results[].Codeset
String
ProbableCode set used to identify the result component
Orders[].Results[].Description
String
ProbableDescription of the result component
Orders[].Results[].RelatedGroupID
String
ProbableID to group separate result components
Orders[].Results[].Specimen.Source
String
ProbableSource of the specimen
Orders[].Results[].Specimen.BodySite
String
ProbableBody site from which the specimen was collected
Orders[].Results[].Specimen.ID
String
PossibleID of the collected specimen
Orders[].Results[].Value
String
ReliableRequiredValue of the result component.
If ValueType is "Encapsulated Data" this field includes the Redox BLOB URI
Orders[].Results[].ValueType
String
ReliableValueSetRequiredData type for the result value
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].CompletionDateTime
String
PossibleDateTime at which the individual results were composed into a report and released.
Orders[].Results[].FileType
String
ReliableIf ValueType is "Encapsulated Data", this field includes the type of file.
E.g. PDF, JPG
Orders[].Results[].Units
String
ProbableUnits of the result
Orders[].Results[].Notes[]
Array of Strings
PossibleNotes about the result component/observation
Orders[].Results[].AbnormalFlag
String
ProbableValueSetIndication of whether the result was abnormal
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Status
String
ReliableValueSetCurrent status of the result
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].PrimaryResultsInterpreter.NPI
String
PossibleNPI of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.ID
String
PossibleID of the Primary Results Interpreter.
This ID is often required for Inpatient Visits.
Orders[].Results[].PrimaryResultsInterpreter.IDType
String
PossibleID type of the ID for the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.FirstName
String
PossibleFirst name of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.LastName
String
PossibleLast name of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.Credentials[]
Array of Strings
PossibleList of credentials for the Primary Results Interpreter.
e.g. MD, PhD
Orders[].Results[].PrimaryResultsInterpreter.Address
Object
PossibleProvider's address
Orders[].Results[].PrimaryResultsInterpreter.Address.StreetAddress
String
PossibleStreet address
Orders[].Results[].PrimaryResultsInterpreter.Address.City
String
PossibleCity
Orders[].Results[].PrimaryResultsInterpreter.Address.State
String
PossibleState
Orders[].Results[].PrimaryResultsInterpreter.Address.ZIP
String
PossibleZIP
Orders[].Results[].PrimaryResultsInterpreter.Address.County
String
PossibleCounty
Orders[].Results[].PrimaryResultsInterpreter.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].PrimaryResultsInterpreter.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].Results[].PrimaryResultsInterpreter.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].PrimaryResultsInterpreter.Location
Object
PossibleProvider's location
Orders[].Results[].PrimaryResultsInterpreter.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].PrimaryResultsInterpreter.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.Department
String
PossibleDepartment
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.Room
String
PossibleRoom.
Example: 136
Orders[].Results[].Producer.ID
String
PossibleID of the producer for this result.
The "Producer" is typically the Lab which did the resulting.
Orders[].Results[].Producer.Name
String
PossibleName of the producer
Orders[].Results[].Producer.IDType
String
PossibleID Type for the corresponding ID of this producer
Orders[].Results[].Producer.Address
Object
PossibleResult producer's address
Orders[].Results[].Producer.Address.StreetAddress
String
PossibleStreet address
Orders[].Results[].Producer.Address.City
String
PossibleCity
Orders[].Results[].Producer.Address.State
String
PossibleState
Orders[].Results[].Producer.Address.ZIP
String
PossibleZIP
Orders[].Results[].Producer.Address.County
String
PossibleCounty
Orders[].Results[].Producer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Performer.ID
String
PossibleID of the performer.
This ID is often required for Inpatient Visits.
Orders[].Results[].Performer.IDType
String
PossibleID type of the ID for the performer
Orders[].Results[].Performer.FirstName
String
PossibleFirst name of the performer
Orders[].Results[].Performer.LastName
String
PossibleLast name of the performer
Orders[].Results[].Performer.Credentials[]
Array of Strings
PossibleList of credentials for the performer.
e.g. MD, PhD
Orders[].Results[].Performer.Address
Object
PossibleProvider's address
Orders[].Results[].Performer.Address.StreetAddress
String
PossibleStreet address
Orders[].Results[].Performer.Address.City
String
PossibleCity
Orders[].Results[].Performer.Address.State
String
PossibleState
Orders[].Results[].Performer.Address.ZIP
String
PossibleZIP
Orders[].Results[].Performer.Address.County
String
PossibleCounty
Orders[].Results[].Performer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Performer.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].Results[].Performer.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].Performer.Location
Object
PossibleProvider's location
Orders[].Results[].Performer.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].Performer.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].Results[].Performer.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.Department
String
PossibleDepartment
Orders[].Results[].Performer.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.Room
String
PossibleRoom.
Example: 136
Orders[].Results[].ReferenceRange
Object
PossibleReference range for the result.
Numeric result values will use the low and high properties. Non-numeric result values will put the normal value in the text property.
Orders[].Results[].ReferenceRange.Low
Numeric
PossibleLower bound for a normal result
Orders[].Results[].ReferenceRange.High
Numeric
PossibleUpper bound for a normal result
Orders[].Results[].ReferenceRange.Text
String
PossibleThe normal value for non-numeric results
Orders[].Results[].ObservationMethod
Object
PossibleMethod used to obtain the observation. This field is used when an observation may be obtained by different methods and the sending system wishes to indicate which method was used.
Orders[].Results[].ObservationMethod.Code
String
PossibleCode for the observation method
Orders[].Results[].ObservationMethod.Codeset
String
PossibleCode set used to identify the observation method
Orders[].Results[].ObservationMethod.Description
String
PossibleDescription of the observation method
Visit
Visit
Object
PossibleInformation about the visit associated with the Result. In many cases, this will be the visit information from the originating Order.
Visit.VisitDateTime
String
PossibleDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.VisitNumber
String
PossibleVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
PossiblePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.Location
Object
PossibleLocation of the visit
Visit.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
PossibleDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location.Bed
String
PossibleBed.
Example: B
Visit.AttendingProvider.ID
String
PossibleID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
PossibleID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.AdditionalStaff[]
PossibleAll of the staff assigned to this visit. Each may be scheduled individually.
Visit.AdditionalStaff[].ID
String
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visit.AdditionalStaff[].IDType
String
ProbableID type of the ID for the Additional staff member
Visit.AdditionalStaff[].FirstName
String
PossibleFirst name of the Additional staff member
Visit.AdditionalStaff[].LastName
String
PossibleLast name of the Additional staff member
Visit.AdditionalStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Additional staff member.
e.g. MD, PhD
Visit.AdditionalStaff[].Address
Object
PossibleProvider's address
Visit.AdditionalStaff[].Address.StreetAddress
String
PossibleStreet address
Visit.AdditionalStaff[].Address.City
String
PossibleCity
Visit.AdditionalStaff[].Address.State
String
PossibleState
Visit.AdditionalStaff[].Address.ZIP
String
PossibleZIP
Visit.AdditionalStaff[].Address.County
String
PossibleCounty
Visit.AdditionalStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdditionalStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdditionalStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdditionalStaff[].Location
Object
PossibleProvider's location
Visit.AdditionalStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdditionalStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdditionalStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Department
String
PossibleDepartment
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Room
String
PossibleRoom.
Example: 136
Visit.AdditionalStaff[].Role
Object
ProbableThe role of this person in the visit.
Visit.AdditionalStaff[].Role.Code
String
ProbableCode for the service
Visit.AdditionalStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visit.AdditionalStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
{
"Meta": {
"DataModel": "Results",
"EventType": "New",
"EventDateTime": "2023-03-31T14:30:11.564Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"[email protected]"
],
"Roles": [
"Emergency Contact"
]
}
]
},
"Orders": [
{
"ID": "157968300",
"ApplicationOrderID": null,
"TransactionDateTime": "2015-05-06T06:00:58.872Z",
"CollectionDateTime": "2015-05-06T06:00:58.872Z",
"CompletionDateTime": "2015-05-06T06:00:58.872Z",
"Notes": [],
"ResultsStatus": "Final",
"Procedure": {
"Code": "49086-2",
"Codeset": null,
"Description": "First trimester maternal screen with nuchal translucency panel"
},
"Provider": {
"NPI": "4356789876",
"ID": null,
"IDType": null,
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ResultCopyProviders": [],
"Status": "Resulted",
"ResponseFlag": "Associated Segments",
"Priority": "Stat",
"Results": [
{
"Code": "TEST0001",
"Codeset": null,
"Description": "Cystic Fibrosis",
"RelatedGroupID": null,
"Specimen": {
"Source": null,
"BodySite": null,
"ID": null
},
"Value": "Positive Result",
"ValueType": "String",
"CompletionDateTime": null,
"FileType": null,
"Units": null,
"Notes": [
"This individual is a carrier for Cystic Fibrosis."
],
"AbnormalFlag": "Very Abnormal",
"Status": "Final",
"PrimaryResultsInterpreter": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Performer": {
"ID": null,
"IDType": null,
"FirstName": "Bob",
"LastName": "Smith",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
},
"ObservationMethod": {
"Code": null,
"Codeset": null,
"Description": null
}
},
{
"Code": "TEST0004",
"Codeset": null,
"Description": "Primary Carnitine Deficiency",
"RelatedGroupID": null,
"Specimen": {
"Source": null,
"BodySite": null,
"ID": null
},
"Value": "Negative Result",
"ValueType": "String",
"CompletionDateTime": null,
"FileType": null,
"Units": null,
"Notes": [],
"AbnormalFlag": "Normal",
"Status": "Final",
"PrimaryResultsInterpreter": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Performer": {
"ID": null,
"IDType": null,
"FirstName": "Bob",
"LastName": "Smith",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
},
"ObservationMethod": {
"Code": null,
"Codeset": null,
"Description": null
}
}
]
}
],
"Visit": {
"VisitDateTime": null,
"VisitNumber": null,
"AccountNumber": null,
"PatientClass": null,
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null,
"Bed": null
},
"AttendingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"AdditionalStaff": []
}
}
Unsolicited results occur when your application has not previously received an electronic order from the EHR through the Orders data model for the order you are now resulting. It is identical to the Results-New event, except that the EHR order ID (Orders[].ID) is not required, and your ID for the order (Orders[].ApplicationOrderID) is required.
Fields
Meta
Meta.DataModel
String
ReliableRequiredResults
Meta.EventType
String
ReliableRequiredNewUnsolicited
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source system to Redox.
Included in requests from Redox.
Meta.Message.ID
Numeric
ReliableRetiredIdentifies the numeric value of the message created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to the destination endpoint.
Included in messages from Redox.
Meta.Transmission.ID
Numeric
ReliableRetiredIdentifies the numeric value of the transmission created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableRequiredID for the patient
Patient.Identifiers[].IDType
String
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstName
String
PossibleFirst name of the contact
Patient.Contacts[].MiddleName
String
PossibleMiddle name of the contact
Patient.Contacts[].LastName
String
PossibleLast name of the contact
Patient.Contacts[].Address
Object
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddress
String
PossibleStreet address
Patient.Contacts[].Address.City
String
PossibleCity
Patient.Contacts[].Address.State
String
PossibleState
Patient.Contacts[].Address.ZIP
String
PossibleZIP
Patient.Contacts[].Address.County
String
PossibleCounty
Patient.Contacts[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].PhoneNumber.Home
String
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.Office
String
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.Mobile
String
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatient
String
PossibleValueSetPersonal relationship to the patient
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].EmailAddresses[]
Array of string
PossibleEmail address(es) of the contact person
Patient.Contacts[].Roles[]
Array of strings
PossibleRole of this contact for the patient.
e.x. Employer, Emergency Contact
Orders
Orders[].ID
String
ReliableID assigned by the ordering system
Orders[].ApplicationOrderID
String
PossibleRequiredID assigned by the application fulfilling the order
Orders[].TransactionDateTime
String
ReliableDateTime at which the order status was updated.
ISO 8601 Format
Orders[].CollectionDateTime
String
ReliableDateTime at which the specimen was collected.
ISO 8601 Format
Orders[].CompletionDateTime
String
ProbableDate and time the results were composed into a report and released.
ISO 8601 Format
Orders[].Notes[]
Array of Strings
PossibleOrder-level notes
Orders[].ResultsStatus
String
ReliableValueSetCurrent overall status of the order
-
Additional values may be added by Redox in the future.
-
Orders[].Procedure
Object
ReliableProcedure associated with the results
Orders[].Procedure.Code
String
ReliableCode for the procedure
Orders[].Procedure.Codeset
String
ReliableCode set used to identify the procedure.
CPT, HCPCS, SNOMED, or LOINC. If no code set is specified, a health system specific identifier is being used.
Orders[].Procedure.Description
String
ReliableDescription of the procedure
Orders[].Provider.NPI
String
PossibleNPI of the ordering provider
Orders[].Provider.ID
String
PossibleID of the ordering provider.
This ID is often required for Inpatient Visits.
Orders[].Provider.IDType
String
PossibleID type of the ID for the ordering provider
Orders[].Provider.FirstName
String
PossibleFirst name of the ordering provider
Orders[].Provider.LastName
String
PossibleLast name of the ordering provider
Orders[].Provider.Credentials[]
Array of Strings
PossibleList of credentials for the ordering provider.
e.g. MD, PhD
Orders[].Provider.Address
Object
PossibleProvider's address
Orders[].Provider.Address.StreetAddress
String
PossibleStreet address
Orders[].Provider.Address.City
String
PossibleCity
Orders[].Provider.Address.State
String
PossibleState
Orders[].Provider.Address.ZIP
String
PossibleZIP
Orders[].Provider.Address.County
String
PossibleCounty
Orders[].Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Provider.Location
Object
PossibleProvider's location
Orders[].Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].Provider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.Department
String
PossibleDepartment
Orders[].Provider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.Room
String
PossibleRoom.
Example: 136
Orders[].ResultCopyProviders[]
Array of Objects
PossibleArray of providers to be copied on the results.
Orders[].ResultCopyProviders[].ID
String
PossibleID of the copied provider.
This ID is often required for Inpatient Visits.
Orders[].ResultCopyProviders[].IDType
String
PossibleID type of the ID for the copied provider
Orders[].ResultCopyProviders[].FirstName
String
PossibleFirst name of the copied provider
Orders[].ResultCopyProviders[].LastName
String
PossibleLast name of the copied provider
Orders[].ResultCopyProviders[].Credentials[]
Array of Strings
PossibleList of credentials for the copied provider.
e.g. MD, PhD
Orders[].ResultCopyProviders[].Address
Object
PossibleProvider's address
Orders[].ResultCopyProviders[].Address.StreetAddress
String
PossibleStreet address
Orders[].ResultCopyProviders[].Address.City
String
PossibleCity
Orders[].ResultCopyProviders[].Address.State
String
PossibleState
Orders[].ResultCopyProviders[].Address.ZIP
String
PossibleZIP
Orders[].ResultCopyProviders[].Address.County
String
PossibleCounty
Orders[].ResultCopyProviders[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].ResultCopyProviders[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].ResultCopyProviders[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].ResultCopyProviders[].Location
Object
PossibleProvider's location
Orders[].ResultCopyProviders[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].ResultCopyProviders[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.Department
String
PossibleDepartment
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.Room
String
PossibleRoom.
Example: 136
Orders[].Status
String
ReliableValueSetRequiredCurrent status of the order
-
Additional values may be added by Redox in the future.
-
Orders[].ResponseFlag
String
ProbableSpecificity of the response requested from the receiving system.
One of the following: "Acknowledgement", "Exceptions", "Replacements", "Associated Segments", "Confirmations" . This list is in increasing specificity, and the value selected will incorporate all previous options. Derived from HL7 Table 0121. The default value is "Associated Segments".
Orders[].Priority
String
ReliableValueSetPriority of the order
-
Additional values may be added by Redox in the future.
-
Orders[].Results[]
Array of Objects
ProbableList of result components and their values
Orders[].Results[].Code
String
ProbableRequiredCode for the result component
Orders[].Results[].Codeset
String
ProbableCode set used to identify the result component
Orders[].Results[].Description
String
ProbableDescription of the result component
Orders[].Results[].RelatedGroupID
String
ProbableID to group separate result components
Orders[].Results[].Specimen.Source
String
ProbableSource of the specimen
Orders[].Results[].Specimen.BodySite
String
ProbableBody site from which the specimen was collected
Orders[].Results[].Specimen.ID
String
PossibleID of the collected specimen
Orders[].Results[].Value
String
ReliableRequiredValue of the result component.
If ValueType is "Encapsulated Data" this field includes the Redox BLOB URI
Orders[].Results[].ValueType
String
ReliableValueSetRequiredData type for the result value
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].CompletionDateTime
String
PossibleDateTime at which the individual results were composed into a report and released.
Orders[].Results[].FileType
String
ReliableIf ValueType is "Encapsulated Data", this field includes the type of file.
E.g. PDF, JPG
Orders[].Results[].Units
String
ProbableUnits of the result
Orders[].Results[].Notes[]
Array of Strings
PossibleNotes about the result component/observation
Orders[].Results[].AbnormalFlag
String
ProbableValueSetIndication of whether the result was abnormal
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Status
String
ReliableValueSetCurrent status of the result
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].PrimaryResultsInterpreter.NPI
String
PossibleNPI of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.ID
String
PossibleID of the Primary Results Interpreter.
This ID is often required for Inpatient Visits.
Orders[].Results[].PrimaryResultsInterpreter.IDType
String
PossibleID type of the ID for the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.FirstName
String
PossibleFirst name of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.LastName
String
PossibleLast name of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.Credentials[]
Array of Strings
PossibleList of credentials for the Primary Results Interpreter.
e.g. MD, PhD
Orders[].Results[].PrimaryResultsInterpreter.Address
Object
PossibleProvider's address
Orders[].Results[].PrimaryResultsInterpreter.Address.StreetAddress
String
PossibleStreet address
Orders[].Results[].PrimaryResultsInterpreter.Address.City
String
PossibleCity
Orders[].Results[].PrimaryResultsInterpreter.Address.State
String
PossibleState
Orders[].Results[].PrimaryResultsInterpreter.Address.ZIP
String
PossibleZIP
Orders[].Results[].PrimaryResultsInterpreter.Address.County
String
PossibleCounty
Orders[].Results[].PrimaryResultsInterpreter.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].PrimaryResultsInterpreter.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].Results[].PrimaryResultsInterpreter.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].PrimaryResultsInterpreter.Location
Object
PossibleProvider's location
Orders[].Results[].PrimaryResultsInterpreter.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].PrimaryResultsInterpreter.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.Department
String
PossibleDepartment
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.Room
String
PossibleRoom.
Example: 136
Orders[].Results[].Producer.ID
String
PossibleID of the producer for this result.
The "Producer" is typically the Lab which did the resulting.
Orders[].Results[].Producer.Name
String
PossibleName of the producer
Orders[].Results[].Producer.IDType
String
PossibleID Type for the corresponding ID of this producer
Orders[].Results[].Producer.Address
Object
PossibleResult producer's address
Orders[].Results[].Producer.Address.StreetAddress
String
PossibleStreet address
Orders[].Results[].Producer.Address.City
String
PossibleCity
Orders[].Results[].Producer.Address.State
String
PossibleState
Orders[].Results[].Producer.Address.ZIP
String
PossibleZIP
Orders[].Results[].Producer.Address.County
String
PossibleCounty
Orders[].Results[].Producer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Performer.ID
String
PossibleID of the performer.
This ID is often required for Inpatient Visits.
Orders[].Results[].Performer.IDType
String
PossibleID type of the ID for the performer
Orders[].Results[].Performer.FirstName
String
PossibleFirst name of the performer
Orders[].Results[].Performer.LastName
String
PossibleLast name of the performer
Orders[].Results[].Performer.Credentials[]
Array of Strings
PossibleList of credentials for the performer.
e.g. MD, PhD
Orders[].Results[].Performer.Address
Object
PossibleProvider's address
Orders[].Results[].Performer.Address.StreetAddress
String
PossibleStreet address
Orders[].Results[].Performer.Address.City
String
PossibleCity
Orders[].Results[].Performer.Address.State
String
PossibleState
Orders[].Results[].Performer.Address.ZIP
String
PossibleZIP
Orders[].Results[].Performer.Address.County
String
PossibleCounty
Orders[].Results[].Performer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Performer.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].Results[].Performer.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].Performer.Location
Object
PossibleProvider's location
Orders[].Results[].Performer.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].Performer.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].Results[].Performer.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.Department
String
PossibleDepartment
Orders[].Results[].Performer.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.Room
String
PossibleRoom.
Example: 136
Orders[].Results[].ReferenceRange
Object
PossibleReference range for the result.
Numeric result values will use the low and high properties. Non-numeric result values will put the normal value in the text property.
Orders[].Results[].ReferenceRange.Low
Numeric
PossibleLower bound for a normal result
Orders[].Results[].ReferenceRange.High
Numeric
PossibleUpper bound for a normal result
Orders[].Results[].ReferenceRange.Text
String
PossibleThe normal value for non-numeric results
Orders[].Results[].ObservationMethod
Object
PossibleMethod used to obtain the observation. This field is used when an observation may be obtained by different methods and the sending system wishes to indicate which method was used.
Orders[].Results[].ObservationMethod.Code
String
PossibleCode for the observation method
Orders[].Results[].ObservationMethod.Codeset
String
PossibleCode set used to identify the observation method
Orders[].Results[].ObservationMethod.Description
String
PossibleDescription of the observation method
Visit
Visit
Object
PossibleInformation about the visit associated with the Result. In many cases, this will be the visit information from the originating Order.
Visit.VisitDateTime
String
PossibleDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.VisitNumber
String
PossibleVisit Number.
Unique ID of a single visit
Visit.AccountNumber
String
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClass
String
PossiblePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.Location
Object
PossibleLocation of the visit
Visit.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Department
String
PossibleDepartment
Visit.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.Room
String
PossibleRoom.
Example: 136
Visit.Location.Bed
String
PossibleBed.
Example: B
Visit.AttendingProvider.ID
String
PossibleID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDType
String
PossibleID type of the ID for the attending provider
Visit.AttendingProvider.FirstName
String
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastName
String
PossibleLast name of the attending provider
Visit.AttendingProvider.Credentials[]
Array of Strings
PossibleList of credentials for the attending provider.
e.g. MD, PhD
Visit.AttendingProvider.Address
Object
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddress
String
PossibleStreet address
Visit.AttendingProvider.Address.City
String
PossibleCity
Visit.AttendingProvider.Address.State
String
PossibleState
Visit.AttendingProvider.Address.ZIP
String
PossibleZIP
Visit.AttendingProvider.Address.County
String
PossibleCounty
Visit.AttendingProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AttendingProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AttendingProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.Location
Object
PossibleProvider's location
Visit.AttendingProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Department
String
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.ReferringProvider.ID
String
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDType
String
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstName
String
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastName
String
PossibleLast name of the referring provider
Visit.ReferringProvider.Credentials[]
Array of Strings
PossibleList of credentials for the referring provider.
e.g. MD, PhD
Visit.ReferringProvider.Address
Object
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddress
String
PossibleStreet address
Visit.ReferringProvider.Address.City
String
PossibleCity
Visit.ReferringProvider.Address.State
String
PossibleState
Visit.ReferringProvider.Address.ZIP
String
PossibleZIP
Visit.ReferringProvider.Address.County
String
PossibleCounty
Visit.ReferringProvider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.ReferringProvider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.ReferringProvider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.Location
Object
PossibleProvider's location
Visit.ReferringProvider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Department
String
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.Room
String
PossibleRoom.
Example: 136
Visit.AdditionalStaff[]
PossibleAll of the staff assigned to this visit. Each may be scheduled individually.
Visit.AdditionalStaff[].ID
String
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visit.AdditionalStaff[].IDType
String
ProbableID type of the ID for the Additional staff member
Visit.AdditionalStaff[].FirstName
String
PossibleFirst name of the Additional staff member
Visit.AdditionalStaff[].LastName
String
PossibleLast name of the Additional staff member
Visit.AdditionalStaff[].Credentials[]
Array of Strings
PossibleList of credentials for the Additional staff member.
e.g. MD, PhD
Visit.AdditionalStaff[].Address
Object
PossibleProvider's address
Visit.AdditionalStaff[].Address.StreetAddress
String
PossibleStreet address
Visit.AdditionalStaff[].Address.City
String
PossibleCity
Visit.AdditionalStaff[].Address.State
String
PossibleState
Visit.AdditionalStaff[].Address.ZIP
String
PossibleZIP
Visit.AdditionalStaff[].Address.County
String
PossibleCounty
Visit.AdditionalStaff[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Visit.AdditionalStaff[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Visit.AdditionalStaff[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdditionalStaff[].Location
Object
PossibleProvider's location
Visit.AdditionalStaff[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdditionalStaff[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Visit.AdditionalStaff[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Department
String
PossibleDepartment
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.Room
String
PossibleRoom.
Example: 136
Visit.AdditionalStaff[].Role
Object
ProbableThe role of this person in the visit.
Visit.AdditionalStaff[].Role.Code
String
ProbableCode for the service
Visit.AdditionalStaff[].Role.Codeset
String
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visit.AdditionalStaff[].Role.Description
String
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
{
"Meta": {
"DataModel": "Results",
"EventType": "NewUnsolicited",
"EventDateTime": "2023-03-31T14:30:11.564Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
"IDType": "EHRID"
},
{
"ID": "a1d4ee8aba494ca",
"IDType": "NIST"
}
],
"Demographics": {
"FirstName": "Timothy",
"MiddleName": "Paul",
"LastName": "Bixby",
"DOB": "2008-01-06",
"SSN": "101-01-0001",
"Sex": "Male",
"Race": "White",
"IsHispanic": null,
"Religion": null,
"MaritalStatus": "Single",
"IsDeceased": null,
"DeathDateTime": null,
"PhoneNumber": {
"Home": "+18088675301",
"Office": null,
"Mobile": null
},
"EmailAddresses": [],
"Language": "en",
"Citizenship": [],
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
}
},
"Notes": [],
"Contacts": [
{
"FirstName": "Barbara",
"MiddleName": null,
"LastName": "Bixby",
"Address": {
"StreetAddress": "4762 Hickory Street",
"City": "Monroe",
"State": "WI",
"ZIP": "53566",
"County": "Green",
"Country": "US"
},
"PhoneNumber": {
"Home": "+18088675303",
"Office": "+17077543758",
"Mobile": "+19189368865"
},
"RelationToPatient": "Mother",
"EmailAddresses": [
"[email protected]"
],
"Roles": [
"Emergency Contact"
]
}
]
},
"Orders": [
{
"ID": null,
"ApplicationOrderID": "1234",
"TransactionDateTime": "2015-05-06T06:00:58.872Z",
"CollectionDateTime": "2015-05-06T06:00:58.872Z",
"CompletionDateTime": "2015-05-06T06:00:58.872Z",
"Notes": [],
"ResultsStatus": "Final",
"Procedure": {
"Code": "49086-2",
"Codeset": null,
"Description": "First trimester maternal screen with nuchal translucency panel"
},
"Provider": {
"NPI": "4356789876",
"ID": null,
"IDType": null,
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ResultCopyProviders": [],
"Status": "Resulted",
"ResponseFlag": "Associated Segments",
"Priority": "Stat",
"Results": [
{
"Code": "TEST0001",
"Codeset": null,
"Description": "Cystic Fibrosis",
"RelatedGroupID": null,
"Specimen": {
"Source": null,
"BodySite": null,
"ID": null
},
"Value": "Positive Result",
"ValueType": "String",
"CompletionDateTime": null,
"FileType": null,
"Units": null,
"Notes": [
"This individual is a carrier for Cystic Fibrosis."
],
"AbnormalFlag": "Very Abnormal",
"Status": "Final",
"PrimaryResultsInterpreter": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Performer": {
"ID": null,
"IDType": null,
"FirstName": "Bob",
"LastName": "Smith",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
},
"ObservationMethod": {
"Code": null,
"Codeset": null,
"Description": null
}
},
{
"Code": "TEST0004",
"Codeset": null,
"Description": "Primary Carnitine Deficiency",
"RelatedGroupID": null,
"Specimen": {
"Source": null,
"BodySite": null,
"ID": null
},
"Value": "Negative Result",
"ValueType": "String",
"CompletionDateTime": null,
"FileType": null,
"Units": null,
"Notes": [],
"AbnormalFlag": "Normal",
"Status": "Final",
"PrimaryResultsInterpreter": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Performer": {
"ID": null,
"IDType": null,
"FirstName": "Bob",
"LastName": "Smith",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
},
"ObservationMethod": {
"Code": null,
"Codeset": null,
"Description": null
}
}
]
}
],
"Visit": {
"VisitDateTime": null,
"VisitNumber": null,
"AccountNumber": null,
"PatientClass": null,
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null,
"Bed": null
},
"AttendingProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferringProvider": {
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"AdditionalStaff": []
}
}
This query finds and returns results that match the query criteria. The response for this query is the Results:QueryResponse event type.
When using this query, the required elements and populated response will be variable depending on the system you are integrating with. Your Redox team will provide details on which elements are required by the EHR during your install process.
When multiple criteria are specified, all provided criteria must match for results to be returned.
Fields
Meta
Meta.DataModel
String
ReliableRequiredResults
Meta.EventType
String
ReliableRequiredQuery
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source system to Redox.
Included in requests from Redox.
Meta.Message.ID
Numeric
ReliableRetiredIdentifies the numeric value of the message created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to the destination endpoint.
Included in messages from Redox.
Meta.Transmission.ID
Numeric
ReliableRetiredIdentifies the numeric value of the transmission created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Patients
Patients[]
Array of Objects
ReliableArray of patients to filter results on.
If multiple patients are provided, all results associated with any of the patients will be returned.
Patients[].Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient.
If multiple identifiers are provided, only patients with all identifiers will be considered.
Patients[].Identifiers[].ID
String
ReliableID for the patient
Patients[].Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Completion
Completion
String
ProbableTime range to search for results. The query will be over the DateTime at which the individual results were composed into a report and released.
ISO 8601 Format
Completion.StartDateTime
String
ProbableStart of the time range to search for results.
ISO 8601 Format
Completion.EndDateTime
String
ProbableEnd of the time range to search for results.
ISO 8601 Format
ResultStatuses
ResultStatuses[]
String
ProbableValueSetArray of result statuses to filter queries by.
-
Additional values may be added by Redox in the future.
-
OrderIDs
OrderIDs[]
String
ProbableArray of order IDs assigned by the ordering system to filter queries by.
If multiple orders are provided, all results associated with any of the orders will be returned.
Procedures
Procedures[]
String
ProbableArray of procedures to query for related results.
All results associated with any of the procedure codes provided will be returned.
Procedures[].Code
String
ProbableCode for the procedure
Procedures[].Codeset
String
ProbableValueSetCode set used to identify the procedure
-
Additional values may be added by Redox in the future.
-
Location
Location.Department
String
PossibleID corresponding to the department from which to retrieved the patient chart.
This field is required for some EHRs.
LastUpdated
LastUpdated
Object
ProbableAn alternative time range to search for results. Instead of querying over a clinically relevant timestamp like Completion, this searches over database update timestamps.
Timestamps are in ISO 8601 Format
LastUpdated.StartDateTime
String
ProbableAllows for searching on updated time of results. This is the start of the time range to search in.
ISO 8601 Format
LastUpdated.EndDateTime
String
ProbableAllows for searching on updated time of results. This is the end of the time range to search in.
ISO 8601 Format
{
"Meta": {
"DataModel": "Results",
"EventType": "Query",
"EventDateTime": "2023-03-31T14:30:11.564Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"FacilityCode": null
},
"Patients": [
{
"Identifiers": [
{
"ID": "000000001",
"IDType": "MRN"
}
]
}
],
"Completion": {
"StartDateTime": "2015-05-06T06:00:00.000Z",
"EndDateTime": "2015-05-06T07:00:00.000Z"
},
"ResultStatuses": [
"Final"
],
"OrderIDs": [
"123",
"456",
"789"
],
"Procedures": [],
"Location": {
"Department": null
},
"LastUpdated": {
"StartDateTime": null,
"EndDateTime": null
}
}
This is the format of the response you will receive for a Results:Query.
Fields
Meta
Meta.DataModel
String
ReliableRequiredResults
Meta.EventType
String
ReliableRequiredQueryResponse
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.Message
String
ReliableRecord in Redox that corresponds to the communication sent from the source system to Redox.
Included in requests from Redox.
Meta.Message.ID
Numeric
ReliableRetiredIdentifies the numeric value of the message created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.Transmission
String
ReliableRecord in Redox that corresponds to the communication sent from Redox to the destination endpoint.
Included in messages from Redox.
Meta.Transmission.ID
Numeric
ReliableRetiredIdentifies the numeric value of the transmission created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Orders
Orders[].Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Orders[].Patient.Identifiers[].ID
String
ReliableID for the patient
Orders[].Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Orders[].Visit.VisitNumber
String
ReliableVisit Number.
Unique ID of the visit this order was placed within
Orders[].LastUpdated
String
ProbableThe last time the order was updated. This timestamp is not clinically relevant but indicates when the order was last updated in the database.
ISO 8601 Format
Orders[].ID
String
ReliableID assigned by the ordering system
Orders[].ApplicationOrderID
String
PossibleID assigned by the application fulfilling the order
Orders[].TransactionDateTime
String
ReliableDateTime at which the order status was updated.
ISO 8601 Format
Orders[].CollectionDateTime
String
ReliableDateTime at which the specimen was collected.
ISO 8601 Format
Orders[].CompletionDateTime
String
ProbableDate and time the results were composed into a report and released.
ISO 8601 Format
Orders[].Notes[]
Array of Strings
PossibleOrder-level notes
Orders[].ResultsStatus
String
ReliableValueSetCurrent overall status of the order
-
Additional values may be added by Redox in the future.
-
Orders[].Procedure
Object
ReliableProcedure associated with the results
Orders[].Procedure.Code
String
ReliableCode for the procedure
Orders[].Procedure.Codeset
String
ReliableCode set used to identify the procedure.
CPT, HCPCS, SNOMED, or LOINC. If no code set is specified, a health system specific identifier is being used.
Orders[].Procedure.Description
String
ReliableDescription of the procedure
Orders[].Provider.NPI
String
PossibleNPI of the ordering provider
Orders[].Provider.ID
String
PossibleID of the ordering provider.
This ID is often required for Inpatient Visits.
Orders[].Provider.IDType
String
PossibleID type of the ID for the ordering provider
Orders[].Provider.FirstName
String
PossibleFirst name of the ordering provider
Orders[].Provider.LastName
String
PossibleLast name of the ordering provider
Orders[].Provider.Credentials[]
Array of Strings
PossibleList of credentials for the ordering provider.
e.g. MD, PhD
Orders[].Provider.Address
Object
PossibleProvider's address
Orders[].Provider.Address.StreetAddress
String
PossibleStreet address
Orders[].Provider.Address.City
String
PossibleCity
Orders[].Provider.Address.State
String
PossibleState
Orders[].Provider.Address.ZIP
String
PossibleZIP
Orders[].Provider.Address.County
String
PossibleCounty
Orders[].Provider.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Provider.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].Provider.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Provider.Location
Object
PossibleProvider's location
Orders[].Provider.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Provider.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].Provider.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.Department
String
PossibleDepartment
Orders[].Provider.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.Room
String
PossibleRoom.
Example: 136
Orders[].ResultCopyProviders[]
Array of Objects
PossibleArray of providers to be copied on the results.
Orders[].ResultCopyProviders[].ID
String
PossibleID of the copied provider.
This ID is often required for Inpatient Visits.
Orders[].ResultCopyProviders[].IDType
String
PossibleID type of the ID for the copied provider
Orders[].ResultCopyProviders[].FirstName
String
PossibleFirst name of the copied provider
Orders[].ResultCopyProviders[].LastName
String
PossibleLast name of the copied provider
Orders[].ResultCopyProviders[].Credentials[]
Array of Strings
PossibleList of credentials for the copied provider.
e.g. MD, PhD
Orders[].ResultCopyProviders[].Address
Object
PossibleProvider's address
Orders[].ResultCopyProviders[].Address.StreetAddress
String
PossibleStreet address
Orders[].ResultCopyProviders[].Address.City
String
PossibleCity
Orders[].ResultCopyProviders[].Address.State
String
PossibleState
Orders[].ResultCopyProviders[].Address.ZIP
String
PossibleZIP
Orders[].ResultCopyProviders[].Address.County
String
PossibleCounty
Orders[].ResultCopyProviders[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].ResultCopyProviders[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].ResultCopyProviders[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].ResultCopyProviders[].Location
Object
PossibleProvider's location
Orders[].ResultCopyProviders[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].ResultCopyProviders[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.Department
String
PossibleDepartment
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.Room
String
PossibleRoom.
Example: 136
Orders[].Status
String
ReliableValueSetCurrent status of the order
-
Additional values may be added by Redox in the future.
-
Orders[].ResponseFlag
String
ProbableSpecificity of the response requested from the receiving system.
One of the following: "Acknowledgement", "Exceptions", "Replacements", "Associated Segments", "Confirmations" . This list is in increasing specificity, and the value selected will incorporate all previous options. Derived from HL7 Table 0121. The default value is "Associated Segments".
Orders[].Priority
String
ReliableValueSetPriority of the order
-
Additional values may be added by Redox in the future.
-
Orders[].Results[]
Array of Objects
ProbableList of result components and their values
Orders[].Results[].Code
String
ProbableCode for the result component
Orders[].Results[].Codeset
String
ProbableCode set used to identify the result component
Orders[].Results[].Description
String
ProbableDescription of the result component
Orders[].Results[].RelatedGroupID
String
ProbableID to group separate result components
Orders[].Results[].Specimen.Source
String
ProbableSource of the specimen
Orders[].Results[].Specimen.BodySite
String
ProbableBody site from which the specimen was collected
Orders[].Results[].Specimen.ID
String
PossibleID of the collected specimen
Orders[].Results[].Value
String
ReliableValue of the result component.
If ValueType is "Encapsulated Data" this field includes the Redox BLOB URI
Orders[].Results[].ValueType
String
ReliableValueSetData type for the result value
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].CompletionDateTime
String
PossibleDateTime at which the individual results were composed into a report and released.
Orders[].Results[].FileType
String
ReliableIf ValueType is "Encapsulated Data", this field includes the type of file.
E.g. PDF, JPG
Orders[].Results[].Units
String
ProbableUnits of the result
Orders[].Results[].Notes[]
Array of Strings
PossibleNotes about the result component/observation
Orders[].Results[].AbnormalFlag
String
ProbableValueSetIndication of whether the result was abnormal
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Status
String
ReliableValueSetCurrent status of the result
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].PrimaryResultsInterpreter.NPI
String
PossibleNPI of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.ID
String
PossibleID of the Primary Results Interpreter.
This ID is often required for Inpatient Visits.
Orders[].Results[].PrimaryResultsInterpreter.IDType
String
PossibleID type of the ID for the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.FirstName
String
PossibleFirst name of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.LastName
String
PossibleLast name of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.Credentials[]
Array of Strings
PossibleList of credentials for the Primary Results Interpreter.
e.g. MD, PhD
Orders[].Results[].PrimaryResultsInterpreter.Address
Object
PossibleProvider's address
Orders[].Results[].PrimaryResultsInterpreter.Address.StreetAddress
String
PossibleStreet address
Orders[].Results[].PrimaryResultsInterpreter.Address.City
String
PossibleCity
Orders[].Results[].PrimaryResultsInterpreter.Address.State
String
PossibleState
Orders[].Results[].PrimaryResultsInterpreter.Address.ZIP
String
PossibleZIP
Orders[].Results[].PrimaryResultsInterpreter.Address.County
String
PossibleCounty
Orders[].Results[].PrimaryResultsInterpreter.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].PrimaryResultsInterpreter.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].Results[].PrimaryResultsInterpreter.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].PrimaryResultsInterpreter.Location
Object
PossibleProvider's location
Orders[].Results[].PrimaryResultsInterpreter.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].PrimaryResultsInterpreter.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.Department
String
PossibleDepartment
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.Room
String
PossibleRoom.
Example: 136
Orders[].Results[].Producer.ID
String
PossibleID of the producer for this result.
The "Producer" is typically the Lab which did the resulting.
Orders[].Results[].Producer.Name
String
PossibleName of the producer
Orders[].Results[].Producer.IDType
String
PossibleID Type for the corresponding ID of this producer
Orders[].Results[].Producer.Address
Object
PossibleResult producer's address
Orders[].Results[].Producer.Address.StreetAddress
String
PossibleStreet address
Orders[].Results[].Producer.Address.City
String
PossibleCity
Orders[].Results[].Producer.Address.State
String
PossibleState
Orders[].Results[].Producer.Address.ZIP
String
PossibleZIP
Orders[].Results[].Producer.Address.County
String
PossibleCounty
Orders[].Results[].Producer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Performer.ID
String
PossibleID of the performer.
This ID is often required for Inpatient Visits.
Orders[].Results[].Performer.IDType
String
PossibleID type of the ID for the performer
Orders[].Results[].Performer.FirstName
String
PossibleFirst name of the performer
Orders[].Results[].Performer.LastName
String
PossibleLast name of the performer
Orders[].Results[].Performer.Credentials[]
Array of Strings
PossibleList of credentials for the performer.
e.g. MD, PhD
Orders[].Results[].Performer.Address
Object
PossibleProvider's address
Orders[].Results[].Performer.Address.StreetAddress
String
PossibleStreet address
Orders[].Results[].Performer.Address.City
String
PossibleCity
Orders[].Results[].Performer.Address.State
String
PossibleState
Orders[].Results[].Performer.Address.ZIP
String
PossibleZIP
Orders[].Results[].Performer.Address.County
String
PossibleCounty
Orders[].Results[].Performer.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Performer.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Orders[].Results[].Performer.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].Performer.Location
Object
PossibleProvider's location
Orders[].Results[].Performer.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].Performer.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Orders[].Results[].Performer.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.Department
String
PossibleDepartment
Orders[].Results[].Performer.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.Room
String
PossibleRoom.
Example: 136
Orders[].Results[].ReferenceRange
Object
PossibleReference range for the result.
Numeric result values will use the low and high properties. Non-numeric result values will put the normal value in the text property.
Orders[].Results[].ReferenceRange.Low
Numeric
PossibleLower bound for a normal result
Orders[].Results[].ReferenceRange.High
Numeric
PossibleUpper bound for a normal result
Orders[].Results[].ReferenceRange.Text
String
PossibleThe normal value for non-numeric results
Orders[].Results[].ObservationMethod
Object
PossibleMethod used to obtain the observation. This field is used when an observation may be obtained by different methods and the sending system wishes to indicate which method was used.
Orders[].Results[].ObservationMethod.Code
String
PossibleCode for the observation method
Orders[].Results[].ObservationMethod.Codeset
String
PossibleCode set used to identify the observation method
Orders[].Results[].ObservationMethod.Description
String
PossibleDescription of the observation method
{
"Meta": {
"DataModel": "Results",
"EventType": "QueryResponse",
"EventDateTime": "2023-03-31T14:30:11.564Z",
"Test": true,
"Source": {
"ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
"Name": "Redox Dev Tools"
},
"Destinations": [
{
"ID": "af394f14-b34a-464f-8d24-895f370af4c9",
"Name": "Redox EMR"
}
],
"Logs": [
{
"ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
"AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
}
],
"Message": {
"ID": 5565
},
"Transmission": {
"ID": 12414
},
"FacilityCode": null
},
"Orders": [
{
"Patient": {
"Identifiers": [
{
"ID": "000000001",
"IDType": "MRN"
}
]
},
"Visit": {
"VisitNumber": 1234567
},
"LastUpdated": null,
"ID": "157968300",
"ApplicationOrderID": null,
"TransactionDateTime": "2015-05-06T06:00:58.872Z",
"CollectionDateTime": "2015-05-06T06:00:58.872Z",
"CompletionDateTime": "2015-05-06T06:00:58.872Z",
"Notes": [],
"ResultsStatus": "Final",
"Procedure": {
"Code": "49086-2",
"Codeset": null,
"Description": "First trimester maternal screen with nuchal translucency panel"
},
"Provider": {
"NPI": "4356789876",
"ID": null,
"IDType": null,
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ResultCopyProviders": [],
"Status": "Resulted",
"ResponseFlag": "Associated Segments",
"Priority": "Stat",
"Results": [
{
"Code": "TEST0001",
"Codeset": null,
"Description": "Cystic Fibrosis",
"RelatedGroupID": null,
"Specimen": {
"Source": null,
"BodySite": null,
"ID": null
},
"Value": "Positive Result",
"ValueType": "String",
"CompletionDateTime": null,
"FileType": null,
"Units": null,
"Notes": [
"This individual is a carrier for Cystic Fibrosis."
],
"AbnormalFlag": "Very Abnormal",
"Status": "Final",
"PrimaryResultsInterpreter": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Performer": {
"ID": null,
"IDType": null,
"FirstName": "Bob",
"LastName": "Smith",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
},
"ObservationMethod": {
"Code": null,
"Codeset": null,
"Description": null
}
},
{
"Code": "TEST0004",
"Codeset": null,
"Description": "Primary Carnitine Deficiency",
"RelatedGroupID": null,
"Specimen": {
"Source": null,
"BodySite": null,
"ID": null
},
"Value": "Negative Result",
"ValueType": "String",
"CompletionDateTime": null,
"FileType": null,
"Units": null,
"Notes": [],
"AbnormalFlag": "Normal",
"Status": "Final",
"PrimaryResultsInterpreter": {
"NPI": null,
"ID": null,
"IDType": null,
"FirstName": null,
"LastName": null,
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Producer": {
"ID": "RL001",
"Name": "Redox Lab WI",
"IDType": null,
"Address": {
"StreetAddress": "111 W. Fairchild",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
}
},
"Performer": {
"ID": null,
"IDType": null,
"FirstName": "Bob",
"LastName": "Smith",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": null
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"ReferenceRange": {
"Low": null,
"High": null,
"Text": null
},
"ObservationMethod": {
"Code": null,
"Codeset": null,
"Description": null
}
}
]
}
]
}