nhsconnect / gpconnect

GP Connect API specification
https://digital.nhs.uk/services/gp-connect/gp-connect-specifications-for-developers
Apache License 2.0
34 stars 26 forks source link

Read an appointment - additional error #235

Closed briandiggle closed 7 years ago

briandiggle commented 7 years ago

Re: HDL-119

GP Connect appointments will always have an associated patient and location reference. If the "Read an Appointment API" is used to retrieve an appointment which does not have these linked references then an error should be returned.

Spec update required

briandiggle commented 7 years ago

After discussion, we decided that for this particular instance, we updated the read an appointment API use case to indicate that a 500 HTTP status code should be used. 4xx HTTP status codes would not be applicable as it is not a "client" error. In this case the provider does not have sufficient data about the appointment to populate the appointment resource according to the profile https://fhir-test.nhs.uk/StructureDefinition/gpconnect-appointment-1.

This would be where a mandatory element in the profile could not be satisfied. E.g. no Patient/Practitioner or Location is associated with the appointment.

An OperationOutcome would be returned with an HTTP 500 status code