Patient Created Detailed

Page View

Patient administration notifications contain details about a patient's record or movements within a specific hospital or provider's office.

You can receive notifications when:

  • A patient record is created, merged, or updated.
  • A patient checks in, transfers to another unit, or leaves the hospital.

created

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

You can opt in for lightweight or detailed notifications.

  • A lightweight notification provides the Patient reference, high-level patient info, and timestamp.
  • A detailed notification contains everything in the lightweight plus the entire patient record and related references.

Select payload example

PatientAdminPatientCreatedFullBundleExample

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

Request Body Schema

  • 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, 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/PatientAdminPatientCreated
  • timestamp
    string

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