Providers
Source Object: Providers
Overview and Usage: The "Providers" source object is a fundamental component in healthcare systems, containing crucial information about healthcare providers. It helps in the management and organization of provider data. Here's a breakdown of the key components:
- Display Name: The name by which the provider is displayed or recognized.
- First Name: The first name of the provider.
- Last Name: The last name of the provider.
- NPI (National Provider Identifier): A unique 10-digit numeric identifier for healthcare providers.
- Sex: The gender or sex of the provider.
- Specialty: The medical specialty or field in which the provider practices.
- Specialty ID: A unique identifier for the provider's medical specialty.
- Accepting New Patients (YN): An indicator specifying whether the provider is currently accepting new patients.
- ANSI Name Code: The provider's name code following ANSI standards.
- ANSI Specialty Code: The specialty code following ANSI standards.
- Billable: An indicator specifying whether the provider's services are billable.
- Create Encounter on Check-In (YN): An indicator specifying whether an encounter is created upon patient check-in.
- Create Encounter Provider ID List: A list of provider IDs associated with encounter creation.
- Direct Address: The direct contact address or means of communication with the provider.
- Entity Type: The type of entity or organization the provider is associated with.
- Federal ID Number: The provider's federal identification number.
- Hide in Portal (YN): An indicator specifying whether the provider is hidden from the portal.
- Home Department: The department in which the provider is primarily based.
- Other Provider ID List: A list of other unique identifiers associated with the provider.
- Personal Pronouns: The pronouns used to refer to the provider.
- Provider Group List: A list of provider groups to which the provider belongs.
- Provider Type: The type of provider, such as physician, nurse, etc.
- Provider Type ID: A unique identifier for the provider type.
- Provider Username: The username or identifier used by the provider for various systems.
- Schedule Resource Type: The type of resource used for scheduling, e.g., room or equipment.
- Scheduling Name: The name associated with provider scheduling.
- Supervising Provider ID: The ID of the supervising provider, if applicable.
- Supervising Provider Username: The username of the supervising provider, if applicable.
- Usual Department ID: The usual department ID for the provider's primary practice.
- Alternate Phone: An alternate contact phone number for the provider.
- ANSI Code: The provider's code following ANSI standards.
- Billed Name Case: The case format for the billed name.
- Communicator Display Name: The name displayed for communication purposes.
- Communicator Home Department: The home department of the communicator.
- CRD Referring: An indicator for CRD (Centralized Referring Department) referrals.
- Entity Type ID: A unique identifier for the entity type.
- Create Encounter on Check-In: Detailed information on encounter creation upon patient check-in.
- Hide in Portal: Additional details on hiding providers in the portal.
- Medical Group ID: The medical group ID associated with the provider.
- Middle Initial: The middle initial of the provider.
- Name Suffix: A suffix or title following the provider's name (e.g., Jr., Sr., MD).
- NPI Number: The provider's NPI number.
- Personal Pronouns ID: A unique identifier for the personal pronouns.
- Practice Role ID: A unique identifier for the provider's practice role.
- Provider Group ID: A unique identifier for the provider's group.
- Provider Profile ID: A unique identifier for the provider's profile.
- Reporting Name: The name used for reporting purposes.
- Signature on File Flag: An indicator specifying whether the provider's signature is on file.
- SSN (Social Security Number): The provider's Social Security Number.
- Staff Bucket: Information on the staff bucket associated with the provider.
- Username: The username or identifier used by the provider.
- Track Missing Slips: Details about tracking missing slips related to the provider.
The "Providers" source object is a central repository of information about healthcare providers, facilitating efficient management and ensuring accurate and up-to-date provider data.
Mapping Table
| Data Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
|---|---|---|---|---|---|---|---|---|---|---|
| displayname | - | The preferred name to use when displaying this provider. | String | 0..1 | Practitioner | name[1].text | - | - | - | Top Level |
| firstname | - | The provider's first name. | String | 0..1 | Practitioner | name[1].given[1] | - | - | - | Top Level |
| lastname | - | The provider's last name | String | 0..1 | Practitioner | name[1].family | - | - | - | Top Level |
| npi | - | The NPI for this provider, if available. | Integer | 0..1 | Practitioner | identifier[1].value | - | - | - | Top Level |
| providerid | - | The ID to be used for this provider. Note that in athenaNet, an individual provider (as defined by a unique NPI) may have multiple provider IDs. For the API, we have collapsed these to a single canonical ID. | Integer | 0..1 | Practitioner | id | - | - | - | Top Level |
| sex | - | The sex of this provider. | String | 0..1 | Practitioner | gender | - | - | - | Top Level |
| specialty | - | A friendly name for this provider's specialty." | String | 0..1 | Practitioner | qualification[1].code.coding[1].display | - | - | - | Top Level |
| specialtyid | - | The ID of the provider's specialty. | Integer | 0..1 | Practitioner | qualification[1].code.coding[1].code | system=http://xcaliber-fhir/structureDefinition/practitioner-speciality | - | - | Top Level |
| acceptingnewpatientsyn | - | Indicates whether the provider is accepting new patients. This field is currently only for informational purposes, and does not drive any athenaNet functionality. | String | 0..1 | Practitioner | extension[*].valueString | - | - | accepting-new-patients-yn | Top Level |
| ansinamecode | - | This is the ANSI name with ANSI code for this provider's specialty. | String | 0..1 | Practitioner.PractitionerRole | specialty[].coding[].display | - | - | - | Contained |
| ansispecialtycode | - | This is the ANSI code for this provider's specialty. | String | 0..1 | Practitioner.PractitionerRole | specialty[].coding[].code | system=http://xcaliber-fhir/structureDefinition/practitioner-speciality | - | - | Contained |
| billable | - | Indicates if this is a billable provider. | String | 0..1 | Practitioner | extension[*].valueString | - | - | billable | Top Level |
| createencounteroncheckinyn | - | If true, appointments scheduled with this provider will create an encounter when the appointment is checked in for encounter supported appointment types. Only applies to the primary providerid. If the provider has other IDs with the same API, please use 'showallproviderids' to see which IDs create encounters. | String | 0..1 | Practitioner | extension[*].valueString | - | - | create-encounter-on-checkin-yn | Top Level |
| createencounterprovideridlist | - | A list of provider IDs for this provider NPI that will create an encounter when the appointment is checked in for encounter supported appointment types. Only populated if 'showallproviderids' is set | String | 0..1 | Practitioner | extension[*].valueString | - | - | create-encounter-provider-id-list | Top Level |
| directaddress | - | The direct email address for the provider | String | 0..1 | Practitioner | telecom[*].value | system=email | - | - | Top Level |
| entitytype | - | Either "Person" or "Non-Person" (e.g. X-Ray machines) | String | 0..1 | Practitioner | extension[*].valueString | - | - | entity-type | Top Level |
| federalidnumber | - | The federal ID number for provider, if SHOWFEDERALIDNUMBER is set. | String | 0..1 | Practitioner | identifier[*].value | - | - | - | Top Level |
| hideinportalyn | - | If set, this provider does not appear in athenaCommunicator's web portal. | String | 0..1 | Practitioner | extension[*].valueString | - | - | hide-in-portal-yn | Top Level |
| homedepartment | - | For certain purposes, this can be considered to be the "home" or default department for a provider. | String | 0..1 | Practitioner | extension[*].valueString | - | - | home-department | Top Level |
| otherprovideridlist | - | When showallproviderids is set to true, a list of all other athenaNet providers IDs that may refer to this same provider. If not present with showallproviderids, there are no other IDs other than the primary ID. | String | 0..1 | Practitioner | extension[*].valueString | - | - | other-provider-id-list | Top Level |
| personalpronouns | - | The preferred personal pronouns of this provider. | String | 0..1 | Practitioner | extension[*].valueString | - | - | personal-pronouns | Top Level |
| providergrouplist | - | "When showallproviderids is set to true, a list of all provider groups that this provider is registered in. Data is only relevant if a practice is using Provider-Group-Based Data Permissions in their practice. | String | 0..1 | Practitioner | extension[*].valueString | - | - | provider-group-list | Top Level |
| providertype | - | There is a long potential list of provider type in the form "full name (id)", but "MD", "NP" or "NP S" (Nurse Practitioner (Supervising)), "RES" (resident), "EQUIP", "DO", "PA" or "PASUP" (Physician's Assistant (Supervising)), "TECH", "RN", LPT", "CRNA" or "CRNASUP" (Certified Registered Nurse Anesthesiologist (Supervising)), and MA (Medical Assistant) are among the most common. | String | 0..1 | Practitioner | extension[*].valueString | - | - | provider-type | Top Level |
| providertypeid | - | This is just the ID (a text string) such as "NP" or "NP S" for the provider type. | String | 0..1 | Practitioner | extension[*].valueString | - | - | provider-type-id | Top Level |
| providerusername | - | The username of the provider. | String | 0..1 | Practitioner | extension[*].valueString | - | - | provider-user-name | Top Level |
| scheduleresourcetype | - | Name of the scheduling resource type tied to the provider. | Integer | 0..1 | Practitioner | extension[*].valueString | - | - | schedule-resource-type | Top Level |
| schedulingname | - | The scheduling name for this provider (as used in athenaNet). | String | 0..1 | Practitioner | extension[*].valueString | - | - | scheduling-name | Top Level |
| supervisingproviderid | - | The ID of the supervising provider. | String | 0..1 | Practitioner | extension[*].valueInteger | - | - | supervising-provider-id | Top Level |
| supervisingproviderusername | - | The username of the supervising provider. | String | 0..1 | Practitioner | extension[*].valueString | - | - | supervising-provider-username | Top Level |
| usualdepartmentid | - | The "usual" department for this provider, if SHOWUSUALDEPARTMENTGUESSTHRESHOLD is set. | Number | 0..1 | Practitioner | extension[*].valueInteger | - | - | usual-department-id | Top Level |
| displayname | - | The preferred name to use when displaying this provider. | String | 0..1 | Person | name[*].text | - | - | - | Top Level |
| firstname | - | The provider's first name. | String | 0..1 | Person | name[*].given | - | - | - | Top Level |
| lastname | - | The provider's last name. | String | 0..1 | Person | name[*].family | - | - | - | Top Level |
| npi | - | The NPI for this provider, if available. | Integer | 0..1 | Person | identifier[0].value | - | - | - | Top Level |
| providerid | - | The ID to be used for this provider. Note that in athenaNet, an individual provider (as defined by a unique NPI) may have multiple provider IDs. For the API, we have collapsed these to a single canonical ID. | Integer | 0..1 | Person | id | - | - | - | Top Level |
| sex | - | The sex of this provider. | String | 0..1 | Person | gender | - | - | - | Top Level |
| acceptingnewpatientsyn | - | Indicates whether the provider is accepting new patients. This field is currently only for informational purposes, and does not drive any athenaNet functionality. | String | 0..1 | Person | extension[*].valueString | - | - | accepting-new-patients-yn | Top Level |
| ansinamecode | - | This is the ANSI name with ANSI code for this provider's specialty. | String | 0..1 | Person | extension[*].valueString | - | - | ansi-name-code | Top Level |
| ansispecialtycode | - | This is the ANSI code for this provider's specialty. | String | 0..1 | Person | extension[*].valueString | - | - | ansi-specialty-code | Top Level |
| billable | - | Indicates if this is a billable provider. | String | 0..1 | Person | extension[*].valueString | - | - | billable | Top Level |
| createencounteroncheckinyn | - | If true, appointments scheduled with this provider will create an encounter when the appointment is checked in for encounter supported appointment types. Only applies to the primary providerid. If the provider has other IDs with the same API, please use 'showallproviderids' to see which IDs create encounters. | String | 0..1 | Person | extension[*].valueString | - | - | create-encounter-on-checkin-yn | Top Level |
| createencounterprovideridlist | - | A list of provider IDs for this provider NPI that will create an encounter when the appointment is checked in for encounter supported appointment types. Only populated if 'showallproviderids' is set. | String | 0..1 | Person | extension[*].valueString | - | - | create-encounter-provider-id-list | Top Level |
| directaddress | - | The direct email address for the provider | String | 0..1 | Person | telecom[*].value | system=email | - | - | Top Level |
| entitytype | - | Either "Person" or "Non-Person" (e.g. X-Ray machines) | String | 0..1 | Person | extension[*].valueString | - | - | entity-type | Top Level |
| federalidnumber | - | The federal ID number for provider, if SHOWFEDERALIDNUMBER is set. | String | 0..1 | Person | identifier[*].value | - | - | - | Top Level |
| hideinportalyn | - | If set, this provider does not appear in athenaCommunicator's web portal. | String | 0..1 | Person | extension[*].valueString | - | - | hide-in-portal-yn | Top Level |
| homedepartment | - | For certain purposes, this can be considered to be the "home" or default department for a provider. | String | 0..1 | Person | extension[*].valueString | - | - | home-department | Top Level |
| otherprovideridlist | - | When showallproviderids is set to true, a list of all other athenaNet providers IDs that may refer to this same provider. If not present with showallproviderids, there are no other IDs other than the primary ID. | String | 0..1 | Person | extension[*].valueString | - | - | other-provider-id-list | Top Level |
| personalpronouns | - | The preferred personal pronouns of this provider. | String | 0..1 | Person | extension[*].valueString | - | - | personal-pronouns | Top Level |
| providergrouplist | - | When showallproviderids is set to true, a list of all provider groups that this provider is registered in. Data is only relevant if a practice is using Provider-Group-Based Data Permissions in their practice. | String | 0..1 | Person | extension[*].valueString | - | - | provider-group-list | Top Level |
| providertype | - | There is a long potential list of provider type in the form "full name (id) but "MD "NP" or "NP S" (Nurse Practitioner (Supervising)), "RES" (resident), "EQUIP "DO "PA" or "PASUP" (Physician's Assistant (Supervising)), "TECH "RN LPT "CRNA" or "CRNASUP" (Certified Registered Nurse Anesthesiologist (Supervising)), and MA (Medical Assistant) are among the most common. | String | 0..1 | Person | extension[*].valueString | - | - | provider-type | Top Level |
| providertypeid | - | This is just the ID (a text string) such as "NP" or "NP S" for the provider type. | String | 0..1 | Person | extension[*].valueString | - | - | provider-type-id | Top Level |
| providerusername | - | The username of the provider. | String | 0..1 | Person | extension[*].valueString | - | - | provider-user-name | Top Level |
| scheduleresourcetype | - | Name of the scheduling resource type tied to the provider. | String | 0..1 | Person | extension[*].valueString | - | - | schedule-resource-type | Top Level |
| schedulingname | - | The scheduling name for this provider (as used in athenaNet). | String | 0..1 | Person | extension[*].valueString | - | - | scheduling-name | Top Level |
| specialty | - | A friendly name for this provider's specialty. | String | 0..1 | Person | extension[*].valueString | - | - | specialty | Top Level |
| specialtyid | - | The ID of the provider's specialty. | Integer | 0..1 | Person | extension[*].valueInteger | - | - | specialty-id | Top Level |
| supervisingproviderid | - | The ID of the supervising provider. | Integer | 0..1 | Person | extension[*].valueInteger | - | - | supervising-provider-id | Top Level |
| supervisingproviderusername | - | The username of the supervising provider. | String | 0..1 | Person | extension[*].valueString | - | - | supervising-provider-username | Top Level |
| usualdepartmentid | - | The "usual" department for this provider, if SHOWUSUALDEPARTMENTGUESSTHRESHOLD is set. | Integer | 0..1 | Person | extension[*].valueInteger | - | - | usual-department-id | Top Level |
| alternatephone | - | The phone number of the provider. | String | 0..1 | Practitioner | telecom[0].value | system=phone | - | - | Top Level |
| ansicode | - | The provider taxonomy code of the provider. | String | 0..1 | Practitioner | extension[*].valueString | - | - | ansi-code | Top Level |
| billednamecase | - | The billing name of the provider. | String | 0..1 | Practitioner | name[1].text | - | - | - | Top Level |
| communicatordisplayname | - | The communicator display name for the provider. | String | 0..1 | Practitioner | extension[*].valueString | - | - | communicator-display-name | Top Level |
| communicatorhomedepartment | - | The communicator home department for the provider. | Integer | 0..1 | Practitioner | extension[*].valueInteger | - | - | communicator-home-department | Top Level |
| crdreferring | - | This provider is a Coordinator referring provider. | Boolean | 0..1 | Practitioner | extension[*].valueBoolean | - | - | crd-referring | Top Level |
| entitytypeid | - | The entity type of provider. 1 = person, 2 = non-person | Integer | 0..1 | Practitioner | extension[*].valueInteger | - | - | entity-type-id | Top Level |
| createencounteroncheckin | - | Automatically create encounters at check-in. | Boolean | 0..1 | Practitioner | extension[*].valueString | - | - | create-encounter-on-checkin-yn | Top Level |
| hideinportal | - | Hide this provider in the Patient Portal. | Boolean | 0..1 | Practitioner | extension[*].valueString | - | - | hide-in-portal-yn | Top Level |
| medicalgroupid | - | The medical group of the provider. | Integer | 0..1 | Practitioner | extension[*].valueInteger | - | - | medical-group-id | Top Level |
| middleinitial | - | The middle name of the provider. | String | 0..1 | Practitioner | name.extension[*].valueString | - | - | middle-initial | Top Level |
| namesuffix | - | The suffix of the provider. | String | 0..1 | Practitioner | name.extension[*].valueString | - | - | name-suffix | Top Level |
| ndctatnumber | - | The NDC TAT number for this provider. | String | 0..1 | Practitioner | extension[*].valueString | - | - | ndc-tat-number | Top Level |
| npinumber | - | The NPI of the provider. | Integer | 0..1 | Practitioner | identifier?.[1]?.value | - | - | - | Top Level |
| personalpronounsid | - | The personal pronouns ID of the provider. See GET /personalpronouns for a mapping of ID to personal pronouns displaytext. | Integer | 0..1 | Practitioner | extension[*].valueInteger | - | - | personal-pronouns-id | Top Level |
| practiceroleid | - | The practice role ID for the provider. | Integer | 0..1 | Practitioner | extension[*].valueInteger | - | - | practice-role-id | Top Level |
| providergroupid | - | The provider group of the provider. | Integer | 0..1 | Practitioner | extension[*].valueInteger | - | - | provider-group-id | Top Level |
| providerprofileid | - | The provider profile of the provider (integer or 'NEW') | String | 0..1 | Practitioner | extension[*].valueString | - | - | provider-profile-id | Top Level |
| reportingname | - | The reporting name for the provider. | String | 0..1 | Practitioner | name[1].text | - | - | - | Top Level |
| signatureonfileflag | - | This provider's signature is on file. | Boolean | 0..1 | Practitioner | extension[*].valueBoolean | - | - | signature-on-file-flag | Top Level |
| ssn | - | The SSN of the provider. | Integer | 0..1 | Practitioner | extension[*].valueInteger | - | - | ssn | Top Level |
| staffbucket | - | Create a staff bucket for this provider. | Boolean | 0..1 | Practitioner | extension[*].valueBoolean | - | - | staff-bucket | Top Level |
| username | - | The username for the provider. | String | 0..1 | Practitioner | extension[*].valueString | - | - | user-name | Top Level |
| trackmissingslips | - | This provider renders services that should be tracked on the Missing Slips Worklist. | Boolean | 0..1 | Practitioner | extension[*].valueBoolean | - | - | track-missing-lips | Top Level |