Feature/raa 9686 - #2873
Conversation
| | `SearchCriteria` | `1..1` | | | ||
| | `ReferringClinician` | `0..1` | | | ||
| | `CommissioningRuleOrganisation` | `0..1` | Required if searching for services for an existing Referral. This field should be provided using the returned Commissioning Rule Organisation already included on the Referral to ensure the services returned are valid. Note this field is not supported when searching with the `ADVICE_AND_GUIDANCE_REQUEST` request type. | | ||
| | `ubrn` | `0..1` | Mandatory for SPC and SPCA requests. This parameter is ignored for RC and RCA requests. | |
There was a problem hiding this comment.
The field name in the table should be with capital 'U', so Ubrn to stick with the convention in this table where the 'titles' of field definitions are referenced here, rather than actual field names in the body.
| | `SearchCriteria` | `1..1` | | | ||
| | `ReferringClinician` | `0..1` | | | ||
| | `CommissioningRuleOrganisation` | `0..1` | Required if searching for services for an existing Referral. This field should be provided using the returned Commissioning Rule Organisation already included on the Referral to ensure the services returned are valid. Note this field is not supported when searching with the `ADVICE_AND_GUIDANCE_REQUEST` request type. | | ||
| | `ubrn` | `0..1` | Mandatory for SPC and SPCA requests. This parameter is ignored for RC and RCA requests. | |
There was a problem hiding this comment.
Mandatory for SPC and SPCA requests. This parameter is ignored for RC and RCA requests.
Let's use the full names of those roles (embraced in back-tick characters for a consistent look, e.g. REFERRING_CLINICIAN) so that the reader doesn't have to look up/decipher what the acronyms refer to.
| | INVALID_VALUE | The input provided does not conform to the expected data types and format. | | ||
| | INVALID_CODE | The input provided for a field is not one of the defined legal values. | | ||
| | INVALID_STATE | Indicates that the service currently holding the referral is not a Triage service. | | ||
| | INVALID_REQUEST_STATE | Indicates that the referral is not in a Triaged - Provider To Action defining state. | |
There was a problem hiding this comment.
The new error codes are in themselves quite generic and could, in the future, be returned for a number of reasons.
Therefore it would be better to make their descriptions less tied to the specific current cases, as the diagnostic messages will clarify the specific context at runtime.
Having said that, we can still mention some specifics as an example. How about something like this:
| INVALID_STATE | Indicates that the referenced item is not in the correct state for the request to be processed (e.g. a service of the wrong type). |
| INVALID_REQUEST_STATE | Indicates that the referral item is not in the correct state for the request to be processed. |
5ad9936 to
dd7d8b0
Compare
3 participants
Update OAS spec for referral redirection API change for A010