StructureDefinition UKCore-Practitioner

Canonical_URLStatusCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioneractive2.4.02023-12-12

This profile defines the UK constraints and extensions on the International FHIR resource Practitioner.


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, is used for attribution of activities and responsibilities to these individuals.

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierS Σ0..*Identifier
activeΣ0..1boolean
nameS Σ0..*HumanName
telecomS Σ I0..*ContactPoint
addressΣ0..*Address
genderΣ0..1codeBinding
birthDateΣ0..1date
photoI0..*Attachment
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
identifier0..*Identifier
code1..1CodeableConcept
periodI0..1Period
issuerI0..1Reference(Organization)
communication0..*CodeableConceptBinding

Detailed Descriptions

Practitioner
DefinitionA person who is directly or indirectly involved in the provisioning of healthcare.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • v2: PRD (as one example)
  • rim: Role
  • servd: Provider
Practitioner.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Practitioner.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Practitioner.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Practitioner.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
Practitioner.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
Practitioner.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
Practitioner.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Practitioner.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Practitioner.identifier
DefinitionAn identifier that applies to this person in this role.
Cardinality0...*
TypeIdentifier
Must SupportTrue
SummaryTrue
Requirements

Often, specific identities are assigned for the agent.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • w5: FiveWs.identifier
  • v2: PRD-7 (or XCN.1)
  • rim: ./id
  • servd: ./Identifiers
Practitioner.active
DefinitionWhether this practitioner's record is in active use.
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

Need to be able to mark a practitioner record as not to be used because it was created in error.

Comments

If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.status
  • rim: ./statusCode
Practitioner.name
DefinitionThe name(s) associated with the practitioner.
Cardinality0...*
TypeHumanName
Must SupportTrue
SummaryTrue
Requirements

The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

Comments

The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.

In general, select the value to be used in the ResourceReference.display based on this:

  1. There is more than 1 name
  2. Use = usual
  3. Period is current to the date of the usage
  4. Use = official
  5. Other order as decided by internal business rules.
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XPN
  • rim: EN (actually, PN)
  • servd: ProviderName
  • v2: XCN Components
  • rim: ./name
  • servd: ./PreferredName (GivenNames, FamilyName, TitleCode)
Practitioner.telecom
DefinitionA contact detail for the practitioner, e.g. a telephone number or an email address.
Cardinality0...*
TypeContactPoint
Must SupportTrue
SummaryTrue
Requirements

Need to know how to reach a practitioner independent to any roles the practitioner may have.

Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • cpt-2: A system is required if a value is provided.
    value.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: XTN
  • rim: TEL
  • servd: ContactPoint
  • v2: PRT-15, STF-10, ROL-12
  • rim: ./telecom
  • servd: ./ContactPoints
Practitioner.address
DefinitionAddress(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
Cardinality0...*
TypeAddress
SummaryTrue
Requirements

The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.

Comments

The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: XAD
  • rim: AD
  • servd: Address
  • v2: ORC-24, STF-11, ROL-11, PRT-14
  • rim: ./addr
  • servd: ./Addresses
Practitioner.gender
DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Cardinality0...1
Typecode
Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)
SummaryTrue
Requirements

Needed to address the person correctly.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: STF-5
  • rim: ./administrativeGender
  • servd: ./GenderCode
Practitioner.birthDate
DefinitionThe date of birth for the practitioner.
Cardinality0...1
Typedate
SummaryTrue
Requirements

Needed for identification.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: STF-6
  • rim: ./birthTime
  • servd: (not represented in ServD)
Practitioner.photo
DefinitionImage of the person.
Cardinality0...*
TypeAttachment
Requirements

Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.

Comments

When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • att-1: If the Attachment has data, it SHALL have a contentType
    data.empty() or contentType.exists()
Mappings
  • rim: n/a
  • v2: ED/RP
  • rim: ED
  • rim: ./subjectOf/ObservationEvent[code="photo"]/value
  • servd: ./ImageURI (only supports the URI reference)
Practitioner.qualification
DefinitionThe official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CER?
  • rim: .playingEntity.playingRole[classCode=QUAL].code
  • servd: ./Qualifications
Practitioner.qualification.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
Practitioner.qualification.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • 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
Practitioner.qualification.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • 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
Practitioner.qualification.identifier
DefinitionAn identifier that applies to this person's qualification in this role.
Cardinality0...*
TypeIdentifier
Requirements

Often, specific identities are assigned for the qualification.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .playingEntity.playingRole[classCode=QUAL].id
Practitioner.qualification.code
DefinitionCoded representation of the qualification.
Cardinality1...1
TypeCodeableConcept
Binding

Specific qualification the practitioner has to provide a service.

v2.0360.2.7 (example)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: .playingEntity.playingRole[classCode=QUAL].code
  • servd: ./Qualifications.Value
Practitioner.qualification.period
DefinitionPeriod during which the qualification is valid.
Cardinality0...1
TypePeriod
Requirements

Qualifications are often for a limited period of time, and can be revoked.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • rim: .playingEntity.playingRole[classCode=QUAL].effectiveTime
  • servd: ./Qualifications.StartDate and ./Qualifications.EndDate
Practitioner.qualification.issuer
DefinitionOrganization that regulates and issues the qualification.
Cardinality0...1
TypeReference(Organization)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: .playingEntity.playingRole[classCode=QUAL].scoper
Practitioner.communication
DefinitionA language the practitioner can use in patient communication.
Cardinality0...*
TypeCodeableConcept
Binding

A ValueSet that identifies the language used by a person.

AllLanguages (required)
Requirements

Knowing which language a practitioner speaks can help in facilitating communication with patients.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2: PID-15, NK1-20, LAN-2
  • rim: ./languageCommunication
  • servd: ./Languages.LanguageSpokenCode

Table View

Practitioner..
Practitioner.identifier..
Practitioner.name..
Practitioner.telecom..
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.4.0" />
    <name value="UKCorePractitioner" />
    <title value="UK Core Practitioner" />
    <status value="active" />
    <date value="2023-12-12" />
    <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="This profile defines the UK constraints and extensions on the International FHIR resource [Practitioner](https://hl7.org/fhir/R4/Practitioner.html)." />
    <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, 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" />
    <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">
            <path value="Practitioner.identifier" />
            <short value="An identifier that applies to this person in this role." />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.name">
            <path value="Practitioner.name" />
            <short value="The name(s) associated with the practitioner." />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.telecom">
            <path value="Practitioner.telecom" />
            <short value="A contact detail for the practitioner (that apply to all roles)." />
            <mustSupport value="true" />
        </element>
        <element id="Practitioner.communication">
            <path value="Practitioner.communication" />
            <binding>
                <strength value="required" />
                <description value="A ValueSet that identifies the language used by a person." />
                <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Practitioner",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
    "version": "2.4.0",
    "name": "UKCorePractitioner",
    "title": "UK Core Practitioner",
    "status": "active",
    "date": "2023-12-12",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Practitioner](https://hl7.org/fhir/R4/Practitioner.html).",
    "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, 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",
    "kind": "resource",
    "abstract": false,
    "type": "Practitioner",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Practitioner.identifier",
                "path": "Practitioner.identifier",
                "short": "An identifier that applies to this person in this role.",
                "mustSupport": true
            },
            {
                "id": "Practitioner.name",
                "path": "Practitioner.name",
                "short": "The name(s) associated with the practitioner.",
                "mustSupport": true
            },
            {
                "id": "Practitioner.telecom",
                "path": "Practitioner.telecom",
                "short": "A contact detail for the practitioner (that apply to all roles).",
                "mustSupport": true
            },
            {
                "id": "Practitioner.communication",
                "path": "Practitioner.communication",
                "binding": {
                    "strength": "required",
                    "description": "A ValueSet that identifies the language used by a person.",
                    "valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
                }
            }
        ]
    }
}

Feedback

Click here to:

Report issue for UKCore-Practitioner, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Examples

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

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

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

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:

Mandatory and Must Support Data Elements

The following elements are identified as MustSupport, and it is expected that consumers and suppliers SHALL support these as per the MustSupport Guidance.

ElementReason
Practitioner.identifierAn identifier that applies to this person in this role.
Practitioner.nameThe name(s) associated with the practitioner.
Practitioner.telecomA contact detail for the practitioner (that apply to all roles).


Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context Strength Link
Practitioner.communication Required Core-defined ValueSet All Languages

identifier

The Practitioner.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.

Practitioner.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.

Example of Practitioner.photo usage:

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.

Example of Practitioner.qualification usage:

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.

The Practitioner.communication element has a Required binding to the Core-defined ValueSet All Languages which is derived form urn:ietf:bcp:47