Home
API reference
FHIR® API
FHIR® notifications
Result
Result Created

Result Created Detailed

Page View

Result notifications contain details about a patient's vitals, as recorded by your connection.

You can receive notifications when a result is created.

created

Indicates that a new patient vital has been recorded in your connection's system.

You can opt in for lightweight or detailed notifications.

  • A lightweight notification provides the DiagnosticReport reference, patient info, and timestamp.
  • A detailed notification contains everything in the lightweight plus extended vital info and related references.

Select payload example

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

Request Body Schema

    Bundle sent as part of a Result-created event

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Indicates the purpose of this bundle - how it is intended to be used.

    Value: message
  • entry
    required, Array of messageHeader, diagnosticReport, patient, observation

    An entry in the bundle containing a FHIR resource

    • fullUrl
      string

      The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:

      • fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
      • Results from operations might involve resources that are not identified.
    • resource
      object

      The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        The source application from which this message originated.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

      • focus
        required, Array of object

        The actual data of the message - a reference to the root/focus class of the event.

        Must be a resource of type Resource.

        • reference
          string

          A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

      • definition
        required, string

        Permanent link to the MessageDefinition for this message.

      • eventUri
        required, string

        Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value http://terminology.hl7.org/CodeSystem/message-events. Alternatively uri to the EventDefinition.

        Value: https://fhir.redoxengine.com/EventDefinition/ResultCreated
  • timestamp
    string

    The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

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