StructureDefinition UKCore-PractitionerRole
Practitioner | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Practitioner.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
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 | |
Definition | The 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. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
Practitioner.implicitRules | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
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 |
|
Mappings |
|
Practitioner.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
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 |
|
Mappings |
|
Practitioner.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, 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 |
|
Mappings |
|
Practitioner.contained | |
Definition | These 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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline 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 |
|
Practitioner.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Practitioner.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Practitioner.identifier | |
Definition | An identifier that applies to this person in this role. |
Cardinality | 0...* |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Often, specific identities are assigned for the agent. |
Invariants |
|
Mappings |
|
Practitioner.active | |
Definition | Whether this practitioner's record is in active use. |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
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 |
|
Mappings |
|
Practitioner.name | |
Definition | The name(s) associated with the practitioner. |
Cardinality | 0...* |
Type | HumanName |
Must Support | True |
Summary | True |
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:
|
Invariants |
|
Mappings |
|
Practitioner.telecom | |
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address. |
Cardinality | 0...* |
Type | ContactPoint |
Must Support | True |
Summary | True |
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 |
|
Mappings |
|
Practitioner.address | |
Definition | Address(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. |
Cardinality | 0...* |
Type | Address |
Summary | True |
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 |
|
Mappings |
|
Practitioner.gender | |
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
Cardinality | 0...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Summary | True |
Requirements | Needed to address the person correctly. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Practitioner.birthDate | |
Definition | The date of birth for the practitioner. |
Cardinality | 0...1 |
Type | date |
Summary | True |
Requirements | Needed for identification. |
Invariants |
|
Mappings |
|
Practitioner.photo | |
Definition | Image of the person. |
Cardinality | 0...* |
Type | Attachment |
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 |
|
Mappings |
|
Practitioner.qualification | |
Definition | The 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. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Practitioner.qualification.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Practitioner.qualification.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Practitioner.qualification.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, 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 |
|
Mappings |
|
Practitioner.qualification.identifier | |
Definition | An identifier that applies to this person's qualification in this role. |
Cardinality | 0...* |
Type | Identifier |
Requirements | Often, specific identities are assigned for the qualification. |
Invariants |
|
Mappings |
|
Practitioner.qualification.code | |
Definition | Coded representation of the qualification. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Specific qualification the practitioner has to provide a service. |
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 |
|
Mappings |
|
Practitioner.qualification.period | |
Definition | Period during which the qualification is valid. |
Cardinality | 0...1 |
Type | Period |
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 |
|
Mappings |
|
Practitioner.qualification.issuer | |
Definition | Organization that regulates and issues the qualification. |
Cardinality | 0...1 |
Type | Reference(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 |
|
Mappings |
|
Practitioner.communication | |
Definition | A language the practitioner can use in patient communication. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A ValueSet that identifies the language used by a person. |
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 |
|
Mappings |
|
Practitioner | .. | |
Practitioner.identifier | .. | |
Practitioner.name | .. | |
Practitioner.telecom | .. | |
Practitioner.communication | .. |
<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 © 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 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>
{ "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" } } ] } }