Patient $patient-update

post/Patient/$patient-update

Page View

This resource establishes demographics and identifiers for an individual visiting or receiving treatment from a healthcare organization. A patient record serves as the most common base for data being exchanged since it establishes the “who” behind the data.

You can review, retrieve, create, update, or match patient records.

Supported fields

We support any valid FHIR® field. However, we only display the fields that we’ve defined in the schema, which are usually based on what’s included in the U.S. Core profile.

$patient-update

Replace or edit details of an existing patient record in your connection's system.

Whether it's a replace or edit depends on how your connection's system handles writeback messages.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Patient/$patient-update' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxPatientUpdateBundleExample",
8
  "type": "message",
9
  "entry": [
10
    {
11
      "resource": {
12
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/PatientUpdate",
13
        "resourceType": "MessageHeader",
14
        "id": "RedoxPatientUpdateMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "focus": [
20
          {
21
            "reference": "Patient/RedoxPatientExampleTimothy"
22
          }
23
        ]
24
      }
25
    },
26
    {
27
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothy",
28
      "resource": {
29
        "resourceType": "Patient",
30
        "id": "RedoxPatientExampleTimothy",
31
        "meta": {
32
          "extension": [
33
            {
34
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
35
              "valueInteger": 1
36
            }
37
          ]
38
        },
39
        "extension": [
40
          {
41
            "extension": [
42
              {
43
                "url": "text",
44
                "valueString": "White"
45
              }
46
            ],
47
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
48
          },
49
          {
50
            "extension": [
51
              {
52
                "url": "ombCategory",
53
                "valueCoding": {
54
                  "code": "2135-2",
55
                  "system": "urn:oid:2.16.840.1.113883.6.238",
56
                  "display": "Hispanic or Latino"
57
                }
58
              },
59
              {
60
                "url": "text",
61
                "valueString": "Hispanic"
62
              }
63
            ],
64
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
65
          }
66
        ],
67
        "identifier": [
68
          {
69
            "value": "0000000001",
70
            "system": "urn:redox:health-one:MR"
71
          },
72
          {
73
            "value": "101-01-0001",
74
            "system": "http://hl7.org/fhir/sid/us-ssn"
75
          }
76
        ],
77
        "name": [
78
          {
79
            "given": [
80
              "Timothy",
81
              "Paul"
82
            ],
83
            "family": "Bixby",
84
            "use": "official"
85
          },
86
          {
87
            "text": "Billy",
88
            "use": "usual"
89
          }
90
        ],
91
        "gender": "male",
92
        "birthDate": "2008-01-06",
93
        "telecom": [
94
          {
95
            "value": "+18088675301",
96
            "system": "phone",
97
            "use": "home"
98
          },
99
          {
100
            "value": "+18008675309",
101
            "system": "phone",
102
            "use": "work"
103
          },
104
          {
105
            "value": "timothy.bixby@redoxengine.com",
106
            "system": "email"
107
          }
108
        ],
109
        "address": [
110
          {
111
            "line": [
112
              "4762 Hickory Street"
113
            ],
114
            "city": "Monroe",
115
            "district": "Greene",
116
            "state": "WI",
117
            "postalCode": "53566",
118
            "country": "US",
119
            "use": "home"
120
          }
121
        ],
122
        "maritalStatus": {
123
          "coding": [
124
            {
125
              "code": "M",
126
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
127
              "display": "Married"
128
            }
129
          ],
130
          "text": "Married"
131
        },
132
        "communication": [
133
          {
134
            "language": {
135
              "coding": [
136
                {
137
                  "code": "en",
138
                  "system": "urn:ietf:bcp:47"
139
                }
140
              ],
141
              "text": "English"
142
            }
143
          }
144
        ],
145
        "contact": [
146
          {
147
            "name": {
148
              "given": [
149
                "Barbara"
150
              ],
151
              "family": "Bixby"
152
            },
153
            "telecom": [
154
              {
155
                "value": "+18088675303",
156
                "system": "phone",
157
                "use": "home"
158
              },
159
              {
160
                "value": "barbara.bixby@redoxengine.com",
161
                "system": "email"
162
              }
163
            ],
164
            "address": {
165
              "line": [
166
                "4762 Hickory St."
167
              ],
168
              "city": "Monroe",
169
              "district": "Green",
170
              "state": "WI",
171
              "postalCode": "53566",
172
              "country": "USA"
173
            },
174
            "relationship": [
175
              {
176
                "coding": [
177
                  {
178
                    "code": "MTH",
179
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
180
                    "display": "mother"
181
                  }
182
                ],
183
                "text": "Mother"
184
              },
185
              {
186
                "coding": [
187
                  {
188
                    "code": "C",
189
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
190
                    "display": "Emergency Contact"
191
                  }
192
                ],
193
                "text": "Emergency Contact"
194
              }
195
            ]
196
          }
197
        ],
198
        "generalPractitioner": [
199
          {
200
            "reference": "Practitioner/RedoxPractitionerExamplePat"
201
          }
202
        ],
203
        "managingOrganization": {
204
          "reference": "Organization/RedoxOrganizationManagingExample"
205
        }
206
      }
207
    },
208
    {
209
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/RelatedPerson/RedoxRelatedPersonExample",
210
      "resource": {
211
        "resourceType": "RelatedPerson",
212
        "id": "RedoxRelatedPersonExample",
213
        "patient": {
214
          "reference": "Patient/RedoxPatientExampleTimothy"
215
        },
216
        "name": [
217
          {
218
            "given": [
219
              "Barbara"
220
            ],
221
            "family": "Bixby"
222
          }
223
        ],
224
        "telecom": [
225
          {
226
            "value": "+18088675303",
227
            "system": "phone",
228
            "use": "home"
229
          },
230
          {
231
            "value": "barbara.bixby@redoxengine.com",
232
            "system": "email"
233
          }
234
        ],
235
        "address": [
236
          {
237
            "line": [
238
              "4762 Hickory St."
239
            ],
240
            "city": "Monroe",
241
            "district": "Green",
242
            "state": "WI",
243
            "postalCode": "53566",
244
            "country": "USA"
245
          }
246
        ],
247
        "relationship": [
248
          {
249
            "coding": [
250
              {
251
                "code": "MTH",
252
                "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
253
                "display": "mother"
254
              }
255
            ],
256
            "text": "Mother"
257
          },
258
          {
259
            "coding": [
260
              {
261
                "code": "C",
262
                "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
263
                "display": "Emergency Contact"
264
              }
265
            ],
266
            "text": "Emergency Contact"
267
          }
268
        ]
269
      }
270
    },
271
    {
272
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Condition/RedoxConditionExampleEncounterDx",
273
      "resource": {
274
        "resourceType": "Condition",
275
        "id": "RedoxConditionExampleEncounterDx",
276
        "category": [
277
          {
278
            "coding": [
279
              {
280
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
281
                "code": "encounter-diagnosis"
282
              }
283
            ]
284
          }
285
        ],
286
        "identifier": [
287
          {
288
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696871",
289
            "value": "8769522345"
290
          }
291
        ],
292
        "subject": {
293
          "reference": "Patient/RedoxPatientExampleTimothy"
294
        },
295
        "encounter": {
296
          "reference": "Encounter/RedoxEncounterUpdateEncounterExample"
297
        },
298
        "code": {
299
          "coding": [
300
            {
301
              "code": "233604007",
302
              "system": "http://snomed.info/sct"
303
            }
304
          ],
305
          "text": "Pneumonia"
306
        }
307
      }
308
    },
309
    {
310
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/AllergyIntolerance/AllergyExample",
311
      "resource": {
312
        "resourceType": "AllergyIntolerance",
313
        "id": "AllergyExample",
314
        "identifier": [
315
          {
316
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
317
            "value": "35892347"
318
          }
319
        ],
320
        "clinicalStatus": {
321
          "coding": [
322
            {
323
              "code": "active",
324
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
325
              "display": "Active"
326
            }
327
          ],
328
          "text": "Active"
329
        },
330
        "type": "allergy",
331
        "_type": {
332
          "extension": [
333
            {
334
              "url": "http://hl7.org/fhir/StructureDefinition/originalText",
335
              "valueString": "Propensity to adverse reaction to drug"
336
            }
337
          ]
338
        },
339
        "criticality": "low",
340
        "code": {
341
          "coding": [
342
            {
343
              "code": "2670",
344
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
345
              "display": "Codeine"
346
            }
347
          ],
348
          "text": "Codeine"
349
        },
350
        "patient": {
351
          "reference": "Patient/RedoxPatientExampleTimothy"
352
        },
353
        "encounter": {
354
          "reference": "Encounter/RedoxEncounterUpdateEncounterExample"
355
        },
356
        "onsetDateTime": "2022-01-03T16:30:00.000Z",
357
        "reaction": [
358
          {
359
            "manifestation": [
360
              {
361
                "coding": [
362
                  {
363
                    "code": "267036007",
364
                    "system": "http://snomed.info/sct",
365
                    "display": "Shortness of Breath"
366
                  }
367
                ]
368
              }
369
            ],
370
            "description": "Shortness of Breath",
371
            "severity": "moderate",
372
            "_severity": {
373
              "extension": [
374
                {
375
                  "url": "http://hl7.org/fhir/StructureDefinition/originalText",
376
                  "valueString": "Mild to moderate"
377
                }
378
              ]
379
            }
380
          }
381
        ],
382
        "note": [
383
          {
384
            "text": "Additional information"
385
          }
386
        ]
387
      }
388
    },
389
    {
390
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Procedure/RedoxProcedureExampleMinimumCompleted",
391
      "resource": {
392
        "resourceType": "Procedure",
393
        "id": "RedoxProcedureExampleMinimumCompleted",
394
        "identifier": [
395
          {
396
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
397
            "value": "6891241274"
398
          }
399
        ],
400
        "subject": {
401
          "reference": "Patient/RedoxPatientExampleTimothy"
402
        },
403
        "encounter": {
404
          "reference": "Encounter/RedoxEncounterUpdateEncounterExample"
405
        },
406
        "performedDateTime": "2022-02-08T19:00:00.000Z",
407
        "performedPeriod": {
408
          "start": "2022-02-08T19:00:00.000Z",
409
          "end": "2022-02-08T20:00:00.000Z"
410
        },
411
        "status": "completed",
412
        "_status": {
413
          "extension": [
414
            {
415
              "url": "http://hl7.org/fhir/StructureDefinition/originalText",
416
              "valueString": "Finished"
417
            }
418
          ]
419
        },
420
        "bodySite": [
421
          {
422
            "coding": [
423
              {
424
                "code": "181608004",
425
                "system": "http://snomed.info/sct",
426
                "display": "Entire chest wall (body structure)"
427
              }
428
            ]
429
          }
430
        ],
431
        "code": {
432
          "coding": [
433
            {
434
              "code": "168731009",
435
              "system": "http://snomed.info/sct",
436
              "display": "Chest X-Ray"
437
            }
438
          ]
439
        },
440
        "category": {
441
          "coding": [
442
            {
443
              "code": "Procedures",
444
              "system": "urn:redox:procedure_act_type",
445
              "display": "Procedures"
446
            }
447
          ]
448
        },
449
        "location": {
450
          "reference": "Location/RedoxLocationExampleRoom"
451
        },
452
        "note": [
453
          {
454
            "authorReference": {
455
              "reference": "Practitioner/RedoxPractitionerExamplePat"
456
            },
457
            "text": "A comment."
458
          }
459
        ],
460
        "performer": [
461
          {
462
            "actor": {
463
              "reference": "Practitioner/RedoxPractitionerExamplePat"
464
            },
465
            "function": {
466
              "coding": [
467
                {
468
                  "code": "41904004",
469
                  "system": "http://snomed.info/sct",
470
                  "display": "Medical X-ray technician"
471
                }
472
              ]
473
            }
474
          }
475
        ]
476
      }
477
    },
478
    {
479
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation/RedoxSocialHistoryObservationExample",
480
      "resource": {
481
        "resourceType": "Observation",
482
        "id": "RedoxSocialHistoryObservationExample",
483
        "category": [
484
          {
485
            "coding": [
486
              {
487
                "code": "social-history",
488
                "system": "http://terminology.hl7.org/CodeSystem/observation-category"
489
              }
490
            ]
491
          }
492
        ],
493
        "identifier": [
494
          {
495
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
496
            "value": "3059131578"
497
          }
498
        ],
499
        "subject": {
500
          "reference": "Patient/RedoxPatientExampleTimothy"
501
        },
502
        "encounter": {
503
          "reference": "Encounter/RedoxEncounterExample"
504
        },
505
        "status": "final",
506
        "code": {
507
          "coding": [
508
            {
509
              "code": "160573003",
510
              "system": "http://snomed.info/sct",
511
              "display": "Alcohol Consumption"
512
            }
513
          ]
514
        },
515
        "effectivePeriod": {
516
          "start": "1990-05-01T04:00:00.000Z"
517
        },
518
        "valueString": "None"
519
      }
520
    },
521
    {
522
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation/RedoxWeightObservationExample",
523
      "resource": {
524
        "resourceType": "Observation",
525
        "id": "RedoxWeightObservationExample",
526
        "category": [
527
          {
528
            "coding": [
529
              {
530
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
531
                "code": "vital-signs",
532
                "display": "Vital Signs"
533
              }
534
            ],
535
            "text": "vital-signs"
536
          }
537
        ],
538
        "identifier": [
539
          {
540
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
541
            "value": "1438629037"
542
          }
543
        ],
544
        "subject": {
545
          "reference": "Patient/RedoxPatientExampleTimothy"
546
        },
547
        "status": "final",
548
        "code": {
549
          "coding": [
550
            {
551
              "code": "3141-9",
552
              "system": "http://loinc.org"
553
            }
554
          ],
555
          "text": "Patient Body Weight - Measured"
556
        },
557
        "effectiveDateTime": "1999-11-14T00:00:00.000Z",
558
        "valueQuantity": {
559
          "value": 86,
560
          "unit": "kg"
561
        },
562
        "interpretation": [
563
          {
564
            "coding": [
565
              {
566
                "code": "N",
567
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
568
                "display": "Normal"
569
              }
570
            ]
571
          }
572
        ],
573
        "note": [
574
          {
575
            "text": "Body weight measurement performed"
576
          }
577
        ],
578
        "performer": [
579
          {
580
            "reference": "Practitioner/RedoxPractitionerExamplePat"
581
          }
582
        ],
583
        "referenceRange": [
584
          {
585
            "low": {
586
              "value": 80,
587
              "unit": "kg"
588
            },
589
            "high": {
590
              "value": 120,
591
              "unit": "kg"
592
            },
593
            "text": "Body weight range"
594
          }
595
        ]
596
      }
597
    }
598
  ],
599
  "timestamp": "2021-06-18T20:33:22.422Z"
600
}'

Request Body Schema

Bundle sent as part of a Patient-update message

resourceType
required, string
Identifies the type of the resource
Value: Bundle
type
required, string
Identifies this bundle as a message
Value: message
entry
required, Array of messageHeader, patient, encounter, account, observation, relatedPerson, location, condition, procedure, coverage, allergyIntolerance or Other
An entry in the bundle containing a FHIR resource
timestamp
string
The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Response fields and example

Example

json

1
"Operation Response"

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