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 modifier extension column indicates whether the extension is a modifier extension or not.
The general rule is extensions can be ignored by receivers*. When a modifier extension is received it SHALL 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 Modifier Extensions.
*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.
Further information from HL7 relating to extensibility is available.
The Extensions listed below have been defined as UK Core extensions. Also included in this library are some HL7 core-defined 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 core-defined extension from the HL7 standard regardless of whether the extension is included in this implementation guide. The list of core-defined extensions in FHIR R4 is available in the HL7 Core-defined 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.
C&TA Sprint 1:
C&TA Sprint 2:
C&TA Sprint 3:
C&TA Sprint 4:
C&TA Sprint 5:
C&TA Sprint 6:
AllergyIntolerance:
Appointment:
Composition:
Condition:
DiagnosticReport:
Encounter:
FamilyMemberHistory:
Immunization:
List:
Medication:
MedicationRequest:
MedicationStatement:
Organization:
Patient:
RelatedPerson:
ServiceRequest:
Slot:
Specimen:
The following HL7 Core-defined Extensions have been agreed as suitable to be included for use with the UK Core Profiles because the use case for an Extension is fully met by a pre-existing HL7 Core-defined Extension. All other HL7 core-defined extensions MAY be used to extend the UK Core if required by the local implementation.
| HL7 Core-defined Extension | Context of Use | Related Profile | Modifier Extension |
|---|---|---|---|
| Extension coding-sctdescid | Coding | Use on Element ID Coding | NO |
| Extension messageheader-response-request | MessageHeader | Profile UKCore-MessageHeader | NO |
| Extension organization-period | Organization | Profile UKCore-Organization | NO |
| Extension patient-birthPlace | Patient | Profile UKCore-Patient | NO |
| Extension patient-birthTime | Patient.birthDate | Profile UKCore-Patient | NO |
| Extension patient-cadavericDonor | Patient | Profile UKCore-Patient | NO |
| Extension patient-interpreterRequired | Patient | Profile UKCore-Patient | NO |
| Extension specimen-specialHandling | Specimen.collection | Profile UKCore-Specimen | NO |
This guidance and list underwent Clinical and Technical Assurance during Sprint 6. This is a new content added to UK Core and should undergo review in this STU2 ballot.
The following R5 elements have been agreed as suitable to be included for use with the UK Core Profiles because the use case for pre-adopting an R5 element as an Extension, rather than creating a UK Core specific extension is fully met.
As of 19/05/2023, the package to enable pre-adopted elements to function as per the guidance, is not available. To enable rendering and validation of these pre-adopted elements, we have provided UKCore proxy extensions, as per the current threads on chat.fhir.org, with the R5 canonical urls. These proxy extensions will be retired once the HL7 package is released.