FHIR Release 3 (STU) Current Build

8.4 Resource Practitioner - Content

Patient Administration Work Group Maturity Level : 3   Trial Use Security Category : Individual Compartments : 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, homecare providers, 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 (and 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 might or may might 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 Annotation , Signature , Account , AdverseEvent , AllergyIntolerance , Appointment , AppointmentResponse , AuditEvent , Basic , BiologicallyDerivedProduct , CarePlan , CareTeam , CatalogEntry , ChargeItem , Claim , ClaimResponse , ClinicalImpression , Communication , CommunicationRequest , Composition , Condition , Consent , Contract , CoverageEligibilityRequest , CoverageEligibilityResponse , DetectedIssue , DeviceRequest , DeviceUseStatement , DiagnosticReport , DocumentManifest , DocumentReference , EligibilityRequest , EligibilityResponse , Encounter , EnrollmentRequest , EnrollmentResponse , EpisodeOfCare , ExplanationOfBenefit , Flag , Goal , Group , ImagingManifest , ImagingStudy , Immunization , Invoice , Linkage , List , MeasureReport , Media , MedicationAdministration , MedicationDispense , MedicationRequest , MedicationStatement , MessageHeader , NutritionOrder , Observation , Patient , PaymentNotice , PaymentReconciliation , Person , PractitionerRole , Procedure , ProcedureRequest , ProcessRequest , ProcessResponse , Provenance , QuestionnaireResponse , ReferralRequest , RequestGroup , ResearchStudy , RiskAssessment , Schedule , ServiceRequest , Specimen , SupplyDelivery , SupplyRequest , Task , VerificationResult and VisionPrescription

Structure

Name Flags Card. Type Description & Constraints doco
. . Practitioner TU 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 An 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 practitioner
. . . telecom Σ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
. . . address Σ 0..* Address Address(es) of the practitioner 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
. . . qualification 0..* BackboneElement Qualifications obtained by Certification, licenses, or training and certification pertaining to the provision of care
. . . . identifier 0..* Identifier An identifier for this qualification for the practitioner
. . . . code 1..1 CodeableConcept Coded representation of the qualification
v2 table 0360, Version 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 can use in patient communication
Common Languages ( Extensible Preferred but limited to All Languages AllLanguages )

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] The name(s) associated with the practitioner name : HumanName [0..*] A contact detail for the practitioner, e.g. a telephone number or an email address telecom : 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 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 can use in patient communication communication : CodeableConcept [0..*] « A human language. (Strength=Extensible) (Strength=Preferred) Common Languages CommonLanguages + ? » 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 service. (Strength=Example) v2 table 0360, Version 2.7 v2.0360.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 » Qualifications obtained by training The official certifications, training, and certification 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 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>

 <identifier><!-- 0..* Identifier An 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..* Certification, licenses, or training pertaining to the provision of care -->

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

  fhir:Practitioner.identifier [ Identifier ], ... ; # 0..* An 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:

  fhir:Practitioner.qualification [ # 0..* Certification, licenses, or training pertaining to the provision of care

    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:

  fhir:Practitioner.communication [ CodeableConcept ], ... ; # 0..* A language the practitioner can use in patient communication

]

Changes since DSTU2 R3

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

See the Full Difference for further information

This analysis is available as XML or JSON .

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

Structure

Name Flags Card. Type Description & Constraints doco
. . Practitioner TU 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 An 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 practitioner
. . . telecom Σ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
. . . address Σ 0..* Address Address(es) of the practitioner 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
. . . qualification 0..* BackboneElement Qualifications obtained by Certification, licenses, or training and certification pertaining to the provision of care
. . . . identifier 0..* Identifier An identifier for this qualification for the practitioner
. . . . code 1..1 CodeableConcept Coded representation of the qualification
v2 table 0360, Version 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 can use in patient communication
Common Languages ( Extensible Preferred but limited to All Languages AllLanguages )

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] The name(s) associated with the practitioner name : HumanName [0..*] A contact detail for the practitioner, e.g. a telephone number or an email address telecom : 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 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 can use in patient communication communication : CodeableConcept [0..*] « A human language. (Strength=Extensible) (Strength=Preferred) Common Languages CommonLanguages + ? » 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 service. (Strength=Example) v2 table 0360, Version 2.7 v2.0360.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 » Qualifications obtained by training The official certifications, training, and certification 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 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>

 <identifier><!-- 0..* Identifier An 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..* Certification, licenses, or training pertaining to the provision of care -->

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

  fhir:Practitioner.identifier [ Identifier ], ... ; # 0..* An 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:

  fhir:Practitioner.qualification [ # 0..* Certification, licenses, or training pertaining to the provision of care

    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:

  fhir:Practitioner.communication [ CodeableConcept ], ... ; # 0..* A language the practitioner can use in patient communication

]

Changes since DSTU2 Release 3

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

See the Full Difference for further information

This analysis is available as XML or JSON .

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

 

Alternate See the Profiles & Extensions and the alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

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 service. Example v2 table 0360, Version 2.7 v2.0360.2.7
Practitioner.communication A human language. Extensible Preferred , but limited to All Languages AllLanguages Common Languages CommonLanguages

  • The practitioner's Qualifications are aquired acquired by the practitioner independant independent of any organization or role, and do not imply that they are allowed/authorzied allowed/authorized 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.

Name Type Description Expression In Common
active token Whether the practitioner record is active Practitioner.active
address string A server defined search that may match any of the string fields in the Address, including line, city, district, 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.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
name string A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text Practitioner.name
phone token A value in a phone contact 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 3 Resources
telecom token The value in any kind of contact Practitioner.telecom 4 Resources