Athena Core Implementation Guide
5.10.2 - release

Athena Core Implementation Guide - Local Development build (v5.10.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: athenahealth Practitioner Provider Details

Official URL: https://fhir.athena.io/StructureDefinition/ah-practitioner-provider-details Version: 5.10.2
Active as of 2026-05-26 Computable Name: AthenaPractitionerProviderDetails

An Extension containing details about a practitioner provider.

Context of Use

This extension may be used on the following element(s):

  • Element ID Practitioner

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: An Extension containing details about a practitioner provider.

  • isHiddenInPortal: boolean: Denotes if this provider needs to be hidden in the patient portal.
  • isBillable: boolean: Indicates if this provider is a supervising provider and is credentialed to bill for services.
  • isPerson: boolean: Denotes whether the provider is person/non-person entity.
  • schedulingName: string: Scheduling name of the provider.
  • homeDepartment: Reference: Communicator home department for the provider.
  • patientFacingName: string: Name of the communicator display department for the provider.
  • pronouns: string: Personal pronouns of the provider.
  • scheduleResourceType: string: The scheduling resource type name of the provider.
  • schedulingNote: string: The scheduling note of the provider.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Practitioner Provider Details
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:isHiddenInPortal 0..1 Extension Denotes if this provider needs to be hidden in the patient portal.
..... extension 0..0 Extension
..... url 1..1 uri "isHiddenInPortal"
..... value[x] 0..1 boolean Denotes if this provider needs to be hidden in the patient portal.
.... extension:isBillable 0..1 Extension Indicates if this provider is a supervising provider
..... extension 0..0 Extension
..... url 1..1 uri "isBillable"
..... value[x] 0..1 boolean Indicates if this provider is a supervising provider
.... extension:isPerson 0..1 Extension Denotes whether the provider is person/non-person entity.
..... extension 0..0 Extension
..... url 1..1 uri "isPerson"
..... value[x] 0..1 boolean Denotes whether the provider is person/non-person entity.
.... extension:schedulingName 1..1 Extension Scheduling name of the provider.
..... extension 0..0 Extension
..... url 1..1 uri "schedulingName"
..... value[x] 1..1 string Scheduling name of the provider.
.... extension:homeDepartment 0..1 Extension Communicator home department for the provider.
..... extension 0..0 Extension
..... url 1..1 uri "homeDepartment"
..... value[x] 0..1 Reference(Organization) Reference to athenahealth Organization for 'provider'.
.... extension:patientFacingName 0..1 Extension Name of the communicator display department for the provider.
..... extension 0..0 Extension
..... url 1..1 uri "patientFacingName"
..... value[x] 0..1 string Name of the communicator display department for the provider.
.... extension:pronouns 0..1 Extension Personal pronouns of the provider.
..... extension 0..0 Extension
..... url 1..1 uri "pronouns"
..... value[x] 0..1 string Personal pronouns of the provider.
.... extension:scheduleResourceType 0..1 Extension The scheduling resource type name of the provider.
..... extension 0..0 Extension
..... url 1..1 uri "scheduleResourceType"
..... value[x] 0..1 string The scheduling resource type name of the provider.
.... extension:schedulingNote 0..1 Extension The scheduling note of the provider.
..... extension 0..0 Extension
..... url 1..1 uri "schedulingNote"
..... value[x] 0..1 string The scheduling note of the provider.
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-practitioner-provider-details"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Practitioner Provider Details
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHiddenInPortal 0..1 Extension Denotes if this provider needs to be hidden in the patient portal.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isHiddenInPortal"
..... value[x] 0..1 boolean Denotes if this provider needs to be hidden in the patient portal.
.... extension:isBillable 0..1 Extension Indicates if this provider is a supervising provider
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isBillable"
..... value[x] 0..1 boolean Indicates if this provider is a supervising provider
.... extension:isPerson 0..1 Extension Denotes whether the provider is person/non-person entity.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isPerson"
..... value[x] 0..1 boolean Denotes whether the provider is person/non-person entity.
.... extension:schedulingName 1..1 Extension Scheduling name of the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "schedulingName"
..... value[x] 1..1 string Scheduling name of the provider.
.... extension:homeDepartment 0..1 Extension Communicator home department for the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "homeDepartment"
..... value[x] 0..1 Reference(Organization) Reference to athenahealth Organization for 'provider'.
.... extension:patientFacingName 0..1 Extension Name of the communicator display department for the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "patientFacingName"
..... value[x] 0..1 string Name of the communicator display department for the provider.
.... extension:pronouns 0..1 Extension Personal pronouns of the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "pronouns"
..... value[x] 0..1 string Personal pronouns of the provider.
.... extension:scheduleResourceType 0..1 Extension The scheduling resource type name of the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "scheduleResourceType"
..... value[x] 0..1 string The scheduling resource type name of the provider.
.... extension:schedulingNote 0..1 Extension The scheduling note of the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "schedulingNote"
..... value[x] 0..1 string The scheduling note of the provider.
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-practitioner-provider-details"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: An Extension containing details about a practitioner provider.

  • isHiddenInPortal: boolean: Denotes if this provider needs to be hidden in the patient portal.
  • isBillable: boolean: Indicates if this provider is a supervising provider and is credentialed to bill for services.
  • isPerson: boolean: Denotes whether the provider is person/non-person entity.
  • schedulingName: string: Scheduling name of the provider.
  • homeDepartment: Reference: Communicator home department for the provider.
  • patientFacingName: string: Name of the communicator display department for the provider.
  • pronouns: string: Personal pronouns of the provider.
  • scheduleResourceType: string: The scheduling resource type name of the provider.
  • schedulingNote: string: The scheduling note of the provider.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Practitioner Provider Details
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:isHiddenInPortal 0..1 Extension Denotes if this provider needs to be hidden in the patient portal.
..... extension 0..0 Extension
..... url 1..1 uri "isHiddenInPortal"
..... value[x] 0..1 boolean Denotes if this provider needs to be hidden in the patient portal.
.... extension:isBillable 0..1 Extension Indicates if this provider is a supervising provider
..... extension 0..0 Extension
..... url 1..1 uri "isBillable"
..... value[x] 0..1 boolean Indicates if this provider is a supervising provider
.... extension:isPerson 0..1 Extension Denotes whether the provider is person/non-person entity.
..... extension 0..0 Extension
..... url 1..1 uri "isPerson"
..... value[x] 0..1 boolean Denotes whether the provider is person/non-person entity.
.... extension:schedulingName 1..1 Extension Scheduling name of the provider.
..... extension 0..0 Extension
..... url 1..1 uri "schedulingName"
..... value[x] 1..1 string Scheduling name of the provider.
.... extension:homeDepartment 0..1 Extension Communicator home department for the provider.
..... extension 0..0 Extension
..... url 1..1 uri "homeDepartment"
..... value[x] 0..1 Reference(Organization) Reference to athenahealth Organization for 'provider'.
.... extension:patientFacingName 0..1 Extension Name of the communicator display department for the provider.
..... extension 0..0 Extension
..... url 1..1 uri "patientFacingName"
..... value[x] 0..1 string Name of the communicator display department for the provider.
.... extension:pronouns 0..1 Extension Personal pronouns of the provider.
..... extension 0..0 Extension
..... url 1..1 uri "pronouns"
..... value[x] 0..1 string Personal pronouns of the provider.
.... extension:scheduleResourceType 0..1 Extension The scheduling resource type name of the provider.
..... extension 0..0 Extension
..... url 1..1 uri "scheduleResourceType"
..... value[x] 0..1 string The scheduling resource type name of the provider.
.... extension:schedulingNote 0..1 Extension The scheduling note of the provider.
..... extension 0..0 Extension
..... url 1..1 uri "schedulingNote"
..... value[x] 0..1 string The scheduling note of the provider.
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-practitioner-provider-details"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension athenahealth Practitioner Provider Details
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:isHiddenInPortal 0..1 Extension Denotes if this provider needs to be hidden in the patient portal.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isHiddenInPortal"
..... value[x] 0..1 boolean Denotes if this provider needs to be hidden in the patient portal.
.... extension:isBillable 0..1 Extension Indicates if this provider is a supervising provider
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isBillable"
..... value[x] 0..1 boolean Indicates if this provider is a supervising provider
.... extension:isPerson 0..1 Extension Denotes whether the provider is person/non-person entity.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "isPerson"
..... value[x] 0..1 boolean Denotes whether the provider is person/non-person entity.
.... extension:schedulingName 1..1 Extension Scheduling name of the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "schedulingName"
..... value[x] 1..1 string Scheduling name of the provider.
.... extension:homeDepartment 0..1 Extension Communicator home department for the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "homeDepartment"
..... value[x] 0..1 Reference(Organization) Reference to athenahealth Organization for 'provider'.
.... extension:patientFacingName 0..1 Extension Name of the communicator display department for the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "patientFacingName"
..... value[x] 0..1 string Name of the communicator display department for the provider.
.... extension:pronouns 0..1 Extension Personal pronouns of the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "pronouns"
..... value[x] 0..1 string Personal pronouns of the provider.
.... extension:scheduleResourceType 0..1 Extension The scheduling resource type name of the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "scheduleResourceType"
..... value[x] 0..1 string The scheduling resource type name of the provider.
.... extension:schedulingNote 0..1 Extension The scheduling note of the provider.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "schedulingNote"
..... value[x] 0..1 string The scheduling note of the provider.
... url 1..1 uri "https://fhir.athena.io/StructureDefinition/ah-practitioner-provider-details"

doco Documentation for this format

 

​Other representations of profile: CSV, Excel, Schematron

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()