Skip to content

Commit 982cfb8

Browse files
committed
NPA-4514 Remove verification and add provision
1 parent 67a365b commit 982cfb8

File tree

3 files changed

+36
-51
lines changed

3 files changed

+36
-51
lines changed

specification/examples/responses/POST_Consent/errors/invalid_evidence_error.yaml

Lines changed: 0 additions & 15 deletions
This file was deleted.

specification/examples/responses/POST_Consent/errors/invalid_patient_age_error.yaml

Lines changed: 0 additions & 15 deletions
This file was deleted.

specification/validated-relationships-service-api.yaml

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -551,22 +551,23 @@ paths:
551551
552552
| HTTP status | Error code | Description |
553553
| ----------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
554-
| 400 | `MISSING_IDENTIFIER` | Missing performer or patient identifier. For details, see the `diagnostics` field. |
554+
| 400 | `MISSING_IDENTIFIER` | Missing performer or patient identifier. For details, see the `diagnostics` field. |
555555
| 400 | `MISSING_STATUS` | Missing status. |
556556
| 400 | `MISSING_SCOPE` | Missing scope. |
557557
| 400 | `MISSING_CATEGORY` | Missing category. |
558558
| 400 | `MISSING_DATETIME` | Missing datetime. |
559559
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
560560
| 403 | `FORBIDDEN` | Access denied to resource. |
561561
| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |
562+
| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |
562563
| 408 | `TIMEOUT` | Request timed out. |
563564
| 409 | `DUPLICATE_RELATIONSHIP` | Conflict with requested proxy role. |
564565
| 422 | `INVALID_IDENTIFIER` | Invalid performer or patient identifier. For details, see the `diagnostics` field. |
565566
| 422 | `INVALID_STATUS` | Invalid status. |
566567
| 422 | `INVALID_SCOPE` | Invalid scope. |
567568
| 422 | `INVALID_CATEGORY` | Invalid category. |
568569
| 422 | `INVALID_DATETIME` | Invalid datetime. |
569-
| 422 | `INVALID_VERIFICATION` | Invalid verification. For details, see the `diagnostics` field. |
570+
| 422 | `INVALID_PROVISION` | Invalid provision. |
570571
| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |
571572
572573
content:
@@ -714,7 +715,6 @@ paths:
714715
patchConsentInvalidStateTransitionError:
715716
$ref: "./examples/responses/PATCH_Consent/error.yaml#/PatchConsentInvalidStateTransitionError"
716717

717-
718718
components:
719719
schemas:
720720
QuestionnaireResponse:
@@ -1080,7 +1080,17 @@ components:
10801080
display:
10811081
type: string
10821082
description: Evidence of responsibility type.
1083-
enum: ['Birth certificate', 'Adoption certificate', 'Court-witnessed parental responsibility agreement','Court-witnessed step-parent parental responsibility agreement', 'Parental order', 'Special guardianship order', 'Other court order', 'Other' ]
1083+
enum:
1084+
[
1085+
"Birth certificate",
1086+
"Adoption certificate",
1087+
"Court-witnessed parental responsibility agreement",
1088+
"Court-witnessed step-parent parental responsibility agreement",
1089+
"Parental order",
1090+
"Special guardianship order",
1091+
"Other court order",
1092+
"Other",
1093+
]
10841094

10851095
- type: object
10861096
properties:
@@ -1724,7 +1734,7 @@ components:
17241734
enum:
17251735
[
17261736
"https://fhir.nhs.uk/Id/nhs-number",
1727-
"https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier"
1737+
"https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier",
17281738
]
17291739
value:
17301740
type: string
@@ -1808,7 +1818,7 @@ components:
18081818
enum:
18091819
[
18101820
"https://fhir.nhs.uk/Id/nhs-number",
1811-
"https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier"
1821+
"https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier",
18121822
]
18131823
value:
18141824
type: string
@@ -1937,27 +1947,33 @@ components:
19371947
items:
19381948
$ref: "#/components/schemas/Reference"
19391949
description: "Individuals or organizations that agreed to the consent."
1940-
verification:
1941-
type: array
1942-
description: Whether consent was verified with the patient, or another authorized person.
1950+
provision:
1951+
type: object
1952+
maxItems: 1
19431953
items:
1944-
type: object
1945-
properties:
1946-
verified:
1947-
type: boolean
1948-
description: Whether the consent has been verified
1949-
verifiedWith:
1950-
$ref: "#/components/schemas/Reference"
1951-
verificationDate:
1952-
type: string
1953-
description: The date and time when consent was collected.
1954-
format: date-time
1954+
$ref: "#/components/schemas/Provision"
19551955
extension:
19561956
type: array
19571957
description: Model the status reason.
19581958
items:
19591959
$ref: "#/components/schemas/Extension"
19601960

1961+
Provision:
1962+
type: object
1963+
properties:
1964+
period:
1965+
type: object
1966+
description: "Timeframe for this provision."
1967+
properties:
1968+
start:
1969+
type: string
1970+
description: "Starting time with inclusive boundary"
1971+
format: date-time
1972+
end:
1973+
type: string
1974+
description: "End time with inclusive boundary, if not ongoing"
1975+
format: date-time
1976+
19611977
Extension:
19621978
type: object
19631979
properties:
@@ -1969,7 +1985,6 @@ components:
19691985
items:
19701986
$ref: "#/components/schemas/CodeableConcept"
19711987

1972-
19731988
OperationOutcome:
19741989
type: object
19751990
description: |

0 commit comments

Comments
 (0)