Athena Core Implementation Guide
2.33.0 - release

Athena Core Implementation Guide - Local Development build (v2.33.0) 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: 2.33.0
Active as of 2024-04-12 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

Usage:

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 & Constraintsdoco
.. Extension 0..*Extensionathenahealth Practitioner Provider Details
... extension 1..*ExtensionExtension
... extension:isHiddenInPortal 0..1ExtensionDenotes if this provider needs to be hidden in the patient portal.
.... extension 0..0
.... url 1..1uri"isHiddenInPortal"
.... value[x] 0..1booleanDenotes if this provider needs to be hidden in the patient portal.
... extension:isBillable 0..1ExtensionIndicates if this provider is a supervising provider
.... extension 0..0
.... url 1..1uri"isBillable"
.... value[x] 0..1booleanIndicates if this provider is a supervising provider
.... extension 0..0
.... url 1..1uri"isPerson"
.... value[x] 0..1booleanDenotes whether the provider is person/non-person entity.
... extension:schedulingName 1..1ExtensionScheduling name of the provider.
.... extension 0..0
.... url 1..1uri"schedulingName"
.... value[x] 1..1stringScheduling name of the provider.
... extension:homeDepartment 0..1ExtensionCommunicator home department for the provider.
.... extension 0..0
.... url 1..1uri"homeDepartment"
.... value[x] 0..1Reference(Organization)Reference to athenahealth Organization for 'provider'.
... extension:patientFacingName 0..1ExtensionName of the communicator display department for the provider.
.... extension 0..0
.... url 1..1uri"patientFacingName"
.... value[x] 0..1stringName of the communicator display department for the provider.
... extension:pronouns 0..1ExtensionPersonal pronouns of the provider.
.... extension 0..0
.... url 1..1uri"pronouns"
.... value[x] 0..1stringPersonal pronouns of the provider.
... extension:scheduleResourceType 0..1ExtensionThe scheduling resource type name of the provider.
.... extension 0..0
.... url 1..1uri"scheduleResourceType"
.... value[x] 0..1stringThe scheduling resource type name of the provider.
... extension:schedulingNote 0..1ExtensionThe scheduling note of the provider.
.... extension 0..0
.... url 1..1uri"schedulingNote"
.... value[x] 0..1stringThe scheduling note of the provider.
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-practitioner-provider-details"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Practitioner Provider Details
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:isHiddenInPortal 0..1ExtensionDenotes if this provider needs to be hidden in the patient portal.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"isHiddenInPortal"
.... value[x] 0..1booleanDenotes if this provider needs to be hidden in the patient portal.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"isBillable"
.... value[x] 0..1booleanIndicates if this provider is a supervising provider
... extension:isPerson 0..1ExtensionDenotes whether the provider is person/non-person entity.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"isPerson"
.... value[x] 0..1booleanDenotes whether the provider is person/non-person entity.
... extension:schedulingName 1..1ExtensionScheduling name of the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"schedulingName"
.... value[x] 1..1stringScheduling name of the provider.
... extension:homeDepartment 0..1ExtensionCommunicator home department for the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"homeDepartment"
.... value[x] 0..1Reference(Organization)Reference to athenahealth Organization for 'provider'.
... extension:patientFacingName 0..1ExtensionName of the communicator display department for the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"patientFacingName"
.... value[x] 0..1stringName of the communicator display department for the provider.
... extension:pronouns 0..1ExtensionPersonal pronouns of the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"pronouns"
.... value[x] 0..1stringPersonal pronouns of the provider.
... extension:scheduleResourceType 0..1ExtensionThe scheduling resource type name of the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"scheduleResourceType"
.... value[x] 0..1stringThe scheduling resource type name of the provider.
... extension:schedulingNote 0..1ExtensionThe scheduling note of the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"schedulingNote"
.... value[x] 0..1stringThe scheduling note of the provider.
... url 1..1uri"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 & Constraintsdoco
.. Extension 0..*Extensionathenahealth Practitioner Provider Details
... extension 1..*ExtensionExtension
... extension:isHiddenInPortal 0..1ExtensionDenotes if this provider needs to be hidden in the patient portal.
.... extension 0..0
.... url 1..1uri"isHiddenInPortal"
.... value[x] 0..1booleanDenotes if this provider needs to be hidden in the patient portal.
... extension:isBillable 0..1ExtensionIndicates if this provider is a supervising provider
.... extension 0..0
.... url 1..1uri"isBillable"
.... value[x] 0..1booleanIndicates if this provider is a supervising provider
.... extension 0..0
.... url 1..1uri"isPerson"
.... value[x] 0..1booleanDenotes whether the provider is person/non-person entity.
... extension:schedulingName 1..1ExtensionScheduling name of the provider.
.... extension 0..0
.... url 1..1uri"schedulingName"
.... value[x] 1..1stringScheduling name of the provider.
... extension:homeDepartment 0..1ExtensionCommunicator home department for the provider.
.... extension 0..0
.... url 1..1uri"homeDepartment"
.... value[x] 0..1Reference(Organization)Reference to athenahealth Organization for 'provider'.
... extension:patientFacingName 0..1ExtensionName of the communicator display department for the provider.
.... extension 0..0
.... url 1..1uri"patientFacingName"
.... value[x] 0..1stringName of the communicator display department for the provider.
... extension:pronouns 0..1ExtensionPersonal pronouns of the provider.
.... extension 0..0
.... url 1..1uri"pronouns"
.... value[x] 0..1stringPersonal pronouns of the provider.
... extension:scheduleResourceType 0..1ExtensionThe scheduling resource type name of the provider.
.... extension 0..0
.... url 1..1uri"scheduleResourceType"
.... value[x] 0..1stringThe scheduling resource type name of the provider.
... extension:schedulingNote 0..1ExtensionThe scheduling note of the provider.
.... extension 0..0
.... url 1..1uri"schedulingNote"
.... value[x] 0..1stringThe scheduling note of the provider.
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-practitioner-provider-details"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Extensionathenahealth Practitioner Provider Details
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:isHiddenInPortal 0..1ExtensionDenotes if this provider needs to be hidden in the patient portal.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"isHiddenInPortal"
.... value[x] 0..1booleanDenotes if this provider needs to be hidden in the patient portal.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"isBillable"
.... value[x] 0..1booleanIndicates if this provider is a supervising provider
... extension:isPerson 0..1ExtensionDenotes whether the provider is person/non-person entity.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"isPerson"
.... value[x] 0..1booleanDenotes whether the provider is person/non-person entity.
... extension:schedulingName 1..1ExtensionScheduling name of the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"schedulingName"
.... value[x] 1..1stringScheduling name of the provider.
... extension:homeDepartment 0..1ExtensionCommunicator home department for the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"homeDepartment"
.... value[x] 0..1Reference(Organization)Reference to athenahealth Organization for 'provider'.
... extension:patientFacingName 0..1ExtensionName of the communicator display department for the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"patientFacingName"
.... value[x] 0..1stringName of the communicator display department for the provider.
... extension:pronouns 0..1ExtensionPersonal pronouns of the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"pronouns"
.... value[x] 0..1stringPersonal pronouns of the provider.
... extension:scheduleResourceType 0..1ExtensionThe scheduling resource type name of the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"scheduleResourceType"
.... value[x] 0..1stringThe scheduling resource type name of the provider.
... extension:schedulingNote 0..1ExtensionThe scheduling note of the provider.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"schedulingNote"
.... value[x] 0..1stringThe scheduling note of the provider.
... url 1..1uri"https://fhir.athena.io/StructureDefinition/ah-practitioner-provider-details"

doco Documentation for this format

 

​Other representations of profile: CSV, Excel, Schematron