Home
API reference
Redox Data Models
PatientEducation
New

PatientEducation

This data model communicates provider-initiated assignments to your system so the patient can view or act on content within your app. You can notify the provider when a patient progresses or completes the assignments.

PatientEducation event types are usually triggered from the EHR system when the clinician creates or updates a patient’s educational plan. This is commonly used for inpatient settings to help prevent readmissions.

This data model has event types that allow you to:

  • receive a notification for new, updated, or deleted patient assignments.

New

Receive a notification when a provider adds new education assignments to a patient's chart.

Beta

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      PatientEducation

    • EventType
      required, string
      Reliable

      New

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

  • Patient
    required, object
    • Identifiers
      required, Array of object

      List of IDs and ID types that identify the patient

      • ID
        required, string
        Reliable

        ID for the patient

      • IDType
        required, string
        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

  • Education
    required, Array of object

    Education concepts

    • Subject
      required, object

      Subject of the education concept

      • Code
        required, string
        Probable

        Code for the education subject

      • Codeset
        string, null
        Probable

        Code set used to identify the education subject

      • Description
        string, null
        Probable

        Description of the education subject

    • InstanceID
      string, null
      Possible

      Unique ID that is assigned to the instance of the education resource

    • CreatedDateTime
      string, null
      Possible

      The date and time the instance of the education resource was assigned.
      ISO 8601 format

    • Status
      string, null
      Possible

      The status of the instance of the education resource.
      Values will be one of the following: Active, Resolved, Deleted

    • ActionStatus
      string, null
      Probable

      The action taken on the instance of education resource.
      Values will be one of the following: Assign, Delete, Update

    • ActionDateTime
      string, null
      Probable

      The date and time the action was taken on the instance of education resource.
      ISO 8601 Format

    • Assignments
      Array of object

      List of assigned patient education resources. Education assignments can be videos, handouts, etc.

      • Code
        string, null
        Reliable

        Code for the assignment

      • Codeset
        string, null
        Reliable

        Code set used to identify the assignment

      • Description
        string, null
        Reliable

        Description of the assignment

      • Topic
        object

        Topic of the education assignment

        • Code
          string, null
          Probable

          Code for the assignment topic

        • Codeset
          string, null
          Probable

          Code set used to identify the assignment topic

        • Description
          string, null
          Probable

          Description of the assignment topic

      • InstanceID
        string, null
        Possible

        Unique ID that is assigned to the instance of the education resource

      • CreatedDateTime
        string, null
        Possible

        The date and time the instance of the education assignment was created.
        ISO 8601 format

      • Status
        string, null
        Possible

        The status of the instance of the education assignment.
        Values will be one of the following: Active, Resolved, Deleted

      • ActionStatus
        string, null
        Probable

        The action taken on the instance of education assignment.
        Values will be one of the following: Assign, Delete, Update

      • ActionDateTime
        string, null
        Probable

        The date and time the action was taken on the instance of education assignment.
        ISO 8601 Format

      • Assignees
        Array of object

        The list of assignees associated to the education assignment

        • Learner
          string, null
          Probable

          The learner type assigned.
          Example: Patient, Parent, Caregiver

        • ContentType
          string, null
          Probable

          The type of content assigned to the learner.
          Example: Video, pamphlet, demonstration

        • Readiness
          string, null
          Possible

          An indication of how eager the learner is to engage in the education.
          Example: Eager, Accepting, Unwilling

        • Response
          string, null
          Possible

          The response of the learner once the education is complete.
          Example: Verbalized understanding, Cannot demonstrate understanding

        • Notes
          Array of string

          Notes about the assignee's assignment

  • Visit
    object
    • VisitNumber
      string, null
      Reliable

      Visit Number.
      Unique ID of a single visit

    • AccountNumber
      string, null
      Possible

      Account Number.
      An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.

    • PatientClass
      string, null
      Probable

      Patient class is used in many EHRs to determine where to put the patient.
      Examples: Inpatient, Outpatient, Emergency

    • VisitDateTime
      string, null
      Possible

      DateTime of visit or the arrival time of the visit or admission.
      ISO 8601 Format

    • AttendingProvider
      object
      • NPI
        string, null
        Probable

        NPI of the attending provider

      • ID
        string, null
        Probable

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

      • IDType
        string, null
        Probable

        ID type of the ID for the attending provider

      • FirstName
        string, null
        Possible

        First name of the attending provider

      • LastName
        string, null
        Possible

        Last name of the attending provider

      • Credentials
        Array of string

        List of credentials for the attending 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

    • ConsultingProvider
      object
      • NPI
        string, null
        Possible

        NPI of the consulting provider

      • ID
        string, null
        Possible

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

      • IDType
        string, null
        Possible

        ID type of the ID for the consulting provider

      • FirstName
        string, null
        Possible

        First name of the consulting provider

      • LastName
        string, null
        Possible

        Last name of the consulting provider

      • Credentials
        Array of string

        List of credentials for the consulting 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

    • ReferringProvider
      object
      • NPI
        string, null
        Possible

        NPI of the referring provider

      • ID
        string, null
        Possible

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

      • IDType
        string, null
        Possible

        ID type of the ID for the referring provider

      • FirstName
        string, null
        Possible

        First name of the referring provider

      • LastName
        string, null
        Possible

        Last name of the referring provider

      • Credentials
        Array of string

        List of credentials for the referring 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

    • Location
      object

      Location of the visit

      • 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

      • Bed
        string, null
        Probable

        Bed.
        Example: B

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "PatientEducation",
4
    "EventType": "New",
5
    "EventDateTime": "2024-11-18T21:23:08.746Z",
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
  "Patient": {
26
    "Identifiers": [
27
      {
28
        "ID": "994002",
29
        "IDType": "MRN"
30
      }
31
    ],
32
    "Demographics": {
33
      "FirstName": "Ase",
34
      "MiddleName": null,
35
      "LastName": "Nzesi",
36
      "DOB": "1978-01-25",
37
      "SSN": "111-22-3333",
38
      "Sex": "Female",
39
      "Race": "Black",
40
      "IsHispanic": false,
41
      "Religion": null,
42
      "MaritalStatus": "Married",
43
      "IsDeceased": false,
44
      "DeathDateTime": null,
45
      "PhoneNumber": {
46
        "Home": "+18088675310",
47
        "Office": null,
48
        "Mobile": null
49
      },
50
      "EmailAddresses": [
51
        "ase@nzesi.th"
52
      ],
53
      "Language": "en",
54
      "Citizenship": [
55
        "US",
56
        "TH",
57
        "CR"
58
      ],
59
      "Address": {
60
        "StreetAddress": "Suan Dok Soi 6/3",
61
        "City": "Chaing Mai",
62
        "State": "Chang Wat Chang Mai",
63
        "ZIP": "50200",
64
        "County": "Amphoe Mueang Chiang Mai",
65
        "Country": "Thailand"
66
      }
67
    },
68
    "Notes": []
69
  },
70
  "Visit": {
71
    "VisitNumber": "3498128348",
72
    "AccountNumber": "12945932",
73
    "PatientClass": "Inpatient",
74
    "VisitDateTime": "2024-11-18T21:23:08.735Z",
75
    "AttendingProvider": {
76
      "NPI": null,
77
      "ID": "426986",
78
      "IDType": "NCT",
79
      "FirstName": "Krittiya",
80
      "LastName": "Somaketarin",
81
      "Credentials": [
82
        "MD"
83
      ],
84
      "Address": {
85
        "StreetAddress": "8 Bunrueang Rit Rd",
86
        "City": "Chiang Mai",
87
        "State": "Chang Wat Chiang Mai",
88
        "ZIP": "50200",
89
        "County": "Amphoe Mueang Chiang Mai",
90
        "Country": "Thailand"
91
      },
92
      "EmailAddresses": [],
93
      "PhoneNumber": {
94
        "Office": "+6653920300"
95
      },
96
      "Location": {
97
        "Type": "Department",
98
        "Facility": "Medical Center",
99
        "FacilityIdentifiers": [],
100
        "Department": "Obstetrics and Gynaecology",
101
        "DepartmentIdentifiers": [],
102
        "Room": "446"
103
      }
104
    },
105
    "ConsultingProvider": {
106
      "NPI": null,
107
      "ID": null,
108
      "IDType": null,
109
      "FirstName": null,
110
      "LastName": null,
111
      "Credentials": [],
112
      "Address": {
113
        "StreetAddress": null,
114
        "City": null,
115
        "State": null,
116
        "ZIP": null,
117
        "County": null,
118
        "Country": null
119
      },
120
      "EmailAddresses": [],
121
      "PhoneNumber": {
122
        "Office": null
123
      },
124
      "Location": {
125
        "Type": null,
126
        "Facility": null,
127
        "FacilityIdentifiers": [],
128
        "Department": null,
129
        "DepartmentIdentifiers": [],
130
        "Room": null
131
      }
132
    },
133
    "ReferringProvider": {
134
      "NPI": null,
135
      "ID": "12981294",
136
      "IDType": "NCT",
137
      "FirstName": "Carol",
138
      "LastName": "Fujiyoshi",
139
      "Credentials": [
140
        "MD"
141
      ],
142
      "Address": {
143
        "StreetAddress": "3-3420 Kuhio Hwy Suite B",
144
        "City": "Lihue",
145
        "State": "HI",
146
        "ZIP": "96766",
147
        "County": "Kauai",
148
        "Country": "United States"
149
      },
150
      "EmailAddresses": [],
151
      "PhoneNumber": {
152
        "Office": "+18082451511"
153
      },
154
      "Location": {
155
        "Type": "Hawaii Pacific Health Hospital",
156
        "Facility": "Wilcox Medical Center",
157
        "FacilityIdentifiers": [],
158
        "Department": "Obstetrics and Gynecology",
159
        "DepartmentIdentifiers": [],
160
        "Room": "32"
161
      }
162
    },
163
    "Location": {
164
      "Type": "Inpatient",
165
      "Facility": "Chiang Mai Ram Hospital",
166
      "FacilityIdentifiers": [],
167
      "Department": "MA",
168
      "DepartmentIdentifiers": [],
169
      "Room": "13",
170
      "Bed": "A"
171
    }
172
  },
173
  "Education": [
174
    {
175
      "Subject": {
176
        "Code": "DN-01",
177
        "Codeset": null,
178
        "Description": "Diet and Nutrition"
179
      },
180
      "InstanceID": "20898465",
181
      "CreatedDateTime": "2024-11-18T21:23:09.051Z",
182
      "Status": "Active",
183
      "ActionStatus": "Assign",
184
      "ActionDateTime": null,
185
      "Assignments": [
186
        {
187
          "Code": "DN-PREG-01A",
188
          "Codeset": "HCOPATED",
189
          "Description": "Diet and Nutrition in Pregnancy - Prenatal Vitamins",
190
          "Topic": {
191
            "Code": "DN-PREG-01",
192
            "Codeset": "HCOPATED",
193
            "Description": "Diet and Nutrition in Pregnancy"
194
          },
195
          "InstanceID": "87300586",
196
          "CreatedDateTime": "2024-11-18T21:23:08.735Z",
197
          "Status": "Active",
198
          "ActionStatus": "Assign",
199
          "ActionDateTime": null,
200
          "Assignees": [
201
            {
202
              "Learner": "Patient",
203
              "ContentType": "Video",
204
              "Readiness": "Eager",
205
              "Response": null,
206
              "Notes": []
207
            }
208
          ]
209
        }
210
      ]
211
    }
212
  ]
213
}