FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

8.4 Resource Practitioner - Content

Patient Administration Work GroupMaturity Level: 3 Trial UseCompartments: Practitioner

A person who is directly or indirectly involved in the provisioning of healthcare.

Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals. Practitioners include (but are not limited to):

  • physicians, dentists, pharmacists
  • physician assistants, nurses, scribes
  • midwives, dietitians, therapists, optometrists, paramedics
  • medical technicians, laboratory scientists, prosthetic technicians, radiographers
  • social workers, professional home carers, official volunteers
  • receptionists handling patient registration
  • IT personnel merging or unmerging patient records
  • Service animal (e.g., ward assigned dog capable of detecting cancer in patients)

The Resource SHALL NOT be used for persons involved without a formal responsibility like individuals taking care for friends, relatives or neighbors. These can be registered as a Patient's Contact. If performing some action or being referenced by another resource, use the RelatedPerson resource.

The primary distinction between a Practitioner and a RelatedPerson is based on whether:

  • The person/animal operates on behalf of the care delivery organization over multiple patients (Practitioner) or,
  • Where the person/animal is not associated with the organization, and instead is allocated tasks specifically for the RelatedPerson's Patient (RelatedPerson).

A standard extension animalSpecies can be used to indicate the species of a service animal.

The PractitionerRole resource provides the details of roles that the practitioner is approved to perform for which organizations (an at which locations, and optionally what services too).

Practitioners are also often grouped into CareTeams independently of roles, where the CareTeam defines what specific role that they are fulfilling within the team, and may or may not have actual practitioner role resources created for the practitioner (and in the care team context, the organization the practitioner is representing)

Practitioner performs different roles within the same or even different organizations. Depending on jurisdiction and custom, it may be necessary to maintain a specific Practitioner Resource for each such role or have a single Practitioner with multiple roles. The role can be limited to a specific period, after which authorization for this role ends. Note that the represented organization need not necessarily be the (direct) employer of a Practitioner.

This resource is referenced by Account, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, AuditEvent, Basic, CarePlan, CareTeam, ChargeItem, Claim, ClaimResponse, ClinicalImpression, Communication, CommunicationRequest, Composition, Condition, Consent, Contract, DetectedIssue, DeviceRequest, DeviceUseStatement, DiagnosticReport, DocumentManifest, DocumentReference, EligibilityRequest, EligibilityResponse, Encounter, EnrollmentRequest, EnrollmentResponse, EpisodeOfCare, ExplanationOfBenefit, Flag, Goal, Group, ImagingManifest, ImagingStudy, Immunization, Linkage, List, Media, MedicationAdministration, MedicationDispense, MedicationRequest, MedicationStatement, MessageHeader, NutritionOrder, Observation, Patient, PaymentNotice, PaymentReconciliation, Person, PractitionerRole, Procedure, ProcedureRequest, ProcessRequest, ProcessResponse, Provenance, QuestionnaireResponse, ReferralRequest, RequestGroup, ResearchStudy, RiskAssessment, Schedule, Specimen, SupplyDelivery, SupplyRequest, Task and VisionPrescription

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner DomainResourceA person with a formal responsibility in the provisioning of healthcare or related services
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierA identifier for the person as this agent
... active Σ0..1booleanWhether this practitioner's record is in active use
... name Σ0..*HumanNameThe name(s) associated with the practitioner
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification 0..*BackboneElementQualifications obtained by training and certification
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
v2 table 0360, Version 2.7 (Example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Common Languages (Extensible but limited to All Languages)

doco Documentation for this format

UML Diagram (Legend)

Practitioner (DomainResource)An identifier that applies to this person in this roleidentifier : Identifier [0..*]Whether this practitioner's record is in active useactive : boolean [0..1]The name(s) associated with the practitionername : HumanName [0..*]A contact detail for the practitioner, e.g. a telephone number or an email addresstelecom : ContactPoint [0..*]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 dependentaddress : Address [0..*]Administrative Gender - the gender that the person is considered to have for administration and record keeping purposesgender : code [0..1] The gender of a person used for administrative purposes. (Strength=Required)AdministrativeGender! The date of birth for the practitionerbirthDate : date [0..1]Image of the personphoto : Attachment [0..*]A language the practitioner is able to use in patient communicationcommunication : CodeableConcept [0..*] A human language. (Strength=Extensible)Common Languages+ QualificationAn identifier that applies to this person's qualification in this roleidentifier : Identifier [0..*]Coded representation of the qualificationcode : CodeableConcept [1..1] Specific qualification the practitioner has to provide a service (Strength=Example)v2 table 0360, Version 2.7?? Period during which the qualification is validperiod : Period [0..1]Organization that regulates and issues the qualificationissuer : Reference [0..1] Organization Qualifications obtained by training and certificationqualification[0..*]

XML Template

<Practitioner xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier A identifier for the person as this agent --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this practitioner's record is in active use -->
 <name><!-- 0..* HumanName The name(s) associated with the practitioner --></name>
 <telecom><!-- 0..* ContactPoint A contact detail for the practitioner (that apply to all roles) --></telecom>
 <address><!-- 0..* Address Address(es) of the practitioner that are not role specific (typically home address) --></address>
 <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
 <birthDate value="[date]"/><!-- 0..1 The date  on which the practitioner was born -->
 <photo><!-- 0..* Attachment Image of the person --></photo>
 <qualification>  <!-- 0..* Qualifications obtained by training and certification -->
  <identifier><!-- 0..* Identifier An identifier for this qualification for the practitioner --></identifier>
  <code><!-- 1..1 CodeableConcept Coded representation of the qualification --></code>
  <period><!-- 0..1 Period Period during which the qualification is valid --></period>
  <issuer><!-- 0..1 Reference(Organization) Organization that regulates and issues the qualification --></issuer>
 </qualification>
 <communication><!-- 0..* CodeableConcept A language the practitioner is able to use in patient communication --></communication>
</Practitioner>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Practitioner;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Practitioner.identifier [ Identifier ], ... ; # 0..* A identifier for the person as this agent
  fhir:Practitioner.active [ boolean ]; # 0..1 Whether this practitioner's record is in active use
  fhir:Practitioner.name [ HumanName ], ... ; # 0..* The name(s) associated with the practitioner
  fhir:Practitioner.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the practitioner (that apply to all roles)
  fhir:Practitioner.address [ Address ], ... ; # 0..* Address(es) of the practitioner that are not role specific (typically home address)
  fhir:Practitioner.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:Practitioner.birthDate [ date ]; # 0..1 The date  on which the practitioner was born
  fhir:Practitioner.photo [ Attachment ], ... ; # 0..* Image of the person
  fhir:Practitioner.qualification [ # 0..* Qualifications obtained by training and certification
    fhir:Practitioner.qualification.identifier [ Identifier ], ... ; # 0..* An identifier for this qualification for the practitioner
    fhir:Practitioner.qualification.code [ CodeableConcept ]; # 1..1 Coded representation of the qualification
    fhir:Practitioner.qualification.period [ Period ]; # 0..1 Period during which the qualification is valid
    fhir:Practitioner.qualification.issuer [ Reference(Organization) ]; # 0..1 Organization that regulates and issues the qualification
  ], ...;
  fhir:Practitioner.communication [ CodeableConcept ], ... ; # 0..* A language the practitioner is able to use in patient communication
]

Changes since DSTU2

Practitioner
Practitioner.name
  • Max Cardinality changed from 1 to *
Practitioner.communication
  • Change binding strength from required to extensible
  • Change value set from http://tools.ietf.org/html/bcp47 to http://hl7.org/fhir/ValueSet/languages
Practitioner.practitionerRole
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 18 tests that all execute ok. 15 fail round-trip testing and all r3 resources are valid.).

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner DomainResourceA person with a formal responsibility in the provisioning of healthcare or related services
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierA identifier for the person as this agent
... active Σ0..1booleanWhether this practitioner's record is in active use
... name Σ0..*HumanNameThe name(s) associated with the practitioner
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification 0..*BackboneElementQualifications obtained by training and certification
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
v2 table 0360, Version 2.7 (Example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*CodeableConceptA language the practitioner is able to use in patient communication
Common Languages (Extensible but limited to All Languages)

doco Documentation for this format

UML Diagram (Legend)

Practitioner (DomainResource)An identifier that applies to this person in this roleidentifier : Identifier [0..*]Whether this practitioner's record is in active useactive : boolean [0..1]The name(s) associated with the practitionername : HumanName [0..*]A contact detail for the practitioner, e.g. a telephone number or an email addresstelecom : ContactPoint [0..*]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 dependentaddress : Address [0..*]Administrative Gender - the gender that the person is considered to have for administration and record keeping purposesgender : code [0..1] The gender of a person used for administrative purposes. (Strength=Required)AdministrativeGender! The date of birth for the practitionerbirthDate : date [0..1]Image of the personphoto : Attachment [0..*]A language the practitioner is able to use in patient communicationcommunication : CodeableConcept [0..*] A human language. (Strength=Extensible)Common Languages+ QualificationAn identifier that applies to this person's qualification in this roleidentifier : Identifier [0..*]Coded representation of the qualificationcode : CodeableConcept [1..1] Specific qualification the practitioner has to provide a service (Strength=Example)v2 table 0360, Version 2.7?? Period during which the qualification is validperiod : Period [0..1]Organization that regulates and issues the qualificationissuer : Reference [0..1] Organization Qualifications obtained by training and certificationqualification[0..*]

XML Template

<Practitioner xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier A identifier for the person as this agent --></identifier>
 <active value="[boolean]"/><!-- 0..1 Whether this practitioner's record is in active use -->
 <name><!-- 0..* HumanName The name(s) associated with the practitioner --></name>
 <telecom><!-- 0..* ContactPoint A contact detail for the practitioner (that apply to all roles) --></telecom>
 <address><!-- 0..* Address Address(es) of the practitioner that are not role specific (typically home address) --></address>
 <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
 <birthDate value="[date]"/><!-- 0..1 The date  on which the practitioner was born -->
 <photo><!-- 0..* Attachment Image of the person --></photo>
 <qualification>  <!-- 0..* Qualifications obtained by training and certification -->
  <identifier><!-- 0..* Identifier An identifier for this qualification for the practitioner --></identifier>
  <code><!-- 1..1 CodeableConcept Coded representation of the qualification --></code>
  <period><!-- 0..1 Period Period during which the qualification is valid --></period>
  <issuer><!-- 0..1 Reference(Organization) Organization that regulates and issues the qualification --></issuer>
 </qualification>
 <communication><!-- 0..* CodeableConcept A language the practitioner is able to use in patient communication --></communication>
</Practitioner>

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Practitioner;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Practitioner.identifier [ Identifier ], ... ; # 0..* A identifier for the person as this agent
  fhir:Practitioner.active [ boolean ]; # 0..1 Whether this practitioner's record is in active use
  fhir:Practitioner.name [ HumanName ], ... ; # 0..* The name(s) associated with the practitioner
  fhir:Practitioner.telecom [ ContactPoint ], ... ; # 0..* A contact detail for the practitioner (that apply to all roles)
  fhir:Practitioner.address [ Address ], ... ; # 0..* Address(es) of the practitioner that are not role specific (typically home address)
  fhir:Practitioner.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:Practitioner.birthDate [ date ]; # 0..1 The date  on which the practitioner was born
  fhir:Practitioner.photo [ Attachment ], ... ; # 0..* Image of the person
  fhir:Practitioner.qualification [ # 0..* Qualifications obtained by training and certification
    fhir:Practitioner.qualification.identifier [ Identifier ], ... ; # 0..* An identifier for this qualification for the practitioner
    fhir:Practitioner.qualification.code [ CodeableConcept ]; # 1..1 Coded representation of the qualification
    fhir:Practitioner.qualification.period [ Period ]; # 0..1 Period during which the qualification is valid
    fhir:Practitioner.qualification.issuer [ Reference(Organization) ]; # 0..1 Organization that regulates and issues the qualification
  ], ...;
  fhir:Practitioner.communication [ CodeableConcept ], ... ; # 0..* A language the practitioner is able to use in patient communication
]

Changes since DSTU2

Practitioner
Practitioner.name
  • Max Cardinality changed from 1 to *
Practitioner.communication
  • Change binding strength from required to extensible
  • Change value set from http://tools.ietf.org/html/bcp47 to http://hl7.org/fhir/ValueSet/languages
Practitioner.practitionerRole
  • deleted

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 18 tests that all execute ok. 15 fail round-trip testing and all r3 resources are valid.).

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

PathDefinitionTypeReference
Practitioner.gender The gender of a person used for administrative purposes.RequiredAdministrativeGender
Practitioner.qualification.code Specific qualification the practitioner has to provide a serviceExamplev2 table 0360, Version 2.7
Practitioner.communication A human language.Extensible, but limited to All LanguagesCommon Languages

  • The practitioner's Qualifications are aquired by the practitioner independant of any organization or role, and do not imply that they are allowed/authorzied to perform roles relevant to the qualification at any specific Organization/Location.

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
activetokenWhether the practitioner record is activePractitioner.active
addressstringA server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or textPractitioner.address3 Resources
address-citystringA city specified in an addressPractitioner.address.city3 Resources
address-countrystringA country specified in an addressPractitioner.address.country3 Resources
address-postalcodestringA postalCode specified in an addressPractitioner.address.postalCode3 Resources
address-statestringA state specified in an addressPractitioner.address.state3 Resources
address-usetokenA use code specified in an addressPractitioner.address.use3 Resources
communicationtokenOne of the languages that the practitioner can communicate withPractitioner.communication
emailtokenA value in an email contactPractitioner.telecom.where(system='email')4 Resources
familystringA portion of the family namePractitioner.name.family1 Resources
gendertokenGender of the practitionerPractitioner.gender3 Resources
givenstringA portion of the given namePractitioner.name.given1 Resources
identifiertokenA practitioner's IdentifierPractitioner.identifier
namestringA server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or textPractitioner.name
phonetokenA value in a phone contactPractitioner.telecom.where(system='phone')4 Resources
phoneticstringA portion of either family or given name using some kind of phonetic matching algorithmPractitioner.name3 Resources
telecomtokenThe value in any kind of contactPractitioner.telecom4 Resources