Receive a request for patient monitoring

Last updated: Nov 6, 2024

HEALTH TECH VENDOR

PRODUCT OWNER

IMPLEMENTATION

You can use this API action if your organization provides some type of patient monitoring, whether via a device, app, or both.

Use cases

This API action may be a good fit for your organization if you perform any of these use cases:

Receive orders from a provider for a device to monitor a patient.
Receive orders from a provider for nursing or app monitoring.

Supported systems

You can receive messages like this with the Redox FHIR® API.

Talk to a Redoxer

It’s also possible to use the Redox Data Model API for this API action. Talk to a Redoxer to learn about your options.

Your connection's system can send messages with their own FHIR® or proprietary API or an HL7v2 feed.

Lightweight or detailed notification

Depending on your connection’s capabilities, you can opt in for lightweight or detailed notifications.

A lightweight notification is typically a bare bones message with the relevant identifier (e.g., patient, visit #) and an indication of “something's new” or “something has changed.” Lightweight notifications generally trigger you to do something within your own workflow or to query for more information.

On the other hand, a detailed notification means that you receive all the data about what’s new or what's changed. This might be useful if you need to persist all that data in your system to complete your own unique workflow.

Things you need to know

New EHR order for patient monitoring

Follow-up actions for monitoring

What's next?

Does this API action seem like a good fit for your unique workflow? If so, let your Redox technical account manager know! You can start development by downloading the relevant resource schema (noted in the related action step below) and deciding which data elements you need. Then, use the Quickstart for Redox guide to dive right in.

If you're not engaged with our sales team yet, talk to a Redoxer to get started.

Action steps

1
Receive a service patient monitoring request
optional
2
Receive a device patient monitoring request
optional

Receive a service patient monitoring request

The EHR system sends a notification whenever a new service request is created for your organization. To review technical specifications for this notification, refer to the Service Request Created schema.

How to respond to FHIR notifications

Upon receiving this type of message, you only need to respond with the relevant HTTP status code. After that, you decide what your system should do with the notification.

ServiceRequest Created

Payload

json

1
{
2
  "resourceType": "Bundle",
3
  "id": "ServiceRequestCreatedBundleExample",
4
  "type": "message",
5
  "timestamp": "2021-06-17T20:33:22.422Z",
6
  "entry": [
7
    {
8
      "resource": {
9
        "resourceType": "MessageHeader",
10
        "id": "RedoxMessageHeaderExample",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
        },
15
        "eventCoding": {
16
          "system": "urn:redox:event-type",
17
          "code": "ServiceRequest-event-created"
18
        }
19
      }
20
    },
21
    {
22
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ServiceRequest?identifier=192743841|urn:redox:redox-fhir-sandbox:OrderID",
23
      "resource": {
24
        "resourceType": "ServiceRequest",
25
        "start": "2022-06-06T05:00:00.000Z",
26
        "end": "2022-06-06T06:00:00.000Z",
27
        "authoredOn": "2022-06-06T06:00:00.000Z",
28
        "status": "active",
29
        "intent": "order",
30
        "subject": {
31
          "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
32
        },
33
        "requester": {
34
          "reference": "Practitioner/dbed0f85-e3cd-47ac-9305-3f629e138832"
35
        },
36
        "code": {
37
          "text": "Monitoring of cardiac output by electrocardiogram (regime/therapy)",
38
          "coding": [
39
            {
40
              "code": "3130004",
41
              "system": "http://snomed.info/sct"
42
            }
43
          ]
44
        }
45
      }
46
    },
47
    {
48
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
49
      "resource": {
50
        "resourceType": "Patient"
51
      }
52
    }
53
  ]
54
}

Receive a device patient monitoring request

The EHR system sends a notification whenever a new service request is created for your organization. To review technical specifications for this notification, refer to the Device Request Created schema.

How to respond to FHIR notifications

Upon receiving this type of message, you only need to respond with the relevant HTTP status code. After that, you decide what your system should do with the notification.

DeviceRequest Created

Payload

json

1
{
2
  "id": "KevaGreen-DeviceRequestCreated-BloodGlucoseMonitor",
3
  "meta": {
4
    "profile": [
5
      "https://fhir.redoxengine.com/StructureDefinition/DeviceRequestCreatedBundleDefinition"
6
    ]
7
  },
8
  "type": "message",
9
  "entry": [
10
    {
11
      "resource": {
12
        "id": "DeviceRequestCreatedMessageHeader",
13
        "focus": [
14
          {
15
            "reference": "DeviceRequest/acb74c31-01a4-462b-b9cc-fe2438d008f1"
16
          },
17
          {
18
            "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
19
          }
20
        ],
21
        "source": {
22
          "name": "Good Health Clinics",
23
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
24
        },
25
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/DeviceRequestCreated",
26
        "definition": "https://fhir.redoxengine.com/MessageDefinition/DeviceRequestCreatedFull",
27
        "resourceType": "MessageHeader"
28
      }
29
    },
30
    {
31
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/DeviceRequest/acb74c31-01a4-462b-b9cc-fe2438d008f1",
32
      "resource": {
33
        "id": "acb74c31-01a4-462b-b9cc-fe2438d008f1",
34
        "meta": {
35
          "profile": [
36
            "https://fhir.redoxengine.com/StructureDefinition/redox-devicerequest"
37
          ]
38
        },
39
        "intent": "order",
40
        "status": "completed",
41
        "subject": {
42
          "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
43
        },
44
        "encounter": {
45
          "reference": "Encounter/004c4cd2-63b0-d216-edf2-079f74d924d6"
46
        },
47
        "resourceType": "DeviceRequest",
48
        "occurrenceDateTime": "2023-02-12T23:50:50-05:00",
49
        "codeCodeableConcept": {
50
          "coding": [
51
            {
52
              "code": "337414009",
53
              "system": "http://snomed.info/sct",
54
              "display": "Blood glucose meter (physical object)"
55
            }
56
          ]
57
        }
58
      }
59
    },
60
    {
61
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=kyHGADnvX3xbkU4V9ayaqh|urn:redox:redox-fhir-sandbox:MR",
62
      "resource": {
63
        "id": "81c2f5eb-f99f-40c4-b504-59483e6148d7",
64
        "link": [
65
          {
66
            "type": "replaces",
67
            "other": {
68
              "reference": "Patient/69efd2ea-1256-4ae7-b4ec-5d0160427185"
69
            }
70
          }
71
        ],
72
        "meta": {
73
          "profile": [
74
            "https://fhir.redoxengine.com/StructureDefinition/redox-patient"
75
          ],
76
          "lastUpdated": "2022-12-01T21:57:23.879Z"
77
        },
78
        "name": [
79
          {
80
            "use": "official",
81
            "given": [
82
              "Keva"
83
            ],
84
            "family": "Green"
85
          }
86
        ],
87
        "active": true,
88
        "gender": "female",
89
        "address": [
90
          {
91
            "use": "home",
92
            "city": "Hillsboro",
93
            "line": [
94
              "932 Stehr Vista"
95
            ],
96
            "state": "OR",
97
            "country": "US",
98
            "postalCode": "97123"
99
          }
100
        ],
101
        "telecom": [
102
          {
103
            "use": "home",
104
            "value": "+18088675302",
105
            "system": "phone"
106
          },
107
          {
108
            "value": "Keva.Green-95@test.net",
109
            "system": "email"
110
          }
111
        ],
112
        "birthDate": "1995-08-26",
113
        "extension": [
114
          {
115
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
116
            "extension": [
117
              {
118
                "url": "text",
119
                "valueString": "White"
120
              },
121
              {
122
                "url": "ombCategory",
123
                "valueCoding": {
124
                  "code": "2106-3",
125
                  "system": "urn:oid:2.16.840.1.113883.6.238",
126
                  "display": "White"
127
                }
128
              }
129
            ]
130
          }
131
        ],
132
        "identifier": [
133
          {
134
            "value": "kyHGADnvX3xbkU4V9ayaqh",
135
            "system": "urn:redox:redox-fhir-sandbox:MR"
136
          },
137
          {
138
            "use": "secondary",
139
            "value": "483749",
140
            "system": "urn:redox:redox-fhir-sandbox:MR"
141
          }
142
        ],
143
        "resourceType": "Patient"
144
      }
145
    },
146
    {
147
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter/004c4cd2-63b0-d216-edf2-079f74d924d6",
148
      "resource": {
149
        "id": "004c4cd2-63b0-d216-edf2-079f74d924d6",
150
        "meta": {
151
          "profile": [
152
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
153
          ]
154
        },
155
        "type": [
156
          {
157
            "text": "General examination of patient (procedure)",
158
            "coding": [
159
              {
160
                "code": "162673000",
161
                "system": "http://snomed.info/sct",
162
                "display": "General examination of patient (procedure)"
163
              }
164
            ]
165
          }
166
        ],
167
        "class": {
168
          "code": "AMB",
169
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode"
170
        },
171
        "period": {
172
          "end": "2023-02-13T00:23:26-05:00",
173
          "start": "2023-02-12T23:50:50-05:00"
174
        },
175
        "status": "finished",
176
        "subject": {
177
          "display": "Keva Green",
178
          "reference": "Patient/81c2f5eb-f99f-40c4-b504-59483e6148d7"
179
        },
180
        "location": [
181
          {
182
            "location": {
183
              "display": "AGELESS WELLNESS CENTER, INC",
184
              "reference": "Location?identifier=https://github.com/synthetichealth/synthea|a5cc27d1-5c70-39f8-a9c4-2f3696988650"
185
            }
186
          }
187
        ],
188
        "identifier": [
189
          {
190
            "use": "official",
191
            "value": "004c4cd2-63b0-d216-edf2-079f74d924d6",
192
            "system": "https://github.com/synthetichealth/synthea"
193
          }
194
        ],
195
        "participant": [
196
          {
197
            "type": [
198
              {
199
                "text": "primary performer",
200
                "coding": [
201
                  {
202
                    "code": "PPRF",
203
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
204
                    "display": "primary performer"
205
                  }
206
                ]
207
              }
208
            ],
209
            "period": {
210
              "end": "2023-02-13T00:23:26-05:00",
211
              "start": "2023-02-12T23:50:50-05:00"
212
            },
213
            "individual": {
214
              "display": "Dr. Will Bernhard",
215
              "reference": "Practitioner?identifier=http://hl7.org/fhir/sid/us-npi|9999945790"
216
            }
217
          }
218
        ],
219
        "resourceType": "Encounter",
220
        "serviceProvider": {
221
          "display": "AGELESS WELLNESS CENTER, INC",
222
          "reference": "Organization?identifier=https://github.com/synthetichealth/synthea|8b124b8e-ce6a-3b8a-bf2c-b8f539a4e3ce"
223
        }
224
      }
225
    },
226
    {
227
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi|9999945790",
228
      "resource": {
229
        "id": "15159e73-b32d-36b2-b57b-e37a3041ace0",
230
        "meta": {
231
          "profile": [
232
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
233
          ]
234
        },
235
        "name": [
236
          {
237
            "given": [
238
              "Will"
239
            ],
240
            "family": "Bernhard",
241
            "prefix": [
242
              "Dr."
243
            ]
244
          }
245
        ],
246
        "active": true,
247
        "gender": "male",
248
        "address": [
249
          {
250
            "city": "MILWAUKEE",
251
            "line": [
252
              "2745 W LAYTON AVE"
253
            ],
254
            "state": "WI",
255
            "country": "US",
256
            "postalCode": "532212651"
257
          }
258
        ],
259
        "telecom": [
260
          {
261
            "use": "work",
262
            "value": "Will.Bernhard@example.com",
263
            "system": "email",
264
            "extension": [
265
              {
266
                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
267
                "valueBoolean": true
268
              }
269
            ]
270
          }
271
        ],
272
        "extension": [
273
          {
274
            "url": "http://synthetichealth.github.io/synthea/utilization-encounters-extension",
275
            "valueInteger": 250
276
          }
277
        ],
278
        "identifier": [
279
          {
280
            "value": "9999945790",
281
            "system": "http://hl7.org/fhir/sid/us-npi"
282
          }
283
        ],
284
        "resourceType": "Practitioner"
285
      }
286
    },
287
    {
288
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization?identifier=https://github.com/synthetichealth/synthea|8b124b8e-ce6a-3b8a-bf2c-b8f539a4e3ce",
289
      "resource": {
290
        "id": "8b124b8e-ce6a-3b8a-bf2c-b8f539a4e3ce",
291
        "meta": {
292
          "profile": [
293
            "https://fhir.redoxengine.com/StructureDefinition/redox-organization",
294
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
295
          ]
296
        },
297
        "name": "AGELESS WELLNESS CENTER, INC",
298
        "type": [
299
          {
300
            "text": "Healthcare Provider",
301
            "coding": [
302
              {
303
                "code": "prov",
304
                "system": "http://terminology.hl7.org/CodeSystem/organization-type",
305
                "display": "Healthcare Provider"
306
              }
307
            ]
308
          }
309
        ],
310
        "active": true,
311
        "address": [
312
          {
313
            "city": "MILWAUKEE",
314
            "line": [
315
              "2745 W LAYTON AVE"
316
            ],
317
            "state": "WI",
318
            "country": "US",
319
            "postalCode": "532212651"
320
          }
321
        ],
322
        "telecom": [
323
          {
324
            "value": "4144755800",
325
            "system": "phone"
326
          }
327
        ],
328
        "extension": [
329
          {
330
            "url": "http://synthetichealth.github.io/synthea/utilization-encounters-extension",
331
            "valueInteger": 250
332
          },
333
          {
334
            "url": "http://synthetichealth.github.io/synthea/utilization-procedures-extension",
335
            "valueInteger": 3592
336
          },
337
          {
338
            "url": "http://synthetichealth.github.io/synthea/utilization-labs-extension",
339
            "valueInteger": 1253
340
          },
341
          {
342
            "url": "http://synthetichealth.github.io/synthea/utilization-prescriptions-extension",
343
            "valueInteger": 1531
344
          }
345
        ],
346
        "identifier": [
347
          {
348
            "value": "8b124b8e-ce6a-3b8a-bf2c-b8f539a4e3ce",
349
            "system": "https://github.com/synthetichealth/synthea"
350
          }
351
        ],
352
        "resourceType": "Organization"
353
      }
354
    }
355
  ],
356
  "timestamp": "2023-02-12T23:50:50-05:00",
357
  "resourceType": "Bundle"
358
}

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.