CCDA Record

The Consolidated Clinical Document Architecture (CCDA) is an ANSI-certified standard from HL7 and is required for Meaningful Use Stage 3 certification. A CCDA document uses a specific syntax and framework as specified by HL7. It can contain numerous types of clinical contents and is in XML format (although it can contain a non-XML body as well). This feature will allow the user to view or update CCDA documents of a specific patient.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Retrieve CCDA document

GET
/v1/{practiceid}/ccda/{patientid}/ccdaexport
Retrieve CCDA document for specific patient and chart
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
version string version USCDI/MU3
chartsharinggroupid integer CHARTSHARING GROUP ID.
startdate string Start date for filtering results within a specific time period. Only for DataPortability document. Example: startdate=2013-01-01T00:00:00
encounterid integer Encounter ID.
enterpriseid integer ENTERPRISE ID.
documentid integer Document ID.
enddate string End date for filtering results within a specific time period. Only for DataPortability document. Example: enddate=2014-01-01T00:00:00
departmentid integer Department ID.
documenttype string Valid types are DataPortability, ReferralNote, CarePlan, DischargeSummary, and CCD.
inpatient boolean Inpatient or ambulatory
THIRDPARTYUSERNAME string User name of the patient in the third party application.
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all
document string CCDA XML text
message string Potential error condition or blank if none
Example Code

Update patient's CCDA record

PUT
/v1/{practiceid}/patients/{patientid}/ccda
Modifies CCDA document for specific patient and chart
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

Output Parameters

Expand all
error array The error messages, if any. This field is an array of errors.
success string Flag that represents if the call was successful.
Example Code

Get patient's CCDA record

GET
/v1/{practiceid}/patients/{patientid}/ccda
Retrieves CCDA document for specific patient and chart
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
patientid integer patientid
format string There are two subtly different standards for the Transition of Care Ambulatory Summary -- A referral summary (called ambulatory summary here) and a data portability document. They contain the same data, but may have slightly different attributes. For backwards compatibility reasons, we allow both for ambulatory practices. For inpatient practices, this parameter is ignored and only the data portability format is used. In the future, both inpatient and ambulatory will use the data portability format by default. Currently, ambulatory summary is the default for ambulatory settings, but that will switch to data portability in the future, and eventually the ambulatory summary format will be removed, along with this parameter. Also, only with this parameter set to data portability can the startdate and enddate parameters be accepted.
enddate string For date filterable items, exclude data after this datetime. Format is MM/DD/YYYY HH24:MM:SS.
xmloutput boolean If set to true, use XML (not JSON) as output. Not needed if an Accept header with application/xml header is included in the request. If set to false, it will return the CCDA format (XML) wrapped in a JSON response.
purpose string The purpose of this request. The sections returned and required patient consent will depend on the purpose. For now we will only support 'internal', which means it's being requested on behalf of the practice.
departmentid integer The department from which to retrieve the patient's chart.
startdate string For date filterable items, exclude data before this datetime. Format is MM/DD/YYYY HH24:MM:SS.
THIRDPARTYUSERNAME string User name of the patient in the third party application.
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all
ccda string
Example Code