HealthcareProviderTaxonomy

Represents the taxonomy or subspecialty codes for a provider or facility. A provider or facility can have multiple taxonomies. This object is available in API version 64.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

This object is available if Provider Management is enabled in your org. To access the object, you need the Provider Management Access permission set or the Provider Management permission set license. Partner users need the Provider Management for Partner permission set or permission set license.

Fields

AccountId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The business account associated with the provider taxonomy.

This field is a relationship field.
Relationship Name: Account
Refers To: Account

EffectiveFrom

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when the healthcare provider taxonomy is active.

EffectiveTo

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date when the healthcare provider taxonomy is no longer active.

HealthcareProviderId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The healthcare provider associated with the healthcare provider taxonomy.

This field is a relationship field.
Relationship Name: HealthcareProvider
Refers To: HealthcareProvider

IsActive

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the healthcare provider taxonomy is active (true) or not (false).
Default value: false

IsPrimaryTaxonomy

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the healthcare provider taxonomy is the provider’s primary taxonomy (true) or not (false).
Default value: false

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the healthcare provider taxonomy.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the record owner.

This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User

PractitionerId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The practitioner associated with the healthcare provider taxonomy.

This field is a relationship field.
Relationship Name: Practitioner
Refers To: Contact

SourceSystem

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: System from which the record was sourced.

SourceSystemIdentifier

Type: string
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
Description: The ID of the system from which the record was sourced.

TaxonomyId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The care taxonomy associated with the heathcare provider taxonomy.

This field is a relationship field.
Relationship Name: Taxonomy
Refers To: CareTaxonomy

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

HealthcareProviderTaxonomyChangeEvent: Change events are available for the object.
HealthcareProviderTaxonomyFeed: Feed tracking is available for the object.
HealthcareProviderTaxonomyHistory: History is available for tracked fields of the object.
HealthcareProviderTaxonomyOwnerSharingRule: Sharing rules are available for the object.
HealthcareProviderTaxonomyShare: Sharing is available for the object.