Skip to content

Commit f091335

Browse files
committed
NPA-4749 Allow GET Consent Patient Identifier Input
1 parent 95f5954 commit f091335

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

specification/validated-relationships-service-api.yaml

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -474,6 +474,7 @@ paths:
474474
parameters:
475475
- $ref: "#/components/parameters/BearerAuthorization"
476476
- $ref: "#/components/parameters/ConsentBundlePerformerIdentifier"
477+
- $ref: "#/components/parameters/ConsentBundlePatientIdentifier"
477478
- $ref: "#/components/parameters/ConsentStatus"
478479
- $ref: "#/components/parameters/ConsentBundleIncludes"
479480
- $ref: "#/components/parameters/RequestID"
@@ -520,7 +521,7 @@ paths:
520521
| ----------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
521522
| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |
522523
| 400 | `INVALID_VALUE` | Invalid header. For details, see the `diagnostics` field. |
523-
| 400 | `MISSING_IDENTIFIER_VALUE` | Missing performer NHS number. |
524+
| 400 | `MISSING_IDENTIFIER_VALUE` | Missing NHS number. |
524525
| 400 | `NOT_SUPPORTED` | The request is not currently supported. |
525526
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
526527
| 403 | `FORBIDDEN` | Access denied to resource. |
@@ -529,7 +530,7 @@ paths:
529530
| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |
530531
| 408 | `TIMEOUT` | Request timed out. |
531532
| 422 | `INVALID_IDENTIFIER_SYSTEM` | Invalid identifier system. |
532-
| 422 | `INVALID_IDENTIFIER_VALUE` | Malformed performer NHS number. |
533+
| 422 | `INVALID_IDENTIFIER_VALUE` | Malformed NHS number. |
533534
| 422 | `INVALID_PARAMETER` | Invalid parameter. For details, see the `diagnostics` field. |
534535
| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |
535536
@@ -2331,8 +2332,25 @@ components:
23312332
in: query
23322333
name: performer:identifier
23332334
description: |
2334-
The performer's (Proxy) NHS number. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).
2335-
required: true
2335+
The performer's (Proxy) NHS number. One of `performer:identifier` or `patient:identifier` is required. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).
2336+
required: false
2337+
schema:
2338+
type: string
2339+
format: token
2340+
examples:
2341+
withoutSystem:
2342+
value: 9000000017
2343+
summary: NHS number specified without system
2344+
withSystem:
2345+
value: https://fhir.nhs.uk/Id/nhs-number|9000000017
2346+
summary: System and NHS number specified
2347+
2348+
ConsentBundlePatientIdentifier:
2349+
in: query
2350+
name: patient:identifier
2351+
description: |
2352+
The patient's NHS number. One of `performer:identifier` or `patient:identifier` is required. For more information on FHIR tokens in general, [see here](https://build.fhir.org/search.html#token).
2353+
required: false
23362354
schema:
23372355
type: string
23382356
format: token

0 commit comments

Comments
 (0)