Naming Segments

The naming conventions defined here use the following naming segments:

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

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

[BusinessName]: The business name of the resource. 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.

[Organisation]: NamingSystem resources may be 'owned' by a particular organisation. In this case use initials e.g. ABUHB (Aneurin Bevan University Health Board), VUNHST (Velindre Univerisity NHS Trust) etc. to identify the organisation.

Naming Conventions for Profiles

The following naming convention applies to the FHIR profiles defined in this guide:

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

• DataStandardsWales-Patient,
• DataStandardsWales-DiagnosticReport

The URL of the profile shall be in the form [base URL]/StructureDefinition/DataStandardsWales-[ResourceType] e.g.

• https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Patient
• https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-MedicationStatement

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

• DataStandardsWalesPatient
• DataStandardsWalesMedicationStatement

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

• Profile-DataStandardsWales-Patient
• Profile-DataStandardsWales-MedicationStatement

Naming Conventions for Extensions

The following naming convention applies to the FHIR profiles defined in this guide:

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

• Extension-DataStandardsWales-HospitalClassification,
• Extension-DataStandardsWales-EffectivePeriod

The URL of the extension shall be in the form [base URL]/StructureDefinition/Extension-DataStandardsWales-[BusinessName] e.g.

• https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-HospitalClassification
• https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-EffectivePeriod

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

• Extension-DataStandardsWales-HospitalClassification
• Extension-DataStandardsWales-EffectivePeriod

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

• Extension-DataStandardsWales-HospitalClassification
• Extension-DataStandardsWales-EffectivePeriod

Naming Conventions for Terminology Resources

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

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

• DataStandardsWales-Ethnicity,
• DataStandardsWales-MaritalStatus

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

• https://fhir.nhs.wales/CodeSystem/DataStandardsWales-Ethnicity
• https://fhir.nhs.wales/ValueSet/DataStandardsWales-GenderIdentity
• https://fhir.nhs.wales/ConceptMap/DataStandardsWales-AdministrativeGender

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 resource shall be in the form [ResourceType]-DataStandardsWales-[BusinessName] e.g.

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

Naming Conventions for NamingSystem Resources

The following naming convention applies to FHIR NamingSystem resources:

The logical id of the NamingSystem shall be in the form DataStandardsWales-{[Organisation]}-[BusinessName1]-[BusinessName2] e.g.

• DataStandardsWales-ABUHB-PAS-PatientIdentifier,
• DataStandardsWales-LIMS-identifier

The filename of the NamingSystem shall be in the form NamingSystem-[BusinessName] e.g.

• NamingSystem-ABUHB-pas-identifier
• NamingSystem-LIMS-identifier

Example ConceptMap

An fully populated ConceptMap example is provided below:

<ConceptMap xmlns="http://hl7.org/fhir">
    <id value="DataStandardsWales-AdministrativeGender" />
    <url value="https://fhir.nhs.wales/ConceptMap/DataStandardsWales-AdministrativeGender" />
    <version value="1.0.0" />
    <name value="DataStandardsWalesAdministrativeGender" />
    <title value="Data Standards Wales AdministrativeGender" />
    <status value="active" />
    <date value="2020-09-24T00:00:00+01:00" />
    <publisher value="NHS Wales" />
    <contact>
        <name value="Data Standards" />
        <telecom>
            <system value="email" />
            <value value="data.standards@wales.nhs.uk" />
            <use value="work" />
        </telecom>
    </contact>
    <description value="A Concept Map from HL7 ValueSet Administrative Gender to Data Standards Wales Gender Identity code to aid interpretation." />
    <copyright value="&#169; 2020 NHS Wales." />
    <sourceUri value="http://hl7.org/fhir/ValueSet/administrative-gender" />
    <targetUri value="https://fhir.nhs.wales/ValueSet/GenderIdentity" />
    <group>
        <source value="http://hl7.org/fhir/administrative-gender" />
        <target value="https://fhir.nhs.wales/CodeSystem/GenderIdentity" />
        <element>
            <code value="male" />
            <display value="Male" />
            <target>
                <code value="M" />
                <display value="Male" />
                <equivalence value="equivalent" />
            </target>
        </element>
        <element>
            <code value="female" />
            <display value="Female" />
            <target>
                <code value="F" />
                <display value="Female" />
                <equivalence value="equivalent" />
            </target>
        </element>
        <element>
            <code value="other" />
            <display value="Other" />
            <target>
                <code value="N" />
                <display value="Non-binary" />
                <equivalence value="inexact" />
                <comment value="This mapping is inexact. Implementers should be careful when using these mappings operationally" />
            </target>
        </element>
        <element>
            <code value="unknown" />
            <display value="Unknown" />
            <target>
                <code value="Z" />
                <display value="Not disclosed or unknown, e.g. for unborn baby" />
                <equivalence value="equivalent" />
            </target>
        </element>
    </group>
</ConceptMap>

{
    "resourceType": "ConceptMap",
    "id": "DataStandardsWales-AdministrativeGender",
    "url": "https://fhir.nhs.wales/ConceptMap/DataStandardsWales-AdministrativeGender",
    "version": "1.0.0",
    "name": "DataStandardsWalesAdministrativeGender",
    "title": "Data Standards Wales AdministrativeGender",
    "status": "active",
    "date": "2020-09-24T00:00:00+01:00",
    "publisher": "NHS Wales",
    "contact":  [
        {
            "name": "Data Standards",
            "telecom":  [
                {
                    "system": "email",
                    "value": "data.standards@wales.nhs.uk",
                    "use": "work"
                }
            ]
        }
    ],
    "description": "A Concept Map from HL7 ValueSet Administrative Gender to Data Standards Wales Gender Identity code to aid interpretation.",
    "copyright": "© 2020 NHS Wales.",
    "sourceUri": "http://hl7.org/fhir/ValueSet/administrative-gender",
    "targetUri": "https://fhir.nhs.wales/ValueSet/GenderIdentity",
    "group":  [
        {
            "source": "http://hl7.org/fhir/administrative-gender",
            "target": "https://fhir.nhs.wales/CodeSystem/GenderIdentity",
            "element":  [
                {
                    "code": "male",
                    "display": "Male",
                    "target":  [
                        {
                            "code": "M",
                            "display": "Male",
                            "equivalence": "equivalent"
                        }
                    ]
                },
                {
                    "code": "female",
                    "display": "Female",
                    "target":  [
                        {
                            "code": "F",
                            "display": "Female",
                            "equivalence": "equivalent"
                        }
                    ]
                },
                {
                    "code": "other",
                    "display": "Other",
                    "target":  [
                        {
                            "code": "N",
                            "display": "Non-binary",
                            "equivalence": "inexact",
                            "comment": "This mapping is inexact. Implementers should be careful when using these mappings operationally"
                        }
                    ]
                },
                {
                    "code": "unknown",
                    "display": "Unknown",
                    "target":  [
                        {
                            "code": "Z",
                            "display": "Not disclosed or unknown, e.g. for unborn baby",
                            "equivalence": "equivalent"
                        }
                    ]
                }
            ]
        }
    ]
}