-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
## Summary 🎫 [AEA-4249](https://nhsd-jira.digital.nhs.uk/browse/AEA-4249) PSU API OAS issues - Routine Change ### Details PSU API OAS issues
- Loading branch information
1 parent
2a830a5
commit 881a8a5
Showing
6 changed files
with
166 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -103,6 +103,7 @@ | |
| "pollable", | ||
| "powertools", | ||
| "pratica", | ||
| "prescriptionid", | ||
| "Prosthetist", | ||
| "pylint", | ||
| "pytest", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
packages/specification/examples/error-invalid-prescriptionid.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| { | ||
| "resourceType": "Bundle", | ||
| "type": "transaction-response", | ||
| "entry": [ | ||
| { | ||
| "response": { | ||
| "status": "400 Bad Request", | ||
| "outcome": { | ||
| "resourceType": "OperationOutcome", | ||
| "meta": { | ||
| "lastUpdated": "2024-07-22T23:59:07.673Z" | ||
| }, | ||
| "issue": [ | ||
| { | ||
| "code": "value", | ||
| "severity": "error", | ||
| "diagnostics": "Prescription ID is invalid." | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "fullUrl": "urn:uuid:3b2d36a9-3cff-45e4-93a7-d1f70f911496" | ||
| } | ||
| ] | ||
| } |
168 changes: 99 additions & 69 deletions
168
packages/specification/schemas/resources/OperationOutcome.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,84 +1,114 @@ | ||
| type: object | ||
| required: [resourceType, id, meta, issue] | ||
| required: [resourceType, type, entry] | ||
| description: | | ||
| Outcome of an operation that does not result in a resource or bundle being returned. | ||
| For example - error, async/batch submission. | ||
| properties: | ||
| resourceType: | ||
| type: string | ||
| description: FHIR Resource Type. | ||
| enum: [OperationOutcome] | ||
| id: | ||
| enum: [Bundle] | ||
| description: The type of resource. | ||
| type: | ||
| type: string | ||
| description: ID to link the request and response (Lambda request ID) | ||
| meta: | ||
| type: object | ||
| required: [lastUpdated] | ||
| description: Metadata regarding the request | ||
| properties: | ||
| lastUpdated: | ||
| type: string | ||
| description: Timestamp at which the response was generated | ||
| issue: | ||
| enum: [transaction-response] | ||
| description: The type of bundle. | ||
| entry: | ||
| type: array | ||
| description: List of issues that have occurred. | ||
| minItems: 1 | ||
| description: An array of entry objects, each representing a single response in the transaction-response bundle. | ||
| items: | ||
| type: object | ||
| required: [severity, code] | ||
| required: [response, fullUrl] | ||
| properties: | ||
| severity: | ||
| type: string | ||
| enum: [fatal, error, warning, information] | ||
| description: Severity of the error. | ||
| code: | ||
| type: string | ||
| description: FHIR error code. | ||
| enum: | ||
| - business-rule | ||
| - code-invalid | ||
| - conflict | ||
| - deleted | ||
| - duplicate | ||
| - exception | ||
| - expired | ||
| - extension | ||
| - forbidden | ||
| - incomplete | ||
| - informational | ||
| - invalid | ||
| - invariant | ||
| - lock-error | ||
| - login | ||
| - multiple-matches | ||
| - no-store | ||
| - not-supported | ||
| - not-found | ||
| - processing | ||
| - required | ||
| - structure | ||
| - security | ||
| - suppressed | ||
| - throttled | ||
| - timeout | ||
| - too-costly | ||
| - too-long | ||
| - transient | ||
| - unknown | ||
| - value | ||
| details: | ||
| response: | ||
| type: object | ||
| description: Internal error code. | ||
| required: [status, outcome] | ||
| description: Contains the response details for the transaction. | ||
| properties: | ||
| coding: | ||
| type: array | ||
| items: | ||
| $ref: ../fragments/codes.yaml#/SpineErrorOrWarningCode | ||
| expression: | ||
| type: string | ||
| description: FHIR Path of element(s) related to the error. | ||
| example: Patient.name.given | ||
| diagnostics: | ||
| status: | ||
| type: string | ||
| description: HTTP status code and reason. | ||
| example: 400 Bad Request | ||
| outcome: | ||
| type: object | ||
| required: [resourceType, meta, issue] | ||
| description: Outcome details of the operation. | ||
| properties: | ||
| resourceType: | ||
| type: string | ||
| description: FHIR Resource Type. | ||
| enum: [OperationOutcome] | ||
| meta: | ||
| type: object | ||
| required: [lastUpdated] | ||
| description: Metadata regarding the request | ||
| properties: | ||
| lastUpdated: | ||
| type: string | ||
| description: Timestamp at which the response was generated | ||
| issue: | ||
| type: array | ||
| description: List of issues that have occurred. | ||
| minItems: 1 | ||
| items: | ||
| type: object | ||
| required: [severity, code] | ||
| properties: | ||
| severity: | ||
| type: string | ||
| enum: [fatal, error, warning, information] | ||
| description: Severity of the error. | ||
| code: | ||
| type: string | ||
| description: FHIR error code. | ||
| enum: | ||
| - business-rule | ||
| - code-invalid | ||
| - conflict | ||
| - deleted | ||
| - duplicate | ||
| - exception | ||
| - expired | ||
| - extension | ||
| - forbidden | ||
| - incomplete | ||
| - informational | ||
| - invalid | ||
| - invariant | ||
| - lock-error | ||
| - login | ||
| - multiple-matches | ||
| - no-store | ||
| - not-supported | ||
| - not-found | ||
| - processing | ||
| - required | ||
| - structure | ||
| - security | ||
| - suppressed | ||
| - throttled | ||
| - timeout | ||
| - too-costly | ||
| - too-long | ||
| - transient | ||
| - unknown | ||
| - value | ||
| details: | ||
| type: object | ||
| description: Internal error code. | ||
| properties: | ||
| coding: | ||
| type: array | ||
| items: | ||
| $ref: ../fragments/codes.yaml#/SpineErrorOrWarningCode | ||
| expression: | ||
| type: string | ||
| description: FHIR Path of element(s) related to the error. | ||
| example: Patient.name.given | ||
| diagnostics: | ||
| type: string | ||
| description: A description of the reasoning for including an OperationOutcome | ||
| example: Prescription ID is invalid. | ||
| fullUrl: | ||
| type: string | ||
| description: A description of the reasoning for including an OperationOutcome | ||
| example: Some prescriptions have been invalidated so could not be returned. | ||
| description: A URL or UUID that identifies the full location of the resource. | ||
| example: urn:uuid:3b2d36a9-3cff-45e4-93a7-d1f70f911496 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters