UK Core Implementation Guide 0.2.0 - STU1

UK Core NHS Number Verification Status

HTML View

ValueSet 'UKCoreNHSNumberVerificationStatus'

Version2.1.0
Published byHL7 UK
StatusActive (since 2021-09-10)

A set of codes that indicate the trace status of an NHS Number with respect to a national source of NHS Numbers.

Where there is no information about the trace status available, a specific code from the nullFlavor Code System can be used instead to indicate this.

Contact Information

HL7 UK

Email: secretariat@hl7.org.uk

NHS Digital

Email: interoperabilityteam@nhs.net

This value set includes codes from the following code systems:

Expansion

This expansion was generated on 2021-09-09T15:39:30+00:00

This value set contains 10 concepts

CodeSystemDisplay
NIhttp://terminology.hl7.org/CodeSystem/v3-NullFlavorNoInformation
number-not-present-and-trace-not-requiredhttps://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusNumber not present and trace not required
number-present-and-traced-using-welsh-nhs-arhttps://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusNumber present and traced using Welsh NHS AR
number-present-and-verifiedhttps://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusNumber present and verified
number-present-but-not-tracedhttps://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusNumber present but not traced
trace-attemptedhttps://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusTrace attempted - No match or multiple match found
trace-in-progresshttps://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusTrace in progress
trace-needs-to-be-resolvedhttps://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusTrace needs to be resolved - (NHS number or patient detail conflict)
trace-postponedhttps://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusTrace postponed (baby under six weeks old)
trace-requiredhttps://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusTrace required

Table View

ValueSet.id[0]UKCore-NHSNumberVerificationStatus
ValueSet.url[0]https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus
ValueSet.version[0]2.1.0
ValueSet.name[0]UKCoreNHSNumberVerificationStatus
ValueSet.title[0]UK Core NHS Number Verification Status
ValueSet.status[0]active
ValueSet.date[0]2021-09-10
ValueSet.publisher[0]HL7 UK
ValueSet.contact[0].name[0]HL7 UK
ValueSet.contact[0].telecom[0].system[0]email
ValueSet.contact[0].telecom[0].value[0]secretariat@hl7.org.uk
ValueSet.contact[0].telecom[0].use[0]work
ValueSet.contact[0].telecom[0].rank[0]1
ValueSet.contact[1].name[0]NHS Digital
ValueSet.contact[1].telecom[0].system[0]email
ValueSet.contact[1].telecom[0].value[0]interoperabilityteam@nhs.net
ValueSet.contact[1].telecom[0].use[0]work
ValueSet.contact[1].telecom[0].rank[0]2
ValueSet.description[0]A set of codes that indicate the trace status of an NHS Number with respect to a national source of NHS Numbers. Where there is no information about the trace status available, a specific code from the nullFlavor Code System can be used instead to indicate this.
ValueSet.copyright[0]Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); 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 "AS IS" 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.
ValueSet.compose[0].include[0].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.compose[0].include[1].system[0]http://terminology.hl7.org/CodeSystem/v3-NullFlavor
ValueSet.compose[0].include[1].concept[0].code[0]NI
ValueSet.compose[0].include[1].concept[0].display[0]NoInformation
ValueSet.expansion[0].identifier[0]daa45a58-75cf-42a6-ac98-8cbee912c065
ValueSet.expansion[0].timestamp[0]2021-09-09T15:39:30+00:00
ValueSet.expansion[0].total[0]10
ValueSet.expansion[0].offset[0]0
ValueSet.expansion[0].parameter[0].name[0]version
ValueSet.expansion[0].parameter[0].valueUri[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus|2.1.0
ValueSet.expansion[0].parameter[1].name[0]version
ValueSet.expansion[0].parameter[1].valueUri[0]http://terminology.hl7.org/CodeSystem/v3-NullFlavor|2018-08-12
ValueSet.expansion[0].parameter[2].name[0]count
ValueSet.expansion[0].parameter[2].valueInteger[0]2147483647
ValueSet.expansion[0].parameter[3].name[0]offset
ValueSet.expansion[0].parameter[3].valueInteger[0]0
ValueSet.expansion[0].contains[0].system[0]http://terminology.hl7.org/CodeSystem/v3-NullFlavor
ValueSet.expansion[0].contains[0].version[0]2018-08-12
ValueSet.expansion[0].contains[0].code[0]NI
ValueSet.expansion[0].contains[0].display[0]NoInformation
ValueSet.expansion[0].contains[1].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.expansion[0].contains[1].version[0]2.1.0
ValueSet.expansion[0].contains[1].code[0]number-not-present-and-trace-not-required
ValueSet.expansion[0].contains[1].display[0]Number not present and trace not required
ValueSet.expansion[0].contains[2].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.expansion[0].contains[2].version[0]2.1.0
ValueSet.expansion[0].contains[2].code[0]number-present-and-traced-using-welsh-nhs-ar
ValueSet.expansion[0].contains[2].display[0]Number present and traced using Welsh NHS AR
ValueSet.expansion[0].contains[3].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.expansion[0].contains[3].version[0]2.1.0
ValueSet.expansion[0].contains[3].code[0]number-present-and-verified
ValueSet.expansion[0].contains[3].display[0]Number present and verified
ValueSet.expansion[0].contains[4].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.expansion[0].contains[4].version[0]2.1.0
ValueSet.expansion[0].contains[4].code[0]number-present-but-not-traced
ValueSet.expansion[0].contains[4].display[0]Number present but not traced
ValueSet.expansion[0].contains[5].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.expansion[0].contains[5].version[0]2.1.0
ValueSet.expansion[0].contains[5].code[0]trace-attempted
ValueSet.expansion[0].contains[5].display[0]Trace attempted - No match or multiple match found
ValueSet.expansion[0].contains[6].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.expansion[0].contains[6].version[0]2.1.0
ValueSet.expansion[0].contains[6].code[0]trace-in-progress
ValueSet.expansion[0].contains[6].display[0]Trace in progress
ValueSet.expansion[0].contains[7].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.expansion[0].contains[7].version[0]2.1.0
ValueSet.expansion[0].contains[7].code[0]trace-needs-to-be-resolved
ValueSet.expansion[0].contains[7].display[0]Trace needs to be resolved - (NHS number or patient detail conflict)
ValueSet.expansion[0].contains[8].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.expansion[0].contains[8].version[0]2.1.0
ValueSet.expansion[0].contains[8].code[0]trace-postponed
ValueSet.expansion[0].contains[8].display[0]Trace postponed (baby under six weeks old)
ValueSet.expansion[0].contains[9].system[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
ValueSet.expansion[0].contains[9].version[0]2.1.0
ValueSet.expansion[0].contains[9].code[0]trace-required
ValueSet.expansion[0].contains[9].display[0]Trace required

XML View

<ValueSet xmlns="http://hl7.org/fhir">
    <id value="UKCore-NHSNumberVerificationStatus" />
    <url value="https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus" />
    <version value="2.1.0" />
    <name value="UKCoreNHSNumberVerificationStatus" />
    <title value="UK Core NHS Number Verification Status" />
    <status value="active" />
    <date value="2021-09-10" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="A set of codes that indicate the trace status of an NHS Number with respect to a national source of NHS Numbers. \n\n  \n Where there is no information about the trace status available, a specific code from the nullFlavor Code System can be used instead to indicate this." />
    <copyright value="Copyright &#169; 2021+ HL7 UK 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&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#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." />
    <compose>
        <include>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
        </include>
        <include>
            <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor" />
            <concept>
                <code value="NI" />
                <display value="NoInformation" />
            </concept>
        </include>
    </compose>
    <expansion>
        <identifier value="daa45a58-75cf-42a6-ac98-8cbee912c065" />
        <timestamp value="2021-09-09T15:39:30+00:00" />
        <total value="10" />
        <offset value="0" />
        <parameter>
            <name value="version" />
            <valueUri value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus|2.1.0" />
        </parameter>
        <parameter>
            <name value="version" />
            <valueUri value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor|2018-08-12" />
        </parameter>
        <parameter>
            <name value="count" />
            <valueInteger value="2147483647" />
        </parameter>
        <parameter>
            <name value="offset" />
            <valueInteger value="0" />
        </parameter>
        <contains>
            <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor" />
            <version value="2018-08-12" />
            <code value="NI" />
            <display value="NoInformation" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
            <version value="2.1.0" />
            <code value="number-not-present-and-trace-not-required" />
            <display value="Number not present and trace not required" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
            <version value="2.1.0" />
            <code value="number-present-and-traced-using-welsh-nhs-ar" />
            <display value="Number present and traced using Welsh NHS AR" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
            <version value="2.1.0" />
            <code value="number-present-and-verified" />
            <display value="Number present and verified" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
            <version value="2.1.0" />
            <code value="number-present-but-not-traced" />
            <display value="Number present but not traced" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
            <version value="2.1.0" />
            <code value="trace-attempted" />
            <display value="Trace attempted - No match or multiple match found" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
            <version value="2.1.0" />
            <code value="trace-in-progress" />
            <display value="Trace in progress" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
            <version value="2.1.0" />
            <code value="trace-needs-to-be-resolved" />
            <display value="Trace needs to be resolved - (NHS number or patient detail conflict)" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
            <version value="2.1.0" />
            <code value="trace-postponed" />
            <display value="Trace postponed (baby under six weeks old)" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus" />
            <version value="2.1.0" />
            <code value="trace-required" />
            <display value="Trace required" />
        </contains>
    </expansion>
</ValueSet>

JSON View

{
    "resourceType": "ValueSet",
    "id": "UKCore-NHSNumberVerificationStatus",
    "url": "https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus",
    "version": "2.1.0",
    "name": "UKCoreNHSNumberVerificationStatus",
    "title": "UK Core NHS Number Verification Status",
    "status": "active",
    "date": "2021-09-10",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "A set of codes that indicate the trace status of an NHS Number with respect to a national source of NHS Numbers. \n\n  \n Where there is no information about the trace status available, a specific code from the nullFlavor Code System can be used instead to indicate this.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); 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 \"AS IS\" 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.",
    "compose": {
        "include":  [
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus"
            },
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
                "concept":  [
                    {
                        "code": "NI",
                        "display": "NoInformation"
                    }
                ]
            }
        ]
    },
    "expansion": {
        "identifier": "daa45a58-75cf-42a6-ac98-8cbee912c065",
        "timestamp": "2021-09-09T15:39:30+00:00",
        "total": 10,
        "offset": 0,
        "parameter":  [
            {
                "name": "version",
                "valueUri": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus|2.1.0"
            },
            {
                "name": "version",
                "valueUri": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor|2018-08-12"
            },
            {
                "name": "count",
                "valueInteger": 2147483647
            },
            {
                "name": "offset",
                "valueInteger": 0
            }
        ],
        "contains":  [
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
                "version": "2018-08-12",
                "code": "NI",
                "display": "NoInformation"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus",
                "version": "2.1.0",
                "code": "number-not-present-and-trace-not-required",
                "display": "Number not present and trace not required"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus",
                "version": "2.1.0",
                "code": "number-present-and-traced-using-welsh-nhs-ar",
                "display": "Number present and traced using Welsh NHS AR"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus",
                "version": "2.1.0",
                "code": "number-present-and-verified",
                "display": "Number present and verified"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus",
                "version": "2.1.0",
                "code": "number-present-but-not-traced",
                "display": "Number present but not traced"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus",
                "version": "2.1.0",
                "code": "trace-attempted",
                "display": "Trace attempted - No match or multiple match found"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus",
                "version": "2.1.0",
                "code": "trace-in-progress",
                "display": "Trace in progress"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus",
                "version": "2.1.0",
                "code": "trace-needs-to-be-resolved",
                "display": "Trace needs to be resolved - (NHS number or patient detail conflict)"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus",
                "version": "2.1.0",
                "code": "trace-postponed",
                "display": "Trace postponed (baby under six weeks old)"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus",
                "version": "2.1.0",
                "code": "trace-required",
                "display": "Trace required"
            }
        ]
    }
}

back to top