Snapshot 3: Connectathon 32 Base
AdministrationThis page is part of the FHIR Specification (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32). 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
| 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 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):
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:
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 | Flags | Card. | Type | Description & Constraints  |
|---|---|---|---|---|
  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 | 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) |
| gender | Σ | 0..1 | code | male | female | other | unknown AdministrativeGender (Required) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
  deceased[x] | Σ | 0..1 | Indicates if the practitioner is deceased or not | |
 deceasedBoolean | boolean | |||
 deceasedDateTime | dateTime | |||
| address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| photo | 0..* | Attachment | Image of the person | |
 qualification | 0..* | BackboneElement | Qualifications, certifications, accreditations, licenses, training, etc 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 hl7VS-degreeLicenseCertificate (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 can use in patient communication Common Languages (Preferred but limited to AllLanguages) | |
| Documentation for this format | ||||
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<Practitioner xmlns="http://hl7.org/fhir"><!-- 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
JSON Template
{
"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
"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/> .
Changes since R4
| Practitioner | |
| Practitioner.active |
|
| Practitioner.deceased[x] |
|
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 | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | 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) |
| gender | Σ | 0..1 | code | male | female | other | unknown AdministrativeGender (Required) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
| deceased[x] | Σ | 0..1 | Indicates if the practitioner is deceased or not | |
| deceasedBoolean | boolean | |||
| deceasedDateTime | dateTime | |||
| address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| photo | 0..* | Attachment | Image of the person | |
| qualification | 0..* | BackboneElement | Qualifications, certifications, accreditations, licenses, training, etc 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 hl7VS-degreeLicenseCertificate (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 can use in patient communication Common Languages (Preferred but limited to AllLanguages) | |
| Documentation for this format | ||||
See the Extensions for this resource
XML Template
<Practitioner xmlns="http://hl7.org/fhir">
JSON Template
{
"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
"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/> .
Changes since Release 4
| Practitioner | |
| Practitioner.active |
|
| Practitioner.deceased[x] |
|
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
| Path | Definition | Type | Reference |
|---|---|---|---|
| Practitioner.gender | The gender of a person used for administrative purposes. | Required | AdministrativeGender |
| 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. | Example | Hl7VSDegreeLicenseCertificate (a valid code from degreeLicenseCertificate ) |
| Practitioner.communication | This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47) | Preferred, but limited to AllLanguages | CommonLanguages |
Practitioner.identifier and/or Practitioner.qualification.identifier based on local requirements.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.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 | 4 Resources |
| address-city | string | A city specified in an address | Practitioner.address.city | 4 Resources |
| address-country | string | A country specified in an address | Practitioner.address.country | 4 Resources |
| address-postalcode | string | A postalCode specified in an address | Practitioner.address.postalCode | 4 Resources |
| address-state | string | A state specified in an address | Practitioner.address.state | 4 Resources |
| address-use | token | A use code specified in an address | Practitioner.address.use | 4 Resources |
| communication | token | One of the languages that the practitioner can communicate with | Practitioner.communication | |
| death-date | date | The date of death has been provided and satisfies this search value | (Practitioner.deceased as dateTime) | |
| deceased | token | This Practitioner has been marked as deceased, or has a death date entered | Practitioner.deceased.exists() and Practitioner.deceased != false | |
| token | A value in an email contact | Practitioner.telecom.where(system='email') | 5 Resources | |
| family | string | A portion of the family name | Practitioner.name.family | 2 Resources |
| gender | token | Gender of the practitioner | Practitioner.gender | 4 Resources |
| given | string | A portion of the given name | Practitioner.name.given | 2 Resources |
| identifier | token | A practitioner's Identifier | Practitioner.identifier | Practitioner.qualification.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') | 5 Resources |
| phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm | Practitioner.name | 4 Resources |
| qualification-period | date | The date(s) a qualification is valid for | Practitioner.qualification.period | |
| telecom | token | The value in any kind of contact | Practitioner.telecom | 5 Resources |
FHIR ®© HL7.org 2011+. FHIR R5 Snapshot 3, hl7.fhir.core#5.0.0-snapshot3 generated on Wed, Dec 14, 2022 07:17+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change