UK Core Implementation Guide 0.4.0 - STU1

UK Core NHS Number Verification Status

HTML View

Filters

CodeDescriptionOperatorValue
ApplicableCountryFilter to identify an applicable country for a conceptEqualApplicableCountry

This code system https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus defines the following codes:

CodeDisplayApplicableCountry
number-present-and-verifiedNumber present and verifiedEngland
number-present-but-not-tracedNumber present but not tracedEngland
trace-requiredTrace requiredEngland
trace-attemptedTrace attempted - No match or multiple match foundEngland
trace-needs-to-be-resolvedTrace needs to be resolved - (NHS number or patient detail conflict)England
trace-in-progressTrace in progressEngland
number-not-present-and-trace-not-requiredNumber not present and trace not requiredEngland
trace-postponedTrace postponed (baby under six weeks old)England
number-present-and-traced-using-welsh-nhs-arNumber present and traced using Welsh NHS ARWales

Properties

CodeURLDescriptionType
ApplicableCountryA UK country where the concept is known to be applicable based on the source information used to construct this CodeSystem as identified within the CodeSystem.identifier fields. In each case this can be one of: England | Scotland | Wales | Northern IrelandString

Table View

CodeSystem.id[0]UKCore-NHSNumberVerificationStatus
CodeSystem.url[0]https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
CodeSystem.version[0]2.1.0
CodeSystem.name[0]UKCoreNHSNumberVerificationStatus
CodeSystem.title[0]UK Core NHS Number Verification Status
CodeSystem.status[0]active
CodeSystem.date[0]2021-09-10
CodeSystem.publisher[0]HL7 UK
CodeSystem.contact[0].name[0]HL7 UK
CodeSystem.contact[0].telecom[0].system[0]email
CodeSystem.contact[0].telecom[0].value[0]secretariat@hl7.org.uk
CodeSystem.contact[0].telecom[0].use[0]work
CodeSystem.contact[0].telecom[0].rank[0]1
CodeSystem.contact[1].name[0]NHS Digital
CodeSystem.contact[1].telecom[0].system[0]email
CodeSystem.contact[1].telecom[0].value[0]interoperabilityteam@nhs.net
CodeSystem.contact[1].telecom[0].use[0]work
CodeSystem.contact[1].telecom[0].rank[0]2
CodeSystem.description[0]A CodeSystem that identifies the trace status of an NHS Number with respect to a national source of NHS Numbers.
CodeSystem.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.
CodeSystem.caseSensitive[0]True
CodeSystem.content[0]complete
CodeSystem.filter[0].code[0]ApplicableCountry
CodeSystem.filter[0].description[0]Filter to identify an applicable country for a concept
CodeSystem.filter[0].operator[0]=
CodeSystem.filter[0].value[0]ApplicableCountry
CodeSystem.property[0].code[0]ApplicableCountry
CodeSystem.property[0].description[0]A UK country where the concept is known to be applicable based on the source information used to construct this CodeSystem as identified within the CodeSystem.identifier fields. In each case this can be one of: England | Scotland | Wales | Northern Ireland
CodeSystem.property[0].type[0]string
CodeSystem.concept[0].code[0]number-present-and-verified
CodeSystem.concept[0].display[0]Number present and verified
CodeSystem.concept[0].property[0].code[0]ApplicableCountry
CodeSystem.concept[0].property[0].valueString[0]England
CodeSystem.concept[0].property[1].code[0]ApplicableCountry
CodeSystem.concept[0].property[1].valueString[0]Wales
CodeSystem.concept[1].code[0]number-present-but-not-traced
CodeSystem.concept[1].display[0]Number present but not traced
CodeSystem.concept[1].property[0].code[0]ApplicableCountry
CodeSystem.concept[1].property[0].valueString[0]England
CodeSystem.concept[1].property[1].code[0]ApplicableCountry
CodeSystem.concept[1].property[1].valueString[0]Wales
CodeSystem.concept[2].code[0]trace-required
CodeSystem.concept[2].display[0]Trace required
CodeSystem.concept[2].property[0].code[0]ApplicableCountry
CodeSystem.concept[2].property[0].valueString[0]England
CodeSystem.concept[2].property[1].code[0]ApplicableCountry
CodeSystem.concept[2].property[1].valueString[0]Wales
CodeSystem.concept[3].code[0]trace-attempted
CodeSystem.concept[3].display[0]Trace attempted - No match or multiple match found
CodeSystem.concept[3].property[0].code[0]ApplicableCountry
CodeSystem.concept[3].property[0].valueString[0]England
CodeSystem.concept[3].property[1].code[0]ApplicableCountry
CodeSystem.concept[3].property[1].valueString[0]Wales
CodeSystem.concept[4].code[0]trace-needs-to-be-resolved
CodeSystem.concept[4].display[0]Trace needs to be resolved - (NHS number or patient detail conflict)
CodeSystem.concept[4].property[0].code[0]ApplicableCountry
CodeSystem.concept[4].property[0].valueString[0]England
CodeSystem.concept[4].property[1].code[0]ApplicableCountry
CodeSystem.concept[4].property[1].valueString[0]Wales
CodeSystem.concept[5].code[0]trace-in-progress
CodeSystem.concept[5].display[0]Trace in progress
CodeSystem.concept[5].property[0].code[0]ApplicableCountry
CodeSystem.concept[5].property[0].valueString[0]England
CodeSystem.concept[5].property[1].code[0]ApplicableCountry
CodeSystem.concept[5].property[1].valueString[0]Wales
CodeSystem.concept[6].code[0]number-not-present-and-trace-not-required
CodeSystem.concept[6].display[0]Number not present and trace not required
CodeSystem.concept[6].property[0].code[0]ApplicableCountry
CodeSystem.concept[6].property[0].valueString[0]England
CodeSystem.concept[6].property[1].code[0]ApplicableCountry
CodeSystem.concept[6].property[1].valueString[0]Wales
CodeSystem.concept[7].code[0]trace-postponed
CodeSystem.concept[7].display[0]Trace postponed (baby under six weeks old)
CodeSystem.concept[7].property[0].code[0]ApplicableCountry
CodeSystem.concept[7].property[0].valueString[0]England
CodeSystem.concept[7].property[1].code[0]ApplicableCountry
CodeSystem.concept[7].property[1].valueString[0]Wales
CodeSystem.concept[8].code[0]number-present-and-traced-using-welsh-nhs-ar
CodeSystem.concept[8].display[0]Number present and traced using Welsh NHS AR
CodeSystem.concept[8].property[0].code[0]ApplicableCountry
CodeSystem.concept[8].property[0].valueString[0]Wales

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="UKCore-NHSNumberVerificationStatus" />
    <url value="https://fhir.hl7.org.uk/CodeSystem/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 CodeSystem that identifies the trace status of an NHS Number with respect to a national source of NHS Numbers." />
    <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." />
    <caseSensitive value="true" />
    <content value="complete" />
    <filter>
        <code value="ApplicableCountry" />
        <description value="Filter to identify an applicable country for a concept" />
        <operator value="=" />
        <value value="ApplicableCountry" />
    </filter>
    <property>
        <code value="ApplicableCountry" />
        <description value="A UK country where the concept is known to be applicable based on the source information used to construct this CodeSystem as identified within the CodeSystem.identifier fields. In each case this can be one of: England | Scotland | Wales | Northern Ireland" />
        <type value="string" />
    </property>
    <concept>
        <code value="number-present-and-verified" />
        <display value="Number present and verified" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="number-present-but-not-traced" />
        <display value="Number present but not traced" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="trace-required" />
        <display value="Trace required" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="trace-attempted" />
        <display value="Trace attempted - No match or multiple match found" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="trace-needs-to-be-resolved" />
        <display value="Trace needs to be resolved - (NHS number or patient detail conflict)" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="trace-in-progress" />
        <display value="Trace in progress" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="number-not-present-and-trace-not-required" />
        <display value="Number not present and trace not required" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="trace-postponed" />
        <display value="Trace postponed (baby under six weeks old)" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="England" />
        </property>
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
    <concept>
        <code value="number-present-and-traced-using-welsh-nhs-ar" />
        <display value="Number present and traced using Welsh NHS AR" />
        <property>
            <code value="ApplicableCountry" />
            <valueString value="Wales" />
        </property>
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "UKCore-NHSNumberVerificationStatus",
    "url": "https://fhir.hl7.org.uk/CodeSystem/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 CodeSystem that identifies the trace status of an NHS Number with respect to a national source of NHS Numbers.",
    "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.",
    "caseSensitive": true,
    "content": "complete",
    "filter":  [
        {
            "code": "ApplicableCountry",
            "description": "Filter to identify an applicable country for a concept",
            "operator":  [
                "="
            ],
            "value": "ApplicableCountry"
        }
    ],
    "property":  [
        {
            "code": "ApplicableCountry",
            "description": "A UK country where the concept is known to be applicable based on the source information used to construct this CodeSystem as identified within the CodeSystem.identifier fields. In each case this can be one of: England | Scotland | Wales | Northern Ireland",
            "type": "string"
        }
    ],
    "concept":  [
        {
            "code": "number-present-and-verified",
            "display": "Number present and verified",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "number-present-but-not-traced",
            "display": "Number present but not traced",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "trace-required",
            "display": "Trace required",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "trace-attempted",
            "display": "Trace attempted - No match or multiple match found",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "trace-needs-to-be-resolved",
            "display": "Trace needs to be resolved - (NHS number or patient detail conflict)",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "trace-in-progress",
            "display": "Trace in progress",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "number-not-present-and-trace-not-required",
            "display": "Number not present and trace not required",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "trace-postponed",
            "display": "Trace postponed (baby under six weeks old)",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "England"
                },
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        },
        {
            "code": "number-present-and-traced-using-welsh-nhs-ar",
            "display": "Number present and traced using Welsh NHS AR",
            "property":  [
                {
                    "code": "ApplicableCountry",
                    "valueString": "Wales"
                }
            ]
        }
    ]
}


back to top