ServiceRequest $servicerequest-create

post/ServiceRequest/$servicerequest-create
Page View

This resource contains a request for patient services like treatment(s), operation(s), consulting, skilled nursing, or other medical-related service(s).

You can review, retrieve, create, update, or cancel service requests.

$servicerequest-create

Place a new service request order for a service or procedure in your connection's system.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/ServiceRequest/$servicerequest-create' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
"resourceType": "Bundle",
7
"id": "RedoxServiceRequestCreateBundleExample",
8
"type": "message",
9
"entry": [
10
{
11
"resource": {
12
"eventUri": "https://fhir.redoxengine.com/EventDefinition/ServiceRequestCreate",
13
"resourceType": "MessageHeader",
14
"id": "RedoxServiceRequestCreateMessageHeaderExample",
15
"source": {
16
"name": "Good Health Clinics",
17
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
},
19
"focus": [
20
{
21
"reference": "ServiceRequest/RedoxServiceRequestOrderExample"
22
}
23
]
24
}
25
},
26
{
27
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/ServiceRequest/RedoxServiceRequestOrderExample",
28
"resource": {
29
"resourceType": "ServiceRequest",
30
"id": "RedoxServiceRequestOrderExample",
31
"identifier": [
32
{
33
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
34
"value": "6547891230"
35
}
36
],
37
"intent": "order",
38
"priority": "stat",
39
"status": "active",
40
"code": {
41
"coding": [
42
{
43
"code": "49086-2",
44
"system": "http://loinc.org",
45
"display": "First trimester maternal screen with nuchal translucency panel"
46
}
47
]
48
},
49
"authoredOn": "2022-08-08T08:00:00.000Z",
50
"note": [
51
{
52
"text": "Additional information"
53
}
54
],
55
"reasonReference": [
56
{
57
"reference": "DocumentReference/RedoxDocumentReferenceExampleMediaTimothy"
58
}
59
],
60
"supportingInfo": [
61
{
62
"reference": "Observation/RedoxPlateletObservationExample"
63
}
64
],
65
"subject": {
66
"reference": "Patient/RedoxPatientExampleTimothy"
67
},
68
"requester": {
69
"reference": "Practitioner/RedoxPractitionerExamplePat"
70
},
71
"performer": [
72
{
73
"reference": "Practitioner/RedoxPractitionerExampleJoan"
74
}
75
],
76
"specimen": [
77
{
78
"reference": "Specimen/RedoxSpecimenExample"
79
}
80
],
81
"encounter": {
82
"reference": "Encounter/RedoxEncounterExample"
83
}
84
}
85
},
86
{
87
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothy",
88
"resource": {
89
"resourceType": "Patient",
90
"id": "RedoxPatientExampleTimothy",
91
"meta": {
92
"extension": [
93
{
94
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
95
"valueInteger": 1
96
}
97
]
98
},
99
"extension": [
100
{
101
"extension": [
102
{
103
"url": "text",
104
"valueString": "White"
105
}
106
],
107
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
108
},
109
{
110
"extension": [
111
{
112
"url": "ombCategory",
113
"valueCoding": {
114
"code": "2135-2",
115
"system": "urn:oid:2.16.840.1.113883.6.238",
116
"display": "Hispanic or Latino"
117
}
118
},
119
{
120
"url": "text",
121
"valueString": "Hispanic"
122
}
123
],
124
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
125
}
126
],
127
"identifier": [
128
{
129
"value": "0000000001",
130
"system": "urn:redox:health-one:MR"
131
},
132
{
133
"value": "101-01-0001",
134
"system": "http://hl7.org/fhir/sid/us-ssn"
135
}
136
],
137
"name": [
138
{
139
"given": [
140
"Timothy",
141
"Paul"
142
],
143
"family": "Bixby",
144
"use": "official"
145
},
146
{
147
"text": "Billy",
148
"use": "usual"
149
}
150
],
151
"gender": "male",
152
"birthDate": "2008-01-06",
153
"telecom": [
154
{
155
"value": "+18088675301",
156
"system": "phone",
157
"use": "home"
158
},
159
{
160
"value": "+18008675309",
161
"system": "phone",
162
"use": "work"
163
},
164
{
165
"value": "timothy.bixby@redoxengine.com",
166
"system": "email"
167
}
168
],
169
"address": [
170
{
171
"line": [
172
"4762 Hickory Street"
173
],
174
"city": "Monroe",
175
"district": "Greene",
176
"state": "WI",
177
"postalCode": "53566",
178
"country": "US",
179
"use": "home"
180
}
181
],
182
"maritalStatus": {
183
"coding": [
184
{
185
"code": "M",
186
"system": "http://hl7.org/fhir/v3/MaritalStatus",
187
"display": "Married"
188
}
189
],
190
"text": "Married"
191
},
192
"communication": [
193
{
194
"language": {
195
"coding": [
196
{
197
"code": "en",
198
"system": "urn:ietf:bcp:47"
199
}
200
],
201
"text": "English"
202
}
203
}
204
],
205
"contact": [
206
{
207
"name": {
208
"given": [
209
"Barbara"
210
],
211
"family": "Bixby"
212
},
213
"telecom": [
214
{
215
"value": "+18088675303",
216
"system": "phone",
217
"use": "home"
218
},
219
{
220
"value": "barbara.bixby@redoxengine.com",
221
"system": "email"
222
}
223
],
224
"address": {
225
"line": [
226
"4762 Hickory St."
227
],
228
"city": "Monroe",
229
"district": "Green",
230
"state": "WI",
231
"postalCode": "53566",
232
"country": "USA"
233
},
234
"relationship": [
235
{
236
"coding": [
237
{
238
"code": "MTH",
239
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
240
"display": "mother"
241
}
242
],
243
"text": "Mother"
244
},
245
{
246
"coding": [
247
{
248
"code": "C",
249
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
250
"display": "Emergency Contact"
251
}
252
],
253
"text": "Emergency Contact"
254
}
255
]
256
}
257
],
258
"generalPractitioner": [
259
{
260
"reference": "Practitioner/RedoxPractitionerExamplePat"
261
}
262
],
263
"managingOrganization": {
264
"reference": "Organization/RedoxOrganizationManagingExample"
265
}
266
}
267
},
268
{
269
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter/RedoxEncounterExample",
270
"resource": {
271
"resourceType": "Encounter",
272
"id": "RedoxEncounterExample",
273
"identifier": [
274
{
275
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
276
"value": "9601346482"
277
}
278
],
279
"status": "finished",
280
"class": {
281
"code": "IMP",
282
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
283
"display": "inpatient encounter"
284
},
285
"type": [
286
{
287
"coding": [
288
{
289
"code": "99222",
290
"system": "http://www.ama-assn.org/go/cpt",
291
"display": "InPatient Admission"
292
}
293
]
294
}
295
],
296
"diagnosis": [
297
{
298
"condition": {
299
"reference": "Condition/RedoxConditionExampleEncounterDx"
300
}
301
}
302
],
303
"participant": [
304
{
305
"individual": {
306
"reference": "Practitioner/RedoxPractitionerExampleEncounter"
307
}
308
}
309
],
310
"location": [
311
{
312
"location": {
313
"reference": "Location/RedoxLocationExampleEncounter"
314
}
315
}
316
],
317
"subject": {
318
"reference": "Patient/RedoxPatientExampleTimothy"
319
},
320
"period": {
321
"start": "2022-02-06T04:00:00.000Z",
322
"end": "2022-02-06T04:15:00.000Z"
323
},
324
"length": {
325
"value": 16,
326
"code": "m",
327
"system": "http://unitsofmeasure.org"
328
},
329
"reasonCode": [
330
{
331
"coding": [
332
{
333
"code": "23360407",
334
"system": "http://snomed.info/sct"
335
}
336
],
337
"text": "Pneumonia"
338
}
339
]
340
}
341
},
342
{
343
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Practitioner/RedoxPractitionerExamplePat",
344
"resource": {
345
"resourceType": "Practitioner",
346
"id": "RedoxPractitionerExamplePat",
347
"identifier": [
348
{
349
"system": "http://hl7.org/fhir/sid/us-npi",
350
"value": "4356789876"
351
}
352
],
353
"name": [
354
{
355
"given": [
356
"Pat"
357
],
358
"family": "Granite"
359
}
360
],
361
"address": [
362
{
363
"line": [
364
"123 Main St."
365
],
366
"city": "Madison",
367
"district": "Dane",
368
"state": "WI",
369
"postalCode": "53703",
370
"country": "USA"
371
}
372
],
373
"telecom": [
374
{
375
"value": "+16085551234"
376
}
377
]
378
}
379
},
380
{
381
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Organization/RedoxOrganizationManagingExample",
382
"resource": {
383
"resourceType": "Organization",
384
"id": "RedoxOrganizationManagingExample",
385
"identifier": [
386
{
387
"value": "1234",
388
"system": "urn:oid:1.2.3.4"
389
}
390
],
391
"active": true,
392
"name": "Custodial Org",
393
"address": [
394
{
395
"line": [
396
"123 Main St"
397
],
398
"city": "Madison",
399
"state": "WI"
400
}
401
],
402
"telecom": [
403
{
404
"value": "1-800-123-4567",
405
"system": "phone"
406
}
407
],
408
"type": [
409
{
410
"text": "Test Type"
411
}
412
]
413
}
414
},
415
{
416
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation/RedoxPlateletObservationExample",
417
"resource": {
418
"resourceType": "Observation",
419
"id": "RedoxPlateletObservationExample",
420
"category": [
421
{
422
"coding": [
423
{
424
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
425
"code": "laboratory"
426
}
427
]
428
}
429
],
430
"identifier": [
431
{
432
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
433
"value": "4910481243"
434
}
435
],
436
"status": "final",
437
"subject": {
438
"reference": "Patient/RedoxPatientExampleTimothy"
439
},
440
"basedOn": [
441
{
442
"reference": "ServiceRequest/RedoxServiceRequestOrderExample"
443
}
444
],
445
"code": {
446
"coding": [
447
{
448
"code": "26515-7",
449
"system": "http://loinc.org"
450
}
451
],
452
"text": "Platelets"
453
},
454
"specimen": {
455
"reference": "Specimen/RedoxSpecimenExample"
456
},
457
"issued": "2022-02-16T17:26:19.778Z",
458
"valueQuantity": {
459
"value": 201,
460
"unit": "10+3/ul"
461
},
462
"note": [
463
{
464
"text": "An observation result note"
465
}
466
],
467
"interpretation": [
468
{
469
"coding": [
470
{
471
"code": "N",
472
"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
473
"display": "Normal"
474
}
475
]
476
}
477
]
478
}
479
},
480
{
481
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Specimen/RedoxSpecimenExample",
482
"resource": {
483
"resourceType": "Specimen",
484
"id": "RedoxSpecimenExample",
485
"identifier": [
486
{
487
"system": "urn:redox:example:SpecimenID",
488
"value": "123"
489
}
490
],
491
"subject": {
492
"reference": "Patient/RedoxPatientExampleTimothy"
493
},
494
"type": {
495
"coding": [
496
{
497
"code": "WB",
498
"system": "http://terminology.hl7.org/CodeSystem/v2-0487",
499
"display": "Blood, Whole"
500
}
501
],
502
"text": "Blood, Whole"
503
},
504
"collection": {
505
"bodySite": {
506
"text": "Left arm"
507
},
508
"collectedDateTime": "2022-02-14T19:20:02.762Z"
509
}
510
}
511
}
512
],
513
"timestamp": "2021-06-17T20:33:22.422Z"
514
}'

Request Body Schema

    Bundle sent as part of a ServiceRequestCreate message

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a message

    Value: message
  • entry
    required, Array of messageHeader, serviceRequest, patient, encounter

    An entry in the bundle containing a FHIR resource

    • resource
      required, object

      Additional metadata about the message including the event

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        Information about the sender of the message and the Bundle content.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

        • name
          string

          Human-readable name for the source system.

      • focus
        required, Array of object

        This describes the focal target resource of the message from which the remainder of the content is referenced from

        Must be a resource of type ServiceRequest.

        • 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.

      • eventUri
        required, string

        This describes the message being communicated

        Value: https://fhir.redoxengine.com/EventDefinition/ServiceRequestCreate
  • timestamp
    string

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

Response fields and example

Example
json
1
"Operation Response"