HL7 FHIR® UK Core Design and Development Approach

HL7 FHIR® UK Core Design and Development Approach

Metadata Design

This section describes the approach taken for metadata relating to the resources used within the UK Core.

File Format

All Resources SHALL be in the XML format and stored within GitHub. Snapshots SHALL NOT be used in any assets. All Profiles and Extensions SHALL be created using Firely Forge. The setting for the snapshot component in Forge, SHALL be deselected from the Options menu.

Properties

Filename format The filename SHALL be human readable with a maximum character limit of 64 digits. The physical filename format to be used for these assets is as below, where [DescriptiveName] is in PascalCase:

  • Profile: UKCore-[Resource(-DescriptiveName)].xml where the Parentheses is for derived profiles only
  • Extension: Extension-UKCore-[DescriptiveName].xml
  • ValueSet: ValueSet-UKCore-[DescriptiveName].xml
  • CodeSystem: CodeSystem-UKCore-[DescriptiveName].xml
  • ConceptMap: ConceptMap-UKCore-[DescriptiveName].xml

url property The url format to be used for these assets is as below, where [DescriptiveName] is in PascalCase:

  • Profile: https://fhir.hl7.org.uk/StructureDefinition/UKCore-[Resource(-DescriptiveName)] where the Parentheses is for derived profiles only
  • Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-[DescriptiveName]
  • ValueSets: https://fhir.hl7.org.uk/ValueSet/UKCore-[DescriptiveName]
  • CodeSystems: https://fhir.hl7.org.uk/CodeSystem/UKCore-[DescriptiveName]
  • ConceptMaps: https://fhir.hl7.org.uk/ConceptMap/UKCore-[DescriptiveName]

Common properties

  • id: in Train-Case, where [Resource] and [DescriptiveName] is in PascalCase
    • Profile: UKCore-[Resource(-DescriptiveName) where the Parentheses is for derived profiles only
    • Other assets: UKCore-[DescriptiveName]
  • name: in PascalCase
    • Profile: UKCore[Resource(DescriptiveName) in PascalCase, where the Parentheses is for derived profiles only
    • Other assets: UKCore[DescriptiveName]
  • title: in Proper Case
    • Profile: UK Core [Resource( DescriptiveName) where the Parentheses is for derived profiles only
    • Other Assets: UK Core [Descriptive Name]
  • status: draft – unless stated otherwise

NOTE: The [DescriptiveName], and specifically the id, must not contains any . characters.

NamingSystem.status

The following status values SHALL be used for all assets:

  • draft - Assets in development.
  • active - Assets that have been approved via Clinical and Technical Assurance (C&TA).
  • retired - Assets that are no longer required, after discussion from C&TA or Ballot process.

Note: when the status changes, such as draft to active, or to retired, the date SHALL also be updated. The version number SHALL stay the same, unless other amendments are carried out to the asset. Retired assets SHALL NOT be deleted from GitHub.

Note: draft assets should be created with a version of 0.0.1

Publisher, Contact & Copyright

Publisher

<publisher value="HL7 UK" />

Contact

<contact>
	<name value="HL7 UK" />
	<telecom>
		<system value="email" />
		<value value="ukcore@hl7.org.uk" />
		<use value="work" />
		<rank value="1" />
	</telecom>
</contact>


<copyright value="Copyright &amp;#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &amp;quot;License&amp;quot;); 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 &amp;quot;AS IS&amp;quot; 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&amp;#174; FHIR&amp;#174; standard Copyright &amp;#169; 2011+ HL7 The HL7&amp;#174; FHIR&amp;#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." />

Instance Conformace Identification

For some information flows, there is a requirement to identify which UK Core profile(s) an instance being exchanged between healthcare IT systems conforms to. This could be for the purpose of validation of the instance against the profile definition and/or for conformance testing. This profile conformance is declared using the profile.meta element. The element carries the profile URL appended with the version information.

The format is: 'URL' "|" 'version' For example:

https://fhir.nhs.uk/R4/StructureDefinition/UKCore-RelatedPerson|1.1.0

This is illustrated below:

<RelatedPerson xmlns="http://hl7.org/fhir">
    <id value="RP123" />
    <meta>
        <profile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson|1.1.0" />
    </meta>

see HL7 - Record Versions vs Business Versions vs FHIR Versions

back to top