Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Practitioner

Implementation guidance for populating and consuming the FHIR Practitioner resource

Introduction

Links to the definitions of the Practitioner resource within the specifications covered within this guidance.

  • Practitioner resource within STU3
  • Practitioner resource within CareConnect
  • Practitioner resource within R4

Minimum Viable Product (MVP)

Elements marked as MVP denote those recommended to be required for an MVP for the target use case.

Elements  
id MVP
text  
identifier  
active  
name MVP
telecom  
address  
gender  
birthDate  
photo  
qualification MVP
communication  

Practitioner elements

id

Data Type: Id
Required / Cardinality: Required 0..1
Version Support: STU3 R4
Description: Logical id of this artifact.

Until such time as there is an approved and adopted national identifier for NHS staff it is recommended that the logical id is a locally issued employee/user identifier. Such an identifier must be unique across the domain of the Acute Trust and not re-used by another member of staff after someone leaves as this could invalidate historic records.

If no suitable local staff identifier exists then consider using a UUID.

text

Data Type: Narrative
Required / Cardinality: Optional 0..1
Version Support: STU3 R4
Description: Text summary of the resource, for human interpretation.

The element is not required for an MVP implementation.

identifier

Data Type: Identifier
Required / Cardinality: Optional 0..*
Version Support: STU3 R4
Description: An identifier for the person as this agent.

The element is not required for an MVP implementation.

Where an implementation does not use a locally issued clinician or employee number as the logical id, such an identifier can be recorded within this element to support local business process interoperability.

active

Data Type: boolean
Required / Cardinality: Optional 0..1
Version Support: STU3 R4
Description: Whether this practitioner's record is in active use.

The element is not required for an MVP implementation.

name

Data Type: HumanName
Required / Cardinality: Required 0..*
Version Support: STU3 R4
Description: The name(s) associated with the practitioner.

A single full name, that is the practitioners preferred name, must be recorded as a complete string within name.text.

The composite name elements of name.prefix, name.given and name.family should be included if available. The complete string used for name.text must be the concatenation of these three elements separated by a single whitespace character.

telecom

Data Type: ContactPoint
Required / Cardinality: Optional 0..*
Version Support: STU3 R4
Description: A contact detail for the practitioner (that apply to all roles).

The element is not required for an MVP implementation.

address

Data Type: Address
Required / Cardinality: Optional 0..*
Version Support: STU3 R4
Description: Address(es) of the practitioner that are not role specific (typically home address).

The element is not required for an MVP implementation.

gender

Data Type: code
Required / Cardinality: Optional 0..1
Version Support: STU3 R4
Description: The gender of the practitioner.

The element is not required for an MVP implementation.

birthDate

Data Type: date
Required / Cardinality: Optional 0..1
Version Support: STU3 R4
Description: The date on which the practitioner was born.

The element is not required for an MVP implementation.

photo

Data Type: Attachment
Required / Cardinality: Optional 0..*
Version Support: STU3 R4
Description: Image of the person.

The element is not required for an MVP implementation.

qualification

Data Type: BackboneElement
Required / Cardinality: Required 0..*
Version Support: STU3 R4
Description: Certification, licenses, or training pertaining to the provision of care.

A business required element to identify the clinical practitioner using their professional code issued by their professional body.

  • The qualifcation.code.coding.system must be the appropriate uri for the professional body;
    • General Medical Council = https://fhir.hl7.org.uk/Id/gmc-number
    • Nursing and Midwifery Council = https://fhir.hl7.org.uk/Id/nmc-number
    • General Pharmaceutical Council = https://fhir.hl7.org.uk/Id/gphc-number
  • The qualifcation.code.coding.code must be the practitioner’s professional code issued by their professional body.
  • The qualifcation.code.coding.display must be the name of the professional body that issued the code, e.g. “General Medical Council”, “Nursing and Midwifery Council” or “General Pharmaceutical Council”.

communication

Data Type: CodeableConceot
Required / Cardinality: Optional 0..*
Version Support: STU3 R4
Description: A spoken language the practitioner can use in patient communication.

The element is not required for an MVP implementation.

Tags: design

All content is available under the Open Government Licence v3.0, except where otherwise stated