StructureDefinition Extension-UKCore-NHSNumberVerificationStatus

Canonical_URLDescriptionProfile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus

Information describing the verification and tracing status of a patient's NHS Number.

This extension extends the identifier element of the Patient resource to support the exchange of information on the verification of a Patient's NHS number.

Context of Use Patient.identifier

Tree View

url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept

Table View

Extension..
Extension.url..
Extension.value[x]CodeableConcept1..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-NHSNumberVerificationStatus" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus" />
    <version value="2.1.0" />
    <name value="ExtensionUKCoreNHSNumberVerificationStatus" />
    <title value="Extension 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="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="Information describing the verification and tracing status of a patient&#39;s NHS Number." />
    <purpose value="This extension extends the identifier element of the Patient resource to support the exchange of information on the verification of a Patient&#39;s 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." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <kind value="complex-type" />
    <abstract value="false" />
    <context>
        <type value="element" />
        <expression value="Patient.identifier" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="NHS number verification status" />
            <definition value="The verification/tracing status of the NHS number." />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="Verification status of the NHS number" />
            <definition value="Verification status of the NHS number." />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
            <binding>
                <strength value="required" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-NHSNumberVerificationStatus",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus",
    "version": "2.1.0",
    "name": "ExtensionUKCoreNHSNumberVerificationStatus",
    "title": "Extension UK Core NHS Number Verification Status",
    "status": "active",
    "date": "2021-09-10",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "Information describing the verification and tracing status of a patient's NHS Number.",
    "purpose": "This extension extends the identifier element of the Patient resource to support the exchange of information on the verification of a Patient's 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.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        }
    ],
    "kind": "complex-type",
    "abstract": false,
    "context":  [
        {
            "type": "element",
            "expression": "Patient.identifier"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "NHS number verification status",
                "definition": "The verification/tracing status of the NHS number."
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "Verification status of the NHS number",
                "definition": "Verification status of the NHS number.",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus"
                }
            }
        ]
    }
}

Examples

NHS Number Verification Status- An example of the extension which states the patient's NHS number verification status.
Example UKCore-Extension-NHSNumberVerificationStatus

Extension Specific Guidance

There is a binding within this extension to a ValueSet UKCore-NHSNumberVerificationStatus.