Metadata Design

This section describes the approach taken for metadata relating to the resources used within the NHS England IG.

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 [Name] is the resource, e.g. Patient:

  • Profile: England-[Name].xml
  • Extension: Extension-England-[Name].xml
  • ValueSet: ValueSet-England-[Name].xml
  • CodeSystem: CodeSystem-England-[Name].xml
  • NamingSystem: NamingSystem-England-[Name].xml
  • Example: England-[Name]-Example.xml

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

  • Profile: https://fhir.nhs.uk/England/StructureDefinition/England-[Name]
  • Extension https://fhir.nhs.uk/England/StructureDefinition/Extension-England-[Name]
  • ValueSet: https://fhir.nhs.uk/England/ValueSet/England-[Name]
  • CodeSystem: https://fhir.nhs.uk/England/CodeSystem/England-[Name]

Common properties

  • id: England-[Name]-[Name] is in PascalCase
  • name: England[Name][Name] is in PascalCase
  • title: England [Name] [Name] is in Proper Case
  • version: Major.Minor.Patch
  • date: YYYY-MM-DD
  • status: draft – or active after C&TA completion

Programme Properties

NHS England Programmes SHALL extend the properties listed above to include [programme concept] - [speciality] as the suffix. The specific programme name should not be included, as assets need to be reusable across different programmes. For instance:

  • Profile: England-[Name]-[programme concept]-[speciality].xml

For example, a project named 'Galleri' requests a screening Observation profile for multi-cancer early detection. The Profile id SHOULD be England-Observation-MCED-Screening. The programme concept being abbreviated due to the 64 digit limit.

Publisher, Contact & Copyright

Publisher

<publisher value="NHS England" />

Contact

<contact>
	<name value="NHS England" />
	<telecom>
		<system value="email" />
		<value value="interoperabilityteam@nhs.net" />
		<use value="work" />
		<rank value="1" />
	</telecom>
</contact>

If additional contact details SHALL be added, then the rank value SHALL be automatically increased by "1". For example now in the above context the rank value is "1" but if additonal contact will be added then the rank value MUST be "2".

<copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \&quot;License\&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 \&quot;AS IS\&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® 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." />