Sign in

v1

latestOpenAPI 3.0.02026-07-14732267.9 KB

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:

ScenarioRequestResponse
Valid access request IDID value: 156e1560-e532-4e2a-85ad-5aeff03dc43eHTTP Status 200 with QuestionnaireResponse
Invalid access request IDID value: INVALIDHTTP Status 400 with INVALID_IDENTIFIER_VALUE message
Missing access request IDNo ID path parameterHTTP Status 405 with METHOD_NOT_ALLOWED message
Non-existent access request IDID value: 60d09b82-f4bb-41f9-b41e-767999b4ac9bHTTP 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.
get/QuestionnaireResponse/{id}

Path parameters

idstring uuid required
Example:156e1560-e532-4e2a-85ad-5aeff03dc43e

The unique access request ID of the QuestionnaireResponse to retrieve

Headers

Authorizationstring ^Bearer\ [[:ascii:]]+$ required
Example:Bearer g1112R_ccQ1Ebbb4gtHBP1aaaNM

An OAuth 2.0 bearer token.

X-Request-IDstring uuid required
Example:60E0B220-8136-4CA5-AE46-1D97EF59D068

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.

X-Correlation-IDstring uuid
Example:11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA

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.