UK Core Implementation Guide 0.4.0

Please note:

The UK Core 0.4.0 STU1 is in development with the updates and bug fixes following the 2 week review of 0.3.0 (Pre-Release).
There will be disruption as the content will be updated daily and with links not working.
Please follow the guidance on the "Contact Us" page if you need any assistance.

Extension Library

This extension library contains all the extensions Clinically and Technically assured for use with UK Core. The profiles are found in the Profiles Index. The table below lists all the current extensions and the context of use. The context of use column indicates the profile and /or element where the extension may be applied. The type column indicates whether the extension is a modifierExtension or not. The general rule is extensions can be ignored by receivers*. When a modifierExtension is received it MUST NOT be ignored as it modifies the meaning of the element or elements that contains it. Typically, this means information that qualifies or negates the primary meaning of the element that contains it.

For more information from HL7 about FHIR extensions.

For more information from HL7 about FHIR modifierExtensions.

*There may be specific use cases where this is not the case and the Domain Implementation Guidance associated with the use case should be consulted.

All the extensions have been assured as suitable for inclusion in the UK Core, however all extensions have been assigned a maturity level similar to the maturity levels described in the FHIR standard. This is intended to indicate how stable the extension is deemed to be, this is in addition to the publication status of the profile HL7 FHIR statuses of draft, active, retired and unknown.

Maturity level	Definition
0	The Extension has been published on the current build. This Extension has had no formal review and therefore may have quality issues. It is published only to allow the review process to start
1	The Extension produces no warnings during the build process and has had a formal internal review by the UK Core development team
2	The Extension has been released for review to the UK FHIR community, any feedback received has been addressed as far as possible
3	The Extension has been presented for inclusion in the Clinical and Technical Assurance process
4	The Extension has completed the Clinical and Technical Assurance process and the status has been changed to active
5	The Extension has been presented for inclusion in the HL7 UK Ballot Process
6	The Extension has completed the HL7 UK Ballot process and is now deemed to be Normative

Important note:
This implementation guide only contains Extensions with a maturity level of 4 or more. Extensions that are at an earlier stage of development (maturity level of 0-2) are available in the UK Core Implementation Guide Assets in Development.

The Extensions are rendered in several formats:

Snapshot: a fully calculated form of the structure that is not dependent on any other structure
Differential: this describes only the differences that the Extension makes relative to the structure definition (FHIR resource) they constrain
Hybrid: a hybrid view of the snapshot and differential views
Table: a tabular view of the Extension elements
XML: a rendering of an XML view of the Extension
JSON: a rendering of a JSON view of the Extension

Further information from HL7 relating to extensibility is available.

Important note:
The Extensions listed below have been defined as UK Core extensions. Also included in this library are some HL7 common extensions which have been added to the UK Core profiles because they have been deemed to be "core" to UK FHIR data exchanges. These will have a page with guidance on usage in the UK and examples to illustrate usage. Note: implementers of UK Core may use any HL7 common extension from the HL7 standard regardless of whether the extension is included in this implemention guide. The list of common extensions in FHIR R4 is available in the HL7 extension registry.

Implementers of the UK Core profiles may also create their own Extensions where required, but are encouraged to engage with the UK Core development process to get their extensions adopted into the UK Core for wider use by the UK FHIR Community.

For the current list of UK Core extensions under development refer to UK Core Implementation Guide Assets in Development Extension Library

Extensions	Status	Maturity	Context of Use	Related Profile	modifierExtension	C&TA Sprint
Extension UKCore-ActualProblem	active	4	Condition	Profile UKCore-Condition	NO	4
Extension UKCore-AddressKey	active	5	Address	Profile UKCore-Patient	NO	1
Extension UKCore-AdmissionMethod	active	4	Encounter	Profile UKCore-Encounter	NO	4
Extension UKCore-AllergyIntoleranceEnd	active	5	AllergyIntolerance	ProfileUKCore-AllergyIntolerance-Index	NO	2
Extension UKCore-AnaestheticIssues	active	4	Procedure	Profile UKCore-Procedure	NO	4
Extension UKCore-BirthSex	active	5	Patient	Profile UKCore-Patient	NO	1
Extension UKCore-CareSettingType	active	4	Composition List	Profile UKCore-Composition Profile UKCore-List	NO	4
Extension UKCore-CodingSCTDescId	active	5	CodeableConcept	All clinical profiles that can use SNOMED CT. See the extension page for information about how this is used in profiles.	NO	2
Extension UKCore-ConditionEpisode	active	4	Condition	Profile UKCore-Condition	NO	4
Extension UKCore-ContactPreference	active	5	Patient, RelatedPerson	Profile UKCore-Patient Profile UKCore-RelatedPerson	NO	1
Extension UKCore-ContactRank	active	5	Patient.contact, RelatedPerson	Profile UKCore-Patient Profile UKCore-RelatedPerson	NO	1
Extension UKCore-CopyCorrespondenceIndicator	active	5	Patient.contact RelatedPerson	Profile UKCore-Patient Profile UKCore-RelatedPerson	NO	1
Extension UKCore-DeathNotificationStatus	active	5	Patient	Profile UKCore-Patient	NO	1
Extension UKCore-DischargeMethod	active	4	Encounter	Profile UKCore-Encounter	NO	4
Extension UKCore-EmergencyCareDischargeStatus	active	4	Encounter	Profile UKCore-Encounter	NO	4
Extension UKCore-EthnicCategory	active	5	Patient	Profile UKCore-Patient	NO	1
Extension UKCore-Evidence	active	5	AllergyIntolerance	ProfileUKCore-AllergyIntolerance-Index	NO	2
Extension UKCore-LegalStatus	active	4	Encounter	Profile UKCore-Encounter	NO	4
Extension UKCore-ListWarningCode	active	4	List	Profile UKCore-List	NO	4
Extension UKCore-MainLocation	active	5	Organization	Profile UKCore-Organization	NO	1
Extension UKCore-MedicationPrescribingOrganization	active	5	MedicationStatement	Profile UKCore-MedicationStatement	NO	3
Extension UKCore-MedicationStatementLastissueDate	active	5	MedicationStatement	Profile UKCore-MedicationStatement	NO	3
Extension UKCore-MedicationRepeatInformation	active	5	MedicationRequest	Profile UKCore-MedicationRequest	NO	3
Extension UKCore-MedicationTradeFamily	active	5	Medication	Profile UKCore-Medication	NO	3
Extension UKCore-MessageHeaderInstruction	active	4	MessageHeader	Profile UKCore-MessageHeader	NO	4
Extension UKCore-NHSNumberVerificationStatus	active	5	Patient.identifier	Profile UKCore-Patient	NO	1
Extension UKCore-OtherContactSystem	active	5	ContactPoint.system	Profile UKCore-Patient Profile UKCore-RelatedPerson	NO	1
Extension UKCore-OutcomeofAttendance	active	4	Encounter	Profile UKCore-Encounter	NO	4
Extension UKCore-ParentPresent	active	5	Immunization	Profile UKCore-Immunization	NO	3
Extension UKCore-PharmacistVerifiedIndicator	active	5	MedicationStatement	Profile UKCore-MedicationStatement	NO	3
Extension UKCore-ProblemSignificance	active	4	Condition	Profile UKCore-Condition	NO	4
Extension UKCore-RelatedClinicalContent	active	4	Condition	Profile UKCore-Condition	NO	4
Extension UKCore-RelatedProblemHeader	active	4	Condition, List	Profile UKCore-Condition Profile UKCore-List	NO	4
Extension UKCore-ResidentialStatus	active	5	Patient	Profile UKCore-Patient	NO	1
Extension UKCore-VaccinationProcedure	active	5	Immunization	Profile UKCore-Immunization	NO	3