12.1 Bi-weekly Release: Updated Endpoints: DocumentReference.identifier will be the same as DocumentReference.id

Summary

There was a bug noted with DocumentReference.identifier where the identifier may be the same for documents of a different type. To resolve this, we are setting the DocumentReference.identifier to be the same as the DocumentReference.id. 

Products

athenaClinicals, athenaClinicals for Hospitals & Health Systems

Roles

Management/Technical

Available

December 1, 2022 (Preview)

January 27, 2023 (GA)

Highlights

DocumentReference.identifier will be the same as the DocumentReference.id. 

Setup

  • N/A

Is this a breaking change

Yes, this is a breaking change

Endpoints affected

  • GET/fhir/r4/DocumentReference/{logicalId}
  • GET/fhir/r4/ DocumentReference
  • POST/fhir/r4/ DocumentReference /_search

New Endpoints

  • N/A

Resources

Refer to the following resources for more information:

What is changing

We will be resolving a bug with DocumentReference.identifier where the identifier may be the same for documents of a different type. To resolve this, we are setting the DocumentReference.identifier to be the same as the DocumentReference.id.  

Why we’re making the change

We’re making this change due to a bug with DocumentReference.identifier where the identifier may be the same for documents of a different type.  

What will current users of the endpoint need to update in their code

Users of the endpoints must update their code to expect the DocumentReference.identifier to be the same as the DocumentReference.id.  

What will happen if users of the endpoint do not update their code

If the code is not updated, and the user is expecting the DocumentReference.identifier in the existing format, their integration may break.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

On this Page