scan_and_share

onpatientshare

Callback the gateway sends after a profile share at a facility, acknowledging the share request.

POST/api/hiecm/patient-share/v3/on-share

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Body

acknowledgementobjectRequired

acknowledgement.statusstringRequired

acknowledgement.abhaAddressstringRequired

acknowledgement.profileobjectRequired

acknowledgement.profile.contextstringRequired

acknowledgement.profile.tokenNumberstringRequired

acknowledgement.profile.expirystringRequired

responseobjectRequired

response.requestIdstringRequired

Responses

400

Example values, scrubbed.

Error codes for this module

500

Example values, scrubbed.

Error codes for this module

onpatientshare

curl --request POST \
  --url https://phrsbx.abdm.gov.in/api/hiecm/patient-share/v3/on-share \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'Content-Type: application/json' \
  --data '{
  "acknowledgement": {
    "status": "SUCCESS",
    "abhaAddress": "<ABHA_ADDRESS>",
    "profile": {
      "context": "5",
      "tokenNumber": "<TOKENNUMBER>",
      "expiry": "1800"
    }
  },
  "response": {
    "requestId": "<TXN_ID>"
  }
}'

{
  "error": {
    "code": "ABDM-1015",
    "message": "Request Timed out"
  }
}

Generated from the schema. The values are placeholders, not a captured response.