Convert - FHIR (R4) to CDA

This operation converts a FHIR R4 bundle (including one from HL7-to-FHIR or Combine Bundles) into an aggregated CDA document.

Contents

Guides
Endpoint
Input
- Request Headers
Output
Details
- Error Handling
Example

Guides

See the Programming Guide for general principles that apply to all Convert API operations.

Endpoint

POST /convert/v1/fhirr4tocda

Input

The input is a FHIR R4 bundle for a single patient.

Tip
If your FHIR bundle contains multiple FHIR Patient resources (all of which must be from the same person), use the combine FHIR bundles operation prior to the CDA conversion.

Request Headers

Header	Value
`x-api-key`	`YOUR_API_KEY`, obtained from the Developer Portal
`content-type`	`application/fhir+json`
`accept`	`application/xml`

Output

The output is an aggregated C-CDA R2.1 document in XML format.

Details

The following sections provide additional details about the message handling.

Error Handling

If the input data is invalid (such as improperly-formatted FHIR data), the request will return an error response (see Error Handling). 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, the invalid data will be omitted from the finished CDA document.

Example

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

FHIR Bundles and CDA documents 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 FHIR Patient resource:

Sample Input

  "resource": {
    "resourceType": "Patient",
    "id": "35b77437-425d-419c-90b5-af4bc433ebe9",
    "name": [
        {
            "use": "official",
            "family": "Smith",
            "given": [
                "John"
            ]
        }
    ],
    ...
  }

would be converted to a patient node in the CDA XML:

Sample Output

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