Home
API reference
FHIR® API
FHIR® resources
DiagnosticReport
$write

DiagnosticReport $write

post/DiagnosticReport/$write
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 comprise discrete results, images, or codes. 

You can receive, retrieve, or save details for diagnostic reports. 

$write

This operation allows you to save new or updated discrete diagnostic results to a patient’s chart after completing some kind of testing for a patient.

Request parameters and payload

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/DiagnosticReport/$write' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "RedoxDiagnosticReportExampleCBCBundle",
8
  "type": "message",
9
  "entry": [
10
    {
11
      "resource": {
12
        "resourceType": "MessageHeader",
13
        "id": "RedoxMessageHeaderExample",
14
        "source": {
15
          "name": "Good Health Clinics",
16
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
17
        },
18
        "eventCoding": {
19
          "system": "urn:redox:event-type",
20
          "code": "DiagnosticReport-New"
21
        }
22
      }
23
    },
24
    {
25
      "resource": {
26
        "resourceType": "Patient",
27
        "id": "RedoxPatientExampleTimothyMinimal",
28
        "identifier": [
29
          {
30
            "value": "0000000001",
31
            "system": "urn:redox:health-one:MR"
32
          },
33
          {
34
            "value": "101-01-0001",
35
            "system": "http://hl7.org/fhir/sid/us-ssn"
36
          }
37
        ],
38
        "name": [
39
          {
40
            "given": [
41
              "Timothy",
42
              "Paul"
43
            ],
44
            "family": "Bixby"
45
          }
46
        ],
47
        "gender": "male",
48
        "birthDate": "2008-01-06"
49
      }
50
    },
51
    {
52
      "resource": {
53
        "resourceType": "DiagnosticReport",
54
        "id": "RedoxDiagnosticReportExampleCBC",
55
        "category": [
56
          {
57
            "coding": [
58
              {
59
                "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
60
                "code": "LAB"
61
              }
62
            ]
63
          }
64
        ],
65
        "identifier": [
66
          {
67
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696871",
68
            "value": "7923457256"
69
          }
70
        ],
71
        "subject": {
72
          "reference": "Patient/RedoxPatientExampleTimothy"
73
        },
74
        "effectiveDateTime": "2022-02-14T19:20:02.762Z",
75
        "issued": "2022-02-15T19:22:41.919Z",
76
        "status": "final",
77
        "specimen": [
78
          {
79
            "reference": "Specimen/RedoxSpecimenExample"
80
          }
81
        ],
82
        "code": {
83
          "coding": [
84
            {
85
              "code": "43789009",
86
              "system": "http://snomed.info/sct"
87
            }
88
          ],
89
          "text": "CBC WO DIFFERENTIAL"
90
        },
91
        "performer": [
92
          {
93
            "reference": "Practitioner/fc5ed2f0-a7a8-4bc6-bcc1-8f72db850a5c"
94
          }
95
        ],
96
        "result": [
97
          {
98
            "reference": "Observation/RedoxHGBObservationExample"
99
          },
100
          {
101
            "reference": "Observation/RedoxWBCObservationExample"
102
          },
103
          {
104
            "reference": "Observation/RedoxPlateletObservationExample"
105
          }
106
        ],
107
        "presentedForm": [
108
          {
109
            "contentType": "application/pdf",
110
            "url": "https://blob.redoxengine.com/123456789",
111
            "title": "SamplePDF-Diagnostic Report 1"
112
          },
113
          {
114
            "contentType": "application/pdf",
115
            "data": "PC4uLmJhc2UgNjQgZmlsZSBjb250ZW50cy4uLj4=",
116
            "title": "SamplePDF-Diagnostic Report 2"
117
          }
118
        ]
119
      }
120
    },
121
    {
122
      "resource": {
123
        "resourceType": "Observation",
124
        "id": "RedoxHGBObservationExample",
125
        "category": [
126
          {
127
            "coding": [
128
              {
129
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
130
                "code": "laboratory"
131
              }
132
            ]
133
          }
134
        ],
135
        "identifier": [
136
          {
137
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
138
            "value": "6492428347"
139
          }
140
        ],
141
        "status": "final",
142
        "subject": {
143
          "reference": "Patient/RedoxPatientExampleTimothy"
144
        },
145
        "code": {
146
          "coding": [
147
            {
148
              "code": "30313-1",
149
              "system": "http://loinc.org"
150
            }
151
          ],
152
          "text": "HGB"
153
        },
154
        "specimen": {
155
          "reference": "RedoxSpecimen"
156
        },
157
        "issued": "2022-02-16T17:26:19.778Z",
158
        "valueQuantity": {
159
          "value": 10.2,
160
          "unit": "g/dl"
161
        },
162
        "note": [
163
          {
164
            "text": "An observation result note"
165
          }
166
        ],
167
        "referenceRange": [
168
          {
169
            "low": {
170
              "value": 13.5
171
            },
172
            "high": {
173
              "value": 17.5
174
            }
175
          }
176
        ],
177
        "interpretation": [
178
          {
179
            "coding": [
180
              {
181
                "code": "L",
182
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
183
                "display": "Low"
184
              }
185
            ]
186
          }
187
        ]
188
      }
189
    },
190
    {
191
      "resource": {
192
        "resourceType": "Observation",
193
        "id": "RedoxWBCObservationExample",
194
        "category": [
195
          {
196
            "coding": [
197
              {
198
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
199
                "code": "laboratory"
200
              }
201
            ]
202
          }
203
        ],
204
        "valueQuantity": {
205
          "value": 10.3,
206
          "_value": {
207
            "extension": [
208
              {
209
                "url": "http://hl7.org/fhir/StructureDefinition/quantity-precision",
210
                "valueInteger": 2
211
              }
212
            ]
213
          },
214
          "unit": "10+3/ul"
215
        },
216
        "identifier": [
217
          {
218
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
219
            "value": "5287452345"
220
          }
221
        ],
222
        "status": "final",
223
        "subject": {
224
          "reference": "Patient/RedoxPatientExampleTimothy"
225
        },
226
        "code": {
227
          "coding": [
228
            {
229
              "code": "33765-9",
230
              "system": "http://loinc.org"
231
            }
232
          ],
233
          "text": "WBC"
234
        },
235
        "specimen": {
236
          "reference": "RedoxSpecimen"
237
        },
238
        "issued": "2022-02-16T17:26:19.778Z",
239
        "note": [
240
          {
241
            "text": "An observation result note"
242
          }
243
        ],
244
        "interpretation": [
245
          {
246
            "coding": [
247
              {
248
                "code": "N",
249
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
250
                "display": "Normal"
251
              }
252
            ]
253
          }
254
        ]
255
      }
256
    },
257
    {
258
      "resource": {
259
        "resourceType": "Observation",
260
        "id": "RedoxPlateletObservationExample",
261
        "category": [
262
          {
263
            "coding": [
264
              {
265
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
266
                "code": "laboratory"
267
              }
268
            ]
269
          }
270
        ],
271
        "identifier": [
272
          {
273
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
274
            "value": "4910481243"
275
          }
276
        ],
277
        "status": "final",
278
        "subject": {
279
          "reference": "Patient/RedoxPatientExampleTimothy"
280
        },
281
        "code": {
282
          "coding": [
283
            {
284
              "code": "26515-7",
285
              "system": "http://loinc.org"
286
            }
287
          ],
288
          "text": "Platelets"
289
        },
290
        "specimen": {
291
          "reference": "RedoxSpecimen"
292
        },
293
        "issued": "2022-02-16T17:26:19.778Z",
294
        "valueQuantity": {
295
          "value": 201,
296
          "unit": "10+3/ul"
297
        },
298
        "note": [
299
          {
300
            "text": "An observation result note"
301
          }
302
        ],
303
        "interpretation": [
304
          {
305
            "coding": [
306
              {
307
                "code": "N",
308
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
309
                "display": "Normal"
310
              }
311
            ]
312
          }
313
        ]
314
      }
315
    }
316
  ]
317
}'

Request Body Schema

  • 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, Observation, DiagnosticReport or Other

    An array of FHIR resources. At a minimum, a Diagnostic Report should include the following entries:

    • Patient - the patient
    • Observation - an observation related to a diagnostic report
    • DiagnosticReport - the diagnostic reports related to the patient

      An entry in the bundle containing a FHIR resource

    • resource
      required, object

      Additional metadata about the message including the event

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        Information about the sender of the message. This will typically be populated by Redox.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

        • name
          string

          Human-readable name for the source system.

      • eventCoding
        required, object

        This describes the message being communicated

        • system
          string

          The identification of the code system that defines the meaning of the symbol in the code.

        • code
          string

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

          Value: DiagnosticReport-New
  • 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

1
"Operation Response"