Newer Version Available

This content describes an older version of this product. View Latest

HealthcarePractitionerFacility

Represents the different locations in which a practitioner provides services.

Supported Calls

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

Fields

Field Details
AvailabilityExceptions
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The times when the facility is not available. Only non-standard time-offs are recorded in this field.
EffectiveFrom
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from which this practitioner facility is effective.
EffectiveTo
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date on which this practitioner facility is no longer effective.
GenderRestriction
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates whether physician sees patients of a specific gender.
Possible values are:
  • Female
  • Male
  • Nonbinary
Has24x7Service
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Specifies whether the facility offers round-the-clock service.
The default value is false.
HealthcareFacilityId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Healthcare facility associated with this healthcare practitioner facility.
Relationship Type
Lookup
Refers To
HealthcareFacility
HealthcareProviderId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Healthcare provider associated with this healthcare practitioner facility.
This is a relationship field.
Relationship Type
Lookup
Refers To
HealthcareProvider
HighestValidAge
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The highest age of patients that the practitioner sees at this facility
InitialStartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date the practitioner started at this facility.
IsActive
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the record is active.
IsDirectoryPrint
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether this facility is displayed in an online or printed directory.
IsPrimaryCarePhysician
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the practitioner provides primary care services at this facility.
IsPrimaryFacility
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the facility is the primary facility for the practitioner.
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.
LowestValidAge
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The lowest age of patients that the practitioner sees at this facility.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the practitioner facility record.
OperatingHoursId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Identifies the operating hours for this practitioner at this facility.
This is a relationship field.
Relationship Name
OperatingHours
Relationship Type
Lookup
Refers To
OperatingHours
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the user who owns this record.
This is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
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
ID of an external record on its source system.
SsaCountyCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Social Security Administration identifier for the county.
TerminationDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date the practitioner stopped working at this facility.
TerminationReason
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reason the practitioner facility is no longer current.
Possible values are:
  • Facility Closed
  • Left Organization
TerminationRequestedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the person or organization requesting the termination.
This field is a relationship field.
Relationship Name
TerminationRequestedBy
Relationship Type
Lookup
Refers To
User

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.

HealthcarePractitionerFacilityFeed
Feed tracking is available for the object.
HealthcarePractitionerFacilityHistory
History is available for tracked fields of the object.
HealthcarePractitionerFacilityOwnerSharingRule
Sharing rules are available for the object.
HealthcarePractitionerFacilityShare
Sharing is available for the object.