Convert - Combine FHIR Bundles (R4)
POST /convert/v1/combinefhirr4bundles/:patientID
This operation aggregates information retrieved from prior Convert API requests into a single entry.
See the Programming Guide for general principles that apply to all Convert API operations.
Contents
Inputs and Outputs
The input is a newline-delimited JSON list of FHIR R4 Bundles, with each entry a bundle retrieved from the conversion operations.
The combine bundles operation uses ndjson format, so be sure to set
content-type: application/x-ndjson in your request header.
Also, be sure each bundle is on its own line, with no newlines interspersed.
The output is a single FHIR R4 Bundle containing the merged data from the input. OperationOutcomes from the input bundles are not carried forward. The combined bundle will contain a new OperationOutcome resource detailing the results (including warnings or errors) of the conversion process.
Processing Considerations
The following nuances should be considered when using the Combine Bundles API:
Demographic Reconciliation
When there are conflicts in demographic data, the data from the most recent bundle will be chosen. Prior names and addresses may be added as aliases. (TODO: Is that implemented?)
Identifier Propagation
Whenever possible, the system maintains continuity of resource identifiers between the inputs and outputs. This allows traceability from the combined FHIR bundle back to the original records.
Example
Try out the operations, with examples, in the Developer Portal Sandbox.
{"resourceType":"Bundle","type":"searchset","entry":[...]}
{"resourceType":"Bundle","type":"searchset","entry":[...]}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.
{
"resourceType": "Bundle",
"type": "searchset",
"entry": [
{
"resource": {
"resourceType": "Patient",
... (patient fields)
}
},
{
"resource": {
"resourceType": "Encounter",
... (encounter fields)
}
},
...
{
"resource": {
"resourceType": "OperationOutcome",
"issue": [
... (any processing issues)
}
}
]
}