Return Social History Template Option Keys Appearing in all Lower Case to Original Casing

Summary

The GET /v1/{practiceid}/chart/configuration/socialhistory, endpoint allows you to retrieve a list of configured social history templates and questions for a given practice.

Products

athenaClinicals, athenaCommunicator, athenaClinicals for Hospitals & Health Systems

Roles

Management/Technical

Available

October 20, 2022

Highlights

We are making enhancements to remove the case-related discrepancy between the fields returned through the GET call and the fields expected for the PUT call for the keys linked to answer selections for the options field.

Setup

  • N/A

Is this a breaking change

This has a breaking change

Endpoints affected

  • GET /v1/{practiceid}/chart/configuration/socialhistory

New Endpoints

  • N/A

Resources

Refer to the following resources for more information:

What is changing

With this change, the GET call to the /chart/configuration/socialhistory endpoint shall return the options field such that the keys linked to the value selections retain the original case of the answer selections that were configured by athenahealth or the practice admin.

Why we’re making the change

We are making changes to remove the case-related discrepancy between the fields returned through the GET call and the fields expected for the PUT call for the keys linked to answer selections for the options field.  

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

Some users may have created workarounds by manually adjusting the casing of the fields when interacting with either the GET or PUT calls for Social History Templates.
If the workaround helped you in resolving your issue, then you should revert your workaround and re-implement the intended configuration of this API (Refer here: Developer Portal Documentation on Social History) before October 20th. Otherwise, it could conflict with the changes being delivered on October 20th. 
Additionally, if you have persisted any of the social history template option fields into a local database, you will need to update this data to match the case sensitivity of the keys reflected in the API response after this change has rolled out.
Example of what the data looks like before and after the changes:


BEFORE:
{
    "options": [
      { "relatives": "Relatives" },
      { "other": "Other" },
      { "foster parents": "Foster parents" }
    ]
}


AFTER: 

{
    "options": [
      { "Relatives": "Relatives" },
      { "Other": "Other" },
      { "Foster parents": "Foster parents" }
    ]
}

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

N/A

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