v1

latestOpenAPI 3.0.02026-07-144898115.8 KB
profile
cm facing

Share patient profile details

Request for sharing patient's profile details to HIP

post/v0.5/patients/profile/share

Headers

Authorizationstring required

Access token which was issued after successful login with gateway auth server.

X-HIP-IDstring required

Identifier of the health information provider to which the request was intended.

Request body

requestIdstring uuid required

a nonce, unique for each HTTP request.

timestampstring date-time required

Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

Example request

{
  "patient": {
    "hipCode": "12345 (CounterId)",
    "userDemographics": {
      "healthId": "<username>@<suffix>",
      "healthIdNumber": "1111-1111-1111-11",
      "identifiers": [
        {
          "value": "+919800083232"
        }
      ],
      "name": "Jane Doe",
      "yearOfBirth": 2000
    }
  },
  "requestId": "499a5a4a-7dda-4f20-9b67-e24589627061"
}

Response

Request accepted