ValueSet Design

HTML View

ValueSet 'UKCoreAddressKeyType'

A set of codes that define the type of Address Key.

Contact Information

HL7 UK
Email: ukcore@hl7.org.uk

This value set includes codes from the following code systems:

• Import all codes from CodeSystem UKCoreAddressKeyType

Expansion

This expansion was generated on 2021-09-10T07:49:44+00:00

This value set contains 2 concepts

Table View

XML View

<ValueSet xmlns="http://hl7.org/fhir">
    <id value="UKCore-AddressKeyType" />
    <url value="https://fhir.hl7.org.uk/ValueSet/UKCore-AddressKeyType" />
    <version value="2.1.0" />
    <name value="UKCoreAddressKeyType" />
    <title value="UK Core Address Key Type" />
    <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="A set of codes that define the type of Address Key." />
    <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-AddressKeyType" />
        </include>
    </compose>
    <expansion>
        <identifier value="ecf148bc-2e81-4fd0-b411-d54020d64198" />
        <timestamp value="2021-09-10T07:49:44+00:00" />
        <total value="2" />
        <offset value="0" />
        <parameter>
            <name value="version" />
            <valueUri value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType|2.1.0" />
        </parameter>
        <parameter>
            <name value="count" />
            <valueInteger value="2147483647" />
        </parameter>
        <parameter>
            <name value="offset" />
            <valueInteger value="0" />
        </parameter>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" />
            <code value="PAF" />
            <display value="Postcode Address File" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" />
            <code value="UPRN" />
            <display value="Unique Property Reference Number" />
        </contains>
    </expansion>
</ValueSet>

JSON View

{
    "resourceType": "ValueSet",
    "id": "UKCore-AddressKeyType",
    "url": "https://fhir.hl7.org.uk/ValueSet/UKCore-AddressKeyType",
    "version": "2.1.0",
    "name": "UKCoreAddressKeyType",
    "title": "UK Core Address Key Type",
    "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": "A set of codes that define the type of Address Key.",
    "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-AddressKeyType"
            }
        ]
    },
    "expansion": {
        "identifier": "ecf148bc-2e81-4fd0-b411-d54020d64198",
        "timestamp": "2021-09-10T07:49:44+00:00",
        "total": 2,
        "offset": 0,
        "parameter":  [
            {
                "name": "version",
                "valueUri": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType|2.1.0"
            },
            {
                "name": "count",
                "valueInteger": 2147483647
            },
            {
                "name": "offset",
                "valueInteger": 0
            }
        ],
        "contains":  [
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType",
                "code": "PAF",
                "display": "Postcode Address File"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType",
                "code": "UPRN",
                "display": "Unique Property Reference Number"
            }
        ]
    }
}

HTML View

ValueSet 'UKCoreNHSNumberVerificationStatus'

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: ukcore@hl7.org.uk

This value set includes codes from the following code systems:

• Import all codes from CodeSystem UKCoreNHSNumberVerificationStatusEngland
• Import all codes from CodeSystem UKCoreNHSNumberVerificationStatusWales

• The following codes from system: v3.NullFlavor

  Code	Display
  NI	NoInformation

Expansion

This expansion was generated on 2022-10-19T14:08:35+00:00

This value set contains 18 concepts

Table View

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.2.0" />
    <name value="UKCoreNHSNumberVerificationStatus" />
    <title value="UK Core NHS Number Verification Status" />
    <status value="active" />
    <date value="2022-08-26" />
    <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 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-NHSNumberVerificationStatusEngland" />
        </include>
        <include>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
        </include>
        <include>
            <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor" />
            <concept>
                <code value="NI" />
                <display value="NoInformation" />
            </concept>
        </include>
    </compose>
    <expansion>
        <identifier value="0b1f8226-afc8-49e6-a7f7-e945cdb24521" />
        <timestamp value="2022-10-19T14:08:35+00:00" />
        <total value="18" />
        <offset value="0" />
        <parameter>
            <name value="offset" />
            <valueInteger value="0" />
        </parameter>
        <parameter>
            <name value="count" />
            <valueInteger value="1000" />
        </parameter>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
            <version value="1.1.0" />
            <code value="01" />
            <display value="Number present and verified" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
            <version value="1.1.0" />
            <code value="02" />
            <display value="Number present but not traced" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
            <version value="1.1.0" />
            <code value="03" />
            <display value="Trace required" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
            <version value="1.1.0" />
            <code value="04" />
            <display value="Trace attempted - No match or multiple match found" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
            <version value="1.1.0" />
            <code value="05" />
            <display value="Trace needs to be resolved - (NHS number or patient detail conflict)" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
            <version value="1.1.0" />
            <code value="06" />
            <display value="Trace in progress" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
            <version value="1.1.0" />
            <code value="07" />
            <display value="Number not present and trace not required" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland" />
            <version value="1.1.0" />
            <code value="08" />
            <display value="Trace postponed (baby under six weeks old)" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
            <version value="1.1.0" />
            <code value="nn" />
            <display value="Number present and traced using Welsh NHS AR" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
            <version value="1.1.0" />
            <code value="01" />
            <display value="Number present &amp; traced" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
            <version value="1.1.0" />
            <code value="02" />
            <display value="Number present but not traced" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
            <version value="1.1.0" />
            <code value="03" />
            <display value="Trace required" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
            <version value="1.1.0" />
            <code value="04" />
            <display value="Trace attempted – no match or multiple match found" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
            <version value="1.1.0" />
            <code value="05" />
            <display value="Trace needs to be resolved (NHS number or patient detail conflict)" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
            <version value="1.1.0" />
            <code value="06" />
            <display value="Trace in progress" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
            <version value="1.1.0" />
            <code value="07" />
            <display value="Number not present and trace not required" />
        </contains>
        <contains>
            <system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales" />
            <version value="1.1.0" />
            <code value="08" />
            <display value="Trace postponed (baby under six weeks old)" />
        </contains>
        <contains>
            <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor" />
            <version value="2018-08-12" />
            <code value="NI" />
            <display value="NoInformation" />
        </contains>
    </expansion>
</ValueSet>

JSON View

{
    "resourceType": "ValueSet",
    "id": "UKCore-NHSNumberVerificationStatus",
    "url": "https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus",
    "version": "2.2.0",
    "name": "UKCoreNHSNumberVerificationStatus",
    "title": "UK Core NHS Number Verification Status",
    "status": "active",
    "date": "2022-08-26",
    "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 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-NHSNumberVerificationStatusEngland"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales"
            },
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
                "concept":  [
                    {
                        "code": "NI",
                        "display": "NoInformation"
                    }
                ]
            }
        ]
    },
    "expansion": {
        "identifier": "0b1f8226-afc8-49e6-a7f7-e945cdb24521",
        "timestamp": "2022-10-19T14:08:35+00:00",
        "total": 18,
        "offset": 0,
        "parameter":  [
            {
                "name": "offset",
                "valueInteger": 0
            },
            {
                "name": "count",
                "valueInteger": 1000
            }
        ],
        "contains":  [
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                "version": "1.1.0",
                "code": "01",
                "display": "Number present and verified"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                "version": "1.1.0",
                "code": "02",
                "display": "Number present but not traced"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                "version": "1.1.0",
                "code": "03",
                "display": "Trace required"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                "version": "1.1.0",
                "code": "04",
                "display": "Trace attempted - No match or multiple match found"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                "version": "1.1.0",
                "code": "05",
                "display": "Trace needs to be resolved - (NHS number or patient detail conflict)"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                "version": "1.1.0",
                "code": "06",
                "display": "Trace in progress"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                "version": "1.1.0",
                "code": "07",
                "display": "Number not present and trace not required"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland",
                "version": "1.1.0",
                "code": "08",
                "display": "Trace postponed (baby under six weeks old)"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales",
                "version": "1.1.0",
                "code": "nn",
                "display": "Number present and traced using Welsh NHS AR"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales",
                "version": "1.1.0",
                "code": "01",
                "display": "Number present & traced"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales",
                "version": "1.1.0",
                "code": "02",
                "display": "Number present but not traced"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales",
                "version": "1.1.0",
                "code": "03",
                "display": "Trace required"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales",
                "version": "1.1.0",
                "code": "04",
                "display": "Trace attempted – no match or multiple match found"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales",
                "version": "1.1.0",
                "code": "05",
                "display": "Trace needs to be resolved (NHS number or patient detail conflict)"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales",
                "version": "1.1.0",
                "code": "06",
                "display": "Trace in progress"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales",
                "version": "1.1.0",
                "code": "07",
                "display": "Number not present and trace not required"
            },
            {
                "system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusWales",
                "version": "1.1.0",
                "code": "08",
                "display": "Trace postponed (baby under six weeks old)"
            },
            {
                "system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
                "version": "2018-08-12",
                "code": "NI",
                "display": "NoInformation"
            }
        ]
    }
}

HTML View

ValueSet 'UKCorePersonRelationshipType'

A set of codes that define the type of relationship a person has to a patient.

Contact Information

HL7 UK
Email: ukcore@hl7.org.uk

This value set includes codes from the following code systems:

• Import all codes from CodeSystem v2.0131
• Include codes from v3.RoleCode where concept IsA _PersonalRelationshipRoleType
  
• Import all codes from CodeSystem UKCoreAdditionalPersonRelationshipRole

This value set excludes codes from the following code systems:

• The following codes from system: v2.0131

  Code	Display
  O	Other

• The following codes from system: v3.RoleCode

  Code	Display
  _PersonalRelationshipRoleType	PersonalRelationshipRoleType

Expansion

This expansion was generated on 2021-09-10T07:25:20+00:00

This value set contains 131 concepts

Table View