Document Created Detailed

Page View

Document notifications contain details about any documents related to a patient's chart, including CDAs, signed provider notes, or other PDF documents with patient data.

You can receive notifications when a document is created, deleted, or replaced.

created

Indicates that a new document has been created in your connection's system.

You can opt in for lightweight or detailed notifications.

  • A lightweight notification provides the DocumentReference reference, patient info, and timestamp.
  • A detailed notification contains everything in the lightweight plus the document content and related references.

Select payload example

DocumentReferenceCreatedFullBundleExample
json
1
{
2
"resourceType": "Bundle",
3
"id": "DocumentReferenceCreatedFullBundleExample",
4
"type": "message",
5
"entry": [
6
{
7
"resource": {
8
"eventUri": "https://fhir.redoxengine.com/EventDefinition/DocumentReferenceCreated",
9
"resourceType": "MessageHeader",
10
"id": "DocRefCreatedMessageHeader",
11
"source": {
12
"name": "Good Health Clinics",
13
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
},
15
"focus": [
16
{
17
"reference": "DocumentReference/RedoxDocumentReferenceExampleMediaTimothy"
18
}
19
],
20
"definition": "https://fhir.redoxengine.com/MessageDefinition/DocumentReferenceCreatedFull"
21
}
22
},
23
{
24
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/DocumentReference?identifier=129.6.58.92.88336|urn:redox:test:media",
25
"resource": {
26
"resourceType": "DocumentReference",
27
"id": "RedoxDocumentReferenceExampleMediaTimothy",
28
"masterIdentifier": {
29
"value": "129.6.58.92.88336",
30
"system": "urn:redox:test:media",
31
"extension": [
32
{
33
"url": "https://fhir.redoxengine.com/StructureDefinition/identifier-origin",
34
"valueString": "RedoxApi"
35
}
36
]
37
},
38
"subject": {
39
"reference": "Patient/RedoxPatientExampleTimothy"
40
},
41
"status": "current",
42
"description": "Test Description",
43
"type": {
44
"text": "Empty File"
45
},
46
"category": [
47
{
48
"coding": [
49
{
50
"system": "urn:redox:document_kind",
51
"code": "Media"
52
}
53
]
54
}
55
],
56
"context": {
57
"period": {
58
"start": "2015-05-06T06:00:58.872Z"
59
}
60
},
61
"content": [
62
{
63
"attachment": {
64
"data": "PC4uLmJhc2UgNjQgZmlsZSBjb250ZW50cy4uLj4=",
65
"contentType": "application/pdf",
66
"title": "SamplePDF-Order Specific Media"
67
}
68
}
69
]
70
}
71
},
72
{
73
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=0000000001|urn:redox:MRN",
74
"resource": {
75
"resourceType": "Patient",
76
"id": "RedoxPatientExampleTimothy",
77
"meta": {
78
"extension": [
79
{
80
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
81
"valueInteger": 1
82
}
83
]
84
},
85
"extension": [
86
{
87
"extension": [
88
{
89
"url": "text",
90
"valueString": "White"
91
}
92
],
93
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
94
},
95
{
96
"extension": [
97
{
98
"url": "ombCategory",
99
"valueCoding": {
100
"code": "2135-2",
101
"system": "urn:oid:2.16.840.1.113883.6.238",
102
"display": "Hispanic or Latino"
103
}
104
},
105
{
106
"url": "text",
107
"valueString": "Hispanic"
108
}
109
],
110
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
111
}
112
],
113
"identifier": [
114
{
115
"value": "0000000001",
116
"system": "urn:redox:health-one:MR"
117
},
118
{
119
"value": "101-01-0001",
120
"system": "http://hl7.org/fhir/sid/us-ssn"
121
}
122
],
123
"name": [
124
{
125
"given": [
126
"Timothy",
127
"Paul"
128
],
129
"family": "Bixby",
130
"use": "official"
131
},
132
{
133
"text": "Billy",
134
"use": "usual"
135
}
136
],
137
"gender": "male",
138
"birthDate": "2008-01-06",
139
"telecom": [
140
{
141
"value": "+18088675301",
142
"system": "phone",
143
"use": "home"
144
},
145
{
146
"value": "+18008675309",
147
"system": "phone",
148
"use": "work"
149
},
150
{
151
"value": "timothy.bixby@redoxengine.com",
152
"system": "email"
153
}
154
],
155
"address": [
156
{
157
"line": [
158
"4762 Hickory Street"
159
],
160
"city": "Monroe",
161
"district": "Greene",
162
"state": "WI",
163
"postalCode": "53566",
164
"country": "US",
165
"use": "home"
166
}
167
],
168
"maritalStatus": {
169
"coding": [
170
{
171
"code": "M",
172
"system": "http://hl7.org/fhir/v3/MaritalStatus",
173
"display": "Married"
174
}
175
],
176
"text": "Married"
177
},
178
"communication": [
179
{
180
"language": {
181
"coding": [
182
{
183
"code": "en",
184
"system": "urn:ietf:bcp:47"
185
}
186
],
187
"text": "English"
188
}
189
}
190
],
191
"contact": [
192
{
193
"name": {
194
"given": [
195
"Barbara"
196
],
197
"family": "Bixby"
198
},
199
"telecom": [
200
{
201
"value": "+18088675303",
202
"system": "phone",
203
"use": "home"
204
},
205
{
206
"value": "barbara.bixby@redoxengine.com",
207
"system": "email"
208
}
209
],
210
"address": {
211
"line": [
212
"4762 Hickory St."
213
],
214
"city": "Monroe",
215
"district": "Green",
216
"state": "WI",
217
"postalCode": "53566",
218
"country": "USA"
219
},
220
"relationship": [
221
{
222
"coding": [
223
{
224
"code": "MTH",
225
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
226
"display": "mother"
227
}
228
],
229
"text": "Mother"
230
},
231
{
232
"coding": [
233
{
234
"code": "C",
235
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
236
"display": "Emergency Contact"
237
}
238
],
239
"text": "Emergency Contact"
240
}
241
]
242
}
243
],
244
"generalPractitioner": [
245
{
246
"reference": "Practitioner/RedoxPractitionerExamplePat"
247
}
248
],
249
"managingOrganization": {
250
"reference": "Organization/RedoxOrganizationManagingExample"
251
}
252
}
253
},
254
{
255
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
256
"resource": {
257
"resourceType": "Practitioner",
258
"id": "RedoxPractitionerExamplePat",
259
"identifier": [
260
{
261
"system": "http://hl7.org/fhir/sid/us-npi",
262
"value": "4356789876"
263
}
264
],
265
"name": [
266
{
267
"given": [
268
"Pat"
269
],
270
"family": "Granite"
271
}
272
],
273
"address": [
274
{
275
"line": [
276
"123 Main St."
277
],
278
"city": "Madison",
279
"district": "Dane",
280
"state": "WI",
281
"postalCode": "53703",
282
"country": "USA"
283
}
284
],
285
"telecom": [
286
{
287
"value": "+16085551234"
288
}
289
]
290
}
291
},
292
{
293
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
294
"resource": {
295
"resourceType": "Organization",
296
"id": "RedoxOrganizationManagingExample",
297
"identifier": [
298
{
299
"value": "1234",
300
"system": "urn:oid:1.2.3.4"
301
}
302
],
303
"active": true,
304
"name": "Custodial Org",
305
"address": [
306
{
307
"line": [
308
"123 Main St"
309
],
310
"city": "Madison",
311
"state": "WI"
312
}
313
],
314
"telecom": [
315
{
316
"value": "1-800-123-4567",
317
"system": "phone"
318
}
319
],
320
"type": [
321
{
322
"text": "Test Type"
323
}
324
]
325
}
326
}
327
],
328
"timestamp": "2021-06-17T20:33:22.422Z"
329
}

Request Body Schema

    Bundle sent as part of a DocumentReference-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, documentReference, patient, practitioner, organization 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/DocumentReferenceCreated
  • timestamp
    string

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