Search
K
< Back

Exporting C-CDAs

The $export-ccda operation allows you to generate and retrieve a Consolidated Clinical Document Architecture (CCDA) file for a patient. The file is built from normalized FHIR resources returned by $p360-retrieve and packaged in a structured XML format suitable for downstream systems or regulatory reporting.

Use Cases

  • Generate a clinical document snapshot of a patient’s aggregated record
  • Support regulatory or quality reporting workflows that require CCDA format
  • Transfer structured records to systems that do not support FHIR

FHIR Version Support

The $export-ccda operation is supported in both R4 and STU3.

  • In R4, the operation commonly follows a synchronous $p360-retrieve, with asynchronous handling available for large datasets or longer processing times.
  • In STU3, the operation typically follows an asynchronous $p360-retrieve because some responses cannot be returned synchronously due to payload size or processing time.

Request Format

Submit a GET request after a successful $p360-retrieve operation:

GET /fhir/[version]/Patient/[id]/$export-ccda

The response includes a FHIR DocumentReference pointing to a CCDA file stored as a Binary resource. The file can be downloaded using the DocumentReference.content.attachment.url.

Behavior

  • Available only after a completed $p360-retrieve
  • Returns a single document representing the patient’s longitudinal record
  • Content reflects deduplicated and normalized data at the time of export
  • Format adheres to standard CCDA specifications, supporting sections such as Problems, Medications, Allergies, and Results
  • Pagination does not apply to $export-ccda. The entire document is returned as a single Binary resource attachment.