To help get the most out of the published resources, understanding what exists and how it is intended to be used is documented here. There are two core resources -
Standard
This site, which can be thought of as an implementation guide, covering everything from use cases for booking through to the what an authentication token needs to include.
Initially, it can be used to guide analysis and define the scope of a solution. Developers will need to use it in conjunction with the Specification (outlined below) to understand workflow, error handling and non-functional requirements a solution needs to fulfil. There are also resources for Project Managers and stakeholders who are involved in moving the solution to live environments, the Deployment Toolkit.
Specification
A technical document which explicitly defines the NHS FHIR(STU3) Booking API resources and structures, along with the method operations (GET, PUT & POST) used.
Planning a project
There is a Quick Start Guide which assists suppliers through all key areas of a project when building a solution. This should be reviewed in detail as part of the analysis process and subsequent project planning. It is also a useful resource to return to, at any of the project phases, to keep track of progress and for links to more detailed information.
Other key areas
Use Cases
User Stories which define the scope of capabilites the booking Standard aims to cover.
Workflows
The Functional Specification outlines the workflows involved in the booking Standard and goes on to breakdown the key areas in more detail. This section covers some of the very technical points of the Standard and will be used by anyone (Developers, Solution Architects, Technical Business Analysts) involved in documenting or building these aspects of a solution.
Tooling
A suite of tools are available called TKW Simulators (replicating Provider and Consumer behaviour). These are Docker Containers, capable of being deployed locally, but with equivalent endpoints within the Path-to-Live environments, OpenTest, DEV and INT. The Simulators will assist with both development and assurance, logging, validating messages and capturing and packaging evidence which can be appended to a SCAL submission.
Assurance
The solution developed is self assured by suppliers using the SCAL. This is a manual process of confirming the solution meets certain capabilities and providing evidence to support this. The new suite of tools (as described above) are capable of capturing and colating the evidence required for the SCAL submission.
Deployment
There is a clearly defined Path-to-Live, taking a solution through all levels of testing maturity and into Production go-live.
