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.DataModelString
ReliableRequiredResults
Meta.EventTypeString
ReliableRequiredNew
Meta.EventDateTimeDateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.TestBoolean
ReliableIndicates whether the request is a test or not.
Meta.SourceString
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.IDString
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.NameString
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[].IDString
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].NameString
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[].IDString
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[].AttemptIDString
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCodeString
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[].IDString
ReliableRequiredID for the patient
Patient.Identifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanicBoolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.ReligionString
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatusString
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
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.LanguageString
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.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstNameString
PossibleFirst name of the contact
Patient.Contacts[].MiddleNameString
PossibleMiddle name of the contact
Patient.Contacts[].LastNameString
PossibleLast name of the contact
Patient.Contacts[].AddressObject
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddressString
PossibleStreet address
Patient.Contacts[].Address.CityString
PossibleCity
Patient.Contacts[].Address.StateString
PossibleState
Patient.Contacts[].Address.ZIPString
PossibleZIP
Patient.Contacts[].Address.CountyString
PossibleCounty
Patient.Contacts[].Address.CountryString
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].PhoneNumber.HomeString
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.OfficeString
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.MobileString
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatientString
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[].IDString
ReliableRequiredContains the unique identifier of the order request, which is assigned by the system that placed the order.
Orders[].ApplicationOrderIDString
PossibleContains the identifier of the order request, which is assigned by the system fulfilling the order.
Orders[].TransactionDateTimeString
ReliableDisplays the timestamp (in ISO 8601 format) for when the order was updated with results.
Not supported with data on demand.
Orders[].CollectionDateTimeString
ReliableDisplays the timestamp for when the specimen was collected.
ISO 8601 Format
Orders[].CompletionDateTimeString
ProbableDate and time the results were composed into a report and released.
ISO 8601 Format
Orders[].Notes[]Array of Strings
PossibleContains any order-level notes.
Not supported with data on demand.
Orders[].ResultsStatusString
ReliableValueSetSpecifies the current overall status of the order.
-
Additional values may be added by Redox in the future.
-
Orders[].ProcedureObject
ReliableDisplays the procedure associated with the results.
Orders[].Procedure.CodeString
ReliableCode for the procedure
Orders[].Procedure.CodesetString
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.DescriptionString
ReliableDescription of the procedure
Orders[].Provider.NPIString
PossibleNPI of the ordering provider
Orders[].Provider.IDString
PossibleID of the ordering provider.
This ID is often required for Inpatient Visits.
Orders[].Provider.IDTypeString
PossibleID type of the ID for the ordering provider
Orders[].Provider.FirstNameString
PossibleFirst name of the ordering provider
Orders[].Provider.LastNameString
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.AddressObject
PossibleProvider's address
Orders[].Provider.Address.StreetAddressString
PossibleStreet address
Orders[].Provider.Address.CityString
PossibleCity
Orders[].Provider.Address.StateString
PossibleState
Orders[].Provider.Address.ZIPString
PossibleZIP
Orders[].Provider.Address.CountyString
PossibleCounty
Orders[].Provider.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Provider.LocationObject
PossibleProvider's location
Orders[].Provider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Provider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].Provider.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.DepartmentString
PossibleDepartment
Orders[].Provider.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.RoomString
PossibleRoom.
Example: 136
Orders[].ResultCopyProviders[]Array of Objects
PossibleContains the providers that should be copied on the results.
Not supported with data on demand.
Orders[].ResultCopyProviders[].IDString
PossibleID of the copied provider.
This ID is often required for Inpatient Visits.
Orders[].ResultCopyProviders[].IDTypeString
PossibleID type of the ID for the copied provider
Orders[].ResultCopyProviders[].FirstNameString
PossibleFirst name of the copied provider
Orders[].ResultCopyProviders[].LastNameString
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[].AddressObject
PossibleProvider's address
Orders[].ResultCopyProviders[].Address.StreetAddressString
PossibleStreet address
Orders[].ResultCopyProviders[].Address.CityString
PossibleCity
Orders[].ResultCopyProviders[].Address.StateString
PossibleState
Orders[].ResultCopyProviders[].Address.ZIPString
PossibleZIP
Orders[].ResultCopyProviders[].Address.CountyString
PossibleCounty
Orders[].ResultCopyProviders[].Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].ResultCopyProviders[].LocationObject
PossibleProvider's location
Orders[].ResultCopyProviders[].Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].ResultCopyProviders[].Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.DepartmentString
PossibleDepartment
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.RoomString
PossibleRoom.
Example: 136
Orders[].StatusString
ReliableValueSetRequiredDisplays the current status of the order. The default value is Resulted.
-
Additional values may be added by Redox in the future.
-
Orders[].ResponseFlagString
ProbableSpecifies the response type that the receiving system requests. Derived from HL7 Table 0121. The default value is D, which includes associated segments.
Not supported with data on demand.
Orders[].PriorityString
ReliableValueSetIndicates the priority of the order.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[]Array of Objects
ProbableContains a list of result components and their values.
Orders[].Results[].CodeString
ProbableRequiredCode for the result component
Orders[].Results[].CodesetString
ProbableCode set used to identify the result component
Orders[].Results[].DescriptionString
ProbableDescription of the result component
Orders[].Results[].RelatedGroupIDString
ProbableContains the identifier to group separate result components.
Orders[].Results[].Specimen.SourceString
ProbableSource of the specimen
Orders[].Results[].Specimen.BodySiteString
ProbableBody site from which the specimen was collected
Orders[].Results[].Specimen.IDString
PossibleID of the collected specimen
Orders[].Results[].ValueString
ReliableRequiredDisplays the value of the result component. If the value type is Encapsulated Data, this field includes the base64 encoded string for the file. Learn more about sending a file.
Orders[].Results[].ValueTypeString
ReliableValueSetRequiredSpecifies the data type of the result value.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].CompletionDateTimeString
PossibleDisplays the timestamp for when the individual results were composed into a report and released.
Orders[].Results[].FileTypeString
ReliableIdentifies the format of the file (e.g., PDF, JPG). If the ValueType is Encapsulated Data, this field is required.
Orders[].Results[].UnitsString
ProbableDefines the units of measurement for the result.
Orders[].Results[].Notes[]Array of Strings
PossibleIncludes notes about the result component/observation.
Not supported with data on demand.
Orders[].Results[].AbnormalFlagString
ProbableValueSetIndicates whether the result is abnormal.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].StatusString
ReliableValueSetDisplays the current status of the result.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].PrimaryResultsInterpreter.NPIString
PossibleNPI of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.IDString
PossibleID of the Primary Results Interpreter.
This ID is often required for Inpatient Visits.
Orders[].Results[].PrimaryResultsInterpreter.IDTypeString
PossibleID type of the ID for the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.FirstNameString
PossibleFirst name of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.LastNameString
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.AddressObject
PossibleProvider's address
Orders[].Results[].PrimaryResultsInterpreter.Address.StreetAddressString
PossibleStreet address
Orders[].Results[].PrimaryResultsInterpreter.Address.CityString
PossibleCity
Orders[].Results[].PrimaryResultsInterpreter.Address.StateString
PossibleState
Orders[].Results[].PrimaryResultsInterpreter.Address.ZIPString
PossibleZIP
Orders[].Results[].PrimaryResultsInterpreter.Address.CountyString
PossibleCounty
Orders[].Results[].PrimaryResultsInterpreter.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].PrimaryResultsInterpreter.LocationObject
PossibleProvider's location
Orders[].Results[].PrimaryResultsInterpreter.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentString
PossibleDepartment
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.RoomString
PossibleRoom.
Example: 136
Orders[].Results[].Producer.IDString
PossibleContains the identifier of the entity that produced the result. This is typically the lab that fulfilled the order.
Orders[].Results[].Producer.NameString
PossibleDisplays the name of the entity (typically the lab) that produced the results.
Orders[].Results[].Producer.IDTypeString
PossibleDefines the type of identifier used for the corresponding ID of the entity that produced the results.
Orders[].Results[].Producer.AddressObject
PossibleResult producer's address
Orders[].Results[].Producer.Address.StreetAddressString
PossibleStreet address
Orders[].Results[].Producer.Address.CityString
PossibleCity
Orders[].Results[].Producer.Address.StateString
PossibleState
Orders[].Results[].Producer.Address.ZIPString
PossibleZIP
Orders[].Results[].Producer.Address.CountyString
PossibleCounty
Orders[].Results[].Producer.Address.CountryString
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Performer.IDString
PossibleID of the performer.
This ID is often required for Inpatient Visits.
Orders[].Results[].Performer.IDTypeString
PossibleID type of the ID for the performer
Orders[].Results[].Performer.FirstNameString
PossibleFirst name of the performer
Orders[].Results[].Performer.LastNameString
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.AddressObject
PossibleProvider's address
Orders[].Results[].Performer.Address.StreetAddressString
PossibleStreet address
Orders[].Results[].Performer.Address.CityString
PossibleCity
Orders[].Results[].Performer.Address.StateString
PossibleState
Orders[].Results[].Performer.Address.ZIPString
PossibleZIP
Orders[].Results[].Performer.Address.CountyString
PossibleCounty
Orders[].Results[].Performer.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].Performer.LocationObject
PossibleProvider's location
Orders[].Results[].Performer.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].Performer.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].Results[].Performer.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.DepartmentString
PossibleDepartment
Orders[].Results[].Performer.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.RoomString
PossibleRoom.
Example: 136
Orders[].Results[].ReferenceRangeObject
PossibleDefines the clinical range for a given result. Numeric results use low and high values to indicate a normal result. Non-numeric results populate the normal value in the text field.
Orders[].Results[].ReferenceRange.LowNumeric
PossibleSpecifies the lower bound for a normal result.
Orders[].Results[].ReferenceRange.HighNumeric
PossibleSpecifies the upper bound for a normal result.
Orders[].Results[].ReferenceRange.TextString
PossibleContains the normal value for non-numeric results.
Orders[].Results[].ObservationMethodObject
PossibleIndicates the method 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.CodeString
PossibleCode for the observation method
Orders[].Results[].ObservationMethod.CodesetString
PossibleCode set used to identify the observation method
Orders[].Results[].ObservationMethod.DescriptionString
PossibleDescription of the observation method
Visit
VisitObject
PossibleContains information about the visit associated with the result. In many cases, this will be the visit information from the associated order.
Visit.VisitDateTimeString
PossibleDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.VisitNumberString
PossibleVisit Number.
Unique ID of a single visit
Visit.AccountNumberString
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClassString
PossiblePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.LocationObject
PossibleLocation of the visit
Visit.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.DepartmentString
PossibleDepartment
Visit.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.RoomString
PossibleRoom.
Example: 136
Visit.Location.BedString
PossibleBed.
Example: B
Visit.AttendingProvider.IDString
PossibleID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDTypeString
PossibleID type of the ID for the attending provider
Visit.AttendingProvider.FirstNameString
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastNameString
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.AddressObject
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddressString
PossibleStreet address
Visit.AttendingProvider.Address.CityString
PossibleCity
Visit.AttendingProvider.Address.StateString
PossibleState
Visit.AttendingProvider.Address.ZIPString
PossibleZIP
Visit.AttendingProvider.Address.CountyString
PossibleCounty
Visit.AttendingProvider.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.LocationObject
PossibleProvider's location
Visit.AttendingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.DepartmentString
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ReferringProvider.IDString
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDTypeString
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstNameString
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastNameString
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.AddressObject
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddressString
PossibleStreet address
Visit.ReferringProvider.Address.CityString
PossibleCity
Visit.ReferringProvider.Address.StateString
PossibleState
Visit.ReferringProvider.Address.ZIPString
PossibleZIP
Visit.ReferringProvider.Address.CountyString
PossibleCounty
Visit.ReferringProvider.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.LocationObject
PossibleProvider's location
Visit.ReferringProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.DepartmentString
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.AdditionalStaff[]PossibleContains information about any other staff assigned to the assist with the patient visit. Each may be scheduled individually.
Visit.AdditionalStaff[].IDString
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visit.AdditionalStaff[].IDTypeString
ProbableID type of the ID for the Additional staff member
Visit.AdditionalStaff[].FirstNameString
PossibleFirst name of the Additional staff member
Visit.AdditionalStaff[].LastNameString
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[].AddressObject
PossibleProvider's address
Visit.AdditionalStaff[].Address.StreetAddressString
PossibleStreet address
Visit.AdditionalStaff[].Address.CityString
PossibleCity
Visit.AdditionalStaff[].Address.StateString
PossibleState
Visit.AdditionalStaff[].Address.ZIPString
PossibleZIP
Visit.AdditionalStaff[].Address.CountyString
PossibleCounty
Visit.AdditionalStaff[].Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdditionalStaff[].LocationObject
PossibleProvider's location
Visit.AdditionalStaff[].Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdditionalStaff[].Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.AdditionalStaff[].Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.DepartmentString
PossibleDepartment
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.RoomString
PossibleRoom.
Example: 136
Visit.AdditionalStaff[].RoleObject
ProbableDefines the role of this person in the patient visit.
Visit.AdditionalStaff[].Role.CodeString
ProbableCode for the service
Visit.AdditionalStaff[].Role.CodesetString
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visit.AdditionalStaff[].Role.DescriptionString
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
{
"Meta": {
"DataModel": "Results",
"EventType": "New",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"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.DataModelString
ReliableRequiredResults
Meta.EventTypeString
ReliableRequiredNewUnsolicited
Meta.EventDateTimeDateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.TestBoolean
ReliableIndicates whether the request is a test or not.
Meta.SourceString
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.IDString
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.NameString
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[].IDString
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].NameString
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[].IDString
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[].AttemptIDString
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCodeString
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[].IDString
ReliableRequiredID for the patient
Patient.Identifiers[].IDTypeString
ReliableRequiredType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstNameString
ReliablePatient's first name
Patient.Demographics.MiddleNameString
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastNameString
ReliablePatient's last name
Patient.Demographics.DOBString
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSNString
ProbablePatient's social security number
Patient.Demographics.SexString
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.RaceString
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanicBoolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.ReligionString
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatusString
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceasedBoolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTimeDateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.HomeString
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.OfficeString
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.MobileString
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.LanguageString
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.AddressObject
ProbablePatient's home address
Patient.Demographics.Address.StreetAddressString
ProbableStreet address
Patient.Demographics.Address.CityString
ProbableCity
Patient.Demographics.Address.StateString
ProbableState
Patient.Demographics.Address.ZIPString
ProbableZIP
Patient.Demographics.Address.CountyString
PossibleCounty
Patient.Demographics.Address.CountryString
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]Array of strings
PossiblePatient-level notes
Patient.Contacts[].FirstNameString
PossibleFirst name of the contact
Patient.Contacts[].MiddleNameString
PossibleMiddle name of the contact
Patient.Contacts[].LastNameString
PossibleLast name of the contact
Patient.Contacts[].AddressObject
PossibleAddress of the contact
Patient.Contacts[].Address.StreetAddressString
PossibleStreet address
Patient.Contacts[].Address.CityString
PossibleCity
Patient.Contacts[].Address.StateString
PossibleState
Patient.Contacts[].Address.ZIPString
PossibleZIP
Patient.Contacts[].Address.CountyString
PossibleCounty
Patient.Contacts[].Address.CountryString
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Contacts[].PhoneNumber.HomeString
PossibleHome phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.OfficeString
PossibleOffice phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].PhoneNumber.MobileString
ProbableMobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Contacts[].RelationToPatientString
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[].IDString
ReliableContains the unique identifier of the order request, which is assigned by the system that placed the order.
Orders[].ApplicationOrderIDString
PossibleRequiredContains the identifier of the order request, which is assigned by the system fulfilling the order.
Orders[].TransactionDateTimeString
ReliableDisplays the timestamp (in ISO 8601 format) for when the order was updated with results.
Not supported with data on demand.
Orders[].CollectionDateTimeString
ReliableDisplays the timestamp for when the specimen was collected.
ISO 8601 Format
Orders[].CompletionDateTimeString
ProbableDate and time the results were composed into a report and released.
ISO 8601 Format
Orders[].Notes[]Array of Strings
PossibleContains any order-level notes.
Not supported with data on demand.
Orders[].ResultsStatusString
ReliableValueSetSpecifies the current overall status of the order.
-
Additional values may be added by Redox in the future.
-
Orders[].ProcedureObject
ReliableDisplays the procedure associated with the results.
Orders[].Procedure.CodeString
ReliableCode for the procedure
Orders[].Procedure.CodesetString
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.DescriptionString
ReliableDescription of the procedure
Orders[].Provider.NPIString
PossibleNPI of the ordering provider
Orders[].Provider.IDString
PossibleID of the ordering provider.
This ID is often required for Inpatient Visits.
Orders[].Provider.IDTypeString
PossibleID type of the ID for the ordering provider
Orders[].Provider.FirstNameString
PossibleFirst name of the ordering provider
Orders[].Provider.LastNameString
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.AddressObject
PossibleProvider's address
Orders[].Provider.Address.StreetAddressString
PossibleStreet address
Orders[].Provider.Address.CityString
PossibleCity
Orders[].Provider.Address.StateString
PossibleState
Orders[].Provider.Address.ZIPString
PossibleZIP
Orders[].Provider.Address.CountyString
PossibleCounty
Orders[].Provider.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Provider.LocationObject
PossibleProvider's location
Orders[].Provider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Provider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].Provider.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.DepartmentString
PossibleDepartment
Orders[].Provider.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.RoomString
PossibleRoom.
Example: 136
Orders[].ResultCopyProviders[]Array of Objects
PossibleContains the providers that should be copied on the results.
Not supported with data on demand.
Orders[].ResultCopyProviders[].IDString
PossibleID of the copied provider.
This ID is often required for Inpatient Visits.
Orders[].ResultCopyProviders[].IDTypeString
PossibleID type of the ID for the copied provider
Orders[].ResultCopyProviders[].FirstNameString
PossibleFirst name of the copied provider
Orders[].ResultCopyProviders[].LastNameString
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[].AddressObject
PossibleProvider's address
Orders[].ResultCopyProviders[].Address.StreetAddressString
PossibleStreet address
Orders[].ResultCopyProviders[].Address.CityString
PossibleCity
Orders[].ResultCopyProviders[].Address.StateString
PossibleState
Orders[].ResultCopyProviders[].Address.ZIPString
PossibleZIP
Orders[].ResultCopyProviders[].Address.CountyString
PossibleCounty
Orders[].ResultCopyProviders[].Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].ResultCopyProviders[].LocationObject
PossibleProvider's location
Orders[].ResultCopyProviders[].Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].ResultCopyProviders[].Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.DepartmentString
PossibleDepartment
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.RoomString
PossibleRoom.
Example: 136
Orders[].StatusString
ReliableValueSetRequiredDisplays the current status of the order. The default value is Resulted.
-
Additional values may be added by Redox in the future.
-
Orders[].ResponseFlagString
ProbableSpecifies the response type that the receiving system requests. Derived from HL7 Table 0121. The default value is D, which includes associated segments.
Not supported with data on demand.
Orders[].PriorityString
ReliableValueSetIndicates the priority of the order.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[]Array of Objects
ProbableContains a list of result components and their values.
Orders[].Results[].CodeString
ProbableRequiredCode for the result component
Orders[].Results[].CodesetString
ProbableCode set used to identify the result component
Orders[].Results[].DescriptionString
ProbableDescription of the result component
Orders[].Results[].RelatedGroupIDString
ProbableContains the identifier to group separate result components.
Orders[].Results[].Specimen.SourceString
ProbableSource of the specimen
Orders[].Results[].Specimen.BodySiteString
ProbableBody site from which the specimen was collected
Orders[].Results[].Specimen.IDString
PossibleID of the collected specimen
Orders[].Results[].ValueString
ReliableRequiredDisplays the value of the result component. If the value type is Encapsulated Data, this field includes the base64 encoded string for the file. Learn more about sending a file.
Orders[].Results[].ValueTypeString
ReliableValueSetRequiredSpecifies the data type of the result value.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].CompletionDateTimeString
PossibleDisplays the timestamp for when the individual results were composed into a report and released.
Orders[].Results[].FileTypeString
ReliableIdentifies the format of the file (e.g., PDF, JPG). If the ValueType is Encapsulated Data, this field is required.
Orders[].Results[].UnitsString
ProbableDefines the units of measurement for the result.
Orders[].Results[].Notes[]Array of Strings
PossibleIncludes notes about the result component/observation.
Not supported with data on demand.
Orders[].Results[].AbnormalFlagString
ProbableValueSetIndicates whether the result is abnormal.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].StatusString
ReliableValueSetDisplays the current status of the result.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].PrimaryResultsInterpreter.NPIString
PossibleNPI of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.IDString
PossibleID of the Primary Results Interpreter.
This ID is often required for Inpatient Visits.
Orders[].Results[].PrimaryResultsInterpreter.IDTypeString
PossibleID type of the ID for the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.FirstNameString
PossibleFirst name of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.LastNameString
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.AddressObject
PossibleProvider's address
Orders[].Results[].PrimaryResultsInterpreter.Address.StreetAddressString
PossibleStreet address
Orders[].Results[].PrimaryResultsInterpreter.Address.CityString
PossibleCity
Orders[].Results[].PrimaryResultsInterpreter.Address.StateString
PossibleState
Orders[].Results[].PrimaryResultsInterpreter.Address.ZIPString
PossibleZIP
Orders[].Results[].PrimaryResultsInterpreter.Address.CountyString
PossibleCounty
Orders[].Results[].PrimaryResultsInterpreter.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].PrimaryResultsInterpreter.LocationObject
PossibleProvider's location
Orders[].Results[].PrimaryResultsInterpreter.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentString
PossibleDepartment
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.RoomString
PossibleRoom.
Example: 136
Orders[].Results[].Producer.IDString
PossibleContains the identifier of the entity that produced the result. This is typically the lab that fulfilled the order.
Orders[].Results[].Producer.NameString
PossibleDisplays the name of the entity (typically the lab) that produced the results.
Orders[].Results[].Producer.IDTypeString
PossibleDefines the type of identifier used for the corresponding ID of the entity that produced the results.
Orders[].Results[].Producer.AddressObject
PossibleResult producer's address
Orders[].Results[].Producer.Address.StreetAddressString
PossibleStreet address
Orders[].Results[].Producer.Address.CityString
PossibleCity
Orders[].Results[].Producer.Address.StateString
PossibleState
Orders[].Results[].Producer.Address.ZIPString
PossibleZIP
Orders[].Results[].Producer.Address.CountyString
PossibleCounty
Orders[].Results[].Producer.Address.CountryString
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Performer.IDString
PossibleID of the performer.
This ID is often required for Inpatient Visits.
Orders[].Results[].Performer.IDTypeString
PossibleID type of the ID for the performer
Orders[].Results[].Performer.FirstNameString
PossibleFirst name of the performer
Orders[].Results[].Performer.LastNameString
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.AddressObject
PossibleProvider's address
Orders[].Results[].Performer.Address.StreetAddressString
PossibleStreet address
Orders[].Results[].Performer.Address.CityString
PossibleCity
Orders[].Results[].Performer.Address.StateString
PossibleState
Orders[].Results[].Performer.Address.ZIPString
PossibleZIP
Orders[].Results[].Performer.Address.CountyString
PossibleCounty
Orders[].Results[].Performer.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].Performer.LocationObject
PossibleProvider's location
Orders[].Results[].Performer.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].Performer.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].Results[].Performer.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.DepartmentString
PossibleDepartment
Orders[].Results[].Performer.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.RoomString
PossibleRoom.
Example: 136
Orders[].Results[].ReferenceRangeObject
PossibleDefines the clinical range for a given result. Numeric results use low and high values to indicate a normal result. Non-numeric results populate the normal value in the text field.
Orders[].Results[].ReferenceRange.LowNumeric
PossibleSpecifies the lower bound for a normal result.
Orders[].Results[].ReferenceRange.HighNumeric
PossibleSpecifies the upper bound for a normal result.
Orders[].Results[].ReferenceRange.TextString
PossibleContains the normal value for non-numeric results.
Orders[].Results[].ObservationMethodObject
PossibleIndicates the method 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.CodeString
PossibleCode for the observation method
Orders[].Results[].ObservationMethod.CodesetString
PossibleCode set used to identify the observation method
Orders[].Results[].ObservationMethod.DescriptionString
PossibleDescription of the observation method
Visit
VisitObject
PossibleContains information about the visit associated with the result. In many cases, this will be the visit information from the associated order.
Visit.VisitDateTimeString
PossibleDateTime of visit or the arrival time of the admission.
ISO 8601 Format
Visit.VisitNumberString
PossibleVisit Number.
Unique ID of a single visit
Visit.AccountNumberString
PossibleAccount Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.
Visit.PatientClassString
PossiblePatient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency
Visit.LocationObject
PossibleLocation of the visit
Visit.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Visit.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Visit.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.DepartmentString
PossibleDepartment
Visit.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Visit.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Visit.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.Location.RoomString
PossibleRoom.
Example: 136
Visit.Location.BedString
PossibleBed.
Example: B
Visit.AttendingProvider.IDString
PossibleID of the attending provider.
This ID is often required for Inpatient Visits.
Visit.AttendingProvider.IDTypeString
PossibleID type of the ID for the attending provider
Visit.AttendingProvider.FirstNameString
PossibleFirst name of the attending provider
Visit.AttendingProvider.LastNameString
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.AddressObject
PossibleProvider's address
Visit.AttendingProvider.Address.StreetAddressString
PossibleStreet address
Visit.AttendingProvider.Address.CityString
PossibleCity
Visit.AttendingProvider.Address.StateString
PossibleState
Visit.AttendingProvider.Address.ZIPString
PossibleZIP
Visit.AttendingProvider.Address.CountyString
PossibleCounty
Visit.AttendingProvider.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AttendingProvider.LocationObject
PossibleProvider's location
Visit.AttendingProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AttendingProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.AttendingProvider.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Visit.AttendingProvider.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.DepartmentString
PossibleDepartment
Visit.AttendingProvider.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Visit.AttendingProvider.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AttendingProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.ReferringProvider.IDString
PossibleID of the referring provider.
This ID is often required for Inpatient Visits.
Visit.ReferringProvider.IDTypeString
PossibleID type of the ID for the referring provider
Visit.ReferringProvider.FirstNameString
PossibleFirst name of the referring provider
Visit.ReferringProvider.LastNameString
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.AddressObject
PossibleProvider's address
Visit.ReferringProvider.Address.StreetAddressString
PossibleStreet address
Visit.ReferringProvider.Address.CityString
PossibleCity
Visit.ReferringProvider.Address.StateString
PossibleState
Visit.ReferringProvider.Address.ZIPString
PossibleZIP
Visit.ReferringProvider.Address.CountyString
PossibleCounty
Visit.ReferringProvider.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.ReferringProvider.LocationObject
PossibleProvider's location
Visit.ReferringProvider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.ReferringProvider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.ReferringProvider.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Visit.ReferringProvider.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.DepartmentString
PossibleDepartment
Visit.ReferringProvider.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Visit.ReferringProvider.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.ReferringProvider.Location.RoomString
PossibleRoom.
Example: 136
Visit.AdditionalStaff[]PossibleContains information about any other staff assigned to the assist with the patient visit. Each may be scheduled individually.
Visit.AdditionalStaff[].IDString
ProbableID of the Additional staff member.
This ID is often required for Inpatient Visits.
Visit.AdditionalStaff[].IDTypeString
ProbableID type of the ID for the Additional staff member
Visit.AdditionalStaff[].FirstNameString
PossibleFirst name of the Additional staff member
Visit.AdditionalStaff[].LastNameString
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[].AddressObject
PossibleProvider's address
Visit.AdditionalStaff[].Address.StreetAddressString
PossibleStreet address
Visit.AdditionalStaff[].Address.CityString
PossibleCity
Visit.AdditionalStaff[].Address.StateString
PossibleState
Visit.AdditionalStaff[].Address.ZIPString
PossibleZIP
Visit.AdditionalStaff[].Address.CountyString
PossibleCounty
Visit.AdditionalStaff[].Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Visit.AdditionalStaff[].LocationObject
PossibleProvider's location
Visit.AdditionalStaff[].Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Visit.AdditionalStaff[].Location.FacilityString
PossibleFacility.
Example: Community Hospital
Visit.AdditionalStaff[].Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Visit.AdditionalStaff[].Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.DepartmentString
PossibleDepartment
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Visit.AdditionalStaff[].Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Visit.AdditionalStaff[].Location.RoomString
PossibleRoom.
Example: 136
Visit.AdditionalStaff[].RoleObject
ProbableDefines the role of this person in the patient visit.
Visit.AdditionalStaff[].Role.CodeString
ProbableCode for the service
Visit.AdditionalStaff[].Role.CodesetString
ProbableCode set used to identify the service.
Codeset will be blank for system-defined codes.
Visit.AdditionalStaff[].Role.DescriptionString
ProbableDescription of the service.
Example: Primary Physician, Technologist, etc.
{
"Meta": {
"DataModel": "Results",
"EventType": "NewUnsolicited",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"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.DataModelString
ReliableRequiredResults
Meta.EventTypeString
ReliableRequiredQuery
Meta.EventDateTimeDateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.TestBoolean
ReliableIndicates whether the request is a test or not.
Meta.SourceString
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.IDString
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.NameString
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[].IDString
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].NameString
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[].IDString
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[].AttemptIDString
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCodeString
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[].IDString
ReliableID for the patient
Patients[].Identifiers[].IDTypeString
ReliableType of ID.
E.g. MRN, EPI
Completion
CompletionString
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.StartDateTimeString
ProbableStart of the time range to search for results.
ISO 8601 Format
Completion.EndDateTimeString
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.
RelatedGroupIDs
RelatedGroupIDs[]String
ProbableArray of related group IDs assigned by the ordering system to filter queries by.
If multiple related group IDs are provided, all results associated with any of the group IDs 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[].CodeString
ProbableCode for the procedure
Procedures[].CodesetString
ProbableValueSetCode set used to identify the procedure
-
Additional values may be added by Redox in the future.
-
Location
Location.DepartmentString
PossibleID corresponding to the department from which to retrieved the patient chart.
This field is required for some EHRs.
LastUpdated
LastUpdatedObject
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.StartDateTimeString
ProbableAllows for searching on updated time of results. This is the start of the time range to search in.
ISO 8601 Format
LastUpdated.EndDateTimeString
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-08-29T18:36:49.023Z",
"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"
],
"RelatedGroupIDs": [],
"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.DataModelString
ReliableRequiredResults
Meta.EventTypeString
ReliableRequiredQueryResponse
Meta.EventDateTimeDateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.TestBoolean
ReliableIndicates whether the request is a test or not.
Meta.SourceString
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.IDString
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.NameString
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[].IDString
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].NameString
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[].IDString
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[].AttemptIDString
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCodeString
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[].IDString
ReliableID for the patient
Orders[].Patient.Identifiers[].IDTypeString
ReliableType of ID.
E.g. MRN, EPI
Orders[].Visit.VisitNumberString
ReliableVisit Number.
Unique ID of the visit this order was placed within
Orders[].LastUpdatedString
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[].IDString
ReliableContains the unique identifier of the order request, which is assigned by the system that placed the order.
Orders[].ApplicationOrderIDString
PossibleContains the identifier of the order request, which is assigned by the system fulfilling the order.
Orders[].TransactionDateTimeString
ReliableDisplays the timestamp (in ISO 8601 format) for when the order was updated with results.
Not supported with data on demand.
Orders[].CollectionDateTimeString
ReliableDisplays the timestamp for when the specimen was collected.
ISO 8601 Format
Orders[].CompletionDateTimeString
ProbableDate and time the results were composed into a report and released.
ISO 8601 Format
Orders[].Notes[]Array of Strings
PossibleContains any order-level notes.
Not supported with data on demand.
Orders[].ResultsStatusString
ReliableValueSetSpecifies the current overall status of the order.
-
Additional values may be added by Redox in the future.
-
Orders[].ProcedureObject
ReliableDisplays the procedure associated with the results.
Orders[].Procedure.CodeString
ReliableCode for the procedure
Orders[].Procedure.CodesetString
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.DescriptionString
ReliableDescription of the procedure
Orders[].Provider.NPIString
PossibleNPI of the ordering provider
Orders[].Provider.IDString
PossibleID of the ordering provider.
This ID is often required for Inpatient Visits.
Orders[].Provider.IDTypeString
PossibleID type of the ID for the ordering provider
Orders[].Provider.FirstNameString
PossibleFirst name of the ordering provider
Orders[].Provider.LastNameString
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.AddressObject
PossibleProvider's address
Orders[].Provider.Address.StreetAddressString
PossibleStreet address
Orders[].Provider.Address.CityString
PossibleCity
Orders[].Provider.Address.StateString
PossibleState
Orders[].Provider.Address.ZIPString
PossibleZIP
Orders[].Provider.Address.CountyString
PossibleCounty
Orders[].Provider.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Provider.LocationObject
PossibleProvider's location
Orders[].Provider.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Provider.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].Provider.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].Provider.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.DepartmentString
PossibleDepartment
Orders[].Provider.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].Provider.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Provider.Location.RoomString
PossibleRoom.
Example: 136
Orders[].ResultCopyProviders[]Array of Objects
PossibleContains the providers that should be copied on the results.
Not supported with data on demand.
Orders[].ResultCopyProviders[].IDString
PossibleID of the copied provider.
This ID is often required for Inpatient Visits.
Orders[].ResultCopyProviders[].IDTypeString
PossibleID type of the ID for the copied provider
Orders[].ResultCopyProviders[].FirstNameString
PossibleFirst name of the copied provider
Orders[].ResultCopyProviders[].LastNameString
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[].AddressObject
PossibleProvider's address
Orders[].ResultCopyProviders[].Address.StreetAddressString
PossibleStreet address
Orders[].ResultCopyProviders[].Address.CityString
PossibleCity
Orders[].ResultCopyProviders[].Address.StateString
PossibleState
Orders[].ResultCopyProviders[].Address.ZIPString
PossibleZIP
Orders[].ResultCopyProviders[].Address.CountyString
PossibleCounty
Orders[].ResultCopyProviders[].Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].ResultCopyProviders[].LocationObject
PossibleProvider's location
Orders[].ResultCopyProviders[].Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].ResultCopyProviders[].Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].ResultCopyProviders[].Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.DepartmentString
PossibleDepartment
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].ResultCopyProviders[].Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].ResultCopyProviders[].Location.RoomString
PossibleRoom.
Example: 136
Orders[].StatusString
ReliableValueSetDisplays the current status of the order. The default value is Resulted.
-
Additional values may be added by Redox in the future.
-
Orders[].ResponseFlagString
ProbableSpecifies the response type that the receiving system requests. Derived from HL7 Table 0121. The default value is D, which includes associated segments.
Not supported with data on demand.
Orders[].PriorityString
ReliableValueSetIndicates the priority of the order.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[]Array of Objects
ProbableContains a list of result components and their values.
Orders[].Results[].CodeString
ProbableCode for the result component
Orders[].Results[].CodesetString
ProbableCode set used to identify the result component
Orders[].Results[].DescriptionString
ProbableDescription of the result component
Orders[].Results[].RelatedGroupIDString
ProbableContains the identifier to group separate result components.
Orders[].Results[].Specimen.SourceString
ProbableSource of the specimen
Orders[].Results[].Specimen.BodySiteString
ProbableBody site from which the specimen was collected
Orders[].Results[].Specimen.IDString
PossibleID of the collected specimen
Orders[].Results[].ValueString
ReliableDisplays the value of the result component. If the value type is Encapsulated Data, this field includes the base64 encoded string for the file. Learn more about sending a file.
Orders[].Results[].ValueTypeString
ReliableValueSetSpecifies the data type of the result value.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].CompletionDateTimeString
PossibleDisplays the timestamp for when the individual results were composed into a report and released.
Orders[].Results[].FileTypeString
ReliableIdentifies the format of the file (e.g., PDF, JPG). If the ValueType is Encapsulated Data, this field is required.
Orders[].Results[].UnitsString
ProbableDefines the units of measurement for the result.
Orders[].Results[].Notes[]Array of Strings
PossibleIncludes notes about the result component/observation.
Not supported with data on demand.
Orders[].Results[].AbnormalFlagString
ProbableValueSetIndicates whether the result is abnormal.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].StatusString
ReliableValueSetDisplays the current status of the result.
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].PrimaryResultsInterpreter.NPIString
PossibleNPI of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.IDString
PossibleID of the Primary Results Interpreter.
This ID is often required for Inpatient Visits.
Orders[].Results[].PrimaryResultsInterpreter.IDTypeString
PossibleID type of the ID for the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.FirstNameString
PossibleFirst name of the Primary Results Interpreter
Orders[].Results[].PrimaryResultsInterpreter.LastNameString
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.AddressObject
PossibleProvider's address
Orders[].Results[].PrimaryResultsInterpreter.Address.StreetAddressString
PossibleStreet address
Orders[].Results[].PrimaryResultsInterpreter.Address.CityString
PossibleCity
Orders[].Results[].PrimaryResultsInterpreter.Address.StateString
PossibleState
Orders[].Results[].PrimaryResultsInterpreter.Address.ZIPString
PossibleZIP
Orders[].Results[].PrimaryResultsInterpreter.Address.CountyString
PossibleCounty
Orders[].Results[].PrimaryResultsInterpreter.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].PrimaryResultsInterpreter.LocationObject
PossibleProvider's location
Orders[].Results[].PrimaryResultsInterpreter.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].Results[].PrimaryResultsInterpreter.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentString
PossibleDepartment
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].Results[].PrimaryResultsInterpreter.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].PrimaryResultsInterpreter.Location.RoomString
PossibleRoom.
Example: 136
Orders[].Results[].Producer.IDString
PossibleContains the identifier of the entity that produced the result. This is typically the lab that fulfilled the order.
Orders[].Results[].Producer.NameString
PossibleDisplays the name of the entity (typically the lab) that produced the results.
Orders[].Results[].Producer.IDTypeString
PossibleDefines the type of identifier used for the corresponding ID of the entity that produced the results.
Orders[].Results[].Producer.AddressObject
PossibleResult producer's address
Orders[].Results[].Producer.Address.StreetAddressString
PossibleStreet address
Orders[].Results[].Producer.Address.CityString
PossibleCity
Orders[].Results[].Producer.Address.StateString
PossibleState
Orders[].Results[].Producer.Address.ZIPString
PossibleZIP
Orders[].Results[].Producer.Address.CountyString
PossibleCounty
Orders[].Results[].Producer.Address.CountryString
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Orders[].Results[].Performer.IDString
PossibleID of the performer.
This ID is often required for Inpatient Visits.
Orders[].Results[].Performer.IDTypeString
PossibleID type of the ID for the performer
Orders[].Results[].Performer.FirstNameString
PossibleFirst name of the performer
Orders[].Results[].Performer.LastNameString
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.AddressObject
PossibleProvider's address
Orders[].Results[].Performer.Address.StreetAddressString
PossibleStreet address
Orders[].Results[].Performer.Address.CityString
PossibleCity
Orders[].Results[].Performer.Address.StateString
PossibleState
Orders[].Results[].Performer.Address.ZIPString
PossibleZIP
Orders[].Results[].Performer.Address.CountyString
PossibleCounty
Orders[].Results[].Performer.Address.CountryString
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.OfficeString
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Orders[].Results[].Performer.LocationObject
PossibleProvider's location
Orders[].Results[].Performer.Location.TypeString
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Orders[].Results[].Performer.Location.FacilityString
PossibleFacility.
Example: Community Hospital
Orders[].Results[].Performer.Location.FacilityIdentifiers[]Array of Objects
PossibleList of IDs specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].IDString
PossibleAn ID specific to this facility
Orders[].Results[].Performer.Location.FacilityIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.DepartmentString
PossibleDepartment
Orders[].Results[].Performer.Location.DepartmentIdentifiers[]Array of Objects
PossibleList of IDs specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].IDString
PossibleAn ID specific to this department
Orders[].Results[].Performer.Location.DepartmentIdentifiers[].IDTypeString
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Orders[].Results[].Performer.Location.RoomString
PossibleRoom.
Example: 136
Orders[].Results[].ReferenceRangeObject
PossibleDefines the clinical range for a given result. Numeric results use low and high values to indicate a normal result. Non-numeric results populate the normal value in the text field.
Orders[].Results[].ReferenceRange.LowNumeric
PossibleSpecifies the lower bound for a normal result.
Orders[].Results[].ReferenceRange.HighNumeric
PossibleSpecifies the upper bound for a normal result.
Orders[].Results[].ReferenceRange.TextString
PossibleContains the normal value for non-numeric results.
Orders[].Results[].ObservationMethodObject
PossibleIndicates the method 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.CodeString
PossibleCode for the observation method
Orders[].Results[].ObservationMethod.CodesetString
PossibleCode set used to identify the observation method
Orders[].Results[].ObservationMethod.DescriptionString
PossibleDescription of the observation method
{
"Meta": {
"DataModel": "Results",
"EventType": "QueryResponse",
"EventDateTime": "2023-08-29T18:36:49.023Z",
"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
},
"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
}
}
]
}
]
}