DiagnosticReport $diagnosticreport-amend

post/DiagnosticReport/$diagnosticreport-amend

Page View

This resource contains clinical context for diagnostic tests (e.g., lab tests, pathology, imaging) performed on a patient or group of patients. Diagnostic reports may contain discrete results, images, or codes.

You can review, retrieve, create, or update diagnostic reports.

Supported fields and schema examples

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

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

$diagnosticreport-amend

Replace an existing diagnostic report in your connection's system.

You may use this to either add new results or edit existing results. Just note that this operation entirely replaces the existing record in your connection's system.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/DiagnosticReport/$diagnosticreport-amend' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxDiagnosticReportAmendBundleExample",
8
  "type": "message",
9
  "entry": [
10
    {
11
      "resource": {
12
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/DiagnosticReportAmend",
13
        "resourceType": "MessageHeader",
14
        "id": "RedoxDiagnosticReportAmendMessageHeaderExample",
15
        "source": {
16
          "name": "Good Health Clinics",
17
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
        },
19
        "focus": [
20
          {
21
            "reference": "DiagnosticReport/RedoxDiagnosticReportAmendDiagnosticReportExample"
22
          }
23
        ]
24
      }
25
    },
26
    {
27
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/DiagnosticReport/RedoxDiagnosticReportAmendDiagnosticReportExample",
28
      "resource": {
29
        "resourceType": "DiagnosticReport",
30
        "id": "RedoxDiagnosticReportAmendDiagnosticReportExample",
31
        "category": [
32
          {
33
            "coding": [
34
              {
35
                "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
36
                "code": "LAB",
37
                "display": "Laboratory"
38
              }
39
            ]
40
          }
41
        ],
42
        "status": "final",
43
        "code": {
44
          "coding": [
45
            {
46
              "code": "49086-2",
47
              "system": "http://loinc.org",
48
              "display": "First trimester maternal screen with nuchal translucency panel"
49
            }
50
          ]
51
        },
52
        "performer": [
53
          {
54
            "reference": "Organization/RedoxOrganizationManagingExample"
55
          }
56
        ],
57
        "subject": {
58
          "reference": "Patient/RedoxPatientExampleTimothy"
59
        },
60
        "effectiveDateTime": "2023-10-04T14:51:23Z",
61
        "encounter": {
62
          "reference": "Encounter/RedoxEncounterExample"
63
        },
64
        "basedOn": [
65
          {
66
            "reference": "ServiceRequest/RedoxServiceRequestOrderExample"
67
          }
68
        ],
69
        "specimen": [
70
          {
71
            "reference": "Specimen/RedoxSpecimenExample"
72
          }
73
        ],
74
        "issued": "2023-10-01T20:29:06Z",
75
        "result": [
76
          {
77
            "reference": "Observation/RedoxDiagnosticReportAmendObservationTrisomy21Example"
78
          },
79
          {
80
            "reference": "Observation/RedoxDiagnosticReportAmendObservationFetNuchalExample"
81
          }
82
        ],
83
        "resultsInterpreter": [
84
          {
85
            "reference": "Practitioner/RedoxPractitionerExamplePat"
86
          }
87
        ]
88
      }
89
    },
90
    {
91
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ServiceRequest/RedoxServiceRequestOrderExample",
92
      "resource": {
93
        "resourceType": "ServiceRequest",
94
        "id": "RedoxServiceRequestOrderExample",
95
        "identifier": [
96
          {
97
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
98
            "value": "6547891230"
99
          }
100
        ],
101
        "intent": "order",
102
        "priority": "stat",
103
        "status": "active",
104
        "code": {
105
          "coding": [
106
            {
107
              "code": "49086-2",
108
              "system": "http://loinc.org",
109
              "display": "First trimester maternal screen with nuchal translucency panel"
110
            }
111
          ]
112
        },
113
        "authoredOn": "2022-08-08T08:00:00.000Z",
114
        "note": [
115
          {
116
            "text": "Additional information"
117
          }
118
        ],
119
        "reasonReference": [
120
          {
121
            "reference": "DocumentReference/RedoxDocumentReferenceExampleMediaTimothy"
122
          }
123
        ],
124
        "supportingInfo": [
125
          {
126
            "reference": "Observation/RedoxPlateletObservationExample"
127
          }
128
        ],
129
        "subject": {
130
          "reference": "Patient/RedoxPatientExampleTimothy"
131
        },
132
        "requester": {
133
          "reference": "Practitioner/RedoxPractitionerExamplePat"
134
        },
135
        "performer": [
136
          {
137
            "reference": "Practitioner/RedoxPractitionerExampleJoan"
138
          }
139
        ],
140
        "specimen": [
141
          {
142
            "reference": "Specimen/RedoxSpecimenExample"
143
          }
144
        ],
145
        "encounter": {
146
          "reference": "Encounter/RedoxEncounterExample"
147
        }
148
      }
149
    },
150
    {
151
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Specimen/RedoxSpecimenExample",
152
      "resource": {
153
        "resourceType": "Specimen",
154
        "id": "RedoxSpecimenExample",
155
        "identifier": [
156
          {
157
            "system": "urn:redox:example:SpecimenID",
158
            "value": "123"
159
          }
160
        ],
161
        "subject": {
162
          "reference": "Patient/RedoxPatientExampleTimothy"
163
        },
164
        "type": {
165
          "coding": [
166
            {
167
              "code": "WB",
168
              "system": "http://terminology.hl7.org/CodeSystem/v2-0487",
169
              "display": "Blood, Whole"
170
            }
171
          ],
172
          "text": "Blood, Whole"
173
        },
174
        "collection": {
175
          "bodySite": {
176
            "text": "Left arm"
177
          },
178
          "collectedDateTime": "2022-02-14T19:20:02.762Z"
179
        }
180
      }
181
    },
182
    {
183
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothy",
184
      "resource": {
185
        "resourceType": "Patient",
186
        "id": "RedoxPatientExampleTimothy",
187
        "meta": {
188
          "extension": [
189
            {
190
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
191
              "valueInteger": 1
192
            }
193
          ]
194
        },
195
        "extension": [
196
          {
197
            "extension": [
198
              {
199
                "url": "text",
200
                "valueString": "White"
201
              }
202
            ],
203
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
204
          },
205
          {
206
            "extension": [
207
              {
208
                "url": "ombCategory",
209
                "valueCoding": {
210
                  "code": "2135-2",
211
                  "system": "urn:oid:2.16.840.1.113883.6.238",
212
                  "display": "Hispanic or Latino"
213
                }
214
              },
215
              {
216
                "url": "text",
217
                "valueString": "Hispanic"
218
              }
219
            ],
220
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
221
          }
222
        ],
223
        "identifier": [
224
          {
225
            "value": "0000000001",
226
            "system": "urn:redox:health-one:MR"
227
          },
228
          {
229
            "value": "101-01-0001",
230
            "system": "http://hl7.org/fhir/sid/us-ssn"
231
          }
232
        ],
233
        "name": [
234
          {
235
            "given": [
236
              "Timothy",
237
              "Paul"
238
            ],
239
            "family": "Bixby",
240
            "use": "official"
241
          },
242
          {
243
            "text": "Billy",
244
            "use": "usual"
245
          }
246
        ],
247
        "gender": "male",
248
        "birthDate": "2008-01-06",
249
        "telecom": [
250
          {
251
            "value": "+18088675301",
252
            "system": "phone",
253
            "use": "home"
254
          },
255
          {
256
            "value": "+18008675309",
257
            "system": "phone",
258
            "use": "work"
259
          },
260
          {
261
            "value": "timothy.bixby@redoxengine.com",
262
            "system": "email"
263
          }
264
        ],
265
        "address": [
266
          {
267
            "line": [
268
              "4762 Hickory Street"
269
            ],
270
            "city": "Monroe",
271
            "district": "Greene",
272
            "state": "WI",
273
            "postalCode": "53566",
274
            "country": "US",
275
            "use": "home"
276
          }
277
        ],
278
        "maritalStatus": {
279
          "coding": [
280
            {
281
              "code": "M",
282
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
283
              "display": "Married"
284
            }
285
          ],
286
          "text": "Married"
287
        },
288
        "communication": [
289
          {
290
            "language": {
291
              "coding": [
292
                {
293
                  "code": "en",
294
                  "system": "urn:ietf:bcp:47"
295
                }
296
              ],
297
              "text": "English"
298
            }
299
          }
300
        ],
301
        "contact": [
302
          {
303
            "name": {
304
              "given": [
305
                "Barbara"
306
              ],
307
              "family": "Bixby"
308
            },
309
            "telecom": [
310
              {
311
                "value": "+18088675303",
312
                "system": "phone",
313
                "use": "home"
314
              },
315
              {
316
                "value": "barbara.bixby@redoxengine.com",
317
                "system": "email"
318
              }
319
            ],
320
            "address": {
321
              "line": [
322
                "4762 Hickory St."
323
              ],
324
              "city": "Monroe",
325
              "district": "Green",
326
              "state": "WI",
327
              "postalCode": "53566",
328
              "country": "USA"
329
            },
330
            "relationship": [
331
              {
332
                "coding": [
333
                  {
334
                    "code": "MTH",
335
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
336
                    "display": "mother"
337
                  }
338
                ],
339
                "text": "Mother"
340
              },
341
              {
342
                "coding": [
343
                  {
344
                    "code": "C",
345
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
346
                    "display": "Emergency Contact"
347
                  }
348
                ],
349
                "text": "Emergency Contact"
350
              }
351
            ]
352
          }
353
        ],
354
        "generalPractitioner": [
355
          {
356
            "reference": "Practitioner/RedoxPractitionerExamplePat"
357
          }
358
        ],
359
        "managingOrganization": {
360
          "reference": "Organization/RedoxOrganizationManagingExample"
361
        }
362
      }
363
    },
364
    {
365
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter/RedoxEncounterExample",
366
      "resource": {
367
        "resourceType": "Encounter",
368
        "id": "RedoxEncounterExample",
369
        "identifier": [
370
          {
371
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
372
            "value": "9601346482"
373
          }
374
        ],
375
        "status": "finished",
376
        "class": {
377
          "code": "IMP",
378
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
379
          "display": "inpatient encounter"
380
        },
381
        "type": [
382
          {
383
            "coding": [
384
              {
385
                "code": "99222",
386
                "system": "http://www.ama-assn.org/go/cpt",
387
                "display": "InPatient Admission"
388
              }
389
            ]
390
          }
391
        ],
392
        "diagnosis": [
393
          {
394
            "condition": {
395
              "reference": "Condition/RedoxConditionExampleEncounterDx"
396
            }
397
          }
398
        ],
399
        "participant": [
400
          {
401
            "individual": {
402
              "reference": "Practitioner/RedoxPractitionerExampleEncounter"
403
            }
404
          }
405
        ],
406
        "location": [
407
          {
408
            "location": {
409
              "reference": "Location/RedoxLocationExampleEncounter"
410
            }
411
          }
412
        ],
413
        "subject": {
414
          "reference": "Patient/RedoxPatientExampleTimothy"
415
        },
416
        "period": {
417
          "start": "2022-02-06T04:00:00.000Z",
418
          "end": "2022-02-06T04:15:00.000Z"
419
        },
420
        "length": {
421
          "value": 16,
422
          "code": "m",
423
          "system": "http://unitsofmeasure.org"
424
        },
425
        "reasonCode": [
426
          {
427
            "coding": [
428
              {
429
                "code": "23360407",
430
                "system": "http://snomed.info/sct"
431
              }
432
            ],
433
            "text": "Pneumonia"
434
          }
435
        ]
436
      }
437
    },
438
    {
439
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
440
      "resource": {
441
        "resourceType": "Organization",
442
        "id": "RedoxOrganizationManagingExample",
443
        "identifier": [
444
          {
445
            "value": "1234",
446
            "system": "urn:oid:1.2.3.4"
447
          }
448
        ],
449
        "active": true,
450
        "name": "Custodial Org",
451
        "address": [
452
          {
453
            "line": [
454
              "123 Main St"
455
            ],
456
            "city": "Madison",
457
            "state": "WI"
458
          }
459
        ],
460
        "telecom": [
461
          {
462
            "value": "1-800-123-4567",
463
            "system": "phone"
464
          }
465
        ],
466
        "type": [
467
          {
468
            "text": "Test Type"
469
          }
470
        ]
471
      }
472
    },
473
    {
474
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
475
      "resource": {
476
        "resourceType": "Practitioner",
477
        "id": "RedoxPractitionerExamplePat",
478
        "identifier": [
479
          {
480
            "system": "http://hl7.org/fhir/sid/us-npi",
481
            "value": "4356789876"
482
          }
483
        ],
484
        "name": [
485
          {
486
            "given": [
487
              "Pat"
488
            ],
489
            "family": "Granite"
490
          }
491
        ],
492
        "address": [
493
          {
494
            "line": [
495
              "123 Main St."
496
            ],
497
            "city": "Madison",
498
            "district": "Dane",
499
            "state": "WI",
500
            "postalCode": "53703",
501
            "country": "USA"
502
          }
503
        ],
504
        "telecom": [
505
          {
506
            "value": "+16085551234"
507
          }
508
        ]
509
      }
510
    },
511
    {
512
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation/RedoxDiagnosticReportAmendObservationTrisomy21Example",
513
      "resource": {
514
        "resourceType": "Observation",
515
        "id": "RedoxDiagnosticReportAmendObservationTrisomy21Example",
516
        "category": [
517
          {
518
            "coding": [
519
              {
520
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
521
                "code": "laboratory"
522
              }
523
            ]
524
          }
525
        ],
526
        "status": "final",
527
        "subject": {
528
          "reference": "Patient/RedoxPatientExampleTimothy"
529
        },
530
        "basedOn": [
531
          {
532
            "reference": "ServiceRequest/RedoxServiceRequestOrderExample"
533
          }
534
        ],
535
        "code": {
536
          "coding": [
537
            {
538
              "code": "43995-0",
539
              "system": "http://loinc.org"
540
            }
541
          ],
542
          "text": "Trisomy 21 risk Qn fetus"
543
        },
544
        "specimen": {
545
          "reference": "Specimen/RedoxSpecimenExample"
546
        },
547
        "issued": "2022-02-16T17:26:19.778Z",
548
        "valueQuantity": {
549
          "value": 24.3,
550
          "unit": "risk"
551
        },
552
        "note": [
553
          {
554
            "text": "An observation result note"
555
          }
556
        ]
557
      }
558
    },
559
    {
560
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation/RedoxDiagnosticReportAmendObservationFetNuchalExample",
561
      "resource": {
562
        "resourceType": "Observation",
563
        "id": "RedoxDiagnosticReportAmendObservationFetNuchalExample",
564
        "category": [
565
          {
566
            "coding": [
567
              {
568
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
569
                "code": "laboratory"
570
              }
571
            ]
572
          }
573
        ],
574
        "status": "final",
575
        "subject": {
576
          "reference": "Patient/RedoxPatientExampleTimothy"
577
        },
578
        "basedOn": [
579
          {
580
            "reference": "ServiceRequest/RedoxServiceRequestOrderExample"
581
          }
582
        ],
583
        "code": {
584
          "coding": [
585
            {
586
              "code": "33069-6",
587
              "system": "http://loinc.org"
588
            }
589
          ],
590
          "text": "Fet nuchal translucency US.meas"
591
        },
592
        "specimen": {
593
          "reference": "Specimen/RedoxSpecimenExample"
594
        },
595
        "issued": "2022-02-16T17:26:19.778Z",
596
        "valueQuantity": {
597
          "value": 2.18,
598
          "unit": "mm"
599
        },
600
        "note": [
601
          {
602
            "text": "An observation result note"
603
          }
604
        ]
605
      }
606
    }
607
  ],
608
  "timestamp": "2023-10-04T20:33:22.422Z"
609
}'

Request Body Schema

Bundle sent as part of a DiagnosticReportAmend 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, diagnosticReport, patient, encounter
Amend an entire report leveraging this. To send results as a collection of Observation resources or a medication result use ObservationUpdate.

An array of FHIR resources. At a minimum, a DiagnosticReport Result should include the following entries:
- Patient - the patient
- DiagnosticReport - the report
- ServiceRequest - the basedOn, if you need basedOn as a MedicationRequest, please look at ObservationUpdate
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®.