Composition $convert

post/Composition/$convert
Page View

This resource can be used to convert Clinical Document Architecture (CDA) data to FHIR®. It contains the original CDA data, which is returned as a FHIR® bundle.   

You can only convert CDA data with this resource type.

$convert

Populate CDA entries for translation to FHIR®.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Composition/$convert' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/fhir+json' \
5
--data '{
6
"resourceType": "Bundle",
7
"id": "RedoxCDAExampleBundle",
8
"meta": {
9
"security": [
10
{
11
"code": "N",
12
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
13
"display": "Normal"
14
}
15
]
16
},
17
"type": "document",
18
"entry": [
19
{
20
"resource": {
21
"resourceType": "Composition",
22
"id": "RedoxCDAExampleComposition",
23
"section": [
24
{
25
"code": {
26
"coding": [
27
{
28
"code": "46241-6",
29
"system": "http://loinc.org"
30
},
31
{
32
"code": "42347-5",
33
"system": "http://loinc.org"
34
}
35
],
36
"text": "Admission Diagnosis"
37
},
38
"title": "AdmissionDiagnosis",
39
"text": {
40
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Displacement of lumbar intervertebral disc without myelopathy</div>",
41
"_status": {
42
"extension": [
43
{
44
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
45
"valueCode": "unsupported"
46
}
47
]
48
}
49
},
50
"entry": [
51
{
52
"reference": "Condition/RedoxDiagnosisConditionExampleDiagnosis"
53
}
54
]
55
},
56
{
57
"code": {
58
"coding": [
59
{
60
"code": "42348-3",
61
"system": "http://loinc.org"
62
}
63
]
64
},
65
"title": "AdvanceDirectives",
66
"text": {
67
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">DNR</div>",
68
"_status": {
69
"extension": [
70
{
71
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
72
"valueCode": "unsupported"
73
}
74
]
75
}
76
},
77
"entry": [
78
{
79
"reference": "Consent/RedoxAdvanceDirectiveConsentExample"
80
}
81
]
82
},
83
{
84
"code": {
85
"coding": [
86
{
87
"code": "48765-2",
88
"system": "http://loinc.org"
89
}
90
]
91
},
92
"title": "Allergies",
93
"text": {
94
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Codeine</div>",
95
"_status": {
96
"extension": [
97
{
98
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
99
"valueCode": "unsupported"
100
}
101
]
102
}
103
},
104
"entry": [
105
{
106
"reference": "AllergyIntolerance/AllergyExample"
107
}
108
]
109
},
110
{
111
"code": {
112
"coding": [
113
{
114
"code": "51848-0",
115
"system": "http://loinc.org"
116
}
117
]
118
},
119
"title": "Assessment",
120
"text": {
121
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Displacement of lumbar intervertebral disc without myelopathy</div>",
122
"_status": {
123
"extension": [
124
{
125
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
126
"valueCode": "unsupported"
127
}
128
]
129
}
130
},
131
"entry": [
132
{
133
"reference": "Condition/RedoxDiagnosisConditionExampleDiagnosis"
134
}
135
]
136
},
137
{
138
"code": {
139
"coding": [
140
{
141
"code": "85847-2",
142
"system": "http://loinc.org"
143
}
144
]
145
},
146
"title": "CareTeam",
147
"text": {
148
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
149
"_status": {
150
"extension": [
151
{
152
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
153
"valueCode": "unsupported"
154
}
155
]
156
}
157
},
158
"entry": [
159
{
160
"reference": "CareTeam/RedoxCareTeamExample"
161
}
162
]
163
},
164
{
165
"code": {
166
"coding": [
167
{
168
"code": "10154-3",
169
"system": "http://loinc.org"
170
}
171
]
172
},
173
"title": "ChiefComplaint",
174
"text": {
175
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Dark stools</div>",
176
"_status": {
177
"extension": [
178
{
179
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
180
"valueCode": "unsupported"
181
}
182
]
183
}
184
}
185
},
186
{
187
"code": {
188
"coding": [
189
{
190
"code": "11535-2",
191
"system": "http://loinc.org"
192
},
193
{
194
"code": "78375-3",
195
"system": "http://loinc.org"
196
}
197
],
198
"text": "Discharge Diagnosis"
199
},
200
"title": "DischargeDiagnosis",
201
"text": {
202
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
203
"_status": {
204
"extension": [
205
{
206
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
207
"valueCode": "unsupported"
208
}
209
]
210
}
211
},
212
"entry": [
213
{
214
"reference": "Condition/RedoxDiagnosisConditionExampleDiagnosis"
215
}
216
]
217
},
218
{
219
"code": {
220
"coding": [
221
{
222
"code": "10183-2",
223
"system": "http://loinc.org"
224
},
225
{
226
"code": "75311-1",
227
"system": "http://loinc.org"
228
}
229
],
230
"text": "Discharge Medications"
231
},
232
"title": "DischargeMedications",
233
"text": {
234
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
235
"_status": {
236
"extension": [
237
{
238
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
239
"valueCode": "unsupported"
240
}
241
]
242
}
243
},
244
"entry": [
245
{
246
"reference": "MedicationRequest/RedoxClinicalSummaryMedicationRequestExample"
247
}
248
]
249
},
250
{
251
"code": {
252
"coding": [
253
{
254
"code": "46240-8",
255
"system": "http://loinc.org"
256
}
257
]
258
},
259
"title": "Encounters",
260
"text": {
261
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Inpatient admission on 2/6/22</div>",
262
"_status": {
263
"extension": [
264
{
265
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
266
"valueCode": "unsupported"
267
}
268
]
269
}
270
},
271
"entry": [
272
{
273
"reference": "Encounter/RedoxEncounterExample"
274
}
275
]
276
},
277
{
278
"code": {
279
"coding": [
280
{
281
"code": "10157-6",
282
"system": "http://loinc.org"
283
}
284
]
285
},
286
"title": "FamilyHistory",
287
"text": {
288
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Father died of Myocardial infarction at age 57</div>",
289
"_status": {
290
"extension": [
291
{
292
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
293
"valueCode": "unsupported"
294
}
295
]
296
}
297
},
298
"entry": [
299
{
300
"reference": "FamilyMemberHistory/RedoxFamilyMemberHistoryExample"
301
}
302
]
303
},
304
{
305
"code": {
306
"coding": [
307
{
308
"code": "47420-5",
309
"system": "http://loinc.org"
310
}
311
]
312
},
313
"title": "Functional Status",
314
"text": {
315
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
316
"_status": {
317
"extension": [
318
{
319
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
320
"valueCode": "unsupported"
321
}
322
]
323
}
324
},
325
"entry": [
326
{
327
"reference": "Observation/RedoxFunctionalStatusObservationExampleWalkingStick"
328
},
329
{
330
"reference": "Observation/RedoxFunctionalStatusObservationExampleDressing"
331
},
332
{
333
"reference": "Observation/RedoxFunctionalStatusObservationExampleTransferring"
334
},
335
{
336
"reference": "Observation/RedoxFunctionalStatusObservationExampleHearing"
337
},
338
{
339
"reference": "SupplyRequest/RedoxSupplyRequestExampleFunctionalStatusSupply"
340
}
341
]
342
},
343
{
344
"code": {
345
"coding": [
346
{
347
"code": "61146-7",
348
"system": "http://loinc.org"
349
}
350
]
351
},
352
"title": "Goals",
353
"text": {
354
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Oxygen saturation at 92%</div>",
355
"_status": {
356
"extension": [
357
{
358
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
359
"valueCode": "unsupported"
360
}
361
]
362
}
363
},
364
"entry": [
365
{
366
"reference": "Goal/RedoxGoalExample"
367
}
368
]
369
},
370
{
371
"code": {
372
"coding": [
373
{
374
"code": "75310-3",
375
"system": "http://loinc.org"
376
}
377
]
378
},
379
"title": "HealthConcerns",
380
"text": {
381
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Community acquired Pneumonia</div>",
382
"_status": {
383
"extension": [
384
{
385
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
386
"valueCode": "unsupported"
387
}
388
]
389
}
390
},
391
"entry": [
392
{
393
"reference": "Condition/RedoxHealthConcernConditionExample"
394
}
395
]
396
},
397
{
398
"code": {
399
"coding": [
400
{
401
"code": "10164-2",
402
"system": "http://loinc.org"
403
}
404
]
405
},
406
"title": "HistoryOfPresentIllness",
407
"text": {
408
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
409
"_status": {
410
"extension": [
411
{
412
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
413
"valueCode": "unsupported"
414
}
415
]
416
}
417
}
418
},
419
{
420
"code": {
421
"coding": [
422
{
423
"code": "11369-6",
424
"system": "http://loinc.org"
425
}
426
]
427
},
428
"title": "Immunizations",
429
"text": {
430
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Influenza on 2/7/22</div>",
431
"_status": {
432
"extension": [
433
{
434
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
435
"valueCode": "unsupported"
436
}
437
]
438
}
439
},
440
"entry": [
441
{
442
"reference": "Immunization/RedoxImmunizationExampleMinimumCompleted"
443
}
444
]
445
},
446
{
447
"code": {
448
"coding": [
449
{
450
"code": "69730-0",
451
"system": "http://loinc.org"
452
}
453
]
454
},
455
"title": "Instructions",
456
"text": {
457
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\"><div>Pat Granite., MD PHD - 10/21/2014 8:07 PM PST</div><div>CONSENT: Procedure for today, its potential benefits as well as its risks and potential side effects were reviewed...</div></div>",
458
"_status": {
459
"extension": [
460
{
461
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
462
"valueCode": "unsupported"
463
}
464
]
465
}
466
}
467
},
468
{
469
"code": {
470
"coding": [
471
{
472
"code": "48768-6",
473
"system": "http://loinc.org"
474
}
475
]
476
},
477
"title": "Insurances",
478
"text": {
479
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">Accelerator Labs<br/>HMO Deductible Plan<br/>Group Number: 847025-024-0009</div>",
480
"_status": {
481
"extension": [
482
{
483
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
484
"valueCode": "unsupported"
485
}
486
]
487
}
488
},
489
"entry": [
490
{
491
"reference": "Coverage/RedoxCoverageExample"
492
}
493
]
494
},
495
{
496
"code": {
497
"coding": [
498
{
499
"code": "62387-6",
500
"system": "http://loinc.org"
501
}
502
]
503
},
504
"title": "Interventions",
505
"text": {
506
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
507
"_status": {
508
"extension": [
509
{
510
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
511
"valueCode": "unsupported"
512
}
513
]
514
}
515
}
516
},
517
{
518
"code": {
519
"coding": [
520
{
521
"code": "46264-8",
522
"system": "http://loinc.org"
523
}
524
]
525
},
526
"title": "MedicalEquipment",
527
"text": {
528
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
529
"_status": {
530
"extension": [
531
{
532
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
533
"valueCode": "unsupported"
534
}
535
]
536
}
537
},
538
"entry": [
539
{
540
"reference": "DeviceRequest/RedoxDeviceRequestExample"
541
}
542
]
543
},
544
{
545
"code": {
546
"coding": [
547
{
548
"code": "10160-0",
549
"system": "http://loinc.org"
550
}
551
]
552
},
553
"title": "Medications",
554
"text": {
555
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
556
"_status": {
557
"extension": [
558
{
559
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
560
"valueCode": "unsupported"
561
}
562
]
563
}
564
},
565
"entry": [
566
{
567
"reference": "MedicationStatement/RedoxMedicationStatementExample"
568
},
569
{
570
"reference": "MedicationRequest/RedoxClinicalSummaryMedicationRequestExample"
571
}
572
]
573
},
574
{
575
"code": {
576
"coding": [
577
{
578
"code": "29549-3",
579
"system": "http://loinc.org"
580
}
581
]
582
},
583
"title": "MedicationsAdministered",
584
"text": {
585
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
586
"_status": {
587
"extension": [
588
{
589
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
590
"valueCode": "unsupported"
591
}
592
]
593
}
594
},
595
"entry": [
596
{
597
"reference": "MedicationAdministration/RedoxMedicationAdministrationExample"
598
}
599
]
600
},
601
{
602
"code": {
603
"coding": [
604
{
605
"code": "61149-1",
606
"system": "http://loinc.org"
607
}
608
]
609
},
610
"title": "Objective",
611
"text": {
612
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
613
"_status": {
614
"extension": [
615
{
616
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
617
"valueCode": "unsupported"
618
}
619
]
620
}
621
}
622
},
623
{
624
"code": {
625
"coding": [
626
{
627
"code": "29545-1",
628
"system": "http://loinc.org"
629
}
630
]
631
},
632
"title": "PhysicalExam",
633
"text": {
634
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
635
"_status": {
636
"extension": [
637
{
638
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
639
"valueCode": "unsupported"
640
}
641
]
642
}
643
}
644
},
645
{
646
"code": {
647
"coding": [
648
{
649
"code": "18776-5",
650
"system": "http://loinc.org"
651
}
652
]
653
},
654
"title": "Plan of Treatment",
655
"text": {
656
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
657
"_status": {
658
"extension": [
659
{
660
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
661
"valueCode": "unsupported"
662
}
663
]
664
}
665
},
666
"entry": [
667
{
668
"reference": "ServiceRequest/RedoxServiceRequestExamplePlanOfCareOrder"
669
},
670
{
671
"reference": "ServiceRequest/RedoxServiceRequestExamplePlanOfCareProcedure"
672
},
673
{
674
"reference": "ServiceRequest/RedoxServiceRequestExamplePlanOfCareService"
675
},
676
{
677
"reference": "MedicationRequest/RedoxMedicationRequestExamplePlanOfCareMedicationAdministration"
678
},
679
{
680
"reference": "SupplyRequest/RedoxSupplyRequestExample"
681
},
682
{
683
"reference": "Appointment/RedoxAppointmentExample"
684
}
685
]
686
},
687
{
688
"code": {
689
"coding": [
690
{
691
"code": "11450-4",
692
"system": "http://loinc.org"
693
}
694
]
695
},
696
"title": "Problems",
697
"text": {
698
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
699
"_status": {
700
"extension": [
701
{
702
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
703
"valueCode": "unsupported"
704
}
705
]
706
}
707
},
708
"entry": [
709
{
710
"reference": "Condition/RedoxProblemConditionExamplePneumonia"
711
}
712
]
713
},
714
{
715
"code": {
716
"coding": [
717
{
718
"code": "47519-4",
719
"system": "http://loinc.org"
720
}
721
]
722
},
723
"title": "Procedures",
724
"text": {
725
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
726
"_status": {
727
"extension": [
728
{
729
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
730
"valueCode": "unsupported"
731
}
732
]
733
}
734
},
735
"entry": [
736
{
737
"reference": "Procedure/RedoxProcedureExampleMinimumCompleted"
738
}
739
]
740
},
741
{
742
"code": {
743
"coding": [
744
{
745
"code": "42349-1",
746
"system": "http://loinc.org"
747
}
748
]
749
},
750
"title": "ReasonForReferral",
751
"text": {
752
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
753
"_status": {
754
"extension": [
755
{
756
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
757
"valueCode": "unsupported"
758
}
759
]
760
}
761
}
762
},
763
{
764
"code": {
765
"coding": [
766
{
767
"code": "29299-5",
768
"system": "http://loinc.org"
769
}
770
]
771
},
772
"title": "ReasonForVisit",
773
"text": {
774
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
775
"_status": {
776
"extension": [
777
{
778
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
779
"valueCode": "unsupported"
780
}
781
]
782
}
783
},
784
"entry": [
785
{
786
"reference": "Condition/RedoxReasonForVisitConditionExample"
787
}
788
]
789
},
790
{
791
"code": {
792
"coding": [
793
{
794
"code": "11348-0",
795
"system": "http://loinc.org"
796
}
797
]
798
},
799
"title": "ResolvedProblems",
800
"text": {
801
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
802
"_status": {
803
"extension": [
804
{
805
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
806
"valueCode": "unsupported"
807
}
808
]
809
}
810
},
811
"entry": [
812
{
813
"reference": "Condition/RedoxProblemConditionExamplePneumonia"
814
}
815
]
816
},
817
{
818
"code": {
819
"coding": [
820
{
821
"code": "30954-2",
822
"system": "http://loinc.org"
823
}
824
]
825
},
826
"title": "Results",
827
"text": {
828
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
829
"_status": {
830
"extension": [
831
{
832
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
833
"valueCode": "unsupported"
834
}
835
]
836
}
837
},
838
"entry": [
839
{
840
"reference": "DiagnosticReport/RedoxDiagnosticReportExampleCBC"
841
}
842
]
843
},
844
{
845
"code": {
846
"coding": [
847
{
848
"code": "10187-3",
849
"system": "http://loinc.org"
850
}
851
]
852
},
853
"title": "ReviewOfSystems",
854
"text": {
855
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
856
"_status": {
857
"extension": [
858
{
859
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
860
"valueCode": "unsupported"
861
}
862
]
863
}
864
}
865
},
866
{
867
"code": {
868
"coding": [
869
{
870
"code": "29762-2",
871
"system": "http://loinc.org"
872
}
873
]
874
},
875
"title": "Social History",
876
"text": {
877
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
878
"_status": {
879
"extension": [
880
{
881
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
882
"valueCode": "unsupported"
883
}
884
]
885
}
886
},
887
"entry": [
888
{
889
"reference": "Observation/RedoxSocialHistorySmokingStatusObservationExample"
890
},
891
{
892
"reference": "Observation/RedoxSocialHistoryObservationExample"
893
},
894
{
895
"reference": "Observation/RedoxSocialHistoryTobaccoUseObservationExample"
896
}
897
]
898
},
899
{
900
"code": {
901
"coding": [
902
{
903
"code": "61150-9",
904
"system": "http://loinc.org"
905
}
906
]
907
},
908
"title": "Subjective",
909
"text": {
910
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
911
"_status": {
912
"extension": [
913
{
914
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
915
"valueCode": "unsupported"
916
}
917
]
918
}
919
}
920
},
921
{
922
"code": {
923
"coding": [
924
{
925
"code": "8716-3",
926
"system": "http://loinc.org"
927
}
928
]
929
},
930
"title": "VitalSigns",
931
"text": {
932
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml/\">...</div>",
933
"_status": {
934
"extension": [
935
{
936
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
937
"valueCode": "unsupported"
938
}
939
]
940
}
941
},
942
"entry": [
943
{
944
"reference": "Observation/RedoxVitalSignsPanelExample"
945
}
946
]
947
}
948
],
949
"identifier": {
950
"system": "urn:oid:1.2.3.5440",
951
"value": "3335453"
952
},
953
"status": "final",
954
"language": "en",
955
"title": "Community Health and Hospitals: Annual Physical",
956
"date": "2022-02-12T00:00:00.000Z",
957
"type": {
958
"coding": [
959
{
960
"code": "18842-5",
961
"system": "http://loinc.org",
962
"display": "Progress Note"
963
}
964
]
965
},
966
"subject": {
967
"reference": "Patient/RedoxPatientExampleTimothy"
968
},
969
"encounter": {
970
"reference": "Encounter/RedoxEncompassingEncounterExample"
971
},
972
"author": [
973
{
974
"reference": "PractitionerRole/RedoxPractitionerRoleExamplePat"
975
}
976
],
977
"custodian": {
978
"reference": "Organization/RedoxOrganizationManagingExample"
979
},
980
"event": [
981
{
982
"extension": [
983
{
984
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
985
"valueCode": "unsupported"
986
}
987
]
988
}
989
]
990
}
991
},
992
{
993
"resource": {
994
"resourceType": "Patient",
995
"id": "RedoxPatientExampleTimothy",
996
"meta": {
997
"extension": [
998
{
999
"url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
1000
"valueInteger": 1
1001
}
1002
]
1003
},
1004
"extension": [
1005
{
1006
"extension": [
1007
{
1008
"url": "text",
1009
"valueString": "White"
1010
}
1011
],
1012
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
1013
},
1014
{
1015
"extension": [
1016
{
1017
"url": "ombCategory",
1018
"valueCoding": {
1019
"code": "2135-2",
1020
"system": "urn:oid:2.16.840.1.113883.6.238",
1021
"display": "Hispanic or Latino"
1022
}
1023
},
1024
{
1025
"url": "text",
1026
"valueString": "Hispanic"
1027
}
1028
],
1029
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
1030
}
1031
],
1032
"identifier": [
1033
{
1034
"value": "0000000001",
1035
"system": "urn:redox:health-one:MR"
1036
},
1037
{
1038
"value": "101-01-0001",
1039
"system": "http://hl7.org/fhir/sid/us-ssn"
1040
}
1041
],
1042
"name": [
1043
{
1044
"given": [
1045
"Timothy",
1046
"Paul"
1047
],
1048
"family": "Bixby",
1049
"use": "official"
1050
},
1051
{
1052
"text": "Billy",
1053
"use": "usual"
1054
}
1055
],
1056
"gender": "male",
1057
"birthDate": "2008-01-06",
1058
"telecom": [
1059
{
1060
"value": "+18088675301",
1061
"system": "phone",
1062
"use": "home"
1063
},
1064
{
1065
"value": "+18008675309",
1066
"system": "phone",
1067
"use": "work"
1068
},
1069
{
1070
"value": "timothy.bixby@redoxengine.com",
1071
"system": "email"
1072
}
1073
],
1074
"address": [
1075
{
1076
"line": [
1077
"4762 Hickory Street"
1078
],
1079
"city": "Monroe",
1080
"district": "Greene",
1081
"state": "WI",
1082
"postalCode": "53566",
1083
"country": "US",
1084
"use": "home"
1085
}
1086
],
1087
"maritalStatus": {
1088
"coding": [
1089
{
1090
"code": "M",
1091
"system": "http://hl7.org/fhir/v3/MaritalStatus",
1092
"display": "Married"
1093
}
1094
],
1095
"text": "Married"
1096
},
1097
"communication": [
1098
{
1099
"language": {
1100
"coding": [
1101
{
1102
"code": "en",
1103
"system": "urn:ietf:bcp:47"
1104
}
1105
],
1106
"text": "English"
1107
}
1108
}
1109
],
1110
"contact": [
1111
{
1112
"name": {
1113
"given": [
1114
"Barbara"
1115
],
1116
"family": "Bixby"
1117
},
1118
"telecom": [
1119
{
1120
"value": "+18088675303",
1121
"system": "phone",
1122
"use": "home"
1123
},
1124
{
1125
"value": "barbara.bixby@redoxengine.com",
1126
"system": "email"
1127
}
1128
],
1129
"address": {
1130
"line": [
1131
"4762 Hickory St."
1132
],
1133
"city": "Monroe",
1134
"district": "Green",
1135
"state": "WI",
1136
"postalCode": "53566",
1137
"country": "USA"
1138
},
1139
"relationship": [
1140
{
1141
"coding": [
1142
{
1143
"code": "MTH",
1144
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
1145
"display": "mother"
1146
}
1147
],
1148
"text": "Mother"
1149
},
1150
{
1151
"coding": [
1152
{
1153
"code": "C",
1154
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
1155
"display": "Emergency Contact"
1156
}
1157
],
1158
"text": "Emergency Contact"
1159
}
1160
]
1161
}
1162
],
1163
"generalPractitioner": [
1164
{
1165
"reference": "Practitioner/RedoxPractitionerExamplePat"
1166
}
1167
],
1168
"managingOrganization": {
1169
"reference": "Organization/RedoxOrganizationManagingExample"
1170
}
1171
}
1172
}
1173
]
1174
}'

Request Body Schema

    A Document bundle containing a FHIR representation of a CDA document. The first resource, Composition, contains the glue that ties all the other clinical resources together.

  • 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: document
  • entry
    required, Array of Composition, Patient, DocumentReference, AllergyIntolerance, Appointment, CareTeam, Condition, Consent, Coverage, Device, DeviceRequest, DiagnosticReport, Encounter, FamilyMemberHistory, Goals, HealthConcerns, Immunization, Location, MedicationAdministration, MedicationRequest, MedicationStatement, Observation, Organization, Practitioner, PractitionerRole, Procedure, RelatedPerson, ServiceRequest, Specimen, SupplyRequest or Other

    Contains the overall Composition resource and all other resources associated with it

    • resource
      required, object

      The main clinical document from which all bundle resources are referenced

      • resourceType
        required, string

        Identifies the type of the resource

        Value: Composition
      • language
        required, string

        The base language in which the resource is written.

      • identifier
        required, object

        A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

        • system
          string

          Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

        • value
          string

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

      • status
        required, string

        The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

        Possible Values: preliminary, final, amended, entered-in-error
      • type
        required, object

        Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.

        • coding
          Array of object

          A reference to a code defined by a terminology system.

          • 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 language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

      • subject
        required, object

        Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

        Must be a resource of type Patient.

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

      • date
        required, string

        The composition editing time, when the composition was last logically changed by the author.

      • author
        required, Array of object

        Identifies who is responsible for the information in the composition, not necessarily who typed it in.

        Must reference one of the following types of resources:

        • Practitioner
        • PractitionerRole
        • extension
          Array of DataAbsentReason or Other

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            Provides a reason why the expected value or elements in the element that is extended are missing.

            See http://hl7.org/fhir/StructureDefinition/data-absent-reason for more information

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

            Value: http://hl7.org/fhir/StructureDefinition/data-absent-reason
          • valueCode
            required, string

            The reason a required field is missing

            Possible Values: unknown, asked-unknown, temp-unknown, not-asked, asked-declined, masked, not-applicable, unsupported, as-text, error, not-a-number, negative-infinity, positive-infinity, not-performed, not-permitted
        • 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.

      • title
        required, string

        Official human-readable label for the composition.

      • custodian
        required, object

        Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

        Must be a resource of type Organization.

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

      • event
        required, Array of object

        event is unsupported, but required by FHIR.

        • extension
          Array of object

          Identifies this field as unsupported

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

            Value: http://hl7.org/fhir/StructureDefinition/data-absent-reason
          • valueCode
            required, string

            The reason a required field is missing

            Value: unsupported
      • section
        required, Array of AdmissionDiagnosis, AdvanceDirectives, Allergies, Assessment, CareTeam, ChiefComplaint, DischargeDiagnosis, DischargeMedications, Encounters, FamilyHistory, FunctionalStatus, Goals, HealthConcerns, HistoryOfPresentIllness, Immunizations, Instructions, Insurances, Interventions, MedicalEquipment, MedicalHistory, Medications, MedicationsAdministered, Objective, PhysicalExam, PlanOfTreatment, Problems, Procedures, ReasonForReferral, ReasonForVisit, ResolvedProblems, Results, ReviewOfSystems, SocialHistory, Subjective, VitalSigns or Other

        The root of the sections that make up the composition.

        • title
          required, string

          Human-readable name of section, e.g. Admission Diagnosis

        • code
          required, object

          Contains two codes (46241-6 and 42347-5) because C-CDA requires both to identify the section as Admission Diagnosis

          • coding
            required, Array of HospitalAdmissionDx or AdmissionDx

            An array of two discrete codes

            • code
              required, string
              Value: 46241-6
            • system
              required, string
              Value: http://loinc.org
          • text
            required, string
            Value: Admission Diagnosis
        • text
          object

          A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

          • status
            required, string

            The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

            Possible Values: generated, extensions, additional, empty
          • _status
            required, object

            This element contains extensions for status. Depending on the extensions present it could be used in place of status or contain additional information about status. See the extension element for more details on the possible extensions being sent.

            • extension
              Array of DataAbsentReason or Other

              May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                Provides a reason why the expected value or elements in the element that is extended are missing.

                See http://hl7.org/fhir/StructureDefinition/data-absent-reason for more information

              • url
                required, string

                Source of the definition for the extension code - a logical name or a URL.

                Value: http://hl7.org/fhir/StructureDefinition/data-absent-reason
              • valueCode
                required, string

                The reason a required field is missing

                Possible Values: unknown, asked-unknown, temp-unknown, not-asked, asked-declined, masked, not-applicable, unsupported, as-text, error, not-a-number, negative-infinity, positive-infinity, not-performed, not-permitted
          • div
            required, 

            The actual narrative content, a stripped down version of XHTML.

        • entry
          Array of object

          A reference to a discrete resource for the section

          Must be a resource of type Condition.

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

      • id
        string

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • extension
        Array of version_number_extension or Other

        An Extension

      • encounter
        object

        Describes the clinical encounter or type of care this documentation is associated with.

        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.

      • attester
        Array of legal_attester, professional_attester, personal_attester or Other

        A participant who has attested to the accuracy of the composition/document.

        • mode
          required, string

          The type of attestation the authenticator offers.

          Value: legal
        • party
          required, object

          Who attested the composition in the specified way.

          Must reference one of the following types of resources:

          • Patient
          • RelatedPerson
          • Practitioner
          • PractitionerRole
          • Organization
          • 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.

        • time
          string

          When the composition was attested by the party.

      • relatesTo
        Array of relatedCDADocument, originalDocument or Other

        Relationships that this composition has with other compositions or documents that already exist.

        • code
          required, string

          The type of relationship that this composition has with anther composition or document.

          Possible Values: replaces, transforms, signs, appends
        • targetIdentifier
          required, object

          The target composition/document of this relationship.

          Only one of targetIdentifier, targetReference may be present.

          • extension
            Array of Boolean, String, CodeableConcept, Coding, HumanName or Reference

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            • url
              required, string

              Source of the definition for the extension code - a logical name or a URL.

            • valueBoolean
              boolean

              A single value for the extension.

          • use
            string

            The purpose of this identifier.

            Possible Values: usual, official, temp, secondary, old (If known)
          • system
            string

            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

          • value
            string

            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

        • extension
          Array of object

          Additional information about the related document

          • url
            required, string

            Source of the definition for the extension code - a logical name or a URL.

            Value: http://hl7.org/fhir/us/ccda/StructureDefinition/VersionNumber
          • valueInteger
            number

            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

  • id
    string

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

  • meta
    object

    The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

    • security
      Array of object

      To communicate confidentiality, one security element will contain system = http://terminology.hl7.org/CodeSystem/v3-Confidentiality and a code from the following list: N, R, V.

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

Response fields and example

Example
json
1
"Operation Response"