Notice
- Important: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
- This Implementation Guide is currently in Draft and SHOULD NOT be used for development or active implementation without express direction from the NHS England Genomics Unit.
Acknowledgements and responses
It is expected that acknowledgements will conform to the NHSDigital FHIR Acknowledgement Framework. This framework and associated IG are still in development. Once published, a link to the IG, and how to interpret the framework for use in Genomics will be provided here.
Until this is finalised, it is expected that individual Create or Update requests (POST and PUT) that are successful will result in the created resources being returned, along with the server assigned IDs to ensure the source system can retrieve the resources at a later time. Create or Update requests bundled together into Transaction Bundles will additionally return OperationOutcomes detailing any validation messages to be returned. The Transaction Bundle will contain links to retrieve the saved resources, if successful, to ensure data has been appropriately parsed by the service and to notify users of the unique IDs assigned to resources.
Operations which encounter validation errors will result in only OperationOutcome resources being returned, the OperationOutcomes will contain diagnostics from the FHIR validation service to guide users on how to correct errors in their request.
Transactions will result in 'transaction-response' bundles being returned. These will contain a set of OperationOutcome resources, each detailing the success or error state of an individual resource. If any one resource fails validation, the whole transaction is failed to ensure resources are not orphaned and maintain referential integrity (as per the FHIR Transaction Rules). Examples of transaction responses can be found under the Bundle example pages.
View requests will result in the the resource itself being returned, if requested by ID, or encapsulated within a SearchSet Bundle if searched for using other parameters.
Note, if Delete events are supported, these will result in OperationOutcome resources being returned, to notify the client of the outcome of the request, detailing either success of failure codes. Support for Delete operations is still under discussion as of the time of publication.