UK Core Implementation Guide 1.0.0 - STU1

StructureDefinition-UKCore-Practitioner

This UK Core profile is a restraint on the International FHIR resource Practitioner, and defines the constraints, extensions, and minimal set of data to query and retrieve practitioner information.

Profile Purpose

This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this profile is used for attribution of activities and responsibilities to these individuals.

Snapshot View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ0..1boolean
nameΣ0..*HumanName
telecomΣ I0..*ContactPoint
addressΣ0..*Address
genderΣ0..1codeBinding
birthDateΣ0..1date
photoI0..*Attachment
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
code1..1CodeableConcept
periodI0..1Period
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
communication0..*CodeableConceptBinding

Differential View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ0..1boolean
nameΣ0..*HumanName
telecomΣ I0..*ContactPoint
addressΣ0..*Address
genderΣ0..1codeBinding
birthDateΣ0..1date
photoI0..*Attachment
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
code1..1CodeableConcept
periodI0..1Period
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
communication0..*CodeableConceptBinding

Hybrid View

useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ0..1boolean
nameΣ0..*HumanName
telecomΣ I0..*ContactPoint
addressΣ0..*Address
genderΣ0..1codeBinding
birthDateΣ0..1date
photoI0..*Attachment
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
code1..1CodeableConcept
periodI0..1Period
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
communication0..*CodeableConceptBinding

Table View

Practitioner..
Practitioner.identifier..
Practitioner.identifier.system1..
Practitioner.identifier.value1..
Practitioner.identifier.assignerReference(UK Core Organization)..
Practitioner.qualification..
Practitioner.qualification.identifier..
Practitioner.qualification.identifier.assignerReference(UK Core Organization)..
Practitioner.qualification.issuerReference(UK Core Organization)..
Practitioner.qualification.issuer.identifier..
Practitioner.qualification.issuer.identifier.assignerReference(UK Core Organization)..
Practitioner.communication..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Practitioner" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
    <version value="2.2.0" />
    <name value="UKCorePractitioner" />
    <title value="UK Core Practitioner" />
    <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="Defines the UK Core constraints and extensions on the Practitioner resource for the minimal set of data to query and retrieve practitioner information." />
    <purpose value="This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this profile is used for attribution of activities and responsibilities to these individuals." />
    <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="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="servd" />
        <uri value="http://www.omg.org/spec/ServD/1.0/" />
        <name value="ServD" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Practitioner" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Practitioner" />
    <derivation value="constraint" />
    <differential>
        <element id="Practitioner.identifier.system">
            <path value="Practitioner.identifier.system" />
            <min value="1" />
        </element>
        <element id="Practitioner.identifier.value">
            <path value="Practitioner.identifier.value" />
            <min value="1" />
        </element>
        <element id="Practitioner.identifier.assigner">
            <path value="Practitioner.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Practitioner.qualification.identifier.assigner">
            <path value="Practitioner.qualification.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Practitioner.qualification.issuer">
            <path value="Practitioner.qualification.issuer" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Practitioner.qualification.issuer.identifier.assigner">
            <path value="Practitioner.qualification.issuer.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Practitioner.communication">
            <path value="Practitioner.communication" />
            <binding>
                <strength value="extensible" />
                <description value="A ValueSet that identifies the language used by a person." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Practitioner",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
    "version": "2.2.0",
    "name": "UKCorePractitioner",
    "title": "UK Core Practitioner",
    "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": "Defines the UK Core constraints and extensions on the Practitioner resource for the minimal set of data to query and retrieve practitioner information.",
    "purpose": "This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this profile is used for attribution of activities and responsibilities to these individuals.",
    "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": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "servd",
            "uri": "http://www.omg.org/spec/ServD/1.0/",
            "name": "ServD"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Practitioner",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Practitioner.identifier.system",
                "path": "Practitioner.identifier.system",
                "min": 1
            },
            {
                "id": "Practitioner.identifier.value",
                "path": "Practitioner.identifier.value",
                "min": 1
            },
            {
                "id": "Practitioner.identifier.assigner",
                "path": "Practitioner.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.qualification.identifier.assigner",
                "path": "Practitioner.qualification.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.qualification.issuer",
                "path": "Practitioner.qualification.issuer",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.qualification.issuer.identifier.assigner",
                "path": "Practitioner.qualification.issuer.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Practitioner.communication",
                "path": "Practitioner.communication",
                "binding": {
                    "strength": "extensible",
                    "description": "A ValueSet that identifies the language used by a person.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage"
                }
            }
        ]
    }
}

Examples

General Practitioner - An example to illustrate a practitioner who is the Patient's GP.
Example UKCore-Practitioner-PaulRastall

Consultant - An example to illustrate a practitioner who is a Consultant.
Example UKCore-Practitioner-SandraGose

Pharmacist - An example to illustrate a practitioner who is a Pharmacist.
Example UKCore-Practitioner-JimmyChuck

Note: the practitioner's role information is carried in the Profile UKCore-PractitionerRole

Example Usage Scenarios

The following are example usage scenarios for the UK Core Practitioner profile:

  • Query for practitioner information using the query parameter identifier (Practitioner.identifier) for a known SDS User Identifier.
  • Exchange practitioner information within a FHIR document or message.

Profile Specific Implementation Guidance:

identifier

The identifier can be populated using the examples given below.

Role Identifier Format System
Doctors General Medical Council Information (GMC) registration number 7 digits OR L + 6 digits.
L prefix is for limited registrations.
https://fhir.hl7.org.uk/Id/gmc-number
Pharmacist General Pharmaceutical Council (GPhC) registration number 7 digit number starting with the number 2. https://fhir.hl7.org.uk/Id/gphc-number
Nurses, Midwives, Health Visitors Nursing and Midwifery Council (NMC) registration number 8 character alphanumeric pin. https://fhir.hl7.org.uk/Id/nmc-number
Other Health Care Professions (HCPs) Health and Care Professions Council (HCPC) registration number Up to 6 numbers, and starts with 2 letters.
For example **PH123456**
https://fhir.hl7.org.uk/Id/hcpc-number
Other (England) Spine Directory Service (SDS) User ID Refer to Spine Directory Service - FHIR API NA
Other Other identifier e.g. local ID Implementation specific NA

More information about the GMC, GPhC, and NMC registration numbers can be found within the Glossary, under NHS Data Model and Dictionary.
More information about SDS can be found within the Glossary, under Spine Directory Service.

name

The name of the practitioner using the HumanName datatype.


telecom

A contact detail (e.g. a telephone number or an email address) by which the practitioner may be contacted.

telecom uses the ContactPoint datatype.


address

The address of the Practitioner using the Address datatype.


gender

Administrative Gender - the gender that the practitioner is considered to have for administration and record keeping purposes.


photo

A photograph relating to the practitioner. This can be included as either:

  • An attachment encoded as base64Binary with a relevant MIME contentType: image/png, image/jpg or image/jpeg preferred.

Table View

Practitioner.id[0]UKCore-Practitioner-Sn-Photo-Example
Practitioner.photo[0].contentType[0]image/png
Practitioner.photo[0].data[0]base64Binary

Tree View

Practitioner

XML View

<Practitioner xmlns="http://hl7.org/fhir">
    <id value="UKCore-Practitioner-Sn-Photo-Example" />
    <!--  **************snippet start**************  -->
    <photo>
        <contentType value="image/png" />
        <data value="base64Binary" />
    </photo>
    <!--  **************snippet end**************  -->
</Practitioner>

JSON View

{
    "resourceType": "Practitioner",
    "id": "UKCore-Practitioner-Sn-Photo-Example",
    "photo":  [
        {
            "contentType": "image/png",
            "data": "base64Binary"
        }
    ]
}

and/or
  • URL where the data can be found.

If both are used the URL SHALL point to the same data as that encoded in the attachment.


qualification

The practitioner's qualifications.
e.g.

Table View

Practitioner.id[0]UKCore-Practitioner-Sn-Qualification-Example
Practitioner.qualification[0].identifier[0].system[0]http://example.org/UniversityIdentifier
Practitioner.qualification[0].identifier[0].value[0]12345
Practitioner.qualification[0].code[0].coding[0].system[0]http://terminology.hl7.org/CodeSystem/v2-0360/2.7
Practitioner.qualification[0].code[0].coding[0].code[0]BS
Practitioner.qualification[0].code[0].coding[0].display[0]Bachelor of Science
Practitioner.qualification[0].code[0].text[0]Bachelor of Science
Practitioner.qualification[0].period[0].start[0]1995
Practitioner.qualification[0].issuer[0].display[0]Example University

Tree View

Practitioner

XML View

<Practitioner xmlns="http://hl7.org/fhir">
    <id value="UKCore-Practitioner-Sn-Qualification-Example" />
    <!--  **************snippet start**************  -->
    <qualification>
        <identifier>
            <system value="http://example.org/UniversityIdentifier" />
            <value value="12345" />
        </identifier>
        <code>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v2-0360/2.7" />
                <code value="BS" />
                <display value="Bachelor of Science" />
            </coding>
            <text value="Bachelor of Science" />
        </code>
        <period>
            <start value="1995" />
        </period>
        <issuer>
            <display value="Example University" />
        </issuer>
    </qualification>
    <!--  **************snippet end**************  -->
</Practitioner>

JSON View

{
    "resourceType": "Practitioner",
    "id": "UKCore-Practitioner-Sn-Qualification-Example",
    "qualification":  [
        {
            "identifier":  [
                {
                    "system": "http://example.org/UniversityIdentifier",
                    "value": "12345"
                }
            ],
            "code": {
                "coding":  [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v2-0360/2.7",
                        "code": "BS",
                        "display": "Bachelor of Science"
                    }
                ],
                "text": "Bachelor of Science"
            },
            "period": {
                "start": "1995"
            },
            "issuer": {
                "display": "Example University"
            }
        }
    ]
}

communication

A language that the practitioner can use to communicate with patients about their health.

Use a value from ValueSet UKCore-HumanLanguage.


back to top