NHnhs

New Access request

Overview

For any new access request, the necessary details should be collected from a user facing service e.g. Proxy Access Service and submitted as a QuestionnaireResponse.

Access modes

This endpoint supports the following access modes:

  • Patient access

Sandbox test scenarios:

You can test the following scenarios in our sandbox environment:

ScenarioRequestResponse
Successful requestValid request with performer identifier value of 9000000009 or 9000000017HTTP Status 200 Success response
Duplicate proxy roleRequest for proxy role that already exists, with performer identifier value of 9000000049HTTP Status 409 and DUPLICATE error response

Sandbox constraints

The sandbox environment has the following constraints for this endpoint:

  • QuestionnaireResponse is not validated.
  • Request headers are not tested. X-Request-ID and X-Correlation-ID are disregarded.
  • No access request is created.
post/QuestionnaireResponse

Request

  • Base URL
    https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4
  • URL
    https://sandbox.api.service.nhs.uk/validated-relationships/FHIR/R4/QuestionnaireResponse
  • Auth
    none declared. Required headers: Authorization, X-Request-ID

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.

Request body

resourceType'QuestionnaireResponse'

The FHIR resource type

status'completed' required

The position of the questionnaire response within its overall lifecycle.

authoredstring date-time required

The date time that this set of answers were last changed.

questionnairestring required

The Questionnaire that defines and organizes the questions for which answers are being provided.

Response

Request was received successfully for processing

resourceTypestring

FHIR Resource Type.

Changes

No recorded changes to this operation across all 1 revision of this API.