Terminology - Standardize FHIR Bundle (R4)

This operation standardizes and enhances a single FHIR R4 bundle into a consistent format suitable for downstream processing.

Guides

See Understanding Uplift for details about what “standardizing” a FHIR bundle means.

Endpoint

POST /terminology/v1/standardize/fhir/r4

Input

The input is FHIR R4 Bundle for a single patient.

Request Headers

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

Output

The output is a FHIR R4 Bundle containing the data parsed from the input, along with an OperationOutcome resource detailing the results (including warnings or errors) of the conversion process.

Example

Try It
Try out the operations, with examples, in the Developer Portal Sandbox.
Sample Input
{
  "resource": {
    "resourceType": "Patient",
    "id": "35b77437-425d-419c-90b5-af4bc433ebe9",
    "name": [
        {
            "use": "official",
            "family": "Smith",
            "given": [
                "John"
            ]
        }
    ],
    ...
  }

FHIR Bundles are verbose, so the output below 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, or refer to the FHIR Specification.

Sample Output
{
  "resourceType": "Bundle",
  "type": "searchset",
  "entry": [
    {
      "resource": {
        "resourceType": "Patient",
        ... (patient fields)
      }
    },
    {
      "resource": {
        "resourceType": "Encounter",
        ... (encounter fields)
      }
    },
    ...
    {
      "resource": {
        "resourceType": "OperationOutcome",
        "issue": [
          ... (any processing issues)
      }
    }
  ]
}