Defines the UK Core constraints and extensions on the Practitioner resource for the minimal set of data to query and retrieve practitioner information.
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.
Practitioner | I | Practitioner | |
identifier | Σ | 0..* | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
active | Σ | 0..1 | boolean |
name | Σ | 0..* | HumanName |
telecom | Σ I | 0..* | ContactPoint |
address | Σ | 0..* | Address |
gender | Σ | 0..1 | codeBinding |
birthDate | Σ | 0..1 | date |
photo | I | 0..* | Attachment |
qualification | 0..* | BackboneElement | |
identifier | 0..* | Identifier | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
code | 1..1 | CodeableConcept | |
period | I | 0..1 | Period |
issuer | I | 0..1 | Reference(UK Core Organization) |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
display | Σ | 0..1 | string |
communication | 0..* | CodeableConceptBinding |
Practitioner | I | Practitioner | |
identifier | Σ | 0..* | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
active | Σ | 0..1 | boolean |
name | Σ | 0..* | HumanName |
telecom | Σ I | 0..* | ContactPoint |
address | Σ | 0..* | Address |
gender | Σ | 0..1 | codeBinding |
birthDate | Σ | 0..1 | date |
photo | I | 0..* | Attachment |
qualification | 0..* | BackboneElement | |
identifier | 0..* | Identifier | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
code | 1..1 | CodeableConcept | |
period | I | 0..1 | Period |
issuer | I | 0..1 | Reference(UK Core Organization) |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
display | Σ | 0..1 | string |
communication | 0..* | CodeableConceptBinding |
Practitioner | I | Practitioner | |
identifier | Σ | 0..* | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
active | Σ | 0..1 | boolean |
name | Σ | 0..* | HumanName |
telecom | Σ I | 0..* | ContactPoint |
address | Σ | 0..* | Address |
gender | Σ | 0..1 | codeBinding |
birthDate | Σ | 0..1 | date |
photo | I | 0..* | Attachment |
qualification | 0..* | BackboneElement | |
identifier | 0..* | Identifier | |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
code | 1..1 | CodeableConcept | |
period | I | 0..1 | Period |
issuer | I | 0..1 | Reference(UK Core Organization) |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ I | 0..1 | Period |
assigner | Σ I | 0..1 | Reference(UK Core Organization) |
display | Σ | 0..1 | string |
communication | 0..* | CodeableConceptBinding |
Practitioner | .. | |
Practitioner.identifier | .. | |
Practitioner.identifier.system | 1.. | |
Practitioner.identifier.value | 1.. | |
Practitioner.identifier.assigner | Reference(UK Core Organization) | .. |
Practitioner.qualification | .. | |
Practitioner.qualification.identifier | .. | |
Practitioner.qualification.identifier.assigner | Reference(UK Core Organization) | .. |
Practitioner.qualification.issuer | Reference(UK Core Organization) | .. |
Practitioner.qualification.issuer.identifier | .. | |
Practitioner.qualification.issuer.identifier.assigner | Reference(UK Core Organization) | .. |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Practitioner" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" /> <version value="2.1.0" /> <name value="UKCorePractitioner" /> <title value="UK Core Practitioner" /> <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="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 © 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" /> <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> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "UKCore-Practitioner", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner", "version": "2.1.0", "name": "UKCorePractitioner", "title": "UK Core Practitioner", "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": "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" ] } ] } ] } }
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 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
The following are example usage scenarios for the UK Core Practitioner profile:
As a minimum either a Practitioner.identifier or Practitioner.name should be provided.
All other elements are optional.
identifier
The identifier
can be ppopulated using the examples given below.
Role | Identifier |
---|---|
Doctors | GMC registration number |
Pharmacist | General Pharmaceutical Council registration number |
Nurses, Midwives, Health Visitors | Nursing and Midwifery Council registration number |
Other HCPs | HCPC registration number |
Other (England) | SDS ID |
Other | Other identifer e.g. local ID |
active
Whether this practitioners's record is in active use.
name
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.
gender
Administrative Gender - the gender that the practioner is considered to have for administration and record keeping purposes.
CodeSystem.id[0] | administrative-gender |
CodeSystem.meta[0].lastUpdated[0] | 2019-11-01T09:29:23.356+11:00 |
CodeSystem.extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/structuredefinition-wg |
CodeSystem.extension[0].valueCode[0] | pa |
CodeSystem.extension[1].url[0] | http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status |
CodeSystem.extension[1].valueCode[0] | normative |
CodeSystem.extension[2].url[0] | http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm |
CodeSystem.extension[2].valueInteger[0] | 5 |
CodeSystem.extension[3].url[0] | http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version |
CodeSystem.extension[3].valueCode[0] | 4.0.0 |
CodeSystem.url[0] | http://hl7.org/fhir/administrative-gender |
CodeSystem.identifier[0].system[0] | urn:ietf:rfc:3986 |
CodeSystem.identifier[0].value[0] | urn:oid:2.16.840.1.113883.4.642.4.2 |
CodeSystem.version[0] | 4.0.1 |
CodeSystem.name[0] | AdministrativeGender |
CodeSystem.title[0] | AdministrativeGender |
CodeSystem.status[0] | active |
CodeSystem.experimental[0] | False |
CodeSystem.date[0] | 2019-11-01T09:29:23+11:00 |
CodeSystem.description[0] | The gender of a person used for administrative purposes. |
CodeSystem.caseSensitive[0] | True |
CodeSystem.valueSet[0] | http://hl7.org/fhir/ValueSet/administrative-gender |
CodeSystem.content[0] | complete |
CodeSystem.concept[0].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments |
CodeSystem.concept[0].extension[0].valueString[0] | Male |
CodeSystem.concept[0].code[0] | male |
CodeSystem.concept[0].display[0] | Male |
CodeSystem.concept[0].definition[0] | Male. |
CodeSystem.concept[1].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments |
CodeSystem.concept[1].extension[0].valueString[0] | Female |
CodeSystem.concept[1].code[0] | female |
CodeSystem.concept[1].display[0] | Female |
CodeSystem.concept[1].definition[0] | Female. |
CodeSystem.concept[2].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments |
CodeSystem.concept[2].extension[0].valueString[0] | The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value. |
CodeSystem.concept[2].code[0] | other |
CodeSystem.concept[2].display[0] | Other |
CodeSystem.concept[2].definition[0] | Other. |
CodeSystem.concept[3].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments |
CodeSystem.concept[3].extension[0].valueString[0] | A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.) |
CodeSystem.concept[3].code[0] | unknown |
CodeSystem.concept[3].display[0] | Unknown |
CodeSystem.concept[3].definition[0] | Unknown. |
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="administrative-gender" /> <meta> <lastUpdated value="2019-11-01T09:29:23.356+11:00" /> </meta> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="pa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="5" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <url value="http://hl7.org/fhir/administrative-gender" /> <identifier> <system value="urn:ietf:rfc:3986" /> <value value="urn:oid:2.16.840.1.113883.4.642.4.2" /> </identifier> <version value="4.0.1" /> <name value="AdministrativeGender" /> <title value="AdministrativeGender" /> <status value="active" /> <experimental value="false" /> <date value="2019-11-01T09:29:23+11:00" /> <description value="The gender of a person used for administrative purposes." /> <caseSensitive value="true" /> <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" /> <content value="complete" /> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments"> <valueString value="Male" /> </extension> <code value="male" /> <display value="Male" /> <definition value="Male." /> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments"> <valueString value="Female" /> </extension> <code value="female" /> <display value="Female" /> <definition value="Female." /> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments"> <valueString value="The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value." /> </extension> <code value="other" /> <display value="Other" /> <definition value="Other." /> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments"> <valueString value="A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)" /> </extension> <code value="unknown" /> <display value="Unknown" /> <definition value="Unknown." /> </concept> </CodeSystem>
{ "resourceType": "CodeSystem", "id": "administrative-gender", "meta": { "lastUpdated": "2019-11-01T09:29:23.356+11:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 5 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "url": "http://hl7.org/fhir/administrative-gender", "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:oid:2.16.840.1.113883.4.642.4.2" } ], "version": "4.0.1", "name": "AdministrativeGender", "title": "AdministrativeGender", "status": "active", "experimental": false, "date": "2019-11-01T09:29:23+11:00", "description": "The gender of a person used for administrative purposes.", "caseSensitive": true, "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender", "content": "complete", "concept": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments", "valueString": "Male" } ], "code": "male", "display": "Male", "definition": "Male." }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments", "valueString": "Female" } ], "code": "female", "display": "Female", "definition": "Female." }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments", "valueString": "The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value." } ], "code": "other", "display": "Other", "definition": "Other." }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments", "valueString": "A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of \"unknown\". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of \"H\" and a URL prefix of \"tel:\" to convey that it is the home phone number that is unknown.)" } ], "code": "unknown", "display": "Unknown", "definition": "Unknown." } ] }
birthDate
The practitioner's date of birth.
photo
A photograph relating to a practitioner. This can be included as either:
e.g. JSON
"photo": [ { "contentType": "image/png", "data":"{base64Binary} " } ]
and/or
If both are used the URL MUST point to the same data as that encoded in the attachment.
qualification
The practitioners qualifications.
e.g.
JSON
"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 which the practitioner is able to use to communicate with patients about his or her health.
Use a value from ValueSet UKCoreHumanLanguage.