Skip to main content

Check the status of reports

Check the status of reports. If the notification is not get from HIP then this API will help to check the status on HIU side.

POST/api/hiecm/scan-gateway/v3/patient/scan-pay/order-status

<ol type='1'> <li> <b>Header</b> <ol type='a'> <br/> <li>Authorisation will be provided by the gateway session API after the successful verification of client ID and Secret [ Example: Bearer <TOKEN> ]</li><li>X-AUTH-TOKEN JWT Authentication token which was issued by ABDM after successful validation of user[ Example: Bearer <TOKEN> ]</li><li>REQUEST-ID unique UUID[ Example: 18235d89-cb13-479d-ad71-7a57d5f669a8 ]</li> <li>TIMESTAMP actual time of the requested was initiated[ Example: 2022-10-06T10:10:00.587Z ]</li> <li>X-CM-ID consent manager ID[ Example: sbx ]</li> <li>X-HIU-ID [ EXample: HIU_ID]</li></ol> </li> <br/> <li> <b>Request Body</b> <ol type='a'><br/> <li> queryStatus which contains the orderNumber and requestId[ Example: { orderNumber: 39413413 abhaAddress: <ABHA_ADDRESS> openOrderRequestId: 059fcb69-8ad8-***-a049-62db16c7b5a0 } ] </li> </ol> </ol>

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired

Unique UUID for track the end to end request transaction

TIMESTAMPstringRequired

Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds.

X-CM-IDstringRequired

Suffix of the consent manager to which the request was intended

X-AUTH-TOKENstringRequired

JWT Authentication token which was issued by ABDM after successful validation of username and password

X-HIU-IDstringRequired

Identifier of the health information user to which the request was intended

Body

queryStatusobjectRequired

The queryStatus is used to check the status of a specific order and its associated patient-share request.

queryStatus.orderNumberstringRequired

A unique identifier for the order. This helps in tracking and referencing the specific order associated with the query.

queryStatus.abhaAddressstringRequired

abha address of the user/patient.

queryStatus.openOrderRequestIdstringRequired

The request id is generated from the /share/Open Order Request id

Responses

202

Accepted

The callback never arrives

400

Bad Request

Error codes for this module

401

Unauthorized

Everything returns 401

403

Forbidden

Error codes for this module

404

Not Found

Error codes for this module

429

Too Many Requests

Error codes for this module

500

Internal Server Error

Error codes for this module

503

Service Unavailable

Error codes for this module