NHSE Design and Development Approach

This guidance is under active development by NHS Digital and content may be added or updated on a regular basis.

Metadata Design

This section describes the approach taken for metadata relating to the resources used within the NHSE 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 in PascalCase:

  • Profile: NHSEngland-[Name].xml
  • Extension: Extension-NHSEngland-[Name].xml
  • ValueSet: ValueSet-NHSEngland-[Name].xml
  • CodeSystem: CodeSystem-NHSEngland-[Name].xml
  • ConceptMap: ConceptMap-NHSEngland-[Name].xml

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

  • Profile: https://fhir.hl7.org.uk/StructureDefinition/NHSEngland-[Name]
  • Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-NHSEngland-[Name]
  • ValueSets: https://fhir.hl7.org.uk/ValueSet/NHSEngland-[Name]
  • CodeSystems: https://fhir.hl7.org.uk/CodeSystem/NHSEngland-[Name]
  • ConceptMaps: https://fhir.hl7.org.uk/ConceptMap/NHSEngland-[Name]

Common properties

  • id: NHSEngland-[Name] - [Name] is in PascalCase
  • name: NHSEngland-[Name] - [Name] is in PascalCase
  • title: NHSEngland-[Name] – [Name] is in Proper Case
  • status: draft – unless stated otherwise

Publisher, Contact & Copyright

Publisher

<publisher value="NHSEngland" />

Contact

<contact>
	<name value="NHSEngland" />
	<telecom>
		<system value="email" />
		<value value="interoperabilityteam@nhs.net" />
		<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." />
back to top