Current Release
0.2.0 BETA
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.2.0 | BETA | Public Beta | Current Version | 12/02/2021 | Volatile |
This is the biggest release for some time. It marks the progression to a public beta level of maturity and it is planned to be the final step before a release candidate for version 1.0.0
The 0.2.0 BETA release has the following highlights:
- The FHIR API Specification has been updated to 2.0.2 BETA
- Resources Overview page has been updated to reflect a generic use case. non-breaking
- Guidance around Location resource has been updated.non-breaking
- Various guidance on Searching for Slots page added/updated:
- Additional guidance added regarding include and revinclude parameters when searching for slots non-breaking correction
- Additional support for all statuses added when searching for slots non-breaking correction
- Guidance added for outputting data in different formats non-breaking
- Addition of a new FHIR SearchParameter required for searching slots . non-breaking
- Element Id has been replaced with identifier for HealthcareService resource . breaking correction
- Updated the description for id for the Schedule resource . non-breaking correction
- Practitioner and PractitionerRole pages have been removed. non-breaking
- Appointment example has been fixed to reflect the correct format for references. non-breaking correction
- References to the registry function has been removed. non-breaking
- Additional guidance added to the Appointment.created element, datatype has been changed from Instant to dateTime to reflect the profile. breaking correction
- Narrative added to the diagrams on the profile overview page . non-breaking
- New page added for the the Bundle resource . non-breaking
- Additional guidance added for the patient.telecom element non-breaking
- A new page describing the capability statement
has been created. non-breaking
- Updated Authentication Page
- Some typos were fixed non-breaking correction
- Guidance around the scope claims was updated to provide more clarity on the application of the different scopes non-breaking
- A new scope claim has been added to make their application more intuitive breaking
- Removed references to Appointment Registry from Cancellation section non-breaking
- Updated the name of the standard to “NHS Booking Standard” and removed references specifically referring to the standard as the “UEC Booking Standard” to support future use cases non-breaking
- Updated most pages to reference booking rather than “appointment” unless specifically appropriate non-breaking
- Updated some wording on booking definition page to be more generic non-breaking
- Updated contact details to new contact email address non-breaking
- A small update to the guidance on how to handle times was made. non-breaking correction
- A new page on how to store patient contacts has been added. This provides clear business rules on what and where contacts should be stored breaking
- Based on usability feedback, the menu system has been updated to use a single menu flow rather than break out to “sub-pages” for certain sections non-breaking
- A new page describing how to maintain transactional integrity and how custom headers can support this breaking
- Updated the deployment toolkit with a significant amount of new content non-breaking
- Removed references to the demonstrator
- Added new pages to support the new Provider and Consumer simulator tools non-breaking
- Fixed some broken links that referenced external resources non-breaking correction
- Added a new page providing some API guidance, removing ambiguity over a number of subjects breaking
- A new page describing interactions with SDS was created non-breaking
- A new page describing interactions with SSP was created non-breaking
- The overview page on error handling was updated to improve clarity and remove ambiguity non-breaking
- The page on error handling was updated to improve clarity and remove ambiguity non-breaking
- The booking and referral messages page was removed as it is duplicating the “transfer of care” page in the “functional spec” section non-breaking
- The transfer of care page was updated to provide more clarity on how to store appointment references in the 111CDA document non-breaking
- A new page describing the FHIR Resource Profile Overrides has been created non-breaking
- IG Pages have been updated with new IG statement non-breaking
- IG FAQ has been updated with new content non-breaking
- A new page: using this site has been added non-breaking
- A new page: getting started has been added with new content non-breaking
- Updated guidance on delivery channel to specifically prohibit setting a defaultbreaking
- An indication of breaking and non-breaking changes has been added to the release notes non-breaking
Future releases
1.0.0 RC1
| Version | Handle | Phase | State | Release Date (planned) | Stability |
|---|---|---|---|---|---|
| 1.0.0 | RC1 | Release Candidate | Unreleased | TBC | Volatile |
Previous releases
0.1.17 ALPHA
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.17 | ALPHA | Alpha | Current Version | 18/12/2020 | Volatile |
The 0.1.17 ALPHA release has the following highlights:
- Update of FHIR Specification to 2.0.1-beta
- Updated description for ‘supportingInfo’ element for the Appointment resource.
- Updated description for ‘participant’ element for the Appointment resource.
- Added guidance for using ‘incomingReferral’ element for the Appointment resource.
- Updated contained resource guidance for the Appointment resource.
- Updated search parameters guidance when searching for free slots.
- Fixed some incorrect interactions in some diagrams on the workflow page
- Removed guidance that PDS trace is mandatory for Consumer systems
- Updated user story (abus13) to be more generic in its guidance, removing specific references to the UEC DoS
- Updated some wording on the “What we are doing?” page
- Updated some wording on the “Care Settings” page
- Updated the conformance catalogue page to reflect the latest status and add links
- Updated the functional scope page to reflect the latest developments in the standard
- Made the “requesting_practitioner” claim optional
- Added a number of new items to the glossary
0.1.16 ALPHA
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.16 | ALPHA | Alpha | Current Version | 28/08/2020 | Volatile |
The 0.1.16 ALPHA release has the following highlights:
- Update of FHIR Specification to 2.0.0-beta
- Renamed from NHS FHIR Scheduling API to NHS FHIR Booking API.
- Updated Appointment guidance to include mandatory Appointment.end to align with the FHIR standard.
- Updated Appointment.created guidance to align with the FHIR standard.
- Updated Appointment.contained to include Slot as a contained resource.
- Updated Appointment examples.
- Updated Patient identifier guidance in line with CareConnect-Patient-1 profile. Notably removing mandatory NHS Number
- Updated ‘success’ behaviour for cancelling an Appointment.
- Updated Slot elements.
- Updated ‘Search for free slots’ example.
- Updated ‘Search for appointments’ example.
- Updated ‘Get an appointment’ examples.
- Updated development guidance on validating resources.
- Created a new page describing how to handle times
- References to times have been updated to refer to new page on times
- The “functional specification” menu items were updated to more clearly reflect content
- The Functional Scope page was updated to move Emergency Departments and Patient facing uses into scope
- A new page documenting requirements for displaying slots, including explicit reference to delivery channel was added
- Fixed broken menu item for GP Connect section
0.1.15 ALPHA
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.15 | ALPHA | Alpha | Released | 24/07/2020 | Volatile |
The 0.1.15 ALPHA release has the following highlights:
- First iteration of the deployment toolkit
- Made a slight wording change to the definition of appointment booking in the overview/definition page
- Updated user story: AUBS.22 wording to remove ambiguity over rebooking appointments
- Updated the cancellation workflow page to have increased clarity over the different possible workflows and the sequence of events.
- Added a placeholder page for addition of support for “Delivery Channels” (due in the next release)
- Fixed some broken links on Authentication page and updated some elements with more detail
- A new page providing (draft) guidence for Appointment Text Messages was added
- Updated the assurance process overview to reflect the current iteration of the process
0.1.14 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.14 | PREVIEW | Alpha | Released | 05/05/2020 | Volatile |
The 0.1.14 PREVIEW release has the following highlights:
- Updated the FHIR specification version to 1.0.6-alpha
- Added a new page in “Functional Specification” section providing guidance for referencing transfer of care documentation
- Tidied up some aspects of the reporting specification
- Updated the demonstrator pages to reflect recent updates and a change for a future update
- added Covid-19 Dx codes and fixed typos to the appointment mapping page
0.1.13 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.13 | PREVIEW | Alpha | Released | 07/02/2020 | Volatile |
The 0.1.13 PREVIEW release has the following highlights:
- Updated all functional specification pages where the ASID being included in the search parameters of FHIR queries is referenced. This has been changed to the more generic Healthcare Service ID and where appropriate direct reference to the DoS Service ID
- Made some updates to the Functional Spec -> Workflow section
- Created new requirements about how times and dates should be handled
- Updated a few of the examples in the diagrams to reflect changes to the FHIR specification
- Updated the references to authentication to reflect new approach
- Updated the Appointment mapping page to correct a typographical error and add clarification around local variance in GP Connect disposition mapping
- Updated slot mapping page to correct some typos
- Updated reporting specification page
- to fix some typos
- to bring future requirements in to current requirements section (as they are now current requirements)
- Updated the Use Cases
- Created a new Use Case for booking outside a disposition timeframe
- Fixed some typos
- Updated the demonstrator pages to reflect a change for a future update
0.1.12 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.12 | PREVIEW | Alpha | Released | 19/11/2019 | Volatile |
The 0.1.12 PREVIEW release has the following highlights:
- New section on error handling created
- Updated Authentication details with significant changes to reflect current approach
- Created “booking only” services section on DoS sub site
- Added details for booking only attribute, including sample code (XML)
- Updated reporting requirements section
- Added future requirements section
- Tidied up existing requirements
0.1.11 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.11 | PREVIEW | Alpha | Released | 14/10/2019 | Volatile |
The 0.1.11 PREVIEW release has the following highlights:
- Updated User Stories
- Updated wording in all existing user stories
- Added new user story for booking only services
- Split cancellation user story into two
- Renamed “getting live” section to “Deployment”
- Created supplier conformance catalogue
- Fixed a couple of issues in the main navigation
- Updated the reporting requirements
- Split the requirements into consumer and provider sections
- updated the layout
- refreshed the requirements
- Fixed the broken link in the FHIR implementation page
- Fixed a few typos in several pages
0.1.10 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.10 | PREVIEW | Alpha | Released | 26/07/2019 | Volatile |
The 0.1.10 PREVIEW release has the following highlights:
- in the DoS workflow section:
- The GP Connect “Register a Patient” capability has been added as a requirement to be supported by consumers
- specific reference to the “Register a Patient” capability has been made in the relevant workflow examples
- Erroneous text removed from diagram
- Additional information regarding the correct sequence to determine the SDS query for booking into GP Connect using the DoS
- A new page displaying road map information was added
- Cancellation capability levels added to cancellation section
- Removed all reference to “HealthcareServiceID” as it was causing confusion and is no longer relevant
- Added guidance for the DoS service attribute
- Removed “not published” note from any pages that are complete
0.1.9 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.9 | PREVIEW | Alpha | Released | 14/06/2019 | Volatile |
The 0.1.9 PREVIEW release has the following highlights:
- Introduction and Overview Sections
- Wording tidied up in the introduction
- Definition page wording tidied up
- UEC Landscape page updated with more appropriate links and improved wording
- Updated UEC Overview infographic
- Tidied up and updated wording in scope section
- Scope and user stories section
- Refreshed the scope overview page to align to current program milestones
- Fixed typos in user story overview section
- Fixed typos and tidied up wording in various user stories
- Updated the non-functional requirements to reflect the current expectations
- Updated the workflow section in Functional Spec
- Various updates were made to the DoS section:
- Updated the DoS endpoints section
- Updated the DoS requirements page
- The workflow examples from the GP Connect section were moved into the DoS workflow section so the workflow examples for DoS interactions are in the same place.
- Some typos were fixed in the workflow section
- “Links between booking and CDA” page was elaborated
- Appointment Types page was removed (concept no longer relevant to FHIR spec - delivery channel used instead - for GP Connect only)
- Cancel / Rebook section
- Wording updated and typos removed from architecture page
- Wording updated and typos removed from workflow page
- The Demonstrator overview section was updated
- Updated the FHIR profile page to link to GP Connect as well as Care Connect
- Updated the Glossary with some more detail and corrections
0.1.8 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.8 | PREVIEW | Alpha | Released | 17/05/2019 | Volatile |
The 0.1.8 PREVIEW release has the following highlights:
- Update to the assurance section encompassing the following new content:
- Update to the assurance overview section
- Complete high level description of assurance and on-boarding process
- Addition of an interactive assurance process info-graphic
- A new section describing the SCAL document was created
- “Supplier assurance process” page (and associated menu item) was renamed to “Supplier Assurance Prerequisites and Requirements”
- Update to the assurance overview section
- Additional information in the DoS workflow overview section describing the recommendation for how a booking only service should be profiled
- A broken link in the DoS workflow section was fixed
- Fixed an incorrect release state for previous releases in the release notes
0.1.7 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.7 | PREVIEW | Alpha | Released | 05/04/2019 | Volatile |
The 0.1.7 PREVIEW release has the following highlights:
- A Detailed work through of a complex workflow was added to the GP Connect section
- A new section for appointment management (Cancel and Rebook) was created
- This includes a section on technical architecture and workflow
- New content for the demonstrator guidance was added
0.1.6 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.6 | PREVIEW | Alpha | Released | 20/02/2019 | Volatile |
The 0.1.6 PREVIEW release has the following highlights:
- A new section in functional spec was created for GP Connect specific content
- A page otlining the key requirements for UEC Consuming systems was created
- A new page comparing GP connect to proprietary booking was added
- New content for the “Monitoring, Analytics and Reporting” was created
- Including a key metrics specification
- Added a FAQ page into IG section
- Added a page on Authentication in Functional Spec section
- Updated DoS workflow example from GP Fed to UTC
0.1.5 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.5 | PREVIEW | Alpha | Released | 04/01/2019 | Volatile |
The 0.1.5 PREVIEW release has the following highlights:
- New DoS subsite in functional specification was created
- New content for “DoS overview” page
- New page “Key requirements” was added
- New page “Workflow overview” was added
- “DoS workflow example” page was tidied up
- New “DoS endpoints” pages were created
- A page describing the existing approach to endpoints was created
- a page describing the new approach to endpoints was created
- a page explaining the new booking changes was created
- Added a page with guidance on transfer of care and ITK messaging
- One of the examples in the “Get Slots” section of the “Workflow and Interactions” page was updated to reflect an evolution of the messaging spec
- Resolved issue with the large codeblock on the “Workflow and Interactions” page
- Some content was added to the “Appointment Management” page
- The FHIR messaging spec link was updated to the latest version (1.0.3-alpha)
0.1.4 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.4 | PREVIEW | Alpha | Released | 07/12/2018 | Volatile |
The 0.1.4 PREVIEW release has the following highlights:
- Small update to the glossary
- Changed references to the specific “StratAuth” to a more generic “NHS Authentication Service” in the functional specification
- Added generic statement regarding reporting requirements
- Added reference to the IUC service specification in the UEC Landscape overview page
- Added content to the user stories overview page
- made the link to the FHIR profile website much more prominent by adding a clickable “specification version” to the sidebar. On clicking it links to the FHIR profile website
0.1.3 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.3 | PREVIEW | Alpha | Released | 16/11/2018 | Volatile |
The 0.1.3 PREVIEW release has the following highlights:
- Created content for “Differences from GP Connect” in the Functional Specification secion.
- Fixed the TOC and some formatting for the release notes page
0.1.2 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.2 | PREVIEW | Alpha | Released | 06/11/2018 | Volatile |
The 0.1.2 PREVIEW release has the following highlights:
- some of the user story text has been updated
- The wording in “Serviceability” section of Non-Functional Requirements has been updated
- Content in the “Interactions with the DoS” page in Functional Specification section has been created
0.1.1 PREVIEW
| Version | Handle | Phase | State | Release Date | Stability |
|---|---|---|---|---|---|
| 0.1.1 | PREVIEW | Alpha | Released | 18/10/2018 | Volatile |
The 0.1.1 PREVIEW release is the first release version of the UEC appointment booking standards. This version has the following highlights:
- Initial site structure and base content
- Background and context setting content
- User stories and scoping information
- Workflow and filtering slots content in the functional specification section
- non-functional requirements
- a link to the FHIR API specification