Home
API reference
FHIR® API
FHIR® resources
Practitioner
$bulk-practitioner-update

Practitioner $bulk-practitioner-update

post/Practitioner/$bulk-practitioner-update
Page View

This resource includes details about an individual at a healthcare organization. The individual may range from those indirectly responsible for patient treatment or services (e.g., receptionists, IT personnel) to those directly responsible for patient treatment or services (e.g., physicians, pharmacists, therapists). However, this resource doesn’t include people related to the patient like a caregiver. 

You can review, retrieve, or update practitioner records in bulk.

$bulk-practitioner-update

Update multiple providers at once.

The structure of the payload is a batch bundle, and the RESTful operation in entry.request.method informs what type of operation should be be made on the resource.

This operation is compatible with HL7v2 MFN style interfaces.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Practitioner/$bulk-practitioner-update' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
  "resourceType": "Bundle",
7
  "id": "BulkPractitionerUpdateExample",
8
  "type": "batch",
9
  "identifier": {
10
    "system": "urn:ietf:rfc:3986",
11
    "value": "urn:uuid:83de1e55-9475-48c4-a1c8-8e25e61d3227"
12
  },
13
  "timestamp": "2025-07-21T19:09:02.452Z",
14
  "entry": [
15
    {
16
      "resource": {
17
        "resourceType": "Practitioner",
18
        "id": "12264ab4-5df9-3447-a281-a1538a533586",
19
        "extension": [
20
          {
21
            "url": "http://synthetichealth.github.io/synthea/utilization-encounters-extension",
22
            "valueInteger": 507
23
          }
24
        ],
25
        "identifier": [
26
          {
27
            "system": "http://hl7.org/fhir/sid/us-npi",
28
            "value": "9999986992"
29
          }
30
        ],
31
        "active": true,
32
        "name": [
33
          {
34
            "family": "Wilderman",
35
            "given": [
36
              "Simonne"
37
            ],
38
            "prefix": [
39
              "Dr."
40
            ]
41
          }
42
        ],
43
        "telecom": [
44
          {
45
            "extension": [
46
              {
47
                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
48
                "valueBoolean": true
49
              }
50
            ],
51
            "system": "email",
52
            "value": "Simonne.Wilderman@example.com",
53
            "use": "work"
54
          }
55
        ],
56
        "address": [
57
          {
58
            "line": [
59
              "855 S MAIN ST"
60
            ],
61
            "city": "OCONTO FALLS",
62
            "state": "WI",
63
            "postalCode": "541541282",
64
            "country": "US"
65
          }
66
        ],
67
        "gender": "female"
68
      },
69
      "request": {
70
        "method": "POST",
71
        "url": "Practitioner"
72
      }
73
    },
74
    {
75
      "resource": {
76
        "resourceType": "Practitioner",
77
        "id": "15159e73-b32d-36b2-b57b-e37a3041ace0",
78
        "extension": [
79
          {
80
            "url": "http://synthetichealth.github.io/synthea/utilization-encounters-extension",
81
            "valueInteger": 250
82
          }
83
        ],
84
        "identifier": [
85
          {
86
            "system": "http://hl7.org/fhir/sid/us-npi",
87
            "value": "9999945790"
88
          }
89
        ],
90
        "active": true,
91
        "name": [
92
          {
93
            "family": "Bernhard",
94
            "given": [
95
              "Will"
96
            ],
97
            "prefix": [
98
              "Dr."
99
            ]
100
          }
101
        ],
102
        "telecom": [
103
          {
104
            "extension": [
105
              {
106
                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
107
                "valueBoolean": true
108
              }
109
            ],
110
            "system": "email",
111
            "value": "Will.Bernhard@example.com",
112
            "use": "work"
113
          }
114
        ],
115
        "address": [
116
          {
117
            "line": [
118
              "2745 W LAYTON AVE"
119
            ],
120
            "city": "MILWAUKEE",
121
            "state": "WI",
122
            "postalCode": "532212651",
123
            "country": "US"
124
          }
125
        ],
126
        "gender": "male"
127
      },
128
      "request": {
129
        "method": "DELETE",
130
        "url": "Practitioner/15159e73-b32d-36b2-b57b-e37a3041ace0"
131
      }
132
    },
133
    {
134
      "resource": {
135
        "resourceType": "PractitionerRole",
136
        "id": "999c23ff-e839-1b1b-7fa7-d22731b78207",
137
        "practitioner": {
138
          "identifier": {
139
            "system": "http://hl7.org/fhir/sid/us-npi",
140
            "value": "9999945790"
141
          },
142
          "display": "Dr. Will Bernhard"
143
        },
144
        "organization": {
145
          "reference": "Organization/8b124b8e-ce6a-3b8a-bf2c-b8f539a4e3ce",
146
          "identifier": {
147
            "system": "https://github.com/synthetichealth/synthea",
148
            "value": "8b124b8e-ce6a-3b8a-bf2c-b8f539a4e3ce"
149
          },
150
          "display": "AGELESS WELLNESS CENTER, INC"
151
        },
152
        "code": [
153
          {
154
            "coding": [
155
              {
156
                "code": "208D00000X",
157
                "system": "http://nucc.org/provider-taxonomy",
158
                "display": "General Practice Physician"
159
              }
160
            ],
161
            "text": "General Practice Physician"
162
          }
163
        ],
164
        "specialty": [
165
          {
166
            "coding": [
167
              {
168
                "code": "208D00000X",
169
                "system": "http://nucc.org/provider-taxonomy",
170
                "display": "General Practice Physician"
171
              }
172
            ],
173
            "text": "General Practice Physician"
174
          }
175
        ],
176
        "location": [
177
          {
178
            "reference": "Location/a5cc27d1-5c70-39f8-a9c4-2f3696988650",
179
            "identifier": {
180
              "system": "https://github.com/synthetichealth/synthea",
181
              "value": "a5cc27d1-5c70-39f8-a9c4-2f3696988650"
182
            },
183
            "display": "AGELESS WELLNESS CENTER, INC"
184
          }
185
        ],
186
        "telecom": [
187
          {
188
            "system": "phone",
189
            "value": "4144755800"
190
          },
191
          {
192
            "extension": [
193
              {
194
                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
195
                "valueBoolean": true
196
              }
197
            ],
198
            "system": "email",
199
            "value": "Will.Bernhard@example.com",
200
            "use": "work"
201
          }
202
        ]
203
      },
204
      "request": {
205
        "url": "PractitionerRole/999c23ff-e839-1b1b-7fa7-d22731b78207",
206
        "method": "POST"
207
      }
208
    },
209
    {
210
      "resource": {
211
        "resourceType": "PractitionerRole",
212
        "id": "36ba349c-0d97-3fd2-c95f-b7eaa5924190",
213
        "practitioner": {
214
          "identifier": {
215
            "system": "http://hl7.org/fhir/sid/us-npi",
216
            "value": "9999986992"
217
          },
218
          "display": "Dr. Simonne Wilderman"
219
        },
220
        "organization": {
221
          "identifier": {
222
            "system": "https://github.com/synthetichealth/synthea",
223
            "value": "86336b7d-af6c-3f75-b2f5-7437732b471d"
224
          },
225
          "display": "HSHS ST CLARE MEMORIAL HOSPITAL"
226
        },
227
        "code": [
228
          {
229
            "coding": [
230
              {
231
                "code": "208D00000X",
232
                "system": "http://nucc.org/provider-taxonomy",
233
                "display": "General Practice Physician"
234
              }
235
            ],
236
            "text": "General Practice Physician"
237
          }
238
        ],
239
        "specialty": [
240
          {
241
            "coding": [
242
              {
243
                "code": "208D00000X",
244
                "system": "http://nucc.org/provider-taxonomy",
245
                "display": "General Practice Physician"
246
              }
247
            ],
248
            "text": "General Practice Physician"
249
          }
250
        ],
251
        "location": [
252
          {
253
            "identifier": {
254
              "system": "https://github.com/synthetichealth/synthea",
255
              "value": "1500ca21-bba4-32a9-8971-00bf404d259d"
256
            },
257
            "display": "HSHS ST CLARE MEMORIAL HOSPITAL"
258
          }
259
        ],
260
        "telecom": [
261
          {
262
            "system": "phone",
263
            "value": "9208463444"
264
          },
265
          {
266
            "extension": [
267
              {
268
                "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
269
                "valueBoolean": true
270
              }
271
            ],
272
            "system": "email",
273
            "value": "Simonne.Wilderman@example.com",
274
            "use": "work"
275
          }
276
        ]
277
      },
278
      "request": {
279
        "url": "PractitionerRole/36ba349c-0d97-3fd2-c95f-b7eaa5924190",
280
        "method": "DELETE"
281
      }
282
    }
283
  ],
284
  "Meta": {
285
    "Logs": [
286
      {
287
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
288
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
289
      }
290
    ],
291
    "Test": true,
292
    "EventDateTime": "2025-08-15T21:15:58.605Z",
293
    "Source": {
294
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
295
      "Name": "Redox Dev Tools"
296
    },
297
    "Destinations": [
298
      {
299
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
300
        "Name": "Redox EMR"
301
      }
302
    ],
303
    "DataModel": "FHIR.Practitioner",
304
    "EventType": "$bulk-practitioner-update"
305
  }
306
}'

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: batch
  • entry
    required, Array of Practitioner, PractitionerRole, Location or Other

    An bundle of Practitioner, PractitionerRole and Location resources to be updated in bulk.

    • request
      object

      Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.

      • method
        required, string

        In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.

        Possible Values: GET, HEAD, POST, PUT, DELETE, PATCH
      • url
        required, string

        The URL for this entry, relative to the root (the address to which the request is posted).

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "OperationOutcome",
3
  "issue": [
4
    {
5
      "id": "string",
6
      "severity": "fatal",
7
      "code": "string",
8
      "details": {
9
        "coding": [
10
          {
11
            "system": "string",
12
            "code": "string"
13
          }
14
        ],
15
        "text": "string"
16
      },
17
      "diagnostics": "string"
18
    }
19
  ]
20
}
  • resourceType
    required, string

    Identifies the type of the resource

    Value: OperationOutcome
  • issue
    required, Array of object

    A structured respresentation of the error that occurred

    • severity
      required, string

      Generally error or fatal

      Possible Values: fatal, error, warning, information
    • code
      required, string

      A FHIR category code that describes the general type of issue. See http://hl7.org/fhir/ValueSet/issue-type for details

    • id
      string

      If the error occurs in the RedoxEngine, this corresponds to an Error record in the organization.

    • details
      object

      Additional details about the error. This may be a text description of the error or a system code that identifies the error.

      • coding
        Array of object

        A more granular FHIR code for the specific error. Typically from http://hl7.org/fhir/ValueSet/operation-outcome

        • system
          string

          The identification of the code system that defines the meaning of the symbol in the code.

        • code
          string

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

      • text
        string

        A human-readable interpretation of the issue code

    • diagnostics
      string

      Additional diagnostic information about the issue.