Upcoming changes to OperationOutcome for Error ndjson files

[Beneficiary Claims Data API (BCDA) Community]

Hello BCDA community,

The structure of the OperationOutcome resource that BCDA returns is changing!

What's changing?

In the OperationOutcome within .ndjosn error files, the 'details' section will be replaced by a new field called 'diagnostics'.

Why the change?

These changes are being made to align BCDA's use of OperationOutcome with the FHIR specification.

How can I prepare?

This change will be effective in the upcoming BCDA release r218, expected to arrive on Thursday, April 11th. Because the change is only when an error occurs, we don't anticipate major impact to BCDA users or how they interact with the API. If your BCDA client relies on the 'details' field of the OperationOutcome resource, please update the client to reference the 'diagnostics' fields which is a string type.

Below are examples of the OperationOutcome resource before and after the change:

Example OperationOutcome for BCDA in release r218 and greater:
{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "error",
            "code": "not-found",
            "diagnostics": "an error occurred!"
        }
    ]
}

Example OperationOutcome before release r218:
{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "error",
            "code": "not-found",
            "details": {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/ValueSet/operation-outcome",
                        "code": "Blue Button Error",
                        "display": "an error occurred!"
                    }
                ],
                "text": "an error occurred!"
            }
        }
    ]
}

Please reach out here in the Google Group or via bc...@cms.hhs.gov if you have any questions or feedback.

Thanks,
The BCDA Team