FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.4 Resource Practitioner - Content

Patient Administration icon Work GroupMaturity Level: 3 Trial UseSecurity Category: Individual Compartments: Practitioner

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

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 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)
  • a bus driver for a community organization
  • a lawyer acting for a hospital or a patient
  • a person working for a supplier of a healthcare organization

The Practitioner resource is used for anyone involved in the provision of care or services to a Patient associated with an organization. The RelatedPerson resource is used for anyone involved in the care for a patient, typically having a personal *relationship *or non-healthcare-specific professional relationship to the patient.

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 (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 might or 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.

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Practitioner TUDomainResourceA 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..*IdentifierAn 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

... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... deceased[x] Σ0..1Indicates if the practitioner is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)

... photo 0..*AttachmentImage of the person

... qualification 0..*BackboneElementQualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care

.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner

.... code 1..1CodeableConceptCoded representation of the qualification
hl7VS-degreeLicenseCertificate icon (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 can use in patient communication
Common Languages (Preferred but limited to AllLanguages)


doco Documentation for this format icon

See the Extensions for this resource

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 use (this element modifies the meaning of other elements)active : 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..*]Administrative Gender - the gender that the person is considered to have for administration and record keeping purposesgender : code [0..1] « null (Strength=Required)AdministrativeGender! »The date of birth for the practitionerbirthDate : date [0..1]Indicates if the practitioner is deceased or notdeceased[x] : PrimitiveType [0..1] « boolean|dateTime »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..*]Image of the personphoto : Attachment [0..*]A language the practitioner can use in patient communicationcommunication : CodeableConcept [0..*] « null (Strength=Preferred)CommonLanguages? »QualificationAn identifier that applies to this person's qualificationidentifier : Identifier [0..*]Coded representation of the qualificationcode : CodeableConcept [1..1] « null (Strength=Example)Hl7VSDegreeLicenseCertificate?? »Period during which the qualification is validperiod : Period [0..1]Organization that regulates and issues the qualificationissuer : Reference [0..1] « Organization »The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain localityqualification[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 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>
 <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
 <birthDate value="[date]"/><!-- 0..1 The date  on which the practitioner was born -->
 <deceased[x]><!-- 0..1 boolean|dateTime Indicates if the practitioner is deceased or not --></deceased[x]>
 <address><!-- 0..* Address Address(es) of the practitioner that are not role specific (typically home address) --></address>
 <photo><!-- 0..* Attachment Image of the person --></photo>
 <qualification>  <!-- 0..* Qualifications, certifications, accreditations, licenses, training, etc 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 icon --></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 can use in patient communication --></communication>
</Practitioner>

JSON Template

{doco
  "resourceType" : "Practitioner",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // An identifier for the person as this agent
  "active" : <boolean>, // Whether this practitioner's record is in active use
  "name" : [{ HumanName }], // The name(s) associated with the practitioner
  "telecom" : [{ ContactPoint }], // A contact detail for the practitioner (that apply to all roles)
  "gender" : "<code>", // male | female | other | unknown
  "birthDate" : "<date>", // The date  on which the practitioner was born
  // deceased[x]: Indicates if the practitioner is deceased or not. One of these 2:
  "deceasedBoolean" : <boolean>,
  "deceasedDateTime" : "<dateTime>",
  "address" : [{ Address }], // Address(es) of the practitioner that are not role specific (typically home address)
  "photo" : [{ Attachment }], // Image of the person
  "qualification" : [{ // Qualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care
    "identifier" : [{ Identifier }], // An identifier for this qualification for the practitioner
    "code" : { CodeableConcept }, // R!  Coded representation of the qualification icon
    "period" : { Period }, // Period during which the qualification is valid
    "issuer" : { Reference(Organization) } // Organization that regulates and issues the qualification
  }],
  "communication" : [{ CodeableConcept }] // A language the practitioner can use in patient communication
}

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..* 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.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:Practitioner.birthDate [ date ]; # 0..1 The date  on which the practitioner was born
  # Practitioner.deceased[x] : 0..1 Indicates if the practitioner is deceased or not. One of these 2
    fhir:Practitioner.deceasedBoolean [ boolean ]
    fhir:Practitioner.deceasedDateTime [ dateTime ]
  fhir:Practitioner.address [ Address ], ... ; # 0..* Address(es) of the practitioner that are not role specific (typically home address)
  fhir:Practitioner.photo [ Attachment ], ... ; # 0..* Image of the person
  fhir:Practitioner.qualification [ # 0..* Qualifications, certifications, accreditations, licenses, training, etc 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:Practitioner.communication [ CodeableConcept ], ... ; # 0..* A language the practitioner can use in patient communication
]

Changes since R4

Practitioner
Practitioner.active
  • Now marked as Modifier
  • Now marked as Modifier
Practitioner.deceased[x]
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

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

Structure

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. Practitioner TUDomainResourceA 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..*IdentifierAn 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

... gender Σ0..1codemale | female | other | unknown
AdministrativeGender (Required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... deceased[x] Σ0..1Indicates if the practitioner is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)

... photo 0..*AttachmentImage of the person

... qualification 0..*BackboneElementQualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care

.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner

.... code 1..1CodeableConceptCoded representation of the qualification
hl7VS-degreeLicenseCertificate icon (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 can use in patient communication
Common Languages (Preferred but limited to AllLanguages)


doco Documentation for this format icon

See the Extensions for this resource

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 use (this element modifies the meaning of other elements)active : 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..*]Administrative Gender - the gender that the person is considered to have for administration and record keeping purposesgender : code [0..1] « null (Strength=Required)AdministrativeGender! »The date of birth for the practitionerbirthDate : date [0..1]Indicates if the practitioner is deceased or notdeceased[x] : PrimitiveType [0..1] « boolean|dateTime »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..*]Image of the personphoto : Attachment [0..*]A language the practitioner can use in patient communicationcommunication : CodeableConcept [0..*] « null (Strength=Preferred)CommonLanguages? »QualificationAn identifier that applies to this person's qualificationidentifier : Identifier [0..*]Coded representation of the qualificationcode : CodeableConcept [1..1] « null (Strength=Example)Hl7VSDegreeLicenseCertificate?? »Period during which the qualification is validperiod : Period [0..1]Organization that regulates and issues the qualificationissuer : Reference [0..1] « Organization »The official qualifications, certifications, accreditations, training, licenses (and other types of educations/skills/capabilities) that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board of licensure authorizing the practitioner to practice medicine within a certain localityqualification[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 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>
 <gender value="[code]"/><!-- 0..1 male | female | other | unknown -->
 <birthDate value="[date]"/><!-- 0..1 The date  on which the practitioner was born -->
 <deceased[x]><!-- 0..1 boolean|dateTime Indicates if the practitioner is deceased or not --></deceased[x]>
 <address><!-- 0..* Address Address(es) of the practitioner that are not role specific (typically home address) --></address>
 <photo><!-- 0..* Attachment Image of the person --></photo>
 <qualification>  <!-- 0..* Qualifications, certifications, accreditations, licenses, training, etc 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 icon --></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 can use in patient communication --></communication>
</Practitioner>

JSON Template

{doco
  "resourceType" : "Practitioner",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // An identifier for the person as this agent
  "active" : <boolean>, // Whether this practitioner's record is in active use
  "name" : [{ HumanName }], // The name(s) associated with the practitioner
  "telecom" : [{ ContactPoint }], // A contact detail for the practitioner (that apply to all roles)
  "gender" : "<code>", // male | female | other | unknown
  "birthDate" : "<date>", // The date  on which the practitioner was born
  // deceased[x]: Indicates if the practitioner is deceased or not. One of these 2:
  "deceasedBoolean" : <boolean>,
  "deceasedDateTime" : "<dateTime>",
  "address" : [{ Address }], // Address(es) of the practitioner that are not role specific (typically home address)
  "photo" : [{ Attachment }], // Image of the person
  "qualification" : [{ // Qualifications, certifications, accreditations, licenses, training, etc pertaining to the provision of care
    "identifier" : [{ Identifier }], // An identifier for this qualification for the practitioner
    "code" : { CodeableConcept }, // R!  Coded representation of the qualification icon
    "period" : { Period }, // Period during which the qualification is valid
    "issuer" : { Reference(Organization) } // Organization that regulates and issues the qualification
  }],
  "communication" : [{ CodeableConcept }] // A language the practitioner can use in patient communication
}

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..* 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.gender [ code ]; # 0..1 male | female | other | unknown
  fhir:Practitioner.birthDate [ date ]; # 0..1 The date  on which the practitioner was born
  # Practitioner.deceased[x] : 0..1 Indicates if the practitioner is deceased or not. One of these 2
    fhir:Practitioner.deceasedBoolean [ boolean ]
    fhir:Practitioner.deceasedDateTime [ dateTime ]
  fhir:Practitioner.address [ Address ], ... ; # 0..* Address(es) of the practitioner that are not role specific (typically home address)
  fhir:Practitioner.photo [ Attachment ], ... ; # 0..* Image of the person
  fhir:Practitioner.qualification [ # 0..* Qualifications, certifications, accreditations, licenses, training, etc 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:Practitioner.communication [ CodeableConcept ], ... ; # 0..* A language the practitioner can use in patient communication
]

Changes since Release 4

Practitioner
Practitioner.active
  • Now marked as Modifier
  • Now marked as Modifier
Practitioner.deceased[x]
  • Added Element

See the Full Difference for further information

This analysis is available as XML or JSON.

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

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

PathDefinitionTypeReference
Practitioner.gender

The gender of a person used for administrative purposes.

RequiredAdministrativeGender
Practitioner.qualification.code

Concepts specifying an educational degree (e.g., MD). Used in the CNN datatype (names and identifiers of clinicians) in Version 2 messaging. Used in Version 2 messaging; note that in releases of HL7 prior to 2.3.1, was also used in person names (XPN), but this use was deprecated, then withdrawn in 2.7.

ExampleHl7VSDegreeLicenseCertificate icon (a valid code from degreeLicenseCertificate icon)
Practitioner.communication

This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47)

Preferred, but limited to AllLanguagesCommonLanguages

  • The practitioner's Qualifications are acquired by the practitioner independent of any organization or role, and do not imply that they are allowed/authorized to perform roles relevant to the qualification at any specific Organization/Location.
  • Business idenfitiers may be used in Practitioner.identifier and/or Practitioner.qualification.identifier based on local requirements.
    The Practitioner.identifier doesn't convey anything about the status of the license (other than period), if this or any additional details are available then the qualification.identifier should be used.
    E.g. a specific license includes its type, status, issuer and a local category extension for which specialties were included in the license.

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

NameTypeDescriptionExpressionIn Common
active NtokenWhether the practitioner record is activePractitioner.active
addressstringA server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or textPractitioner.address
address-city NstringA city specified in an addressPractitioner.address.city
address-country NstringA country specified in an addressPractitioner.address.country
address-postalcode NstringA postalCode specified in an addressPractitioner.address.postalCode
address-state NstringA state specified in an addressPractitioner.address.state
address-use NtokenA use code specified in an addressPractitioner.address.use
communicationtokenOne of the languages that the practitioner can communicate withPractitioner.communication
death-datedateThe date of death has been provided and satisfies this search value(Practitioner.deceased as dateTime)
deceasedtokenThis Practitioner has been marked as deceased, or has a death date enteredPractitioner.deceased.exists() and Practitioner.deceased != false
emailtokenA value in an email contactPractitioner.telecom.where(system='email')
family NstringA portion of the family namePractitioner.name.family
gender NtokenGender of the practitionerPractitioner.gender
given NstringA portion of the given namePractitioner.name.given
identifiertokenA practitioner's IdentifierPractitioner.identifier | Practitioner.qualification.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')
phoneticstringA portion of either family or given name using some kind of phonetic matching algorithmPractitioner.name
qualification-perioddateThe date(s) a qualification is valid forPractitioner.qualification.period
telecomtokenThe value in any kind of contactPractitioner.telecom