Home
API reference
Redox Data Models
Research
SubjectUpdate

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.

SubjectUpdate

Receive or push a notification about a patient's participation or status in a clinical trial.

An EHR system may allow users to mark patients as a candidate for a study or the CTMS may confirm the status of the patient.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Research

    • EventType
      required, string
      Reliable

      SubjectUpdate

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

  • Enrollment
    object
    • SubjectStatus
      string, null
      Reliable
      Value Set

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

    • StartDateTime
      string, null
      Reliable

      Start of participation in the study, or consent date.

    • EndDateTime
      string, null
      Reliable

      End of participation in the study.

    • 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

  • Patient
    object
    • Identifiers
      Array of object

      List of IDs and ID types that identify the patient

      • ID
        string, null
        Reliable

        ID for the patient

      • IDType
        string, null
        Reliable

        Type of ID.
        E.g. MRN, EPI

    • Demographics
      object
      • FirstName
        string, null
        Reliable

        Patient's first name

      • MiddleName
        string, null
        Possible

        Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

      • LastName
        string, null
        Reliable

        Patient's last name

      • DOB
        string, null
        Reliable

        Patient's date of birth.
        In ISO 8601 format

      • SSN
        string, null
        Probable

        Patient's social security number

      • Sex
        string, null
        Reliable
        Value Set

        Patient's sex

      • Race
        string, null
        Possible
        Value Set

        Patient's race

      • IsHispanic
        boolean, null
        Possible
        Value Set

        Indicates if the patient is of hispanic origin.

      • Religion
        string, null
        Possible
        Value Set

        Patient's religious affiliation

      • MaritalStatus
        string, null
        Possible
        Value Set

        Patient's marital status

      • IsDeceased
        boolean, null
        Possible

        Indicates if the patient is deceased

      • DeathDateTime
        string, null
        Possible

        Date and Time the patient was proclaimed deceased.
        ISO 8601 Format

      • PhoneNumber
        object
        • Home
          string, null
          Probable

          Patient's home phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Office
          string, null
          Probable

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

        • Mobile
          string, null
          Probable

          Patient's mobile phone number.
          In E. 164 Format. (e.g. +16085551234)

      • EmailAddresses
        Array of string

        Patient's email address(es)

      • Language
        string, null
        Possible
        Value Set

        Patient's primary spoken language.
        In ISO 639-1 alpha values (e.g. 'en'). Supported Values

      • Citizenship
        Array of string

        Patient's nation(s) of citizenship.
        In ISO 3166 alpha 2 format (e.g. 'US').

      • Address
        object

        Patient's home 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

    • Notes
      Array of string

      Patient-level notes

  • Study
    object
    • Identifiers
      Array of object

      Identifiers for the study this patient should be enrolled in.

      • ID
        string, null
        Reliable
      • IDType
        string, null
        Reliable
    • Title
      string, null
      Reliable
    • Type
      string, null
      Reliable
      Value Set

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

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Research",
4
    "EventType": "SubjectUpdate",
5
    "EventDateTime": "2024-12-20T18:11:36.537Z",
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
  "Enrollment": {
26
    "SubjectStatus": "active",
27
    "StartDateTime": "1906-12-10T00:00:00.000Z",
28
    "EndDateTime": null,
29
    "Coordinators": [
30
      {
31
        "ID": "4356789876",
32
        "IDType": "NPI",
33
        "FirstName": "Pat",
34
        "LastName": "Granite",
35
        "Credentials": [
36
          "MD"
37
        ],
38
        "Address": {
39
          "StreetAddress": "123 Main St.",
40
          "City": "Madison",
41
          "State": "WI",
42
          "ZIP": "53703",
43
          "County": "Dane",
44
          "Country": "USA"
45
        },
46
        "EmailAddresses": [],
47
        "PhoneNumber": {
48
          "Office": "+16085551234"
49
        },
50
        "Location": {
51
          "Type": null,
52
          "Facility": null,
53
          "FacilityIdentifiers": [],
54
          "Department": null,
55
          "DepartmentIdentifiers": [],
56
          "Room": null
57
        }
58
      },
59
      {
60
        "ID": "4236464757",
61
        "IDType": "NPI",
62
        "FirstName": "John",
63
        "LastName": "Slate",
64
        "Credentials": [
65
          "DO"
66
        ],
67
        "Address": {
68
          "StreetAddress": "500 First St.",
69
          "City": "Clayton",
70
          "State": "MO",
71
          "ZIP": "63105",
72
          "County": "Saint Louis",
73
          "Country": "USA"
74
        },
75
        "EmailAddresses": [],
76
        "PhoneNumber": {
77
          "Office": "+13145554321"
78
        },
79
        "Location": {
80
          "Type": null,
81
          "Facility": null,
82
          "FacilityIdentifiers": [],
83
          "Department": null,
84
          "DepartmentIdentifiers": [],
85
          "Room": null
86
        }
87
      }
88
    ]
89
  },
90
  "Patient": {
91
    "Identifiers": [
92
      {
93
        "ID": "0000000001",
94
        "IDType": "MR"
95
      },
96
      {
97
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
98
        "IDType": "EHRID"
99
      },
100
      {
101
        "ID": "a1d4ee8aba494ca",
102
        "IDType": "NIST"
103
      }
104
    ],
105
    "Demographics": {
106
      "FirstName": "Timothy",
107
      "MiddleName": "Paul",
108
      "LastName": "Bixby",
109
      "DOB": "2008-01-06",
110
      "SSN": "101-01-0001",
111
      "Sex": "Male",
112
      "Race": "White",
113
      "IsHispanic": null,
114
      "Religion": null,
115
      "MaritalStatus": "Single",
116
      "IsDeceased": null,
117
      "DeathDateTime": null,
118
      "PhoneNumber": {
119
        "Home": "+18088675301",
120
        "Office": null,
121
        "Mobile": null
122
      },
123
      "EmailAddresses": [],
124
      "Language": "en",
125
      "Citizenship": [],
126
      "Address": {
127
        "StreetAddress": "4762 Hickory Street",
128
        "City": "Monroe",
129
        "State": "WI",
130
        "ZIP": "53566",
131
        "County": "Green",
132
        "Country": "US"
133
      }
134
    },
135
    "Notes": []
136
  },
137
  "Study": {
138
    "Identifiers": [
139
      {
140
        "ID": "2012P000957F",
141
        "IDType": "Org ID"
142
      },
143
      {
144
        "ID": "NCT02738255",
145
        "IDType": "NCT"
146
      }
147
    ],
148
    "Title": "Effect of Added Varnum Mouthpiece on Pharyngeal Collapsibility and Sleep Apnea Severity in Mouth Breathers.",
149
    "Type": "Interventional"
150
  }
151
}