UK Core Implementation Guide 0.4.0

Please note:

The UK Core 0.4.0 STU1 is in development with the updates and bug fixes following the 2 week review of 0.3.0 (Pre-Release).
There will be disruption as the content will be updated daily and with links not working.
Please follow the guidance on the "Contact Us" page if you need any assistance.

StructureDefinition Extension-UKCore-ContactRank

The preferred ranking or order of contact applied to a contact on a Patient's contact list.

Purpose

This extension extends the Patient and RelatedPerson resources to support the exchange of the preferred ranking or order of contact applied to a contact on a Patient's contact list, which is currently not supported by the FHIR standard.

Context of Use
Use on element	RelatedPerson Patient.contact

Snapshot View

Extension	I		Extension	Element Id Extension Short description Preferred ranking or order of contact applied to a contact on a patient's contact list Definition The preferred ranking or order of contact applied to a contact on a patient's contact list. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	Element Id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank Mappings rim:N/A
value[x]		1..1		Element Id Extension.value[x] Short description The preferred ranking or order of contact applied to a contact on a patient's contact list Definition The preferred ranking or order of contact applied to a contact on a patient's contact list. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valuePositiveInt			positiveInt	Data Type positiveInt

Differential View

Extension	I		Extension	Element Id Extension Short description Preferred ranking or order of contact applied to a contact on a patient's contact list Definition The preferred ranking or order of contact applied to a contact on a patient's contact list. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	Element Id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank Mappings rim:N/A
value[x]		1..1		Element Id Extension.value[x] Short description The preferred ranking or order of contact applied to a contact on a patient's contact list Definition The preferred ranking or order of contact applied to a contact on a patient's contact list. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valuePositiveInt			positiveInt	Data Type positiveInt

Hybrid View

Extension	I		Extension	Element Id Extension Short description Preferred ranking or order of contact applied to a contact on a patient's contact list Definition The preferred ranking or order of contact applied to a contact on a patient's contact list. Data Type Extension Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url		1..1	System.StringFixed Value	Element Id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data Type System.String Fixed Value https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank Mappings rim:N/A
value[x]		1..1		Element Id Extension.value[x] Short description The preferred ranking or order of contact applied to a contact on a patient's contact list Definition The preferred ranking or order of contact applied to a contact on a patient's contact list. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valuePositiveInt			positiveInt	Data Type positiveInt

Table View

Extension		..1
Extension.url		..
Extension.value[x]	positiveInt	1..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="Extension-UKCore-ContactRank" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" />
    <version value="2.1.0" />
    <name value="ExtensionUKCoreContactRank" />
    <title value="Extension UK Core Contact Rank" />
    <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="The preferred ranking or order of contact applied to a contact on a Patient&#39;s contact list." />
    <purpose value="This extension extends the Patient and RelatedPerson resources to support the exchange of the preferred ranking or order of contact applied to a contact on a Patient&#39;s contact list, which is currently not supported by the FHIR standard." />
    <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.contact" />
    </context>
    <context>
        <type value="element" />
        <expression value="RelatedPerson" />
    </context>
    <type value="Extension" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
    <derivation value="constraint" />
    <differential>
        <element id="Extension">
            <path value="Extension" />
            <short value="Preferred ranking or order of contact applied to a contact on a patient&#39;s contact list" />
            <definition value="The preferred ranking or order of contact applied to a contact on a patient&#39;s contact list." />
            <max value="1" />
        </element>
        <element id="Extension.url">
            <path value="Extension.url" />
            <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" />
        </element>
        <element id="Extension.value[x]">
            <path value="Extension.value[x]" />
            <short value="The preferred ranking or order of contact applied to a contact on a patient&#39;s contact list" />
            <definition value="The preferred ranking or order of contact applied to a contact on a patient&#39;s contact list." />
            <min value="1" />
            <type>
                <code value="positiveInt" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "Extension-UKCore-ContactRank",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank",
    "version": "2.1.0",
    "name": "ExtensionUKCoreContactRank",
    "title": "Extension UK Core Contact Rank",
    "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": "The preferred ranking or order of contact applied to a contact on a Patient's contact list.",
    "purpose": "This extension extends the Patient and RelatedPerson resources to support the exchange of the preferred ranking or order of contact applied to a contact on a Patient's contact list, which is currently not supported by the FHIR standard.",
    "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.contact"
        },
        {
            "type": "element",
            "expression": "RelatedPerson"
        }
    ],
    "type": "Extension",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Extension",
                "path": "Extension",
                "short": "Preferred ranking or order of contact applied to a contact on a patient's contact list",
                "definition": "The preferred ranking or order of contact applied to a contact on a patient's contact list.",
                "max": "1"
            },
            {
                "id": "Extension.url",
                "path": "Extension.url",
                "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"
            },
            {
                "id": "Extension.value[x]",
                "path": "Extension.value[x]",
                "short": "The preferred ranking or order of contact applied to a contact on a patient's contact list",
                "definition": "The preferred ranking or order of contact applied to a contact on a patient's contact list.",
                "min": 1,
                "type":  [
                    {
                        "code": "positiveInt"
                    }
                ]
            }
        ]
    }
}

Examples

Example UKCore-Patient-ContactRank