Research
The Research data model is primarily used for connections with Clinical Trial Management Systems (CTMS). Clinical trials are defined in CTMS and synced to the EHR system via a push from CTMS. Either you or your connection may enroll patients in the trial and share relevant information with your connection.
This data model is common if you connect with healthcare organizations that have ties to academia or strong research programs, and they must have robust interfacing capabilities. You may want to use this data model if your organization is interested in patient study status or a list of active studies, especially if your organization does labs, imaging, or other work to contribute to the study.
CTMS or EHR systems can make this data available via HL7v3-based messages defined in IHE's Protocol for Execution profile and Research Process content.
The Study event is used to exchange information about one specific clinical study. For example, a Clinical Trial Management System may update an EHR with each new study when created or updated.
Fields
Meta
Meta.DataModel
String
ReliableRequiredResearch
Meta.EventType
String
ReliableRequiredStudy
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Study
Study.Identifiers[]
Array of Objects
ReliableIdentifiers for the study. Should include both internal and external identifiers (such as an NCT ID)
Study.Identifiers[].ID
String
Reliable
Study.Identifiers[].IDType
String
Reliable
Study.Title
String
ReliableOfficial title of the study
Study.Type
String
ReliableValueSetThe nature of the investigation or investigational use for the study.
-
Additional values may be added by Redox in the future.
-
Study.Sponsor
Object
ReliableThe sponsor of the study
Study.Sponsor.ID
String
ProbableIdentifier for the sponsor of the study, if applicable
Study.Sponsor.Name
String
ReliableString representation of the sponsor name
Study.PrincipalInvestigator.ID
String
PossibleID of the provider.
This ID is often required for Inpatient Visits.
Study.PrincipalInvestigator.IDType
String
PossibleID type of the ID for the provider
Study.PrincipalInvestigator.FirstName
String
PossibleFirst name of the provider
Study.PrincipalInvestigator.LastName
String
PossibleLast name of the provider
Study.PrincipalInvestigator.Credentials[]
Array of Strings
PossibleList of credentials for the provider.
e.g. MD, PhD
Study.PrincipalInvestigator.Address
Object
PossibleProvider's address
Study.PrincipalInvestigator.Address.StreetAddress
String
PossibleStreet address
Study.PrincipalInvestigator.Address.City
String
PossibleCity
Study.PrincipalInvestigator.Address.State
String
PossibleState
Study.PrincipalInvestigator.Address.ZIP
String
PossibleZIP
Study.PrincipalInvestigator.Address.County
String
PossibleCounty
Study.PrincipalInvestigator.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Study.PrincipalInvestigator.EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Study.PrincipalInvestigator.PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Study.PrincipalInvestigator.Location
Object
PossibleProvider's location
Study.PrincipalInvestigator.Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Study.PrincipalInvestigator.Location.Facility
String
PossibleFacility.
Example: Community Hospital
Study.PrincipalInvestigator.Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Study.PrincipalInvestigator.Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Study.PrincipalInvestigator.Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Study.PrincipalInvestigator.Location.Department
String
PossibleDepartment
Study.PrincipalInvestigator.Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Study.PrincipalInvestigator.Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Study.PrincipalInvestigator.Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Study.PrincipalInvestigator.Location.Room
String
PossibleRoom.
Example: 136
Study.Coordinators[].ID
String
PossibleID of the provider.
This ID is often required for Inpatient Visits.
Study.Coordinators[].IDType
String
PossibleID type of the ID for the provider
Study.Coordinators[].FirstName
String
PossibleFirst name of the undefined
Study.Coordinators[].LastName
String
PossibleLast name of the undefined
Study.Coordinators[].Credentials[]
Array of Strings
PossibleList of credentials for the undefined.
e.g. MD, PhD
Study.Coordinators[].Address
Object
PossibleProvider's address
Study.Coordinators[].Address.StreetAddress
String
PossibleStreet address
Study.Coordinators[].Address.City
String
PossibleCity
Study.Coordinators[].Address.State
String
PossibleState
Study.Coordinators[].Address.ZIP
String
PossibleZIP
Study.Coordinators[].Address.County
String
PossibleCounty
Study.Coordinators[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Study.Coordinators[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Study.Coordinators[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Study.Coordinators[].Location
Object
PossibleProvider's location
Study.Coordinators[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Study.Coordinators[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Study.Coordinators[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Study.Coordinators[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Study.Coordinators[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Study.Coordinators[].Location.Department
String
PossibleDepartment
Study.Coordinators[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Study.Coordinators[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Study.Coordinators[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Study.Coordinators[].Location.Room
String
PossibleRoom.
Example: 136
Study.Description
String
ProbableFull description of the study
Study.Status
String
ProbableWhat state the study is currently in. Drawn from the clinicaltrials.gov "Overall Recruitment Statuses".
Not yet recruiting: Participants are not yet being recruited Recruiting: Participants are currently being recruited, whether or not any participants have yet been enrolled Enrolling by invitation: Participants are being (or will be) selected from a predetermined population Active, not recruiting: Study is continuing, meaning participants are receiving an intervention or being examined, but new participants are not currently being recruited or enrolled Completed: The study has concluded normally; participants are no longer receiving an intervention or being examined (that is, last participant’s last visit has occurred) Suspended: Study halted prematurely but potentially will resume Terminated: Study halted prematurely and will not resume; participants are no longer being examined or receiving intervention Withdrawn: Study halted prematurely, prior to enrollment of first participant
Study.StartDateTime
DateTime
ProbableThe estimated date on which the clinical study will be open for recruitment of participants.
Study.Conditions[].Code
String
ProbableA code describing conditions applicable to the study
Study.Conditions[].CodeSystem
String
ProbableID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Study.Conditions[].CodeSystemName
String
ProbableCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Study.Conditions[].Name
String
ProbableName of conditions applicable to the study
Study.Conditions[].AltCodes[]
Array of Objects
PossibleAlternate or translation codes for conditions applicable to the study
Study.Conditions[].AltCodes[].Code
String
PossibleA code describing conditions applicable to the study
Study.Conditions[].AltCodes[].CodeSystem
String
PossibleID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Study.Conditions[].AltCodes[].CodeSystemName
String
PossibleCoding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.
Study.Conditions[].AltCodes[].Name
String
PossibleName of conditions applicable to the study
Study.Design
Object
ProbableInformation about how the trial will run.
Study.Design.Purpose
Object
ProbableThe objective of the study.
Treatment: One or more interventions are being evaluated for treating a disease, syndrome, or condition. Prevention: One or more interventions are being assessed for preventing the development of a specific disease or health condition. Diagnostic: One or more interventions are being evaluated for identifying a disease or health condition. Supportive Care: One or more interventions are evaluated for maximizing comfort, minimizing side effects, or mitigating against a decline in the participant's health or function. Screening: One or more interventions are assessed or examined for identifying a condition, or risk factors for a condition, in people who are not yet known to have the condition or risk factor. Health Services Research: One or more interventions for evaluating the delivery, processes, management, organization, or financing of healthcare. Basic Science: One or more interventions for examining the basic mechanism of action (for example, physiology or biomechanics of an intervention). Device Feasibility: An intervention of a device product is being evaluated in a small clinical trial (generally fewer than 10 participants) to determine the feasibility of the product; or a clinical trial to test a prototype device for feasibility and not health outcomes. Such studies are conducted to confirm the design and operating specifications of a device before beginning a full clinical trial. Other: None of the other options applies.
Study.Design.Phase
Object
ProbableFor studies of drug products, the numerical phase of the study.
N/A: Trials without phases (for example, studies of devices or behavioral interventions). Early Phase 1 (Formerly listed as "Phase 0"): Exploratory trials, involving very limited human exposure, with no therapeutic or diagnostic intent (e.g., screening studies, microdose studies). See FDA guidance on exploratory IND studies for more information. Phase 1: Includes initial studies to determine the metabolism and pharmacologic actions of drugs in humans, the side effects associated with increasing doses, and to gain early evidence of effectiveness; may include healthy participants and/or patients. Phase 1/Phase 2: Trials that are a combination of phases 1 and 2. Phase 2: Includes controlled clinical studies conducted to evaluate the effectiveness of the drug for a particular indication or indications in participants with the disease or condition under study and to determine the common short-term side effects and risks. Phase 2/Phase 3: Trials that are a combination of phases 2 and 3. Phase 3: Includes trials conducted after preliminary evidence suggesting effectiveness of the drug has been obtained, and are intended to gather additional information to evaluate the overall benefit-risk relationship of the drug. Phase 4: Studies of FDA-approved drugs to delineate additional information including the drug's risks, benefits, and optimal use.
Study.Eligibility
Object
ProbableRules about individuals eligible to participate in the study.
Study.Eligibility.Gender
String
ProbableThe gender of the participants eligible to participate in the clinical study.
All, Male, or Female
Study.Eligibility.MinimumAge
Numeric
ProbableMinimum age a potential participant must meet to be eligible for the clinical study.
Study.Eligibility.MaximumAge
Numeric
ProbableMaximum age a potential participant must meet to be eligible for the clinical study.
Study.Location
Object
Probable
Study.Location.Type
String
ProbableType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Study.Location.Facility
String
ProbableFacility.
Example: Community Hospital
Study.Location.FacilityIdentifiers[]
Array of Objects
ProbableList of IDs specific to this facility
Study.Location.FacilityIdentifiers[].ID
String
ProbableAn ID specific to this facility
Study.Location.FacilityIdentifiers[].IDType
String
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Study.Location.Department
String
ProbableDepartment
Study.Location.DepartmentIdentifiers[]
Array of Objects
ProbableList of IDs specific to this department
Study.Location.DepartmentIdentifiers[].ID
String
ProbableAn ID specific to this department
Study.Location.DepartmentIdentifiers[].IDType
String
ProbableThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Study.Location.Room
String
ProbableRoom.
Example: 136
Study.Location.Address
Object
ProbablePhysical address
Study.Location.Address.StreetAddress
String
ProbableStreet address
Study.Location.Address.City
String
ProbableCity
Study.Location.Address.State
String
ProbableState
Study.Location.Address.ZIP
String
ProbableZIP
Study.Location.Address.County
String
PossibleCounty
Study.Location.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Protocols
Protocols[]
Array of Objects
PossibleEach protocol represents a sequence of events that will be assigned to a group of patients participating in the study.
Protocols[].ID
String
PossibleThe identifier for the protocol.
Protocols[].IDType
String
PossibleThe identifier type for the protocol.
Protocols[].Description
String
PossibleThe unique name for the protocol.
Protocols[].Cycles[]
Array of Objects
PossibleEach cycle represents a grouping of days within the protocol.
Protocols[].Cycles[].ID
String
PossibleThe identifier for the cycle.
Protocols[].Cycles[].IDType
String
PossibleThe identifier type for the cycle.
Protocols[].Cycles[].Description
String
PossibleThe unique name for the cycle.
Protocols[].Cycles[].StartDate
String
PossibleThe date the cycle begins.
ISO 8601 Format
Protocols[].Cycles[].EndDate
String
PossibleThe date the cycle ends.
ISO 8601 Format
Protocols[].Cycles[].Days[]
Array of Objects
PossibleEach day represents a patient's visit related to the study protocol.
Protocols[].Cycles[].Days[].ID
String
PossibleThe identifier for this day.
Protocols[].Cycles[].Days[].IDType
String
PossibleThe identifier type for the day.
Protocols[].Cycles[].Days[].Description
String
PossibleThe unique name for the day.
Protocols[].Cycles[].Days[].ActivityDateTime
String
PossibleThe activity date.
ISO 8601 Format
Protocols[].Cycles[].Days[].EarliestDateTime
String
PossibleThe earliest date in which the activity can be scheduled.
ISO 8601 Format
Protocols[].Cycles[].Days[].LatestDateTime
String
PossibleThe latest date in which the activity can be scheduled.
ISO 8601 Format
Protocols[].Cycles[].Days[].Procedures[]
Array of Objects
PossibleA list of procedures that are related to the study day.
Protocols[].Cycles[].Days[].Procedures[].Code
String
ProbableThe identifier for the procedure.
Protocols[].Cycles[].Days[].Procedures[].CodeSet
String
PossibleIdentifiers for the protocol this patient should be enrolled in.
Protocols[].Cycles[].Days[].Procedures[].Description
String
PossibleThe description of the procedure.
Protocols[].Cycles[].Days[].Procedures[].Modifiers[]
Array of Strings
PossibleList of modifiers for this procedure
{
"Meta": {
"DataModel": "Research",
"EventType": "Study",
"EventDateTime": "2024-09-26T13:09:20.653Z",
"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
},
"Study": {
"Identifiers": [
{
"ID": "2012P000957F",
"IDType": "Org ID"
},
{
"ID": "NCT02738255",
"IDType": "NCT"
}
],
"Title": "Effect of Added Varnum Mouthpiece on Pharyngeal Collapsibility and Sleep Apnea Severity in Mouth Breathers.",
"Type": "Interventional",
"Sponsor": {
"ID": null,
"Name": "David Andrew Wellman"
},
"PrincipalInvestigator": {
"ID": null,
"IDType": null,
"FirstName": "Andrew",
"LastName": "Wellman",
"Credentials": [],
"Address": {
"StreetAddress": null,
"City": null,
"State": null,
"ZIP": null,
"County": null,
"Country": null
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "6174078483"
},
"Location": {
"Type": null,
"Facility": "Brigham and Women's Hospital",
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
"Coordinators": [
{
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
}
],
"Description": "Test the effect of added a single-use Varnum mouthpiece on pharyngeal collapsibility and\n obstructive sleep apnea (OSA) severity in patients who identify themselves as mouth\n breathers. Research indicates that nasal breathing not only may improve sleep apnea but it\n also increases circulation, blood oxygen, and carbon dioxide levels, slows the breathing\n rate, and improves overall lung volumes. Thus, the investigators will test whether a\n single-use Varnum mouthpiece can improve pharyngeal collapsibility and OSA severity in mouth\n breathers.",
"Status": "Completed",
"StartDateTime": "2016-06-02T04:00:00.000Z",
"Conditions": [
{
"Code": null,
"CodeSystem": null,
"CodeSystemName": null,
"Name": "Obstructive Sleep Apnea",
"AltCodes": []
}
],
"Design": {
"Purpose": "Treatment",
"Phase": null
},
"Eligibility": {
"Gender": "All",
"MinimumAge": 21,
"MaximumAge": 70
},
"Location": {
"Type": null,
"Facility": "Brigham and Women's Hospital",
"FacilityIdentifiers": [],
"Department": "Sleep Disorders Research Program Brigham and Women's Hospital",
"DepartmentIdentifiers": [],
"Room": null,
"Address": {
"StreetAddress": null,
"City": "Boston",
"State": "MA",
"ZIP": "02115",
"County": null,
"Country": null
}
}
},
"Protocols": [
{
"ID": "P1",
"IDType": "CELL",
"Description": "Protocol 1",
"Cycles": [
{
"ID": "P1.C1",
"IDType": "CYCLE",
"Description": "Cycle 1",
"StartDate": "2019-01-01",
"EndDate": "2019-01-31",
"Days": [
{
"ID": "P1.C1.D1",
"IDType": "VISIT",
"Description": null,
"ActivityDateTime": null,
"EarliestDateTime": null,
"LatestDateTime": null,
"Procedures": [
{
"Code": "77416",
"CodeSet": "PROC",
"Description": "Chest XRay",
"Modifiers": []
}
]
}
]
}
]
}
]
}
The SubjectUpdate event can be used to associate a patient to a study. An EHR may allow users to mark patients as a candidate for a study, in which case this event would be communicated to the trial management system. The trial management system may also then confirm the status of the patient, which will be sent back to the EHR.
Fields
Meta
Meta.DataModel
String
ReliableRequiredResearch
Meta.EventType
String
ReliableRequiredSubjectUpdate
Meta.EventDateTime
DateTime
ReliableDisplays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format
Meta.Test
Boolean
ReliableIndicates whether the request is a test or not.
Meta.Source
String
ReliableContains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox
Meta.Source.ID
String
ReliableIdentifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID
Meta.Source.Name
String
ReliableDisplays the name of the system initiating the message.
Meta.Destinations[]
Array of Objects
ReliableContains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.
Meta.Destinations[].ID
String
ReliableIdentifies the endpoint that the request is directed to.
UUID
Meta.Destinations[].Name
String
ReliableDisplays the name of the endpoint that the request is directed to.
Meta.Logs[]
Array of Objects
ReliableContains the log identifier(s) for the request.
Meta.Logs[].ID
String
ReliableIdentifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID
Meta.Logs[].AttemptID
String
ReliableIdentifies the request log attempt value, which is useful when retries are possible.
UUID
Meta.FacilityCode
String
PossibleCode for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
Enrollment
Enrollment.SubjectStatus
String
ReliableValueSetThe status of the Patient/Subject. For example, eligible may be sent when a patient matches certain criteria, and on-study may be sent when they are enrolled.
-
Additional values may be added by Redox in the future.
-
Enrollment.StartDateTime
DateTime
ReliableStart of participation in the study, or consent date.
Enrollment.EndDateTime
DateTime
ReliableEnd of participation in the study.
Enrollment.Coordinators[].ID
String
PossibleID of the provider.
This ID is often required for Inpatient Visits.
Enrollment.Coordinators[].IDType
String
PossibleID type of the ID for the provider
Enrollment.Coordinators[].FirstName
String
PossibleFirst name of the undefined
Enrollment.Coordinators[].LastName
String
PossibleLast name of the undefined
Enrollment.Coordinators[].Credentials[]
Array of Strings
PossibleList of credentials for the undefined.
e.g. MD, PhD
Enrollment.Coordinators[].Address
Object
PossibleProvider's address
Enrollment.Coordinators[].Address.StreetAddress
String
PossibleStreet address
Enrollment.Coordinators[].Address.City
String
PossibleCity
Enrollment.Coordinators[].Address.State
String
PossibleState
Enrollment.Coordinators[].Address.ZIP
String
PossibleZIP
Enrollment.Coordinators[].Address.County
String
PossibleCounty
Enrollment.Coordinators[].Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Enrollment.Coordinators[].EmailAddresses[]
Array of Strings
ProbableProvider's email address(es)
Enrollment.Coordinators[].PhoneNumber.Office
String
PossibleProvider's office phone number.
In E. 164 Format. (e.g. +16085551234)
Enrollment.Coordinators[].Location
Object
PossibleProvider's location
Enrollment.Coordinators[].Location.Type
String
PossibleType of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone
Enrollment.Coordinators[].Location.Facility
String
PossibleFacility.
Example: Community Hospital
Enrollment.Coordinators[].Location.FacilityIdentifiers[]
Array of Objects
PossibleList of IDs specific to this facility
Enrollment.Coordinators[].Location.FacilityIdentifiers[].ID
String
PossibleAn ID specific to this facility
Enrollment.Coordinators[].Location.FacilityIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Enrollment.Coordinators[].Location.Department
String
PossibleDepartment
Enrollment.Coordinators[].Location.DepartmentIdentifiers[]
Array of Objects
PossibleList of IDs specific to this department
Enrollment.Coordinators[].Location.DepartmentIdentifiers[].ID
String
PossibleAn ID specific to this department
Enrollment.Coordinators[].Location.DepartmentIdentifiers[].IDType
String
PossibleThe source or system to which this ID pertains.
Could be an OID or a human-readable name
Enrollment.Coordinators[].Location.Room
String
PossibleRoom.
Example: 136
Patient
Patient.Identifiers[]
Array of Objects
ReliableList of IDs and ID types that identify the patient
Patient.Identifiers[].ID
String
ReliableID for the patient
Patient.Identifiers[].IDType
String
ReliableType of ID.
E.g. MRN, EPI
Patient.Demographics.FirstName
String
ReliablePatient's first name
Patient.Demographics.MiddleName
String
PossiblePatient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
Patient.Demographics.LastName
String
ReliablePatient's last name
Patient.Demographics.DOB
String
ReliablePatient's date of birth.
In ISO 8601 format
Patient.Demographics.SSN
String
ProbablePatient's social security number
Patient.Demographics.Sex
String
ReliableValueSetPatient's sex
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Race
String
PossibleValueSetPatient's race
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsHispanic
Boolean
PossibleValueSetIndicates if the patient is of hispanic origin.
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Religion
String
PossibleValueSetPatient's religious affiliation
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.MaritalStatus
String
PossibleValueSetPatient's marital status
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.IsDeceased
Boolean
PossibleIndicates if the patient is deceased
Patient.Demographics.DeathDateTime
DateTime
PossibleDate and Time the patient was proclaimed deceased.
ISO 8601 Format
Patient.Demographics.PhoneNumber.Home
String
ProbablePatient's home phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Office
String
ProbablePatient's office phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.PhoneNumber.Mobile
String
ProbablePatient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
Patient.Demographics.EmailAddresses[]
Array of Strings
ProbablePatient's email address(es)
Patient.Demographics.Language
String
PossibleValueSetPatient's primary spoken language
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Citizenship[]
Array of strings
PossibleValueSetPatient's nation(s) of citizenship
-
Additional values may be added by Redox in the future.
-
Patient.Demographics.Address
Object
ProbablePatient's home address
Patient.Demographics.Address.StreetAddress
String
ProbableStreet address
Patient.Demographics.Address.City
String
ProbableCity
Patient.Demographics.Address.State
String
ProbableState
Patient.Demographics.Address.ZIP
String
ProbableZIP
Patient.Demographics.Address.County
String
PossibleCounty
Patient.Demographics.Address.Country
String
PossibleValueSetCountry
-
Additional values may be added by Redox in the future.
-
Patient.Notes[]
Array of strings
PossiblePatient-level notes
Study
Study.Identifiers[]
Array of Objects
ReliableIdentifiers for the study this patient should be enrolled in.
Study.Identifiers[].ID
String
Reliable
Study.Identifiers[].IDType
String
Reliable
Study.Title
String
Reliable
Study.Type
String
ReliableValueSetThe nature of the investigation or investigational use for the study.
-
Additional values may be added by Redox in the future.
-
{
"Meta": {
"DataModel": "Research",
"EventType": "SubjectUpdate",
"EventDateTime": "2024-09-26T13:09:20.653Z",
"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
},
"Enrollment": {
"SubjectStatus": "active",
"StartDateTime": "1906-12-10T00:00:00.000Z",
"EndDateTime": null,
"Coordinators": [
{
"ID": "4356789876",
"IDType": "NPI",
"FirstName": "Pat",
"LastName": "Granite",
"Credentials": [
"MD"
],
"Address": {
"StreetAddress": "123 Main St.",
"City": "Madison",
"State": "WI",
"ZIP": "53703",
"County": "Dane",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+16085551234"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": null
}
},
{
"ID": "4236464757",
"IDType": "NPI",
"FirstName": "John",
"LastName": "Slate",
"Credentials": [
"DO"
],
"Address": {
"StreetAddress": "500 First St.",
"City": "Clayton",
"State": "MO",
"ZIP": "63105",
"County": "Saint Louis",
"Country": "USA"
},
"EmailAddresses": [],
"PhoneNumber": {
"Office": "+13145554321"
},
"Location": {
"Type": null,
"Facility": null,
"FacilityIdentifiers": [],
"Department": null,
"DepartmentIdentifiers": [],
"Room": 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": []
},
"Study": {
"Identifiers": [
{
"ID": "2012P000957F",
"IDType": "Org ID"
},
{
"ID": "NCT02738255",
"IDType": "NCT"
}
],
"Title": "Effect of Added Varnum Mouthpiece on Pharyngeal Collapsibility and Sleep Apnea Severity in Mouth Breathers.",
"Type": "Interventional"
}
}