Skip to main content
GET
Retrieve Ccda
Allergies and end_date. When you pass end_date, an allergy added to the chart after that date is excluded from the returned document. However, an allergy’s active/inactive status is not tracked with a point-in-time history: if an allergy was later marked inactive or resolved, the returned document reflects its current status, not necessarily its status as of end_date.
Assessment-to-Plan linking depends on the source visit note’s format. In the returned CCDA, a diagnosis (Assessment) is only linked to its specific plan items (Plan of Treatment) when the underlying visit note uses a format with a combined Assessment/Plan section (Assessplan category) — see Visit Note Formats. For notes using a format with separate Assessment and Plan fields (e.g. SOAP), both the diagnosis and the plan content are present in the document, but without a structural link between them.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
integer
required

The id of the patient to retrieve the CCDA for.

Query Parameters

end_date
string<date>

The end date of the CCDA to retrieve.

sections
string[]

A comma-separated list of sections to include in the CCDA. If not provided, all sections will be included.

start_date
string<date>

The start date of the CCDA to retrieve.

template
enum<string>

The template used to display the desired information on the CCDA

Available options:
generateCCD,
generateCarePlan,
generateProgressNote,
generateReferralNote

Response

200 - application/json
id
integer<int64>
required
base64_ccda
file
read-only