Home
API reference
Redox Data Models
Research
Study

Research

This data model allows you to exchange data with any Clinical Management Systems (CTMS). The CTMS defines a clinical trial in their system and pushes data to the EHR system. Either you or your connection may enroll patients in the trial and share relevant information with between systems.

The Research data model is useful if you work with academia or strong research programs and are interested in patient study status or a list of active studies. You can exchange data if your organization does labs, imaging, or other work to contribute to the study. Your connections must have robust interfacing capabilities to use this data model.

This data model has event types that allow you to:

  • receive a notification when a study is created or updated; or
  • receive or push a notification about study participants.

Study

Receive a notification when a new study is created or an existing study is updated in the CTMS. This event has information about one specific study.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Research

    • EventType
      required, string
      Reliable

      Study

    • EventDateTime
      string, null
      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

      • ID
        string, null
        Reliable

        Identifies 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

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      Contains 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.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the endpoint that the request is directed to.

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        Reliable

        Identifies 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

      • AttemptID
        string, null
        Reliable

        Identifies the request log attempt value, which is useful when retries are possible.
        UUID

    • FacilityCode
      string, null
      Possible

      Code 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
    object
    • Identifiers
      Array of object

      Identifiers for the study. Should include both internal and external identifiers (such as an NCT ID)

      • ID
        string, null
        Reliable
      • IDType
        string, null
        Reliable
    • Title
      string, null
      Reliable

      Official title of the study

    • Type
      string, null
      Reliable
      Value Set

      The nature of the investigation or investigational use for the study.

    • Sponsor
      object

      The sponsor of the study

      • ID
        string, null
        Probable

        Identifier for the sponsor of the study, if applicable

      • Name
        string, null
        Reliable

        String representation of the sponsor name

    • PrincipalInvestigator
      object
      • ID
        string, null
        Possible

        ID of the provider.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the provider

      • FirstName
        string, null
        Possible

        First name of the provider

      • LastName
        string, null
        Possible

        Last name of the provider

      • Credentials
        Array of string

        List of credentials for the provider.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • Coordinators
      Array of object
      • ID
        string, null
        Possible

        ID of the provider.
        This ID is often required for Inpatient Visits.

      • IDType
        string, null
        Possible

        ID type of the ID for the provider

      • FirstName
        string, null
        Possible

        First name of the undefined

      • LastName
        string, null
        Possible

        Last name of the undefined

      • Credentials
        Array of string

        List of credentials for the undefined.
        e.g. MD, PhD

      • Address
        object

        Provider's address

        • StreetAddress
          string, null
          Possible

          Street address

        • City
          string, null
          Possible

          City

        • State
          string, null
          Possible

          State

        • ZIP
          string, null
          Possible

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

      • EmailAddresses
        Array of string

        Provider's email address(es)

      • PhoneNumber
        object
        • Office
          string, null
          Possible

          Provider's office phone number.
          In E. 164 Format. (e.g. +16085551234)

      • Location
        object

        Provider's location

        • Type
          string, null
          Possible

          Type of location.
          Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

        • Facility
          string, null
          Possible

          Facility.
          Example: Community Hospital

        • FacilityIdentifiers
          Array of object

          List of IDs specific to this facility

          • ID
            string, null
            Possible

            An ID specific to this facility

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Department
          string, null
          Possible

          Department

        • DepartmentIdentifiers
          Array of object

          List of IDs specific to this department

          • ID
            string, null
            Possible

            An ID specific to this department

          • IDType
            string, null
            Possible

            The source or system to which this ID pertains.
            Could be an OID or a human-readable name

        • Room
          string, null
          Possible

          Room.
          Example: 136

    • Description
      string, null
      Probable

      Full description of the study

    • Status
      string, null
      Probable

      What 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

    • StartDateTime
      string, null
      Probable

      The estimated date on which the clinical study will be open for recruitment of participants.

    • Conditions
      Array of object
      • Code
        string, null
        Probable

        A code describing conditions applicable to the study

      • CodeSystem
        string, null
        Probable

        ID of the coding system to which the code belongs in OID format.
        Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

      • CodeSystemName
        string, null
        Probable

        Coding 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.

      • Name
        string, null
        Probable

        Name of conditions applicable to the study

      • AltCodes
        Array of object

        Alternate or translation codes for conditions applicable to the study

        • Code
          string, null
          Possible

          A code describing conditions applicable to the study

        • CodeSystem
          string, null
          Possible

          ID of the coding system to which the code belongs in OID format.
          Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

        • CodeSystemName
          string, null
          Possible

          Coding 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.

        • Name
          string, null
          Possible

          Name of conditions applicable to the study

    • Design
      object

      Information about how the trial will run.

      • Purpose
        string, null
        Probable

        The 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.

      • Phase
        string, null
        Probable

        For 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.

    • Eligibility
      object

      Rules about individuals eligible to participate in the study.

      • Gender
        string, null
        Probable

        The gender of the participants eligible to participate in the clinical study.
        All, Male, or Female

      • MinimumAge
        number, null
        Probable

        Minimum age a potential participant must meet to be eligible for the clinical study.

      • MaximumAge
        number, null
        Probable

        Maximum age a potential participant must meet to be eligible for the clinical study.

    • Location
      object
      • Type
        string, null
        Probable

        Type of location.
        Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

      • Facility
        string, null
        Probable

        Facility.
        Example: Community Hospital

      • FacilityIdentifiers
        Array of object

        List of IDs specific to this facility

        • ID
          string, null
          Probable

          An ID specific to this facility

        • IDType
          string, null
          Probable

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Department
        string, null
        Probable

        Department

      • DepartmentIdentifiers
        Array of object

        List of IDs specific to this department

        • ID
          string, null
          Probable

          An ID specific to this department

        • IDType
          string, null
          Probable

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Room
        string, null
        Probable

        Room.
        Example: 136

      • Address
        object

        Physical address

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

  • Protocols
    Array of object

    Each protocol represents a sequence of events that will be assigned to a group of patients participating in the study.

    • ID
      string, null
      Possible

      The identifier for the protocol.

    • IDType
      string, null
      Possible

      The identifier type for the protocol.

    • Description
      string, null
      Possible

      The unique name for the protocol.

    • Cycles
      Array of object

      Each cycle represents a grouping of days within the protocol.

      • ID
        string, null
        Possible

        The identifier for the cycle.

      • IDType
        string, null
        Possible

        The identifier type for the cycle.

      • Description
        string, null
        Possible

        The unique name for the cycle.

      • StartDate
        string, null
        Possible

        The date the cycle begins.
        ISO 8601 Format

      • EndDate
        string, null
        Possible

        The date the cycle ends.
        ISO 8601 Format

      • Days
        Array of object

        Each day represents a patient's visit related to the study protocol.

        • ID
          string, null
          Possible

          The identifier for this day.

        • IDType
          string, null
          Possible

          The identifier type for the day.

        • Description
          string, null
          Possible

          The unique name for the day.

        • ActivityDateTime
          string, null
          Possible

          The activity date.
          ISO 8601 Format

        • EarliestDateTime
          string, null
          Possible

          The earliest date in which the activity can be scheduled.
          ISO 8601 Format

        • LatestDateTime
          string, null
          Possible

          The latest date in which the activity can be scheduled.
          ISO 8601 Format

        • Procedures
          Array of object

          A list of procedures that are related to the study day.

          • Code
            string, null
            Probable

            The identifier for the procedure.

          • CodeSet
            string, null
            Possible

            Identifiers for the protocol this patient should be enrolled in.

          • Description
            string, null
            Possible

            The description of the procedure.

          • Modifiers
            Array of string

            List of modifiers for this procedure

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Research",
4
    "EventType": "Study",
5
    "EventDateTime": "2024-11-20T14:08:29.777Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Study": {
26
    "Identifiers": [
27
      {
28
        "ID": "2012P000957F",
29
        "IDType": "Org ID"
30
      },
31
      {
32
        "ID": "NCT02738255",
33
        "IDType": "NCT"
34
      }
35
    ],
36
    "Title": "Effect of Added Varnum Mouthpiece on Pharyngeal Collapsibility and Sleep Apnea Severity in Mouth Breathers.",
37
    "Type": "Interventional",
38
    "Sponsor": {
39
      "ID": null,
40
      "Name": "David Andrew Wellman"
41
    },
42
    "PrincipalInvestigator": {
43
      "ID": null,
44
      "IDType": null,
45
      "FirstName": "Andrew",
46
      "LastName": "Wellman",
47
      "Credentials": [],
48
      "Address": {
49
        "StreetAddress": null,
50
        "City": null,
51
        "State": null,
52
        "ZIP": null,
53
        "County": null,
54
        "Country": null
55
      },
56
      "EmailAddresses": [],
57
      "PhoneNumber": {
58
        "Office": "6174078483"
59
      },
60
      "Location": {
61
        "Type": null,
62
        "Facility": "Brigham and Women's Hospital",
63
        "FacilityIdentifiers": [],
64
        "Department": null,
65
        "DepartmentIdentifiers": [],
66
        "Room": null
67
      }
68
    },
69
    "Coordinators": [
70
      {
71
        "ID": "4356789876",
72
        "IDType": "NPI",
73
        "FirstName": "Pat",
74
        "LastName": "Granite",
75
        "Credentials": [
76
          "MD"
77
        ],
78
        "Address": {
79
          "StreetAddress": "123 Main St.",
80
          "City": "Madison",
81
          "State": "WI",
82
          "ZIP": "53703",
83
          "County": "Dane",
84
          "Country": "USA"
85
        },
86
        "EmailAddresses": [],
87
        "PhoneNumber": {
88
          "Office": "+16085551234"
89
        },
90
        "Location": {
91
          "Type": null,
92
          "Facility": null,
93
          "FacilityIdentifiers": [],
94
          "Department": null,
95
          "DepartmentIdentifiers": [],
96
          "Room": null
97
        }
98
      }
99
    ],
100
    "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.",
101
    "Status": "Completed",
102
    "StartDateTime": "2016-06-02T04:00:00.000Z",
103
    "Conditions": [
104
      {
105
        "Code": null,
106
        "CodeSystem": null,
107
        "CodeSystemName": null,
108
        "Name": "Obstructive Sleep Apnea",
109
        "AltCodes": []
110
      }
111
    ],
112
    "Design": {
113
      "Purpose": "Treatment",
114
      "Phase": null
115
    },
116
    "Eligibility": {
117
      "Gender": "All",
118
      "MinimumAge": 21,
119
      "MaximumAge": 70
120
    },
121
    "Location": {
122
      "Type": null,
123
      "Facility": "Brigham and Women's Hospital",
124
      "FacilityIdentifiers": [],
125
      "Department": "Sleep Disorders Research Program Brigham and Women's Hospital",
126
      "DepartmentIdentifiers": [],
127
      "Room": null,
128
      "Address": {
129
        "StreetAddress": null,
130
        "City": "Boston",
131
        "State": "MA",
132
        "ZIP": "02115",
133
        "County": null,
134
        "Country": null
135
      }
136
    }
137
  },
138
  "Protocols": [
139
    {
140
      "ID": "P1",
141
      "IDType": "CELL",
142
      "Description": "Protocol 1",
143
      "Cycles": [
144
        {
145
          "ID": "P1.C1",
146
          "IDType": "CYCLE",
147
          "Description": "Cycle 1",
148
          "StartDate": "2019-01-01",
149
          "EndDate": "2019-01-31",
150
          "Days": [
151
            {
152
              "ID": "P1.C1.D1",
153
              "IDType": "VISIT",
154
              "Description": null,
155
              "ActivityDateTime": null,
156
              "EarliestDateTime": null,
157
              "LatestDateTime": null,
158
              "Procedures": [
159
                {
160
                  "Code": "77416",
161
                  "CodeSet": "PROC",
162
                  "Description": "Chest XRay",
163
                  "Modifiers": []
164
                }
165
              ]
166
            }
167
          ]
168
        }
169
      ]
170
    }
171
  ]
172
}