UK Core Implementation Guide STU3 Sequence

Please note:

This version of the UK Core is a development copy.
This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
Please follow the guidance on the Contact Us page if you need any assistance.
A summary of changes is available on the STU3 Sequence Change Log

UK Core NHS Number Unavailable Reason

Important

The CodeSystem UKCore-WithheldIdentityReason has been newly added to this ValueSet

HTML View

ValueSet 'UKCoreNHSNumberUnavailableReason'

Version	1.1.0
Published by	HL7 UK
Status	Active (since 2024-06-14)

A set of codes that define the reason why a patient does not have an NHS Number.

Contact Information

HL7 UK
Email: ukcore@hl7.org.uk

This value set includes codes from the following code systems:

Import all codes from CodeSystem UKCoreNHSNumberUnavailableReason
Import all codes from CodeSystem UKCoreWithheldIdentityReason

Expansion

This expansion was generated on 2023-03-29T15:09:15+00:00

This value set contains 8 concepts

Code	System	Display
nhs-number-not-known	https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason	NHS number not known
overseas-patient	https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason	Overseas patient
devolved-nation	https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason	Devolved nation
01	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason	Record anonymised for legal/statutory reasons
02	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason	Record anonymised at request of Caldicott Guardian
03	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason	Record anonymised at request of Patient
97	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason	Record anonymised for other reason
99	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason	Identity withheld but reason not known

Table View

ValueSet.id[0]	UKCore-NHSNumberUnavailableReason
ValueSet.url[0]	https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberUnavailableReason
ValueSet.version[0]	1.1.0
ValueSet.name[0]	UKCoreNHSNumberUnavailableReason
ValueSet.title[0]	UK Core NHS Number Unavailable Reason
ValueSet.status[0]	active
ValueSet.date[0]	2024-06-14
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]	ukcore@hl7.org.uk
ValueSet.contact[0].telecom[0].use[0]	work
ValueSet.contact[0].telecom[0].rank[0]	1
ValueSet.description[0]	A set of codes that define the reason why a patient does not have an NHS Number.
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-NHSNumberUnavailableReason
ValueSet.compose[0].include[1].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason
ValueSet.expansion[0].identifier[0]	a130430a-9572-4a68-9952-87907c3c2915
ValueSet.expansion[0].timestamp[0]	2023-03-29T15:09:15+00:00
ValueSet.expansion[0].total[0]	8
ValueSet.expansion[0].offset[0]	0
ValueSet.expansion[0].contains[0].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason
ValueSet.expansion[0].contains[0].code[0]	nhs-number-not-known
ValueSet.expansion[0].contains[0].display[0]	NHS number not known
ValueSet.expansion[0].contains[1].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason
ValueSet.expansion[0].contains[1].code[0]	overseas-patient
ValueSet.expansion[0].contains[1].display[0]	Overseas patient
ValueSet.expansion[0].contains[2].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason
ValueSet.expansion[0].contains[2].code[0]	devolved-nation
ValueSet.expansion[0].contains[2].display[0]	Devolved nation
ValueSet.expansion[0].contains[3].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason
ValueSet.expansion[0].contains[3].code[0]	01
ValueSet.expansion[0].contains[3].display[0]	Record anonymised for legal/statutory reasons
ValueSet.expansion[0].contains[4].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason
ValueSet.expansion[0].contains[4].code[0]	02
ValueSet.expansion[0].contains[4].display[0]	Record anonymised at request of Caldicott Guardian
ValueSet.expansion[0].contains[5].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason
ValueSet.expansion[0].contains[5].code[0]	03
ValueSet.expansion[0].contains[5].display[0]	Record anonymised at request of Patient
ValueSet.expansion[0].contains[6].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason
ValueSet.expansion[0].contains[6].code[0]	97
ValueSet.expansion[0].contains[6].display[0]	Record anonymised for other reason
ValueSet.expansion[0].contains[7].system[0]	https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason
ValueSet.expansion[0].contains[7].code[0]	99
ValueSet.expansion[0].contains[7].display[0]	Identity withheld but reason not known

XML View

<ValueSet xmlns="http://hl7.org/fhir">
    <id value="UKCore-NHSNumberUnavailableReason" />
    <url value="https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberUnavailableReason" />
    <version value="1.1.0" />
    <name value="UKCoreNHSNumberUnavailableReason" />
    <title value="UK Core NHS Number Unavailable Reason" />
    <status value="active" />
    <date value="2024-06-14" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="A set of codes that define the reason why a patient does not have an NHS Number." />
    <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-NHSNumberUnavailableReason" />
        </include>
        <include>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason" />
        </include>
    </compose>
    <expansion>
        <identifier value="a130430a-9572-4a68-9952-87907c3c2915" />
        <timestamp value="2023-03-29T15:09:15+00:00" />
        <total value="8" />
        <offset value="0" />
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason" />
            <code value="nhs-number-not-known" />
            <display value="NHS number not known" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason" />
            <code value="overseas-patient" />
            <display value="Overseas patient" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason" />
            <code value="devolved-nation" />
            <display value="Devolved nation" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason" />
            <code value="01" />
            <display value="Record anonymised for legal/statutory reasons" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason" />
            <code value="02" />
            <display value="Record anonymised at request of Caldicott Guardian" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason" />
            <code value="03" />
            <display value="Record anonymised at request of Patient" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason" />
            <code value="97" />
            <display value="Record anonymised for other reason" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason" />
            <code value="99" />
            <display value="Identity withheld but reason not known" />
        </contains>
    </expansion>
</ValueSet>

JSON View

{
    "resourceType": "ValueSet",
    "id": "UKCore-NHSNumberUnavailableReason",
    "url": "https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberUnavailableReason",
    "version": "1.1.0",
    "name": "UKCoreNHSNumberUnavailableReason",
    "title": "UK Core NHS Number Unavailable Reason",
    "status": "active",
    "date": "2024-06-14",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "A set of codes that define the reason why a patient does not have an NHS Number.",
    "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-NHSNumberUnavailableReason"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason"
            }
        ]
    },
    "expansion": {
        "identifier": "a130430a-9572-4a68-9952-87907c3c2915",
        "timestamp": "2023-03-29T15:09:15+00:00",
        "total": 8,
        "offset": 0,
        "contains":  [
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason",
                "code": "nhs-number-not-known",
                "display": "NHS number not known"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason",
                "code": "overseas-patient",
                "display": "Overseas patient"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberUnavailableReason",
                "code": "devolved-nation",
                "display": "Devolved nation"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason",
                "code": "01",
                "display": "Record anonymised for legal/statutory reasons"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason",
                "code": "02",
                "display": "Record anonymised at request of Caldicott Guardian"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason",
                "code": "03",
                "display": "Record anonymised at request of Patient"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason",
                "code": "97",
                "display": "Record anonymised for other reason"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-WithheldIdentityReason",
                "code": "99",
                "display": "Identity withheld but reason not known"
            }
        ]
    }
}

Feedback

Click here to:

Report issue for ValueSet-UKCore-NHSNumberUnavailableReason, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,