Encounter $encounter-register

post/Encounter/$encounter-register
Page View

This resource contains details and outcomes for a patient encounter, which can include one or more providers, locations, and services.

Encounters may encompass preadmission, outpatient visits, telehealth visits, inpatient stays, and discharges, depending on the organization and context for the encounter.

Encounters may contain references to procedures if:

  • A procedure was completed during a patient visit.
  • A follow-up procedure is scheduled as a result of the encounter.

You can review, retrieve, save, or cancel encounter details.

$encounter-register

Register a patient for an encounter in your connection's system.

Registering a patient typically means that a patient has arrived and registered for care but hasn't been assigned a location.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Encounter/$encounter-register' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
"resourceType": "Bundle",
7
"id": "RedoxEncounterRegisterBundleExample",
8
"type": "message",
9
"entry": [
10
{
11
"resource": {
12
"eventUri": "https://fhir.redoxengine.com/EventDefinition/EncounterRegister",
13
"resourceType": "MessageHeader",
14
"id": "RedoxEncounterCreateMessageHeaderExample",
15
"source": {
16
"name": "Good Health Clinics",
17
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
18
},
19
"focus": [
20
{
21
"reference": "Encounter/RedoxEncounterCreateEncounterExample"
22
}
23
]
24
}
25
},
26
{
27
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Encounter/RedoxEncounterCreateEncounterExample",
28
"resource": {
29
"resourceType": "Encounter",
30
"id": "RedoxEncounterCreateEncounterExample",
31
"identifier": [
32
{
33
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
34
"value": "9601346482"
35
}
36
],
37
"status": "planned",
38
"class": {
39
"code": "IMP",
40
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
41
"display": "inpatient encounter"
42
},
43
"type": [
44
{
45
"coding": [
46
{
47
"code": "99222",
48
"system": "http://www.ama-assn.org/go/cpt",
49
"display": "InPatient Admission"
50
}
51
]
52
}
53
],
54
"account": [
55
{
56
"reference": "Account/RedoxEncounterCreateRedoxAccountExample"
57
}
58
],
59
"diagnosis": [
60
{
61
"condition": {
62
"reference": "Condition/RedoxConditionExampleEncounterDx"
63
}
64
}
65
],
66
"reasonReference": [
67
{
68
"reference": "Procedure/RedoxProcedureExampleMinimumCompleted"
69
}
70
],
71
"participant": [
72
{
73
"individual": {
74
"reference": "Practitioner/RedoxPractitionerExampleEncounter"
75
}
76
}
77
],
78
"location": [
79
{
80
"location": {
81
"reference": "Location/RedoxLocationExampleRoom"
82
},
83
"status": "reserved"
84
}
85
],
86
"subject": {
87
"reference": "Patient/RedoxPatientExampleTimothy"
88
},
89
"period": {
90
"start": "2022-02-06T04:00:00.000Z",
91
"end": "2022-02-06T04:15:00.000Z"
92
},
93
"length": {
94
"value": 16,
95
"code": "m",
96
"system": "http://unitsofmeasure.org"
97
},
98
"reasonCode": [
99
{
100
"coding": [
101
{
102
"code": "23360407",
103
"system": "http://snomed.info/sct"
104
}
105
],
106
"text": "Pneumonia"
107
}
108
]
109
}
110
},
111
{
112
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient/RedoxPatientExampleTimothy",
113
"resource": {
114
"resourceType": "Patient",
115
"id": "RedoxPatientExampleTimothy",
116
"meta": {
117
"extension": [
118
{
119
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
120
"valueInteger": 1
121
}
122
]
123
},
124
"extension": [
125
{
126
"extension": [
127
{
128
"url": "text",
129
"valueString": "White"
130
}
131
],
132
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
133
},
134
{
135
"extension": [
136
{
137
"url": "ombCategory",
138
"valueCoding": {
139
"code": "2135-2",
140
"system": "urn:oid:2.16.840.1.113883.6.238",
141
"display": "Hispanic or Latino"
142
}
143
},
144
{
145
"url": "text",
146
"valueString": "Hispanic"
147
}
148
],
149
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
150
}
151
],
152
"identifier": [
153
{
154
"value": "0000000001",
155
"system": "urn:redox:health-one:MR"
156
},
157
{
158
"value": "101-01-0001",
159
"system": "http://hl7.org/fhir/sid/us-ssn"
160
}
161
],
162
"name": [
163
{
164
"given": [
165
"Timothy",
166
"Paul"
167
],
168
"family": "Bixby",
169
"use": "official"
170
},
171
{
172
"text": "Billy",
173
"use": "usual"
174
}
175
],
176
"gender": "male",
177
"birthDate": "2008-01-06",
178
"telecom": [
179
{
180
"value": "+18088675301",
181
"system": "phone",
182
"use": "home"
183
},
184
{
185
"value": "+18008675309",
186
"system": "phone",
187
"use": "work"
188
},
189
{
190
"value": "timothy.bixby@redoxengine.com",
191
"system": "email"
192
}
193
],
194
"address": [
195
{
196
"line": [
197
"4762 Hickory Street"
198
],
199
"city": "Monroe",
200
"district": "Greene",
201
"state": "WI",
202
"postalCode": "53566",
203
"country": "US",
204
"use": "home"
205
}
206
],
207
"maritalStatus": {
208
"coding": [
209
{
210
"code": "M",
211
"system": "http://hl7.org/fhir/v3/MaritalStatus",
212
"display": "Married"
213
}
214
],
215
"text": "Married"
216
},
217
"communication": [
218
{
219
"language": {
220
"coding": [
221
{
222
"code": "en",
223
"system": "urn:ietf:bcp:47"
224
}
225
],
226
"text": "English"
227
}
228
}
229
],
230
"contact": [
231
{
232
"name": {
233
"given": [
234
"Barbara"
235
],
236
"family": "Bixby"
237
},
238
"telecom": [
239
{
240
"value": "+18088675303",
241
"system": "phone",
242
"use": "home"
243
},
244
{
245
"value": "barbara.bixby@redoxengine.com",
246
"system": "email"
247
}
248
],
249
"address": {
250
"line": [
251
"4762 Hickory St."
252
],
253
"city": "Monroe",
254
"district": "Green",
255
"state": "WI",
256
"postalCode": "53566",
257
"country": "USA"
258
},
259
"relationship": [
260
{
261
"coding": [
262
{
263
"code": "MTH",
264
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
265
"display": "mother"
266
}
267
],
268
"text": "Mother"
269
},
270
{
271
"coding": [
272
{
273
"code": "C",
274
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
275
"display": "Emergency Contact"
276
}
277
],
278
"text": "Emergency Contact"
279
}
280
]
281
}
282
],
283
"generalPractitioner": [
284
{
285
"reference": "Practitioner/RedoxPractitionerExamplePat"
286
}
287
],
288
"managingOrganization": {
289
"reference": "Organization/RedoxOrganizationManagingExample"
290
}
291
}
292
},
293
{
294
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Account/RedoxEncounterCreateRedoxAccountExample",
295
"resource": {
296
"resourceType": "Account",
297
"id": "RedoxEncounterCreateRedoxAccountExample",
298
"status": "active",
299
"type": {
300
"coding": [
301
{
302
"code": "PBILLACCT",
303
"display": "Patient Billing Account"
304
}
305
]
306
},
307
"name": "Redox Account Example",
308
"subject": [
309
{
310
"reference": "Patient/RedoxPatientExampleTimothy"
311
}
312
],
313
"coverage": [
314
{
315
"coverage": {
316
"reference": "Coverage/RedoxCoverageExample"
317
}
318
}
319
],
320
"guarantor": [
321
{
322
"party": {
323
"reference": "RelatedPerson/RedoxRelatedPersonExample"
324
}
325
}
326
],
327
"identifier": [
328
{
329
"value": "acct12345",
330
"system": "urn:redox:accountNumber"
331
}
332
]
333
}
334
},
335
{
336
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Coverage/RedoxCoverageExample",
337
"resource": {
338
"resourceType": "Coverage",
339
"id": "RedoxCoverageExample",
340
"class": [
341
{
342
"type": {
343
"coding": [
344
{
345
"code": "group",
346
"system": "http://terminology.hl7.org/CodeSystem/coverage-class"
347
}
348
]
349
},
350
"value": "847025-024-0009",
351
"name": "Accelerator Labs"
352
},
353
{
354
"type": {
355
"coding": [
356
{
357
"code": "plan",
358
"system": "http://terminology.hl7.org/CodeSystem/coverage-class"
359
}
360
]
361
},
362
"value": "31572",
363
"name": "HMO Deductible Plan"
364
},
365
{
366
"type": {
367
"coding": [
368
{
369
"code": "agreement-type",
370
"system": "https://fhir.redoxengine.com/CodeSystem/other-coverage-class"
371
}
372
]
373
},
374
"value": "Standard"
375
},
376
{
377
"type": {
378
"coding": [
379
{
380
"code": "coverage-type",
381
"system": "https://fhir.redoxengine.com/CodeSystem/other-coverage-class"
382
}
383
]
384
},
385
"value": "Insurance"
386
}
387
],
388
"identifier": [
389
{
390
"system": "urn:redox:example:MBRNUM",
391
"value": "2234566"
392
},
393
{
394
"system": "urn:redox:example:POLNUM",
395
"value": "9140860055"
396
}
397
],
398
"type": {
399
"text": "HMO"
400
},
401
"status": "active",
402
"subscriber": {
403
"reference": "#RedoxRelatedPersonExample"
404
},
405
"beneficiary": {
406
"reference": "Patient/RedoxPatientExampleTimothy"
407
},
408
"period": {
409
"start": "2015-01-01",
410
"end": "2020-12-31"
411
},
412
"payor": [
413
{
414
"reference": "#RedoxInsurerOrganizationExample"
415
}
416
],
417
"contained": [
418
{
419
"resourceType": "RelatedPerson",
420
"id": "RedoxRelatedPersonExample",
421
"patient": {
422
"reference": "Patient/RedoxPatientExampleTimothy"
423
},
424
"name": [
425
{
426
"given": [
427
"Barbara"
428
],
429
"family": "Bixby"
430
}
431
],
432
"telecom": [
433
{
434
"value": "+18088675303",
435
"system": "phone",
436
"use": "home"
437
},
438
{
439
"value": "barbara.bixby@redoxengine.com",
440
"system": "email"
441
}
442
],
443
"address": [
444
{
445
"line": [
446
"4762 Hickory St."
447
],
448
"city": "Monroe",
449
"district": "Green",
450
"state": "WI",
451
"postalCode": "53566",
452
"country": "USA"
453
}
454
],
455
"relationship": [
456
{
457
"coding": [
458
{
459
"code": "MTH",
460
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
461
"display": "mother"
462
}
463
],
464
"text": "Mother"
465
},
466
{
467
"coding": [
468
{
469
"code": "C",
470
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
471
"display": "Emergency Contact"
472
}
473
],
474
"text": "Emergency Contact"
475
}
476
]
477
},
478
{
479
"resourceType": "Organization",
480
"id": "RedoxInsurerOrganizationExample",
481
"active": true,
482
"identifier": [
483
{
484
"type": {
485
"text": "PayorID"
486
},
487
"value": "60054"
488
}
489
],
490
"telecom": [
491
{
492
"system": "phone",
493
"value": "+18089541123"
494
}
495
],
496
"name": "Aetna",
497
"address": [
498
{
499
"line": [
500
"PO Box 14080"
501
],
502
"city": "Lexington",
503
"district": "Fayette",
504
"state": "KY",
505
"postalCode": "40512-4079",
506
"country": "USA"
507
}
508
]
509
}
510
]
511
}
512
},
513
{
514
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/RelatedPerson/RedoxRelatedPersonExample",
515
"resource": {
516
"resourceType": "RelatedPerson",
517
"id": "RedoxRelatedPersonExample",
518
"patient": {
519
"reference": "Patient/RedoxPatientExampleTimothy"
520
},
521
"name": [
522
{
523
"given": [
524
"Barbara"
525
],
526
"family": "Bixby"
527
}
528
],
529
"telecom": [
530
{
531
"value": "+18088675303",
532
"system": "phone",
533
"use": "home"
534
},
535
{
536
"value": "barbara.bixby@redoxengine.com",
537
"system": "email"
538
}
539
],
540
"address": [
541
{
542
"line": [
543
"4762 Hickory St."
544
],
545
"city": "Monroe",
546
"district": "Green",
547
"state": "WI",
548
"postalCode": "53566",
549
"country": "USA"
550
}
551
],
552
"relationship": [
553
{
554
"coding": [
555
{
556
"code": "MTH",
557
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
558
"display": "mother"
559
}
560
],
561
"text": "Mother"
562
},
563
{
564
"coding": [
565
{
566
"code": "C",
567
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
568
"display": "Emergency Contact"
569
}
570
],
571
"text": "Emergency Contact"
572
}
573
]
574
}
575
},
576
{
577
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Location/RedoxLocationExampleRoom",
578
"resource": {
579
"resourceType": "Location",
580
"id": "RedoxLocationExampleRoom",
581
"identifier": [
582
{
583
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696570",
584
"value": "6592045611"
585
}
586
],
587
"name": "136",
588
"physicalType": {
589
"coding": [
590
{
591
"code": "ro",
592
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
593
"display": "Room"
594
}
595
]
596
},
597
"partOf": {
598
"reference": "Location/RedoxLocationExampleDepartment"
599
}
600
}
601
},
602
{
603
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Location/RedoxLocationExampleDepartment",
604
"resource": {
605
"resourceType": "Location",
606
"id": "RedoxLocationExampleDepartment",
607
"identifier": [
608
{
609
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696570",
610
"value": "3490285621"
611
}
612
],
613
"name": "3N",
614
"type": [
615
{
616
"text": "Inpatient"
617
}
618
],
619
"physicalType": {
620
"coding": [
621
{
622
"code": "wa",
623
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
624
"display": "Ward"
625
}
626
],
627
"text": "Department"
628
},
629
"partOf": {
630
"reference": "Location/RedoxLocationExampleFacility"
631
}
632
}
633
},
634
{
635
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Location/RedoxLocationExampleFacility",
636
"resource": {
637
"resourceType": "Location",
638
"id": "RedoxLocationExampleFacility",
639
"identifier": [
640
{
641
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696570",
642
"value": "461904242"
643
}
644
],
645
"name": "RES General Hospital",
646
"physicalType": {
647
"coding": [
648
{
649
"code": "si",
650
"system": "http://terminology.hl7.org/CodeSystem/location-physical-type",
651
"display": "Site"
652
}
653
],
654
"text": "Facility"
655
}
656
}
657
},
658
{
659
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Condition/RedoxConditionExampleEncounterDx",
660
"resource": {
661
"resourceType": "Condition",
662
"id": "RedoxConditionExampleEncounterDx",
663
"category": [
664
{
665
"coding": [
666
{
667
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
668
"code": "encounter-diagnosis"
669
}
670
]
671
}
672
],
673
"identifier": [
674
{
675
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696871",
676
"value": "8769522345"
677
}
678
],
679
"subject": {
680
"reference": "Patient/RedoxPatientExampleTimothy"
681
},
682
"encounter": {
683
"reference": "Encounter/RedoxEncounterCreateEncounterExample"
684
},
685
"code": {
686
"coding": [
687
{
688
"code": "233604007",
689
"system": "http://snomed.info/sct"
690
}
691
],
692
"text": "Pneumonia"
693
}
694
}
695
},
696
{
697
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/AllergyIntolerance/AllergyExample",
698
"resource": {
699
"resourceType": "AllergyIntolerance",
700
"id": "AllergyExample",
701
"identifier": [
702
{
703
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
704
"value": "35892347"
705
}
706
],
707
"clinicalStatus": {
708
"coding": [
709
{
710
"code": "active",
711
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
712
"display": "Active"
713
}
714
],
715
"text": "Active"
716
},
717
"type": "allergy",
718
"_type": {
719
"extension": [
720
{
721
"url": "http://hl7.org/fhir/StructureDefinition/originalText",
722
"valueString": "Propensity to adverse reaction to drug"
723
}
724
]
725
},
726
"criticality": "low",
727
"code": {
728
"coding": [
729
{
730
"code": "2670",
731
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
732
"display": "Codeine"
733
}
734
],
735
"text": "Codeine"
736
},
737
"patient": {
738
"reference": "Patient/RedoxPatientExampleTimothy"
739
},
740
"encounter": {
741
"reference": "Encounter/RedoxEncounterCreateEncounterExample"
742
},
743
"onsetDateTime": "2022-01-03T16:30:00.000Z",
744
"reaction": [
745
{
746
"manifestation": [
747
{
748
"coding": [
749
{
750
"code": "267036007",
751
"system": "http://snomed.info/sct",
752
"display": "Shortness of Breath"
753
}
754
]
755
}
756
],
757
"description": "Shortness of Breath",
758
"severity": "moderate",
759
"_severity": {
760
"extension": [
761
{
762
"url": "http://hl7.org/fhir/StructureDefinition/originalText",
763
"valueString": "Mild to moderate"
764
}
765
]
766
}
767
}
768
],
769
"note": [
770
{
771
"text": "Additional information"
772
}
773
]
774
}
775
},
776
{
777
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Procedure/RedoxProcedureExampleMinimumCompleted",
778
"resource": {
779
"resourceType": "Procedure",
780
"id": "RedoxProcedureExampleMinimumCompleted",
781
"identifier": [
782
{
783
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
784
"value": "6891241274"
785
}
786
],
787
"subject": {
788
"reference": "Patient/RedoxPatientExampleTimothy"
789
},
790
"encounter": {
791
"reference": "Encounter/RedoxEncounterCreateEncounterExample"
792
},
793
"performedDateTime": "2022-02-08T19:00:00.000Z",
794
"performedPeriod": {
795
"start": "2022-02-08T19:00:00.000Z",
796
"end": "2022-02-08T20:00:00.000Z"
797
},
798
"status": "completed",
799
"_status": {
800
"extension": [
801
{
802
"url": "http://hl7.org/fhir/StructureDefinition/originalText",
803
"valueString": "Finished"
804
}
805
]
806
},
807
"bodySite": [
808
{
809
"coding": [
810
{
811
"code": "181608004",
812
"system": "http://snomed.info/sct",
813
"display": "Entire chest wall (body structure)"
814
}
815
]
816
}
817
],
818
"code": {
819
"coding": [
820
{
821
"code": "168731009",
822
"system": "http://snomed.info/sct",
823
"display": "Chest X-Ray"
824
}
825
]
826
},
827
"category": {
828
"coding": [
829
{
830
"code": "Procedures",
831
"system": "urn:redox:procedure_act_type",
832
"display": "Procedures"
833
}
834
]
835
},
836
"location": {
837
"reference": "Location/RedoxLocationExampleRoom"
838
},
839
"note": [
840
{
841
"authorReference": {
842
"reference": "Practitioner/RedoxPractitionerExamplePat"
843
},
844
"text": "A comment."
845
}
846
],
847
"performer": [
848
{
849
"actor": {
850
"reference": "Practitioner/RedoxPractitionerExamplePat"
851
},
852
"function": {
853
"coding": [
854
{
855
"code": "41904004",
856
"system": "http://snomed.info/sct",
857
"display": "Medical X-ray technician"
858
}
859
]
860
}
861
}
862
]
863
}
864
},
865
{
866
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation/RedoxSocialHistoryObservationExample",
867
"resource": {
868
"resourceType": "Observation",
869
"id": "RedoxSocialHistoryObservationExample",
870
"category": [
871
{
872
"coding": [
873
{
874
"code": "social-history",
875
"system": "http://terminology.hl7.org/CodeSystem/observation-category"
876
}
877
]
878
}
879
],
880
"identifier": [
881
{
882
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
883
"value": "3059131578"
884
}
885
],
886
"subject": {
887
"reference": "Patient/RedoxPatientExampleTimothy"
888
},
889
"encounter": {
890
"reference": "Encounter/RedoxEncounterExample"
891
},
892
"status": "final",
893
"code": {
894
"coding": [
895
{
896
"code": "160573003",
897
"system": "http://snomed.info/sct",
898
"display": "Alcohol Consumption"
899
}
900
]
901
},
902
"effectivePeriod": {
903
"start": "1990-05-01T04:00:00.000Z"
904
},
905
"valueString": "None"
906
}
907
},
908
{
909
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Observation/RedoxWeightObservationExample",
910
"resource": {
911
"resourceType": "Observation",
912
"id": "RedoxWeightObservationExample",
913
"category": [
914
{
915
"coding": [
916
{
917
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
918
"code": "vital-signs",
919
"display": "Vital Signs"
920
}
921
],
922
"text": "vital-signs"
923
}
924
],
925
"identifier": [
926
{
927
"system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
928
"value": "1438629037"
929
}
930
],
931
"subject": {
932
"reference": "Patient/RedoxPatientExampleTimothy"
933
},
934
"status": "final",
935
"code": {
936
"coding": [
937
{
938
"code": "3141-9",
939
"system": "http://loinc.org"
940
}
941
],
942
"text": "Patient Body Weight - Measured"
943
},
944
"effectiveDateTime": "1999-11-14T00:00:00.000Z",
945
"valueQuantity": {
946
"value": 86,
947
"unit": "kg"
948
},
949
"interpretation": [
950
{
951
"coding": [
952
{
953
"code": "N",
954
"system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
955
"display": "Normal"
956
}
957
]
958
}
959
],
960
"note": [
961
{
962
"text": "Body weight measurement performed"
963
}
964
],
965
"performer": [
966
{
967
"reference": "Practitioner/RedoxPractitionerExamplePat"
968
}
969
],
970
"referenceRange": [
971
{
972
"low": {
973
"value": 80,
974
"unit": "kg"
975
},
976
"high": {
977
"value": 120,
978
"unit": "kg"
979
},
980
"text": "Body weight range"
981
}
982
]
983
}
984
}
985
],
986
"timestamp": "2021-06-17T20:33:22.422Z"
987
}'

Request Body Schema

    Bundle sent to notify that a patient has shown up and registered, but likely not assigned a location

  • 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, encounter, patient, account

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

        • 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/EncounterRegister
  • 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"