UK Core Implementation Guide STU3 Sequence

Please note:

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

StructureDefinition

Context of Use

Canonical_URL	Status	Current_Version	Last_Updated	Description	Profile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure	active	2.2.0	2022-12-16	This describes the immunization procedure code.	This extension extends the Immunization resource to support the exchange of an immunization procedure code.

Tree View

ExtensionUKCoreVaccinationProcedure (Extension)	C		Extension	Element id Extension Short description An extension to hold an immunization procedure code Definition An extension to hold an immunization procedure code. Data type Extension Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	C	0..*	Extension	There are no (further) constraints on this element Element id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure Mappings rim: N/A
value[x]		1..1	Binding	Element id Extension.value[x] Short description A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure Definition A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure. Binding UKCoreVaccinationProcedure (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valueCodeableConcept			CodeableConcept	Data type CodeableConcept

Detailed Descriptions

Extension
Short	An extension to hold an immunization procedure code
Definition	An extension to hold an immunization procedure code.
Cardinality	0..1
Conditions	The cardinality or value of this element may be affected by these constraints: ele-1
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a rim: N/A
Extension.id
Short	Unique id for inter-element referencing
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality	0..1
Type	string
Mappings	rim: n/a
Extension.extension
Short	Additional content defined by implementations
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality	0..*
Type	Extension
Alias	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Slicing	Unordered, Open, by url(Value) Extensions are always sliced by (at least) url
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
Mappings	rim: n/a
Extension.url
Short	identifies the meaning of the extension
Definition	Source of the definition for the extension code - a logical name or a URL.
Cardinality	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure
Mappings	rim: N/A
Extension.value[x]
Short	A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure
Definition	A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure.
Cardinality	1..1
Type	CodeableConcept
Binding	UKCoreVaccinationProcedure (preferred)
Constraints	ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
Mappings	rim: N/A

Table View

Extension		..1
Extension.url		..
Extension.value[x]	CodeableConcept	1..

XML View

<id value="Extension-UKCore-VaccinationProcedure" />
<url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" />
<version value="2.2.0" />
<name value="ExtensionUKCoreVaccinationProcedure" />
<title value="Extension UK Core Vaccination Procedure" />
<status value="active" />
<date value="2022-12-16" />
<publisher value="HL7 UK" />
<contact>
<name value="HL7 UK" />
<telecom>
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="This describes the immunization procedure code." />
<purpose value="This extension extends the Immunization resource to support the exchange of an immunization procedure code." />
<copyright value="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." />
<fhirVersion value="4.0.1" />
<mapping>
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="Immunization" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<differential>
<element id="Extension">
<path value="Extension" />
<short value="An extension to hold an immunization procedure code" />
<definition value="An extension to hold an immunization procedure code." />
<max value="1" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<short value="A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure" />
<definition value="A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure." />
<min value="1" />
<type>
<code value="CodeableConcept" />
</type>
<binding>
<strength value="preferred" />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure" />
</binding>
</element>
</differential>

</StructureDefinition>

JSON View

{

"resourceType": "StructureDefinition",
"id": "Extension-UKCore-VaccinationProcedure",
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
"version": "2.2.0",
"name": "ExtensionUKCoreVaccinationProcedure",
"title": "Extension UK Core Vaccination Procedure",
"status": "active",
"date": "2022-12-16",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "This describes the immunization procedure code.",
"purpose": "This extension extends the Immunization resource to support the exchange of an immunization procedure code.",
"copyright": "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.",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Immunization"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "An extension to hold an immunization procedure code",
"definition": "An extension to hold an immunization procedure code.",
"max": "1"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure",
"definition": "A code from the SNOMED Clinical Terminology UK coding system to record a vaccination procedure.",
"min": 1,
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "preferred",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure"
}
}
]
}

}

Examples

Feedback

Click here to:

Examples

Vaccination Procedure - An example to illustrate the extension for a vaccination procedure.
Extension-UKCore-VaccinationProcedure-Example

Covid Vaccination Procedure - An example to illustrate the extension for a vaccination procedure for COVID.
Extension-UKCore-VaccinationProcedure-COVID-Example

Extension Specific Guidance

Whilst there is a binding within this extension to a ValueSet-UKCore-VaccinationProcedure , an additional ValueSet-UKCore-VaccinationProcedureSupplementary is available that essentially extends the UKCore-VaccinationProcedure ValueSet with SNOMED CT concepts that some systems may have used in the past on record entries that may also be relevant to the population of the UKCore-VaccinationProcedure extension within Immunization profile instances.