(g)(9): Application access — all data request

Aidbox supports the §170.315(g)(9) "all data request" capability by providing an API that returns a CCD (C-CDA R2.1) summary record for a requested patient, optionally constrained to a specific date or date range.

The CCD is formatted in accordance with the C-CDA version 2.1 specification and the USCDI v3 data element list.

Standards compliance

Base URL

https://[your-aidbox]

API endpoint

GET /ccda/make-doc

Returns a CCD (C-CDA XML) for the requested patient.

Query parameters:

• pid (string, required): Patient identifier in Aidbox
• docdef-id (string, required): Aidbox document definition identifier. Use continuity-of-care for the predefined CCD definition.
• start-date (string YYYY-MM-DD, optional): start of requested time window
• end-date (string YYYY-MM-DD, optional): end of requested time window
• filename (string, optional): desired filename for the document

Example request:

GET /ccda/make-doc?docdef-id=continuity-of-care&pid=amb1&start-date=2015-06-22&end-date=2015-06-25&filename=amb1.xml
Authorization: Bearer <access_token>

Response:

• 200 OK: CCD as XML
• Content-Type: application/xml

Errors:

• 400 invalid parameters (e.g., invalid date format)
• 404 patient not found

CCD sections included

The predefined continuity-of-care document definition produces a CCD with the following sections:

Sections with no data for the patient are rendered with "entries optional" or omitted per C-CDA R2.1 rules.

Date and date-range requests

When start-date and/or end-date are provided, the API returns patient data associated with the specified date/date range and does not ignore the filter by returning the entire record.

Date parameters must be provided as YYYY-MM-DD.

References

• Aidbox C-CDA / FHIR Converter
• Producing C-CDA Documents
• Supported C-CDA Sections
• USCDI v3
• C-CDA R2.1 Specification