[Sandbox Deployment] Minor changes in the Share Profile API contract

mdubey · February 23, 2021, 2:54pm

Hello Everyone,

There have been minor changes to Share Profile API(/v0.5/patients/profile/share).

The field patient has been renamed to profile
The field userDemographics has been renamed to patient.

This is to keep it consistent with our other APIs where we pass patient profile details(e.g. auth/on-confirm). We wanted to make these changes before we go for a production deployment.

Current API, (Reflected in the sandbox website documentation as well)

{
  "requestId": "499a5a4a-7dda-4f20-9b67-e24589627061",
  "timestamp": "2021-02-22T05:49:04.382Z",
  "patient": {
    "hipCode": "12345 (CounterId)",
    "userDemographics": <USER-PROFILE>
}

New API

{
  "requestId": "499a5a4a-7dda-4f20-9b67-e24589627061",
  "timestamp": "2021-02-22T05:49:04.382Z",
  "profile": {
    "hipCode": "12345 (CounterId)",
    "patient": <USER-PROFILE>
}

Please make necessary changes and test this. Also we have updated the sandbox website with the steps of How to test this API from an HIP side. Please find the updates in section 5 on this page.

Thank you.