Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Practitioner

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-practitioner-profile Version: 23.1.0
Active as of 2022-03-01 Computable Name: AthenaPractitioner

Defines constraints and extensions on the practitioner resource as supported by Athena Products.

This Practitioner profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

This resource records the person who is directly or indirectly involved in the provisioning of healthcare. For ambulatory clinics, this is typically the physician or nurse attending to a patient.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Practitioner resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The Practitioner resource describes healthcare providers who use or indirectly interact (e.g., through referrals) with the athenaPractice or athenaFlow products. It is derived from the DoctorFacility and SERVPROV tables in athenaFlow and the USR, SERVPROV and PERSON tables in athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id 0..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Practitioner Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
..... profile:Athena Practitioner Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-practitioner-profile
... Slices for identifier S 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by value:type
.... identifier:PVID 0..1 Identifier An identifier for the person as this agent
.... identifier:NPI 0..1 Identifier An identifier for the person as this agent
.... identifier:TAX 0..1 Identifier An identifier for the person as this agent
... name S 1..1 HumanName The name(s) associated with the practitioner
.... family 1..1 string Family name (often called 'Surname')
.... Slices for given 0..2 string Given names (not always 'first'). Includes middle names
Slice: Unordered, Open by value:given
..... given:FIRSTNAME 0..1 string Given names (not always 'first'). Includes middle names
..... given:MIDDLENAME 0..1 string Given names (not always 'first'). Includes middle names
.... prefix 0..1 string Parts that come before the name
.... suffix 0..1 string Parts that come after the name
... Slices for telecom S 0..2 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:type use
.... telecom:WORKPHONE 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
.... telecom:FAXPHONE 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Fixed Value: mobile
... address S 0..1 Address Address(es) of the practitioner that are not role specific (typically home address)
.... Slices for line 0..2 string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:line
..... line:ADDRESS1 0..1 string Street name, number, direction & P.O. Box etc.
..... line:ADDRESS2 0..1 string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... state 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode 0..1 string Postal code for area
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Practitioner Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
..... profile:Athena Practitioner Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-practitioner-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for identifier SΣ 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by value:type
.... identifier:PVID Σ 0..1 Identifier An identifier for the person as this agent
.... identifier:NPI Σ 0..1 Identifier An identifier for the person as this agent
.... identifier:TAX Σ 0..1 Identifier An identifier for the person as this agent
... active SΣ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..1 HumanName The name(s) associated with the practitioner
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family Σ 1..1 string Family name (often called 'Surname')
.... Slices for given Σ 0..2 string Given names (not always 'first'). Includes middle names
Slice: Unordered, Open by value:given
This repeating element order: Given Names appear in the correct order for presenting the name
..... given:FIRSTNAME Σ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... given:MIDDLENAME Σ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..1 string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... Slices for telecom SΣ 0..2 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:type use
.... telecom:WORKPHONE Σ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... telecom:FAXPHONE Σ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: mobile
... address SΣ 0..1 Address Address(es) of the practitioner that are not role specific (typically home address)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... Slices for line Σ 0..2 string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:line
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:ADDRESS1 Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:ADDRESS2 Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom:WORKPHONE.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom:WORKPHONE.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.telecom:FAXPHONE.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom:FAXPHONE.userequiredFixed Value: mobile
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Practitioner Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
..... profile:Athena Practitioner Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-practitioner-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by value:type
.... identifier:PVID Σ 0..1 Identifier An identifier for the person as this agent
.... identifier:NPI Σ 0..1 Identifier An identifier for the person as this agent
.... identifier:TAX Σ 0..1 Identifier An identifier for the person as this agent
... active SΣ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..1 HumanName The name(s) associated with the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string Family name (often called 'Surname')
.... Slices for given Σ 0..2 string Given names (not always 'first'). Includes middle names
Slice: Unordered, Open by value:given
This repeating element order: Given Names appear in the correct order for presenting the name
..... given:FIRSTNAME Σ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... given:MIDDLENAME Σ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..1 string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom SΣ 0..2 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:type use
.... telecom:WORKPHONE Σ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:FAXPHONE Σ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: mobile
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..1 Address Address(es) of the practitioner that are not role specific (typically home address)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... Slices for line Σ 0..2 string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:line
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:ADDRESS1 Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:ADDRESS2 Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... 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
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Practitioner.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom:WORKPHONE.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom:WORKPHONE.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.telecom:FAXPHONE.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom:FAXPHONE.userequiredFixed Value: mobile
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

This structure is derived from Practitioner

Summary

Mandatory: 3 elements(6 nested mandatory elements)
Must-Support: 12 elements
Fixed: 6 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Practitioner.meta.profile
  • The element 1 is sliced based on the value of Practitioner.identifier
  • The element 1 is sliced based on the value of Practitioner.name.given
  • The element 1 is sliced based on the value of Practitioner.telecom
  • The element 1 is sliced based on the value of Practitioner.address.line

Differential View

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id 0..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... versionId S 0..1 id Version specific identifier
.... Slices for profile 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Practitioner Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
..... profile:Athena Practitioner Profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-practitioner-profile
... Slices for identifier S 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by value:type
.... identifier:PVID 0..1 Identifier An identifier for the person as this agent
.... identifier:NPI 0..1 Identifier An identifier for the person as this agent
.... identifier:TAX 0..1 Identifier An identifier for the person as this agent
... name S 1..1 HumanName The name(s) associated with the practitioner
.... family 1..1 string Family name (often called 'Surname')
.... Slices for given 0..2 string Given names (not always 'first'). Includes middle names
Slice: Unordered, Open by value:given
..... given:FIRSTNAME 0..1 string Given names (not always 'first'). Includes middle names
..... given:MIDDLENAME 0..1 string Given names (not always 'first'). Includes middle names
.... prefix 0..1 string Parts that come before the name
.... suffix 0..1 string Parts that come after the name
... Slices for telecom S 0..2 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:type use
.... telecom:WORKPHONE 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Fixed Value: work
.... telecom:FAXPHONE 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system S 1..1 code phone | fax | email | pager | url | sms | other
Fixed Value: phone
..... value S 1..1 string The actual contact point details
..... use S 0..1 code home | work | temp | old | mobile - purpose of this contact point
Fixed Value: mobile
... address S 0..1 Address Address(es) of the practitioner that are not role specific (typically home address)
.... Slices for line 0..2 string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:line
..... line:ADDRESS1 0..1 string Street name, number, direction & P.O. Box etc.
..... line:ADDRESS2 0..1 string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... state 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode 0..1 string Postal code for area
.... country 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Practitioner Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
..... profile:Athena Practitioner Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-practitioner-profile
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for identifier SΣ 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by value:type
.... identifier:PVID Σ 0..1 Identifier An identifier for the person as this agent
.... identifier:NPI Σ 0..1 Identifier An identifier for the person as this agent
.... identifier:TAX Σ 0..1 Identifier An identifier for the person as this agent
... active SΣ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..1 HumanName The name(s) associated with the practitioner
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family Σ 1..1 string Family name (often called 'Surname')
.... Slices for given Σ 0..2 string Given names (not always 'first'). Includes middle names
Slice: Unordered, Open by value:given
This repeating element order: Given Names appear in the correct order for presenting the name
..... given:FIRSTNAME Σ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... given:MIDDLENAME Σ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..1 string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
... Slices for telecom SΣ 0..2 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:type use
.... telecom:WORKPHONE Σ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
.... telecom:FAXPHONE Σ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: mobile
... address SΣ 0..1 Address Address(es) of the practitioner that are not role specific (typically home address)
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... Slices for line Σ 0..2 string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:line
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:ADDRESS1 Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:ADDRESS2 Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom:WORKPHONE.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom:WORKPHONE.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.telecom:FAXPHONE.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom:FAXPHONE.userequiredFixed Value: mobile
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 2..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:USCore Practitioner Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
..... profile:Athena Practitioner Profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-practitioner-profile
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier An identifier for the person as this agent
Slice: Unordered, Open by value:type
.... identifier:PVID Σ 0..1 Identifier An identifier for the person as this agent
.... identifier:NPI Σ 0..1 Identifier An identifier for the person as this agent
.... identifier:TAX Σ 0..1 Identifier An identifier for the person as this agent
... active SΣ 0..1 boolean Whether this practitioner's record is in active use
... name SΣ 1..1 HumanName The name(s) associated with the practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ 0..1 string Text representation of the full name
.... family Σ 1..1 string Family name (often called 'Surname')
.... Slices for given Σ 0..2 string Given names (not always 'first'). Includes middle names
Slice: Unordered, Open by value:given
This repeating element order: Given Names appear in the correct order for presenting the name
..... given:FIRSTNAME Σ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... given:MIDDLENAME Σ 0..1 string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ 0..1 string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ 0..1 string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ 0..1 Period Time period when name was/is in use
... Slices for telecom SΣ 0..2 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:type use
.... telecom:WORKPHONE Σ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: work
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... telecom:FAXPHONE Σ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


Fixed Value: phone
..... value SΣ 1..1 string The actual contact point details
..... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


Fixed Value: mobile
..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
... address SΣ 0..1 Address Address(es) of the practitioner that are not role specific (typically home address)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... Slices for line Σ 0..2 string Street name, number, direction & P.O. Box etc.
Slice: Unordered, Open by value:line
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:ADDRESS1 Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
..... line:ADDRESS2 Σ 0..1 string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... 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
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Practitioner.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
Practitioner.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Practitioner.name.userequiredNameUse
http://hl7.org/fhir/ValueSet/name-use|4.0.1
from the FHIR Standard
Practitioner.telecom:WORKPHONE.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom:WORKPHONE.userequiredFixed Value: work
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.telecom:FAXPHONE.systemrequiredFixed Value: phone
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Practitioner.telecom:FAXPHONE.userequiredFixed Value: mobile
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Practitioner.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Practitioner.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Practitioner.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
http://terminology.hl7.org/ValueSet/v2-2.7-0360
from the FHIR Standard
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard

This structure is derived from Practitioner

Summary

Mandatory: 3 elements(6 nested mandatory elements)
Must-Support: 12 elements
Fixed: 6 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Practitioner.meta.profile
  • The element 1 is sliced based on the value of Practitioner.identifier
  • The element 1 is sliced based on the value of Practitioner.name.given
  • The element 1 is sliced based on the value of Practitioner.telecom
  • The element 1 is sliced based on the value of Practitioner.address.line

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Practitioner resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/r4/Practitioner?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Practitioner resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
active (token) Whether the practitioner record is 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
address-city (string) A city specified in an address
address-country (string) A country specified in an address
address-postalcode (string) A postalCode specified in an address
address-state (string) A state specified in an address
family (string) A portion of the family name
given (string) A portion of the given name
identifier (token) A practitioner's 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
phone (token) A value in a phone contact
phonetic (string) A portion of either family or given name using some kind of phonetic matching algorithm
telecom (token) The value in any kind of contact
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.