Skip to content

Commit 6710e6a

Browse files
ClarksonAdamClarksonAdam
committed
chore: updated OAS
1 parent 983eb47 commit 6710e6a

File tree

5 files changed

+60
-17
lines changed

5 files changed

+60
-17
lines changed

‎specification/examples/responses/errors/invalid-identifier.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
RelatedPersonInvalidIdentifierError:
2-
summary: Invalid RelatedPerson identifier
3-
description: Error raised due to an invalid RelatedPerson identifier request parameter being specified.
1+
InvalidIdentifierError:
2+
summary: Bad request invalid identifier
3+
description: Error raised due to an invalid identifier request parameter being specified.
44
value:
55
resourceType: "OperationOutcome"
66
issue:

‎specification/examples/responses/errors/invalid-include-parameter.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
ConsentInvalidIncludeParameterBundle:
1+
InvalidIncludeParameterBundle:
22
summary: Bad request include param invalid
33
description: 400 error response bundle for an invalid include parameter
44
value:

‎specification/examples/responses/errors/missing-identifier.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
ConsentIdentifierMissingBundle:
1+
IdentifierMissingBundle:
22
summary: Bad request identifier missing
33
description: 400 error response bundle for a missing identifier
44
value:

‎specification/examples/responses/errors/not-found.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
ConsentNotFoundBundle:
1+
NotFoundBundle:
22
summary: Bad request not found
33
description: 400 error response bundle for record not found
44
value:

‎specification/validated-relationships-service-api.yaml‎

Lines changed: 54 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -355,11 +355,26 @@ paths:
355355
356356
## Sandbox test scenarios
357357
358-
| Scenario | Request | Response |
359-
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
360-
| A single active proxy relationship for two consenting adults with capacity | `performer:identifier`=`9000000010` and `status`=`active` and `_include`=`Consent:performer` | HTTP Status 200 Bundle containing a single active proxy relationship for two consenting adults with capacity |
361-
| Multiple active proxy relationships with varying legal basis' | `performer:identifier`=`9000000017` and `status`=`active` and `_include`=`Consent:performer` | HTTP Status 200 A Bundle containing multiple active proxy relationships with varying legal basis' |
362-
| A single active proxy relationship for a birth mother & child | `performer:identifier`=`9000000019` and `status`=`active` and `_include`=`Consent:performer` | HTTP Status 200 Bundle containing a single active proxy relationship for a birth mother & child |
358+
| Scenario | Request | Response |
359+
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------| ---------------------------------------------------------------------------------------------------------|
360+
| Multiple proxy relationships filtered by 'active' status | `performer:identifier`=`9000000017` and `status`=`active` | HTTP Status 200 Bundle containing a multiple active proxy relationships |
361+
| Multiple proxy relationships filtered by 'inactive' status | `performer:identifier`=`9000000017` and `status`=`inactive` | HTTP Status 200 Bundle containing a multiple inactive proxy relationships |
362+
| Multiple proxy relationships filtered by 'proposed' and 'active' status | `performer:identifier`=`9000000017` and `status`=`proposed,active` | HTTP Status 200 Bundle containing a multiple proposed and active proxy relationships |
363+
| Multiple proxy relationships without filtering and details | `performer:identifier`=`9000000017` | HTTP Status 200 Bundle containing a multiple proxy relationships without details |
364+
| Multiple proxy relationships including performer details | `performer:identifier`=`9000000022` and `_include` = `Consent:performer` | HTTP Status 200 Bundle containing a multiple proxy relationships including performer details |
365+
| Multiple proxy relationships including patient details | `performer:identifier`=`9000000022` and `_include` = `Consent:patient` | HTTP Status 200 Bundle containing a multiple proxy relationships including patient details |
366+
| Multiple proxy relationships including performer and patient details | `performer:identifier`=`9000000022` and `_include` = `Consent:patient,Consent:proxy` | HTTP Status 200 Bundle containing a multiple proxy relationships including performer and patient details |
367+
| No proxy relationships | `performer:identifier`=`9000000025` and `_include` = `Consent:patient,Consent:proxy` and `status` = `active` | HTTP Status 200 empty bundle |
368+
| A single proxy relationship between consenting adults | `performer:identifier`=`9000000010` | HTTP Status 200 Bundle containing a single proxy relationship |
369+
| A single proxy relationship between consenting adults including details | `performer:identifier`=`9000000010` and `_include` = `Consent:patient,Consent:proxy` | HTTP Status 200 Bundle containing a single proxy relationship including performer and patient details |
370+
| A single proxy relationship between a mother and child | `performer:identifier`=`9000000019` | HTTP Status 200 Bundle containing a single proxy relationship |
371+
| A single proxy relationship between a mother and child including details | `performer:identifier`=`9000000019` and `_include` = `Consent:patient,Consent:proxy` | HTTP Status 200 Bundle containing a single proxy relationship including performer and patient details |
372+
| Invalid status parameter | `performer:identifier`=`9000000019` and `status` = `test` | HTTP Status 400 and INVALID_VALUE error response |
373+
| Invalid include parameter | `performer:identifier`=`9000000019` and `_include` = `test` | HTTP Status 400 and INVALID_VALUE error response |
374+
| Missing identifier | `patient:identifier`=`9000000009` | HTTP Status 400 and MISSING_IDENTIFIER_VALUE error response |
375+
| Invalid identifier | `identifier`=`900000000` Note: This identifier is 9 characters long, too short to be NHS Number | HTTP Status 400 and INVALID_IDENTIFIER_VALUE error response |
376+
| Invalid identifier system | `identifier`=`https://fhir.nhs.uk/Id/nhs-number/9730675929` | HTTP Status 400 and INVALID_IDENTIFIER_SYSTEM error response |
377+
| No performer record found | `identifier`=`9000000999` | HTTP Status 404 and INVALIDATED_RESOURCE error response |
363378
364379
operationId: get-consent
365380
parameters:
@@ -378,12 +393,30 @@ paths:
378393
schema:
379394
$ref: "#/components/schemas/ConsentBundle"
380395
examples:
381-
consentMotherChildBundle:
382-
$ref: "./examples/responses/GET_Consent/mother-child.yaml#/ConsentMotherChildBundle"
383-
consentAdultsConsentingBundle:
384-
$ref: "./examples/responses/GET_Consent/adults-consenting.yaml#/ConsentAdultsConsentingBundle"
385-
consentMultipleBundle:
386-
$ref: "./examples/responses/GET_Consent/mixed.yaml#/ConsentMixedBundle"
396+
ConsentMultipleRelationshipsStatusActiveBundle:
397+
$ref: "./examples/responses/GET_Consent/filtered-relationships-status-active.yaml#/ConsentMultipleRelationshipsStatusActiveBundle"
398+
ConsentMultipleRelationshipsStatusInactiveBundle:
399+
$ref: "./examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml#/ConsentMultipleRelationshipsStatusInactiveBundle"
400+
ConsentMultipleRelationshipsStatusProposedActiveBundle:
401+
$ref: "./examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml#/ConsentMultipleRelationshipsStatusProposedActiveBundle"
402+
ConsentMultipleRelationshipsBundle:
403+
$ref: "./examples/responses/GET_Consent/multiple-relationships.yaml#/ConsentMultipleRelationshipsBundle"
404+
ConsentMultipleRelationshipsIncludePatientBundle:
405+
$ref: "./examples/responses/GET_Consent/multiple-relationships-include-patient.yaml#/ConsentMultipleRelationshipsIncludePatientBundle"
406+
ConsentMultipleRelationshipsIncludePerformerBundle:
407+
$ref: "./examples/responses/GET_Consent/multiple-relationships-include-performer.yaml#/ConsentMultipleRelationshipsIncludePerformerBundle"
408+
ConsentMultipleRelationshipsIncludePerformerPatientBundle:
409+
$ref: "./examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml#/ConsentMultipleRelationshipsIncludePerformerPatientBundle"
410+
ConsentNoRelationshipsEmptyBundle:
411+
$ref: "./examples/responses/GET_Consent/no-relationships.yaml#/ConsentNoRelationshipsEmptyBundle"
412+
ConsentSingleConsentingAdultRelationshipBundle:
413+
$ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship.yaml#/ConsentSingleConsentingAdultRelationshipBundle"
414+
ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle:
415+
$ref: "./examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml#/ConsentSingleConsentingAdultRelationshipIncludePerformerPatientBundle"
416+
ConsentSingleAdultChildRelationshipBundle:
417+
$ref: "./examples/responses/GET_Consent/single-mother-child-relationship.yaml#/ConsentSingleAdultChildRelationshipBundle"
418+
ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle:
419+
$ref: "./examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml#/ConsentSingleAdultChildRelationshipIncludePerformerPatientBundle"
387420

388421
"4XX":
389422
description: |
@@ -411,6 +444,16 @@ paths:
411444
examples:
412445
accessDeniedError:
413446
$ref: './examples/responses/errors/access-denied.yaml#/AccessDeniedError'
447+
InvalidIdentifierError:
448+
$ref: './examples/responses/errors/invalid-identifier.yaml#/InvalidIdentifierError'
449+
InvalidIncludeParameterBundle:
450+
$ref: './examples/responses/errors/invalid-include-parameter.yaml#/InvalidIncludeParameterBundle'
451+
IdentifierMissingBundle:
452+
$ref: './examples/responses/errors/missing-identifier.yaml#/IdentifierMissingBundle'
453+
NotFoundBundle:
454+
$ref: './examples/responses/errors/not-found.yaml#/NotFoundBundle'
455+
ConsentInvalidStatusParameterBundle:
456+
$ref: './examples/responses/GET_Consent/errors/invalid-status-parameter.yaml#/ConsentInvalidStatusParameterBundle'
414457
"500":
415458
description: Internal server error
416459
content:

0 commit comments

Comments
 (0)