DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 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 R3 R2

5.4 8.4 Resource Practitioner - Content

Patient Administration Work Group Maturity Level : 1 3   Trial Use Compartments : Practitioner

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

5.4.1 8.4.1 Scope and Usage

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 physicians, dentists, pharmacists
  • physician assistants, nurses, assistants, nurses, scribes
  • midwives, dietitians, therapists, optometrists, midwives, dietitians, therapists, optometrists, paramedics
  • medical technicians, laboratory 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)

5.4.2 8.4.2 Boundaries and Relationships

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)

5.4.3 8.4.3 Background and Context

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 , DiagnosticOrder DeviceRequest , DeviceUseStatement , DiagnosticReport , DocumentManifest , DocumentReference , EligibilityRequest , EligibilityResponse , Encounter , EnrollmentRequest , EnrollmentResponse , EpisodeOfCare , ExplanationOfBenefit , Flag , Goal , Group , ImagingObjectSelection ImagingManifest , ImagingStudy , Immunization , Linkage , List , Media , MedicationAdministration , MedicationDispense , MedicationOrder MedicationRequest , MedicationStatement , MessageHeader , NutritionOrder , Observation , Order , OrderResponse , Patient , PaymentNotice , PaymentReconciliation , Person , PractitionerRole , Procedure , ProcedureRequest , ProcessRequest , ProcessResponse , Provenance , QuestionnaireResponse , ReferralRequest , RequestGroup , ResearchStudy , RiskAssessment , Schedule , Specimen , SupplyDelivery , SupplyRequest , Task and VisionPrescription

5.4.4 8.4.4 Resource Content

Structure

0..1 A name Where specialty Σ 0..* CodeableConcept Specific specialty of the practitioner PractitionerSpecialty ( Example ) period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s) location 0..* Reference ( Location ) The location(s) at which this practitioner provides care healthcareService 0..* Reference ( HealthcareService ) The list of healthcare services that this worker provides for this role's Organization/Location(s)
Name Flags Card. Type Description & Constraints doco
. . Practitioner DomainResource A 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..* Identifier A identifier for the person as this agent
. . . active Σ 0..1 boolean Whether this practitioner's record is in active use
. . . name Σ 0..* HumanName The name(s) associated with the person practitioner
. . . telecom Σ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
. . . address Σ 0..* Address Address(es) of the practitioner can be found/visited that are not role specific (typically home address)
. . . gender Σ 0..1 code male | female | other | unknown
AdministrativeGender ( Required )
. . . birthDate Σ 0..1 date The date on which the practitioner was born
. . . photo 0..* Attachment Image of the person practitionerRole 0..* BackboneElement Roles/organizations the practitioner is associated with managingOrganization 0..1 Reference ( Organization ) Organization where the roles are performed role Σ 0..1 CodeableConcept Roles which this practitioner may perform
PractitionerRole ( Example )
. . . qualification 0..* BackboneElement Qualifications obtained by training and certification
. . . . identifier 0..* Identifier An identifier for this qualification for the practitioner
. . . . code 1..1 CodeableConcept Coded representation of the qualification
ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, v2 table 0360, Version 1.2 2.7 ( Example )
. . . . period 0..1 Period Period during which the qualification is valid
. . . . issuer 0..1 Reference ( Organization ) Organization that regulates and issues the qualification
. . . communication 0..* CodeableConcept A language the practitioner is able to use in patient communication
Language Common Languages ( Required 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 role identifier : Identifier [0..*] Whether this practitioner's record is in active use active : boolean [0..1] A name The name(s) associated with the person practitioner name : HumanName [0..1] [0..*] A contact detail for the practitioner, e.g. a telephone number or an email address telecom : ContactPoint [0..*] The postal address where Address(es) of the practitioner can be found or visited or to which mail can be delivered that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent address : Address [0..*] Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes gender : code [0..1] « The gender of a person used for administrative purposes. (Strength=Required) AdministrativeGender ! » The date of birth for the practitioner birthDate : date [0..1] Image of the person photo : Attachment [0..*] A language the practitioner is able to use in patient communication communication : CodeableConcept [0..*] « A human language. (Strength=Required) Language ! » PractitionerRole The organization where the Practitioner performs the roles associated managingOrganization : Reference [0..1] « Organization » Roles which this practitioner is authorized to perform for the organization role : CodeableConcept [0..1] « The role a person plays representing an organization (Strength=Example) PractitionerRole ?? » Specific specialty of the practitioner specialty : CodeableConcept [0..*] « Specific specialty associated with the agency (Strength=Example) PractitionerSpecialty ?? » The period during which the person is authorized to act as a practitioner in these role(s) for the organization period : Period [0..1] The location(s) at which this practitioner provides care location : Reference [0..*] « Location » The list of healthcare services that this worker provides for this role's Organization/Location(s) (Strength=Extensible) healthcareService : Reference [0..*] « HealthcareService Common Languages » + Qualification An identifier that applies to this person's qualification in this role identifier : Identifier [0..*] Coded representation of the qualification code : CodeableConcept [1..1] « Specific qualification the practitioner has to provide a service (Strength=Example) ANZSCO -- Australian and New ... v2 table 0360, Version 2.7 ?? » Period during which the qualification is valid period : Period [0..1] Organization that regulates and issues the qualification issuer : Reference [0..1] « Organization » The list of roles/organizations that the practitioner is associated with practitionerRole [0..*] Qualifications obtained by training and certification qualification [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>
 <
 <</name>
 <</telecom>
 <</address>
 <
 <
 <</photo>
 <
  <</managingOrganization>
  <</role>
  <</specialty>
  <</period>
  <</location>
  <</healthcareService>
 </practitionerRole>
 <
  <</identifier>
  <</code>
  <</period>
  <</issuer>

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

 <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

0..1 A name Where healthcareService 0..* Reference ( HealthcareService ) The list of healthcare services that this worker provides for this role's Organization/Location(s)
Name Flags Card. Type Description & Constraints doco
. . Practitioner DomainResource A 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..* Identifier A identifier for the person as this agent
. . . active Σ 0..1 boolean Whether this practitioner's record is in active use
. . . name Σ 0..* HumanName The name(s) associated with the person practitioner
. . . telecom Σ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
. . . address Σ 0..* Address Address(es) of the practitioner can be found/visited that are not role specific (typically home address)
. . . gender Σ 0..1 code male | female | other | unknown
AdministrativeGender ( Required )
. . . birthDate Σ 0..1 date The date on which the practitioner was born
. . . photo 0..* Attachment Image of the person practitionerRole 0..* BackboneElement Roles/organizations the practitioner is associated with managingOrganization 0..1 Reference ( Organization ) Organization where the roles are performed role Σ 0..1 CodeableConcept Roles which this practitioner may perform
PractitionerRole ( Example ) specialty Σ 0..* CodeableConcept Specific specialty of the practitioner PractitionerSpecialty ( Example ) period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s) location 0..* Reference ( Location ) The location(s) at which this practitioner provides care
. . . qualification 0..* BackboneElement Qualifications obtained by training and certification
. . . . identifier 0..* Identifier An identifier for this qualification for the practitioner
. . . . code 1..1 CodeableConcept Coded representation of the qualification
ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, v2 table 0360, Version 1.2 2.7 ( Example )
. . . . period 0..1 Period Period during which the qualification is valid
. . . . issuer 0..1 Reference ( Organization ) Organization that regulates and issues the qualification
. . . communication 0..* CodeableConcept A language the practitioner is able to use in patient communication
Language Common Languages ( Required 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 role identifier : Identifier [0..*] Whether this practitioner's record is in active use active : boolean [0..1] A name The name(s) associated with the person practitioner name : HumanName [0..1] [0..*] A contact detail for the practitioner, e.g. a telephone number or an email address telecom : ContactPoint [0..*] The postal address where Address(es) of the practitioner can be found or visited or to which mail can be delivered that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent address : Address [0..*] Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes gender : code [0..1] « The gender of a person used for administrative purposes. (Strength=Required) AdministrativeGender ! » The date of birth for the practitioner birthDate : date [0..1] Image of the person photo : Attachment [0..*] A language the practitioner is able to use in patient communication communication : CodeableConcept [0..*] « A human language. (Strength=Required) Language ! » PractitionerRole The organization where the Practitioner performs the roles associated managingOrganization : Reference [0..1] « Organization » Roles which this practitioner is authorized to perform for the organization role : CodeableConcept [0..1] « The role a person plays representing an organization (Strength=Example) PractitionerRole ?? » Specific specialty of the practitioner specialty : CodeableConcept [0..*] « Specific specialty associated with the agency (Strength=Example) PractitionerSpecialty ?? » The period during which the person is authorized to act as a practitioner in these role(s) for the organization period : Period [0..1] The location(s) at which this practitioner provides care location : Reference [0..*] « Location » The list of healthcare services that this worker provides for this role's Organization/Location(s) (Strength=Extensible) healthcareService : Reference [0..*] « HealthcareService Common Languages » + Qualification An identifier that applies to this person's qualification in this role identifier : Identifier [0..*] Coded representation of the qualification code : CodeableConcept [1..1] « Specific qualification the practitioner has to provide a service (Strength=Example) ANZSCO -- Australian and New ... v2 table 0360, Version 2.7 ?? » Period during which the qualification is valid period : Period [0..1] Organization that regulates and issues the qualification issuer : Reference [0..1] « Organization » The list of roles/organizations that the practitioner is associated with practitionerRole [0..*] Qualifications obtained by training and certification qualification [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>
 <
 <</name>
 <</telecom>
 <</address>
 <
 <
 <</photo>
 <
  <</managingOrganization>
  <</role>
  <</specialty>
  <</period>
  <</location>
  <</healthcareService>
 </practitionerRole>
 <
  <</identifier>
  <</code>
  <</period>
  <</issuer>

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

 <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: Schema / Schematron , Resource Profile Master Definition ( XML , JSON ), Questionnaire XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle )

5.4.4.1 8.4.4.1 Terminology Bindings

Practitioner.practitionerRole.role The role a person plays representing an organization Example PractitionerRole Practitioner.practitionerRole.specialty Specific specialty associated with the agency Example PractitionerSpecialty
Path Definition Type Reference
Practitioner.gender The gender of a person used for administrative purposes. Required AdministrativeGender
Practitioner.qualification.code Specific qualification the practitioner has to provide a service Example ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, v2 table 0360, Version 1.2 2.7
Practitioner.communication A human language. Required Extensible , but limited to All Languages IETF language tag Common Languages

5.4.5 8.4.5 Notes:

  • Practitioner.period is different from Qualification.period: the first concerns the period during which The practitioner's Qualifications are aquired by the Practitioner is allowed practitioner independant of any organization or role, and do not imply that they are allowed/authorzied to perform in the given roles for the organization. The second is about relevant to the period of validity for qualifications for which licenses have been obtained by training or otherwise. qualification at any specific Organization/Location.

5.4.6 8.4.6 Search Parameters

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

role The practitioner can perform this role at for the organization Practitioner.practitionerRole.role
Name Type Description Paths Expression In Common
active token Whether the practitioner record is active Practitioner.active
address string An address in A server defined search that may match any kind of address/part the string fields in the Address, including line, city, state, country, postalCode, and/or text Practitioner.address 3 Resources
address-city string A city specified in an address Practitioner.address.city 3 Resources
address-country string A country specified in an address Practitioner.address.country 3 Resources
address-postalcode string A postalCode specified in an address Practitioner.address.postalCode 3 Resources
address-state string A state specified in an address Practitioner.address.state 3 Resources
address-use token A use code specified in an address Practitioner.address.use 3 Resources
communication token One of the languages that the practitioner can communicate with Practitioner.communication
email token A value in an email contact Practitioner.telecom(system=email) Practitioner.telecom.where(system='email') 4 Resources
family string A portion of the family name Practitioner.name.family 1 Resources
gender token Gender of the practitioner Practitioner.gender 3 Resources
given string A portion of the given name Practitioner.name.given 1 Resources
identifier token A practitioner's Identifier Practitioner.identifier
location reference One of the locations at which this practitioner provides care Practitioner.practitionerRole.location ( Location ) name string A portion server defined search that may match any of either family or given name the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text Practitioner.name
organization reference The identity of the organization the practitioner represents / acts on behalf of Practitioner.practitionerRole.managingOrganization ( Organization ) phone token A value in a phone contact Practitioner.telecom(system=phone) Practitioner.telecom.where(system='phone') 4 Resources
phonetic string A portion of either family or given name using some kind of phonetic matching algorithm Practitioner.name token 3 Resources
specialty token The practitioner has this specialty at an organization Practitioner.practitionerRole.specialty telecom token The value in any kind of contact Practitioner.telecom 4 Resources