Home
API reference
FHIR® API
FHIR® notifications
PatientAdmin
Patient Created

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.

Review tips for receiving patient record notifications.

Select payload example

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

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/PatientAdminCreated
  • 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®.