STU1 Sequence
| Date | IG Version | FHIR Version | Description |
|---|---|---|---|
| 31st January 2023 | 1.0.0 | 4.0.1 | UK Core Implementation Guide 1.0.0 - STU1 First HL7 UK Ballot version of UK Core. |
| Changes for this version
| |||
| 18th November 2022 | 1.0.0 - Pre-Release | 4.0.1 | UK Core Implementation Guide 1.0.0 - STU1 - Pre-release version of the First HL7 UK Ballot version of UK Core. |
Changes for this version
|
|||
STU1 Sequence - Historical releases
| Date | IG Version | FHIR Version | Description |
|---|---|---|---|
| 14th March 2022 | 0.5.0 | 4.0.1 | UK Core Implementation Guide 0.5.0 - STU1 - Version of the UK Core Implementation Guide from Sprint 5 of Clinical and Technical Assurance. |
| Changes for this version
Added the Profiles and associated FHIR assets required for Sprint 5 of C&TA.
| |||
| 27th January 2022 | 0.4.0 | 4.0.1 | UK Core Implementation Guide 0.4.0 - STU1 - Version of the UK Core Implementation Guide from Sprint 4 of Clinical and Technical Assurance. |
Changes for this version
|
|||
| 19th January 2022 | 0.3.0 | 4.0.1 | UK Core Implementation Guide 0.3.0 - STU1 (Pre-Release) - Version of the UK Core Implementation Guide with updates from Sprint 4 of Clinical and Technical Assurance as a pre-release for external comments and feedback. |
| Changes for this version | |||
| Related Asset | Change Description | ||
| All Sprint 4 artefacts | For artefacts not covered by a previous sprint, status element set to active (unless being retired), date set to 2022-01-07, version incremented from existing value (unless being retired) or set to 1.0.0 for new artefacts. | ||
| All profile elements that use reference data types | Updated the guidance on the element page to give links to the allowable UK Core profile(s) or where no UK Core profile exists to the allowable R4 Resource in the FHIR Standard. | ||
| Multiple profile and extension guidance pages and index pages | Correction of typos, formatting issues and broken and missing links, and minor amendments that do not alter meaning. | ||
| Profile UKCore-Composition | Structure Definition changes: - added in binding to 1 extension; - category element: changed binding to a new UKCore-CompositionCategory ValueSet with a preferred binding strength to reflect it being a suggested set of concepts. Guidance changes: - Example Usage Scenarios: incorrect references to encounter changed to composition and document; - subject element: added in guidance for references to FHIR resources other than Patient; - category element: updated guidance to reflect change of binding; - attester element: provided additional guidance. Examples: - new example illustrating a discharge summary added. |
||
| Profile UKCore-Condition | Structure Definition changes: - added in bindings to 5 extensions; - category element: changed binding to a new UKCore-ConditionCategory ValueSet; - code element: removed slicing and moved binding to UKCore-ConditionCode ValueSet from the slice to this element; - bodySite element: removed slicing and moved binding to UKCore-BodySite ValueSet from the slice to this element. Guidance changes: - added in pages for each of the 4 new extensions; - verificationStatus element: provided strong guidance to highlight potential clinical risks associated with some of the values in the FHIR Standard required ConditionVerificationStatus ValueSet associated with this element; - bodySite element: added in guidance relating to the use of the UKCore-BodySite ValueSet; - category element: updated guidance to reflect change of binding; - subject element: added in guidance to the Group FHIR resource. |
||
| Profile UKCore-Encounter | Structure Definition changes: - added in bindings to 5 extensions; - type element: removed slicing and moved binding to UKCore-EncounterType ValueSet from the slice to this element; - serviceType element: changed binding to a new UKCore-CareSettingType ValueSet; - hospitalization.admitSource element: changed binding strength from extensible to preferred to reflect the important note on the ValueSets and CodeSystem page relating to ValueSets containing CodeSystems specific to individual UK countries; - hospitalization.reAdmission element: removed redundant slicing (there being no specific binding to a UKCore ValueSet); - hospitalization.dischargeDisposition element: changed binding strength from extensible to preferred to reflect the important note on the ValueSets and CodeSystem page relating to ValueSets containing CodeSystems specific to individual UK countries; - location.physicalType element: changed binding to a new UKCore-EncounterLocationType ValueSet, with a preferred binding strength to reflect the important note on the ValueSets and CodeSystem page relating to ValueSets containing CodeSystems specific to individual UK countries. Guidance changes: - removed guidance page for the UKCore-EncounterTransport extension as there was no identified use case for this extension; - type element: removed reference to using other ValueSets and the slice being open; - subject element: added in guidance to the Group FHIR resource. Examples: - UKCore-Encounter-InpatientEncounter has two added extensions incorporated and the CodeSystem reference for DischargeDestination updated in line with changes associated with the ValueSet for this data |
||
| Profile UKCore-EpisodeOfCare | Guidance changes: - added in a section describing the relationship between EpisodeOfCare and Encounter. |
||
| Profile UKCore-List | Structure Definition changes: - added in bindings to 3 extensions. Guidance changes: - changed guidance page for the clinicalSetting extension to the careSettingType extension; - identifier element: incorrect reference to EpisodeOfCare changed to List; - subject element: added in guidance for references to FHIR resources other than Patient; - emptyReason element: added in guidance relating to the use of the UKCore-ListEmptyReasonCode ValueSet. |
||
| Profile UKCore-MessageHeader | Structure Definition changes: - added in a binding to 1 extension; - event[x] element: reinstated the eventUri choice. Guidance changes: - added in a section relating to extending the MessageHeader resource; - destination element: added in guidance on some of the component elements of destination; - source element: added in guidance on the component elements of source. Examples: - new example illustrating the message header for a discharge summary added. |
||
| Profile UKCore-OperationOutcome | Structure Definition changes: - issue.details element: changed binding to a new UKCore-OperationOutcomeIssueDetails ValueSet with a preferred binding strength to reflect it being a suggested set of concepts. Guidance changes: - issue.details element: updated guidance to reflect change of binding. |
||
| Profile UKCore-Patient | Examples: - UKCore-Patient-BabyPatient has changes associated with EthnicCategory - UKCore-Patient-RichardSmith has changes associated with EthnicCategory and PreferredContactTimes |
||
| Profile UKCore-Procedure | Structure Definition changes: - added in a binding to 1 extension; - code element: removed slicing and moved binding to UKCore-ProcedureCode ValueSet from the slice to this element; - bodySite element: removed slicing and moved binding to UKCore-BodySite ValueSet from the slice to this element; - complication element: removed slicing and moved binding to UKCore-ConditionCode ValueSet from the slice to this element. Guidance changes: - status element: provided strong guidance to highlight that this element is a modifier because it contains codes that mark the resource as not currently valid and that the code element must not be processed in isolation but implementers must also process the status and statusReason elements as they may modify the context of the procedure code information; - performer element: added in guidance on some of the component elements of performer; - bodySite element: added in guidance relating to the use of the UKCore-BodySite ValueSet. |
||
| Profile UKCore-RelatedPerson | Examples: - UKCore-RelatedPerson-JoySmith has changes associated with PreferredContactTimes |
||
| Extension Library page | - Additional entries included for new UK Core and additional HL7 Common Extensions (details of the specific added Extensions are listed below). - Extensions from Sprints 1-3 given a maturity level of 5. |
||
| Extension UKCore-ActualProblem | New extension, based on the Care Connect Actual Problem extension, with a context of use of the UKCore-Condition profile. | ||
| Extension UKCore-AdmissionMethod | Structure Definition changes: - value[x] element: changed binding strength from extensible to preferred to reflect the important note on the ValueSets and CodeSystem page relating to ValueSets containing CodeSystems specific to individual UK countries. Example added. |
||
| Extension UKCore-AnaestheticIssues | Example added. | ||
| Extension UKCore-CareSettingType | Existing extension context of use updated to also include the UKCore-List profile. Description amended to reflect the additional context of use. | ||
| Extension UKCore-ClinicalSetting | Existing extension status changed to retired as it effectively duplicated the UKCore-CareSettingType extension. | ||
| Extension UKCore-CodingSCTDescId | Example amended to provide correct context for the extension content. | ||
| Extension UKCore-ConditionEpisode | Example added. | ||
| Extension UKCore-ContactPreference | Example amended to align with changes to the datatype for PreferredContactTimes. | ||
| Extension UKCore-DischargeMethod | Structure Definition changes: - value[x] element: changed binding strength from extensible to preferred to reflect the important note on the ValueSets and CodeSystem page relating to ValueSets containing CodeSystems specific to individual UK countries. Example added. |
||
| Extension UKCore-EmergencyCareDischargeStatus | Structure Definition changes: - value[x] element: changed binding strength from extensible to preferred to reflect the important note on the ValueSets and CodeSystem page relating to ValueSets containing CodeSystems specific to individual UK countries. |
||
| Extension UKCore-EncounterTransport | Existing extension status changed to retired as there was no identified use case for this extension. | ||
| Extension UKCore-EthnicCategory | Structure Definition changes: - value[x] element: changed binding strength from extensible to preferred to reflect the important note on the ValueSets and CodeSystem page relating to ValueSets containing CodeSystems specific to individual UK countries. |
||
| Extension UKCore-Evidence | Existing extension status corrected to active. No other changes made. | ||
| Extension UKCore-LegalStatus | New extension to support legal status on admission and legal status on discharge, with a context of use of the UKCore-Encounter profile. | ||
| Extension UKCore-ListWarningCode | Example added. | ||
| Extension UKCore-MessageHeaderInstruction | New extension to support a specific instruction for receivers of the message, with a context of use of the UKCore-MessageHeader profile. | ||
| Extension UKCore-OutcomeOfAttendance | Structure Definition changes: - value[x] element: changed binding strength from extensible to preferred to reflect the important note on the ValueSets and CodeSystem page relating to ValueSets containing CodeSystems specific to individual UK countries. Guidance changes: - page description: removed the word "Consultant" at the end. Example added. |
||
| Extension UKCore-RelatedClinicalContent | New extension, based on the Care Connect Related Clinical Content extension, with a context of use of the UKCore-Condition profile. | ||
| Extension UKCore-RelatedProblemHeader | New extension, based on the Care Connect Related Problem Header extension, with a context of use of the UKCore-Condition and UKCore-List profiles. | ||
| Common Extension-messageheader-response-request | Newly listed extension, with a context of use of the UKCore-MessageHeader profile. | ||
| ValueSet and CodeSystems page | - Reformatted the table to make it easier to read. - Additional entries included for new ValueSets (details of the specific added ValueSets are listed below). - ValueSets from Sprints 1-3 given a maturity level of 5. - Important note regarding use of SNOMED CT and the binding strength of extensible added in. - Important note regarding the use of the "preferred" binding strength for UK Core ValueSets containing CodeSystems specific to individual UK countries added in. - Miscellaneous corrections also made. |
||
| All Sprint 4 ValueSets | The description for each Sprint 4 ValueSet has been modified to align with the wording approach used for ValueSets in Sprints 1 to 3. | ||
| All Sprint 4 ValueSets | An expansion is provided for each Sprint 4 ValueSet where concepts are specified within the constituent CodeSystem(s). | ||
| All Sprint 4 ValueSets which use SNOMED CT | The Content Logical Definition for each Sprint 4 ValueSet which makes use of SNOMED CT has been modified to align with the approach used for ValueSets using SNOMED CT in Sprints 1 to 3. All SNOMED is encapsulated within the Content Logical Definition using SNOMED Expression Constraint Language (ECL) in a single statement in the value element, together with a property element value of "constraint" and an op element value of "=". The ECL informative long syntax rather than the normative brief syntax is used to identify a hierarchy or reference set. Concept display values are not included in the ECL statement. | ||
| ValueSet UKCore-AdmissionMethod | Existing ValueSet modified to replace the single existing NHSDataModelAndDictionaryAdmissionMethod Codesystem in the Content Logical Definition with two UK Core CodeSystems. Bound in the UKCore-AdmissionMethod extension. | ||
| ValueSet UKCore-CompositionCategory | New ValueSet, bound in the UKCore-Composition profile. | ||
| ValueSet UKCore-ConditionCategory | Existing ValueSet modified to include concepts from the FHIR standard condition-category CodeSystem and a new UKCoreConditionCategory CodeSystem. Bound in the UKCore-Condition profile. | ||
| ValueSet UKCore-ConditionRelationship | New ValueSet, bound in the UKCore-RelatedProblemHeader extension. | ||
| ValueSet UKCore-DischargeDestination | Existing ValueSet modified to replace the single existing NHSDataModelAndDictionaryDischargeDestination Codesystem in the Content Logical Definition with two UK Core CodeSystems. Bound in the UKCore-Encounter profile. | ||
| ValueSet UKCore-DischargeMethod | Existing ValueSet modified to replace the single existing NHSDataModelAndDictionaryDischargeMethod Codesystem in the Content Logical Definition with two UK Core CodeSystems. Bound in the UKCore-DischargeMethod extension. | ||
| ValueSet UKCore-EmergencyCareDischargeStatus | Existing ValueSet modified to add in a UK Core Codesystem into the Content Logical Definition. Bound in the UKCore-EmergencyCareDischargeStatus extension. | ||
| ValueSet UKCore-EncounterLocationType | New ValueSet, bound in the UKCore-Encounter profile. | ||
| ValueSet UKCore-LegalStatusClassification | New ValueSet, bound in the UKCore-LegalStatus extension. | ||
| ValueSet UKCore-LegalStatusContext | New ValueSet, bound in the UKCore-LegalStatus extension. | ||
| ValueSet UKCore-ListEmptyReasonCode | Existing ValueSet modified to include concepts from the FHIR standard List Empty Reasons CodeSystem. Bound in the UKCore-List profile. | ||
| ValueSet UKCore-MessageEvent | Existing ValueSet modified to remove the single existing SNOMED CT concept and be composed of a single UK Core CodeSystem. Bound in the UKCore-MessageHeader profile. | ||
| ValueSet UKCore-MessageHeaderInstruction | New ValueSet, bound in the UKCore-MessageHeaderInstruction extension. | ||
| ValueSet UKCore-OperationOutcomeIssueDetails | New ValueSet, bound in the UKCore-OperationOutcome profile. | ||
| ValueSet UKCore-OutcomeOfAttendance | Existing ValueSet modified to replace the single existing NHSDataModelAndDictionaryOutcomeofAttendance Codesystem in the Content Logical Definition with two UK Core CodeSystems. Bound in the UKCore-OutcomeofAttendance extension. Also removed the word "Consultant" at the end of the ValueSet description. | ||
| ValueSet UKCore-ProblemSignificance | New ValueSet, bound in the UKCore-ProblemSignificance extension. | ||
| ValueSet UKCore-SourceOfAdmission | Existing ValueSet modified to replace the single existing NHSDataModelAndDictionarySourceOfAdmission Codesystem in the Content Logical Definition with two UK Core CodeSystems. Bound in the UKCore-Encounter profile. | ||
| CodeSystem NHSDataModelandDictionary-AdmissionMethod | Existing CodeSystem retired and replaced by a similar CodeSystem UKCore-AdmissionMethodEngland. | ||
| CodeSystem NHSDataModelandDictionary-DischargeDestination | Existing CodeSystem retired and replaced by a similar CodeSystem UKCore-DischargeDestinationEngland. | ||
| CodeSystem NHSDataModelandDictionary-DischargeMethod | Existing CodeSystem retired and replaced by a similar CodeSystem UKCore-DischargeMethodEngland. | ||
| CodeSystem NHSDataModelandDictionary-OutcomeofAttendance | Existing CodeSystem retired and replaced by a similar CodeSystem UKCore-OutcomeofAttendanceEngland. | ||
| CodeSystem NHSDataModelandDictionary-SourceOfAdmission | Existing CodeSystem retired and replaced by a similar CodeSystem UKCore-SourceOfAdmissionEngland. | ||
| CodeSystem UKCore-AdmissionMethodEngland | New CodeSystem, to replace NHSDataModelandDictionary-AdmissionMethod. | ||
| CodeSystem UKCore-AdmissionMethodWales | New CodeSystem, derived from the NHS Wales Data Dictionary Admission Method data element. | ||
| CodeSystem UKCore-ConditionCategory | New CodeSystem, consisting of concepts from the Care Connect Condition Category CodeSystem not contained in the FHIR standard condition-category CodeSystem. | ||
| CodeSystem UKCore-ConditionRelationship | New CodeSystem, based on the Care Connect Condition Relationship CodeSystem. | ||
| CodeSystem UKCore-DischargeDestinationEngland | New CodeSystem, to replace NHSDataModelandDictionary-DischargeDestination. | ||
| CodeSystem UKCore-DischargeDestinationWales | New CodeSystem, derived from the NHS Wales Data Dictionary Discharge Destination data element. | ||
| CodeSystem UKCore-DischargeMethodEngland | New CodeSystem, to replace NHSDataModelandDictionary-DischargeDestination. | ||
| CodeSystem UKCore-DischargeMethodWales | New CodeSystem, derived from the NHS Wales Data Dictionary Discharge Method data element. | ||
| CodeSystem UKCore-EncounterLocationTypeEngland | New CodeSystem, derived from the NHS Data Dictionary Activity Location Type Code data element. | ||
| CodeSystem UKCore-EncounterLocationTypeWales | New CodeSystem, derived from the NHS Wales Data Dictionary Location Type Code data element. | ||
| CodeSystem UKCore-EPSIssueCode | New CodeSystem, derived from NHS Digital defined EPS Issue Codes. | ||
| CodeSystem UKCore-ITKResponseCode | New CodeSystem, derived from NHS Digital defined ITK Response Codes. | ||
| CodeSystem UKCore-LegalStatusClassificationEngland | New CodeSystem, derived from the NHS Data Dictionary Mental Health Act Legal Status Classification Code data element. | ||
| CodeSystem UKCore-LegalStatusClassificationWales | New CodeSystem, derived from the NHS Wales Data Dictionary Legal Status data element. | ||
| CodeSystem UKCore-LegalStatusContext | New CodeSystem, providing a context for the legal status classification (admission or discharge). | ||
| CodeSystem UKCore-MessageHeaderInstruction | New CodeSystem, intending to provide a specific instruction for a receiver of a message (currently no UK Core set of codes are specified). | ||
| CodeSystem UKCore-OutcomeOfAttendanceEngland | New CodeSystem, to replace NHSDataModelandDictionary-OutcomeOfAttendance. | ||
| CodeSystem UKCore-OutcomeOfAttendanceWales | New CodeSystem, derived from the NHS Wales Data Dictionary Outcome Of Attendance data element. | ||
| CodeSystem UKCore-ProblemSignificance | New CodeSystem, based on the Care Connect Problem Significance CodeSystem. | ||
| CodeSystem UKCore-SourceOfAdmissionEngland | New CodeSystem, to replace NHSDataModelandDictionary-SourceOfAdmission. | ||
| CodeSystem UKCore-SourceOfAdmissionWales | New CodeSystem, derived from the NHS Wales Data Dictionary Source Of Admission data element. | ||
| CodeSystem UKCore-SpineErrorOrWarningCode | New CodeSystem, derived from NHS Digital defined Spine Error Or Warning Codes. | ||
| Examples index page | - New profile example added: UKCore-Composition-Discharge - New profile example added: UKCore-MessageHeader-Discharge - New common extension example added: MessageHeaderResponseRequest - New extension example added: UKCore-Condition-Extension-ActualProblem - New extension example added: UKCore-Condition-Extension-ConditionEpisode - New extension example added: UKCore-Condition-Extension-ProblemSignificance - New extension example added: UKCore-Condition-Extension-RelatedClinicalContent - New extension example added: UKCore-Condition-Extension-RelatedProblemHeader - New extension example added: UKCore-Encounter-AdmissionMethod - New extension example added: UKCore-Encounter-DischargeMethod - New extension example added: UKCore-Encounter-EmergencyCareDischargeStatus - New extension example added: UKCore-Encounter-Extension-LegalStatus - New extension example added: UKCore-Encounter-Extension-OutcomeOfAttendance - New extension example added: UKCore-List-Extension-ListWarningCode - New extension example added: UKCore-MessageHeader-Extension-MessageHeaderInstruction - New extension example added: UKCore-Procedure-Extension-AnaestheticIssues - Existing profile example updated: UKCore-Encounter-InpatientEncounter has two added extensions incorporated and the CodeSystem reference for DischargeDestination updated in line with changes associated with the ValueSet for this data - Existing profile example updated: UKCore-Patient-BabyPatient has changes associated with EthnicCategory - Existing profile example updated: UKCore-Patient-RichardSmith has changes associated with EthnicCategory and PreferredContactTimes - Existing extension example updated: UKCore-Patient-ContactPreferences has changes associated with PreferredContactTimes - Existing extension example renamed: UKCore-Composition-Extension-CareSettingType (was UKCore-Extension-Composition-CareSettingType) - Existing extension example renamed: patientInterpreterRequired (was UKCore-InterpreterRequired but this is a FHIR standard common extension) - Existing profile example removed: UKCore-AllergyList (a duplicate of UKCore-Bundle-BundledAllergyList) - Existing profile example removed: UKCore-ContactPreference (a duplicate of UKCore-Patient-ContactPreference) - Existing profile example removed: UKCore-CopyCorrespondenceIndicator (a duplicate of UKCore-Patient-CopyCorrespondenceIndicator) - Existing profile example removed: UKCore-Extension-Patient-AddressKey (a duplicate of UKCore-Patient-AddressKey) - Existing profile example removed: UKCore-Extension-Organization-MainLocation (a duplicate of UKCore-Organization-MainLocation) - Existing profile example removed: UKCore-Patient-ContactRank (to remove one of two instances of the same example with the same name) |
||
| 11th October 2021 | 0.2.0 | 4.0.1 | UK Core Implementation Guide 0.2.0 - STU1 - Version of the UK Core Implementation Guide from Sprint 4 of Clinical and Technical Assurance |
| Changes for this version
Added the Profiles and associated FHIR assets required for Sprint 4 of C&TA
|
|||
| 10th September 2021 | 0.1.0 | 4.0.1 | UK Core Implementation Guide 0.1.0 - First release of UK Core STU1 sequence, contains the content from Clinical and Technical Assurance |
Changes for this version
|
|||