Naming Conventions

Naming segments

The naming conventions defined here use the following naming segments:

[base URL]: the base URL is https://fhir.standards.wales/

[ResourceType]: The FHIR resource type e.g. 'CodeSystem', 'ValueSet' or 'ConceptMap'.

[BusinessName]: For CodeSystem and ValueSet, the business name shall reflect the name given to the data set as published in the relevant Data Standards Change Notice (DSCN). For ConceptMap resources, the business name shall reflect the name given to the value set that is being mapped from.

Note that in some cases the HL7 FHIR standard mandates value sets that do not match the equivalent Wales data standards e.g. AdministrativeGender. In this case a concept map is required to map from the HL7 standard to the Welsh standard.

Naming conventions for CodeSystem, ValueSet and ConceptMap resources

The following naming convention applies to FHIR CodeSystem, ConceptMap and ValueSet resources:

The URL of the resource shall be in the form [base URL]/[ResourceType]/[BusinessName] e.g.

  • https://fhir.standards.wales/CodeSystem/Ethnicity
  • https://fhir.standards.wales/ValueSet/GenderIdentity
  • https://fhir.standards.wales/ConceptMap/AdministrativeGender

The logical id of the CodeSystem shall be in the form [ResourceType]-DataStandardsWales-[BusinessName] e.g.

  • CodeSystem-DataStandardsWales-Ethnicity,
  • ValueSystem-DataStandardsWales-MaritalStatus

The name of the resource - specifically the name.value.element - shall be in the form DataStandardsWales[BusinessName] e.g.

  • DataStandardsWalesEthnicity
  • DataStandardsWalesMaritalStatus

The title of the resource shall follow the name.value.element, using title case e.g.

  • Data Standards Wales Ethnicity
  • Data Standards Wales Marital Status

The filename of the CodeSystem shall be in the form [ResourceType]-DataStandardsWales-[BusinessName] e.g.

  • CodeSystem-DataStandardsWales-Ethnicity
  • ConceptMap-DataStandardsWales-AdministrativeGender

Example ConceptMap

An fully populated ConceptMap example is provided below:

  • XML View
  • JSON View
  • Table View
  • Mapping View
Command 'xml' could not render: Project was not found for ConceptMap-DataStandardsWales-AdministrativeGender.
Command 'json' could not render: Project was not found for ConceptMap-DataStandardsWales-AdministrativeGender.
Command 'table' could not render: Project was not found for ConceptMap-DataStandardsWales-AdministrativeGender.
Could not find subject. Project was not found for ConceptMap-DataStandardsWales-AdministrativeGender.