R4 Ballot #1 (Mixed Normative/Trial use)
AdministrationThis page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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 | 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):
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.
This resource is referenced by Account, AdverseEvent, AllergyIntolerance, Appointment, AppointmentResponse, AuditEvent, Basic, BiologicallyDerivedProduct, CarePlan, CareTeam, ChargeItem, Claim, ClaimResponse, ClinicalImpression, Communication, CommunicationRequest, Composition, Condition, Consent, Contract, DetectedIssue, DeviceRequest, DeviceUseStatement, DiagnosticReport, DocumentManifest, DocumentReference, EligibilityRequest, EligibilityResponse, Encounter, EnrollmentRequest, EnrollmentResponse, EntryDefinition, EpisodeOfCare, ExplanationOfBenefit, Flag, Goal, Group, ImagingStudy, Immunization, Invoice, Linkage, List, MeasureReport, Media, MedicationAdministration, MedicationDispense, MedicationRequest, MedicationStatement, MessageHeader, NutritionOrder, Observation, OccupationalData, Patient, PaymentNotice, PaymentReconciliation, Person, PractitionerRole, Procedure, ProcessRequest, ProcessResponse, Provenance, QuestionnaireResponse, RequestGroup, ResearchStudy, RiskAssessment, Schedule, ServiceRequest, Specimen, SupplyDelivery, SupplyRequest, Task, UserSession, VerificationResult and VisionPrescription
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) |
| 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 training and certification | |
 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 can use in patient communication Common Languages (Extensible but limited to All Languages) | |
| Documentation for this format | ||||
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> <address><!-- 0..* Address Address(es) of the practitioner that are not role specific (typically home address) --></address> <gender value="[code]"/><!-- 0..1 male | female | other | unknown --> <birthDate value="[date]"/><!-- 0..1 The date on which the practitioner was born --> <photo><!-- 0..* Attachment Image of the person --></photo> <qualification> <!-- 0..* Qualifications obtained by training and certification --> <identifier><!-- 0..* Identifier An identifier for this qualification for the practitioner --></identifier> <code><!-- 1..1 CodeableConcept Coded representation of the qualification --></code> <period><!-- 0..1 Period Period during which the qualification is valid --></period> <issuer><!-- 0..1 Reference(Organization) Organization that regulates and issues the qualification --></issuer> </qualification> <communication><!-- 0..* CodeableConcept A language the practitioner can use in patient communication --></communication> </Practitioner>
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)
"address" : [{ Address }], // Address(es) of the practitioner that are not role specific (typically home address)
"gender" : "<code>", // male | female | other | unknown
"birthDate" : "<date>", // The date on which the practitioner was born
"photo" : [{ Attachment }], // Image of the person
"qualification" : [{ // Qualifications obtained by training and certification
"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 R3
| Practitioner | |
| Practitioner.active |
|
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.). Note: these have note yet been updated to be R3 to R4
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) |
| 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 training and certification | |
| 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 can use in patient communication Common Languages (Extensible but limited to All Languages) | |
| Documentation for this format | ||||
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)
"address" : [{ Address }], // Address(es) of the practitioner that are not role specific (typically home address)
"gender" : "<code>", // male | female | other | unknown
"birthDate" : "<date>", // The date on which the practitioner was born
"photo" : [{ Attachment }], // Image of the person
"qualification" : [{ // Qualifications obtained by training and certification
"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 DSTU2
| Practitioner | |
| Practitioner.active |
|
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.). Note: these have note yet been updated to be R3 to R4
Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + 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 | Example | v2 table 0360, Version 2.7 |
| Practitioner.communication | A human language. | Extensible, but limited to All Languages | Common Languages |
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 | |
| 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 |
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot (v3.3.0-13671) generated on Tue, Apr 3, 2018 12:17+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change