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 Observation reference, patient info, and timestamp.
  • A detailed notification contains everything in the lightweight plus extended vital info and related references.

Select payload example

ResultCreatedFullBundleExample
json
1
{
2
  "resourceType": "Bundle",
3
  "id": "ResultCreatedFullBundleExample",
4
  "type": "message",
5
  "entry": [
6
    {
7
      "resource": {
8
        "eventUri": "https://fhir.redoxengine.com/EventDefinition/ResultCreated",
9
        "resourceType": "MessageHeader",
10
        "id": "ResultCreatedMessageHeader",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
        },
15
        "focus": [
16
          {
17
            "reference": "Observation/RedoxHGBObservationExample"
18
          }
19
        ],
20
        "definition": "https://fhir.redoxengine.com/MessageDefinition/ResultCreatedFull"
21
      }
22
    },
23
    {
24
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation?identifier=6492428347|urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
25
      "resource": {
26
        "resourceType": "Observation",
27
        "id": "RedoxHGBObservationExample",
28
        "category": [
29
          {
30
            "coding": [
31
              {
32
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
33
                "code": "laboratory"
34
              }
35
            ]
36
          }
37
        ],
38
        "identifier": [
39
          {
40
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
41
            "value": "6492428347"
42
          }
43
        ],
44
        "status": "final",
45
        "subject": {
46
          "reference": "Patient/RedoxPatientExampleTimothy"
47
        },
48
        "basedOn": [
49
          {
50
            "reference": "ServiceRequest/RedoxServiceRequestOrderExample"
51
          }
52
        ],
53
        "code": {
54
          "coding": [
55
            {
56
              "code": "30313-1",
57
              "system": "http://loinc.org"
58
            }
59
          ],
60
          "text": "HGB"
61
        },
62
        "specimen": {
63
          "reference": "Specimen/RedoxSpecimenExample"
64
        },
65
        "issued": "2022-02-16T17:26:19.778Z",
66
        "valueQuantity": {
67
          "value": 10.2,
68
          "unit": "g/dl"
69
        },
70
        "note": [
71
          {
72
            "text": "An observation result note"
73
          }
74
        ],
75
        "referenceRange": [
76
          {
77
            "low": {
78
              "value": 13.5
79
            },
80
            "high": {
81
              "value": 17.5
82
            }
83
          }
84
        ],
85
        "interpretation": [
86
          {
87
            "coding": [
88
              {
89
                "code": "L",
90
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
91
                "display": "Low"
92
              }
93
            ]
94
          }
95
        ]
96
      }
97
    },
98
    {
99
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
100
      "resource": {
101
        "resourceType": "Patient",
102
        "id": "RedoxPatientExampleTimothy",
103
        "meta": {
104
          "extension": [
105
            {
106
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
107
              "valueInteger": 1
108
            }
109
          ]
110
        },
111
        "extension": [
112
          {
113
            "extension": [
114
              {
115
                "url": "text",
116
                "valueString": "White"
117
              }
118
            ],
119
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
120
          },
121
          {
122
            "extension": [
123
              {
124
                "url": "ombCategory",
125
                "valueCoding": {
126
                  "code": "2135-2",
127
                  "system": "urn:oid:2.16.840.1.113883.6.238",
128
                  "display": "Hispanic or Latino"
129
                }
130
              },
131
              {
132
                "url": "text",
133
                "valueString": "Hispanic"
134
              }
135
            ],
136
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
137
          }
138
        ],
139
        "identifier": [
140
          {
141
            "value": "0000000001",
142
            "system": "urn:redox:health-one:MR"
143
          },
144
          {
145
            "value": "101-01-0001",
146
            "system": "http://hl7.org/fhir/sid/us-ssn"
147
          }
148
        ],
149
        "name": [
150
          {
151
            "given": [
152
              "Timothy",
153
              "Paul"
154
            ],
155
            "family": "Bixby",
156
            "use": "official"
157
          },
158
          {
159
            "text": "Billy",
160
            "use": "usual"
161
          }
162
        ],
163
        "gender": "male",
164
        "birthDate": "2008-01-06",
165
        "telecom": [
166
          {
167
            "value": "+18088675301",
168
            "system": "phone",
169
            "use": "home"
170
          },
171
          {
172
            "value": "+18008675309",
173
            "system": "phone",
174
            "use": "work"
175
          },
176
          {
177
            "value": "timothy.bixby@redoxengine.com",
178
            "system": "email"
179
          }
180
        ],
181
        "address": [
182
          {
183
            "line": [
184
              "4762 Hickory Street"
185
            ],
186
            "city": "Monroe",
187
            "district": "Greene",
188
            "state": "WI",
189
            "postalCode": "53566",
190
            "country": "US",
191
            "use": "home"
192
          }
193
        ],
194
        "maritalStatus": {
195
          "coding": [
196
            {
197
              "code": "M",
198
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
199
              "display": "Married"
200
            }
201
          ],
202
          "text": "Married"
203
        },
204
        "communication": [
205
          {
206
            "language": {
207
              "coding": [
208
                {
209
                  "code": "en",
210
                  "system": "urn:ietf:bcp:47"
211
                }
212
              ],
213
              "text": "English"
214
            }
215
          }
216
        ],
217
        "contact": [
218
          {
219
            "name": {
220
              "given": [
221
                "Barbara"
222
              ],
223
              "family": "Bixby"
224
            },
225
            "telecom": [
226
              {
227
                "value": "+18088675303",
228
                "system": "phone",
229
                "use": "home"
230
              },
231
              {
232
                "value": "barbara.bixby@redoxengine.com",
233
                "system": "email"
234
              }
235
            ],
236
            "address": {
237
              "line": [
238
                "4762 Hickory St."
239
              ],
240
              "city": "Monroe",
241
              "district": "Green",
242
              "state": "WI",
243
              "postalCode": "53566",
244
              "country": "USA"
245
            },
246
            "relationship": [
247
              {
248
                "coding": [
249
                  {
250
                    "code": "MTH",
251
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
252
                    "display": "mother"
253
                  }
254
                ],
255
                "text": "Mother"
256
              },
257
              {
258
                "coding": [
259
                  {
260
                    "code": "C",
261
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
262
                    "display": "Emergency Contact"
263
                  }
264
                ],
265
                "text": "Emergency Contact"
266
              }
267
            ]
268
          }
269
        ],
270
        "generalPractitioner": [
271
          {
272
            "reference": "Practitioner/RedoxPractitionerExamplePat"
273
          }
274
        ],
275
        "managingOrganization": {
276
          "reference": "Organization/RedoxOrganizationManagingExample"
277
        }
278
      }
279
    },
280
    {
281
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Specimen?identifier=123|urn:redox:example:SpecimenID",
282
      "resource": {
283
        "resourceType": "Specimen",
284
        "id": "RedoxSpecimenExample",
285
        "identifier": [
286
          {
287
            "system": "urn:redox:example:SpecimenID",
288
            "value": "123"
289
          }
290
        ],
291
        "subject": {
292
          "reference": "Patient/RedoxPatientExampleTimothy"
293
        },
294
        "type": {
295
          "coding": [
296
            {
297
              "code": "WB",
298
              "system": "http://terminology.hl7.org/CodeSystem/v2-0487",
299
              "display": "Blood, Whole"
300
            }
301
          ],
302
          "text": "Blood, Whole"
303
        },
304
        "collection": {
305
          "bodySite": {
306
            "text": "Left arm"
307
          },
308
          "collectedDateTime": "2022-02-14T19:20:02.762Z"
309
        }
310
      }
311
    }
312
  ],
313
  "timestamp": "2021-06-17T20:33:22.422Z"
314
}

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, result, patient, specimen or Other

    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.