Skip to main content

Fetch the consent details

Fetch the details of a consent using the consent artefact ID.

POST/api/hiecm/consent/v3/fetch

By invoking this API, HIUs can retrieve comprehensive information about a specific consent, including its status, scope, and any associated conditions. This functionality is essential for ensuring that HIUs have access to accurate and up-to-date consent information, supporting secure and compliant health information exchange. The API facilitates efficient management and verification of consents, enhancing the overall integrity of the consent management process.

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-HIU-IDstringRequired

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

Body

consentIdstringRequired

The id of the consent artefact that needs to be fetched. Allows alpha numeric character and special characters like "^[a-zA-Z0-9_\\-@,. \":/]{0,255}$"

Responses

401

Unauthorized

Everything returns 401

500

Internal Server Error

Error codes for this module

503

Service Unavailable

Error codes for this module