Convert - CDA to PDF

POST /convert/v1/cdatopdf

This operation converts a CDA document into a PDF document.

Contents

Inputs and Outputs
- Custom Logo
Error Handling
Data Format
Example

Inputs and Outputs

The input is a single CDA document for a single patient. Supported CDA formats/versions are:

C-CDA R1.1/R2.1
HITSP C32 CDAs

The output is a formatted PDF document suitable for human review.

Custom Logo

To specify a custom logo in the PDF header, set the content type to multipart/form-data and pass the following form fields:

xml file

File containing the XML data for the CDA.

image file

File containing the custom logo image.

Error Handling

If the input data is invalid (such as improperly-formatted XML), the PDF will not be created and a “bad request” response returned.

However, in many cases the Convert service can continue processing even when there are issues with the input data, such as missing fields or unexpected data types. In such cases, invalid data will simply be omitted from the resulting PDF.

Data Format

The input is XML and the output is PDF, so be sure to specify the following request headers:

content-type: application/xml
accept: application/pdf

Example

Try It
Try out the operations, with examples, in the Developer Portal Sandbox.

CDA documents and the formatted PDFs are verbose, so this just shows a small sample to illustrate how the data is structured. For a more complete example, try out the API in the Developer Portal Sandbox.

For example, a patient node in the CDA XML:

Sample Input

  <patient classCode="PSN" determinerCode="INSTANCE">
      <name>
          <given>John</given>
          <family>Smith</family>
      </name>
      ... 
  </patient>

would result in a PDF similar to: