Get a proxy access request
Overview
Retrieve a QuestionnaireResponse using its unique access request ID. This endpoint returns the full QuestionnaireResponse document that was previously submitted.
Request Requirements
A valid access request ID must be provided as a path parameter.
Access modes
This endpoint supports the following access modes:
- Patient access
- Healthcare worker access
- Application-restricted access
Sandbox test scenarios
You can test the following scenarios in our sandbox environment:
| Scenario | Request | Response |
|---|---|---|
| Valid access request ID | ID value: 156e1560-e532-4e2a-85ad-5aeff03dc43e | HTTP Status 200 with QuestionnaireResponse |
| Invalid access request ID | ID value: INVALID | HTTP Status 400 with INVALID_IDENTIFIER_VALUE message |
| Missing access request ID | No ID path parameter | HTTP Status 405 with METHOD_NOT_ALLOWED message |
| Non-existent access request ID | ID value: 60d09b82-f4bb-41f9-b41e-767999b4ac9b | HTTP Status 404 with QUESTIONNAIRE_RESPONSE_NOT_FOUND message |
Sandbox constraints
The sandbox environment has the following constraints for this endpoint:
- Request headers are not tested. For example, X-Request-ID and X-Correlation-ID are disregarded.
Path parameters
The unique access request ID of the QuestionnaireResponse to retrieve
Headers
A globally unique identifier (GUID) for the request, which we use to correlate logs through different components. Must be a universally unique identifier (UUID) (ideally version 4). Mirrored back in a response header.
An optional ID which you can use to track transactions across multiple systems. Must be a universally unique identifier (UUID) (ideally version 4). Mirrored back in a response header.
Response
QuestionnaireResponse successfully retrieved.