Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). 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

Content Examples Detailed Descriptions Mappings Profiles & Extensions R3 Conversions 8.4 Resource Practitioner - Content

Example CodeSystem/payment-outcome (XML)

Compartments : Practitioner
Patient Administration Financial Management Work Group Maturity Level : 3   Trial Use N/A Security Category Standards Status : Individual Informative
A person who is directly or indirectly involved in the provisioning of healthcare. 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 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) 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 (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) 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 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 , Encounter , EnrollmentRequest , EnrollmentResponse , EpisodeOfCare , ExplanationOfBenefit , Flag , Goal , Group , ImagingStudy , Immunization , Invoice , Linkage , List , MeasureReport , Media , MedicationAdministration , MedicationDispense , MedicationRequest , MedicationStatement , MessageHeader , NutritionOrder , Observation , Patient , PaymentNotice , PaymentReconciliation , Person , PractitionerRole , Procedure , Provenance , QuestionnaireResponse , RequestGroup , ResearchStudy , RiskAssessment , Schedule , ServiceRequest , Specimen , SupplyDelivery , SupplyRequest , Task , VerificationResult and VisionPrescription 8.4.4 Resource Content

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 Certification, licenses, or training 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 can use in patient communication Common Languages Raw XML ( Preferred but limited to AllLanguages ) Documentation for this format canonical form UML Diagram ( Legend + also see XML Format Specification )

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 can use in patient communication communication : CodeableConcept [0..*] « A human language. (Strength=Preferred) 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. (Strength=Example) 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 » The official certifications, training, and 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 < <!-- from --> <!-- from --> <</identifier> < <</name> <</telecom> <<a href="practitioner-definitions.html#Practitioner.address" title="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." class="dict"></address> < < <</photo> < <</identifier> <</code> <</period> <</issuer> </qualification> <</communication> </Practitioner> JSON Template { "resourceType" : "", // from // from " " " " "<a href="practitioner-definitions.html#Practitioner.address" title="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." class="dict">address " " " " " " " " }], " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: fhir: fhir:<a href="practitioner-definitions.html#Practitioner.address" title="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." class="dict">Practitioner.address fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: ] Changes since R3 Practitioner Practitioner.active Default Value "true" removed Practitioner.gender Change value set from http://hl7.org/fhir/ValueSet/administrative-gender to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 Practitioner.communication Change binding strength from extensible to preferred

See the Full Difference Definition 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.) Code SystemClaimProcessingCodes

Structure 
<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="payment-outcome"/> 
  <meta> 
    <lastUpdated value="2022-09-10T05:52:37.223+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system 
        <code> http://hl7.org/fhir/payment-outcome</code>  defines the following codes:
      </p> 
      <table class="codes">
        <tr> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">queued
            <a name="payment-outcome-queued"> </a> 
          </td> 
          <td> Queued</td> 
          <td> The Claim/Pre-authorization/Pre-determination has been received but processing

             has not begun.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">complete
            <a name="payment-outcome-complete"> </a> 
          </td> 
          <td> Processing Complete</td> 
          <td> The processing has completed without errors</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">error
            <a name="payment-outcome-error"> </a> 
          </td> 
          <td> Error</td> 
          <td> One or more errors have been detected in the Claim</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">partial
            <a name="payment-outcome-partial"> </a> 
          </td> 
          <td> Partial Processing</td> 
          <td> No errors have been detected in the Claim and some of the adjudication has been

             performed.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fm"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2"/> 
  </extension> 
  <url value="http://hl7.org/fhir/payment-outcome"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.2058"/> 
  </identifier> 
  <version value="5.0.0-ballot"/> 
  <name value="ClaimProcessingCodes"/> 
  <title value="Claim Processing Codes"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <publisher value="FHIR Project team"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="This value set includes Claim Processing Outcome codes."/> 
  <copyright value="HL7 Inc."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/payment-outcome"/> 
  <content value="complete"/> 
  <concept> 
    <code value="queued"/> 
    <display value="Queued"/> 
    <definition value="The Claim/Pre-authorization/Pre-determination has been received but processing

     has not begun."/> 
  </concept> 
  <concept> 
    <code value="complete"/> 
    <display value="Processing Complete"/> 
    <definition value="The processing has completed without errors"/> 
  </concept> 
  <concept> 
    <code value="error"/> 
    <display value="Error"/> 
    <definition value="One or more errors have been detected in the Claim"/> 
  </concept> 
  <concept> 
    <code value="partial"/> 
    <display value="Partial Processing"/> 
    <definition value="No errors have been detected in the Claim and some of the adjudication has been

     performed."/> 
  </concept> 

Name
Flags
Card.
Type
Description
&
Constraints


</

CodeSystem


>


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
Certification,
licenses,
or
training
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
can
use
in
patient
communication
Common
Languages
(
Preferred
but
limited
to
AllLanguages
)
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 can use in patient communication communication : CodeableConcept [0..*] « A human language. (Strength=Preferred) 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 Usage note: every effort has been made to provide a service. (Strength=Example) 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 » The official certifications, training, and licenses ensure 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 < <!-- from --> <!-- from --> <</identifier> < <</name> <</telecom> <<a href="practitioner-definitions.html#Practitioner.address" title="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." class="dict"></address> < < <</photo> < <</identifier> <</code> <</period> <</issuer> </qualification> <</communication> </Practitioner> JSON Template { "resourceType" : "", // from // from " " " " "<a href="practitioner-definitions.html#Practitioner.address" title="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." class="dict">address " " " " " " " " }], " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: fhir: fhir:<a href="practitioner-definitions.html#Practitioner.address" title="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." class="dict">Practitioner.address fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: ] Changes since Release 3 Practitioner Practitioner.active Default Value "true" removed Practitioner.gender Change value set from http://hl7.org/fhir/ValueSet/administrative-gender to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 Practitioner.communication Change binding strength from extensible to preferred 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 examples are valid.)   See the Profiles & Extensions correct and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis 8.4.4.1 Terminology Bindings 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.0360.2.7 Practitioner.communication A human language. Preferred , useful, but limited to AllLanguages CommonLanguages 8.4.5 Notes: 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. 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. 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 not 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 normative part of contact Practitioner.telecom 4 Resources the specification.