- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
Home
UK Core Implementation Guide Current Draft Build
Project Description and Scope
The FHIR UK Core Implementation Guide as a project aims to provide UK wide FHIR implementation guidance that has applicability across jurisdictions and care settings.
The guidance includes:
- FHIR resource components including Profiles and Extensions
- FHIR terminology components including ValueSets and CodeSystems
- Other general guidance useful to FHIR implementers in the UK
The guidance does not form the basis for a completely described deployable service in and of itself but is the basis from which other FHIR implementation guides can be derived.
The FHIR UK Core Implementation Guide shows only the differences between the base FHIR resources and the UK Core Profiles, and does not repeat base guidance. For this reason, it is expected to be used in conjunction with https://hl7.org/fhir/R4/.
The FHIR UK Core will never contradict the base FHIR standard but will restrict and extend resources, including amending of any ValueSets and CodeSystems, as necessary to bring in line the UK requirements. The content is relevant to the UK as a whole (4 Nations) although some nation specific CodeSystems are included and referenced in ValueSets.
Any derived profiles will follow similar guidance, and will only show the differences between the base FHIR UK Core profile and the derived profile itself.
Note about the label "STU3" for this FHIR implementation guide (IG)
The "3" refers to this being a third ballot of the UK Core, as a "Standard for Trial Use" (STU). It is based on, and provides extra UK specific guidance for use of, the international standard FHIR R4. The STU3 label of this Implementation Guide is not in any way related to earlier versions of FHIR itself, with coincidentally similar labels such as FHIR DSTU2 or FHIR STU3.For additional guidance, see FHIR Version Guidance.
Implementation Guidance Directory
The Implementation Guidance Directory contains links to other guidance and documentation which is available to assist Implementers of the UK Core. This guidance covers items such as:- Version history and change control information.
- Information around the design and approach of the UK Core.
- Information to help identify clinical safety issues.
- Further implementation guidance related to medication that has been developed by NHS England.
Use International FHIR
We are not restricted to use UKCore only, one can also use International FHIR depends on the need of their work. So, One can do there work with the use of International FHIR resources if they are not present in the UKCORE.How to Read This Guide
This Guide is divided into several pages which are listed at the top of each page in the menu bar.
- Home: The home page provides the introduction and background for UK Core.
- Sitemap Overview: The Guidance page provides the sitemap of UK Core IG.
- DataType Guidance: This page gives guidance on the representation of constructs like Address, Name, and Telecom etc.
- CodeableConcept Guidance: This page gives guidance on the processing of CodeableConcept codes such as SNOMED CT concepts and descriptions.
- FHIR Version Guidance: This page gives guidance on UK Core and FHIR Versions beyond R4.
- MustSupport Guidance: This page gives guidance on the the use of MustSupport flags in UK Core.
- Profiles and Extensions: The header for pages about Extensions and Profiles
- Extensions Index: The Extensions which have been defined for the UK Core.
- All Extensions: This is the rendering of all Extensions defined for use within the UK Core.
- Profiles Index: The Profiles which have been defined for the UK Core.
- Terminology: This page lists all the Terminology assets defined as part of this Implementation Guide.
- ConceptMaps: This page lists all the ConceptMaps defined as part of this Implementation Guide.
- ValueSets and CodeSystems: This is the list of ValueSets and CodeSystems defined for use within the UK Core.
- All ValueSets: This is the rendering of all ValueSets defined for use within the UK Core.
- All CodeSystems: This is the rendering of all CodeSystems defined for use within the UK Core.
- Examples: The header for examples of UK Core FHIR assets.
- Examples Index: This is the list of examples available in this implementation guide
- Profile Examples: This is the rendering of all Profile examples available in this implementation guide
- Extension Examples: This is the rendering of all Extension examples available in this implementation guide
- Contact Us: How to Contact the key parties associated with this implementation guide.
- Downloads: List of downloads for this implementation guide
- Glossary: List of abbreviations and external links used in this implementation guide
Licensing and Publisher
- Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.
- Developed and authored by UK Core Development Team and published by HL7 UK.