HealthcareFacility

Represents a healthcare facility and all its related details. These details may be physical, functional, geographic, or business details. This object is available in API version 51.0 and later.

Supported Calls

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

Fields

Field	Details
AccountId	Type Master-detail reference Properties Create, Filter, Group, Sort Description References the business account of the facility. Referenced Objects Account
AreResearchStudiesConducted	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether research studies are conducted in the healthcare facility (`true`) or not (`false`). This field is available in API version 63.0 when Site Management (Pilot) is enabled. The default value is `false`.
AvailabilityExceptions	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The times when the facility isn’t available. Only non-standard time-offs are recorded in this field. Examples Facility time off because of a natural disaster.
AverageActualPtcpEnrlDrtn	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average actual number of days spent enrolling participants at the site. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AverageOpdPatientCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average count of the patients that visit the OPD at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AvgActualPtcpEnrlCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average actual number of participants that are enrolled for the research study at the site. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AvgClnclTrialAgreeDrtn	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average time taken to execute the clinical trial agreement. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AvgInvtglProductReleaseDrtn	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average number of days between the start of the site activation process to the release of the investigational product at the site. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AvgProjectedPtcpEnrlCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average number of participants that are expected to enroll for the research study at the site. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AvgProjectedPtcpEnrlDrtn	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average projected number of days to enroll participants at the site. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AvgProtocolDeviationCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average number of protocol deviations reported during the research study at the site. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AvgQualVstToInitVstDrtn	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average number of days between the site qualification visit and site initiation visit. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AvgRegltyDocTrnarndDrtn	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average turnaround time for the preparation of the regulatory documents for Institutional Review Board (IRB) or the Ethics Committee (EC) submission. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
AvgRsrchEthicalReviewDrtn	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the average duration required for an approval for the clinical trial at the heathcare facility from the Institutional Review Board (IRB) or Ethics Committee (EC). This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `Central` `Local` `Others`
AvgSiteActvToFstPtcpDrtn	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average number of days between the site activation and the first participant visit to the site.
AvgSiteActvToLastPtcpDrtn	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The average number of days between the site activation and the last participant visit to the site. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
Classification	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the classification of the healthcare facility, such as Previous Partner, Key Opinion Leader, and Novice Member. This field is available in API version 63.0 and later when Site Management (Pilot) is enabled. Possible values are: `Key Opinion Leader` `Novice Member.` `Previous Partner`
ClinicalTrialAgreementType	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the type of clinical trial agreement that can be done with the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `Tetra-Partite` `Tripartite`
HealthcareProviderId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The healthcare provider associated with the facility. This field is a relationship field. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Relationship Name HealthcareProvider Refers To HealthcareProvider
InvestigationalProductType	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the type of investigational product available at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `Biologic` `Device` `Diagnostic` `Drug` `Others` `Palliative` `Vaccine`
InvtglProdtDestructionCpbl	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the type of Investigational Product disposal capability. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `Off-Site` `On-Site` `Others`
InvtglProdtPreparationCpbl	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the list of handling equipment available at the facility for the investigational product. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `Extemporaneous Preparation` `Horizontal Laminar Flow Hood` `Non-Vented Glove Box` `Other` `Vented Glove Box` `Vertical Laminar Flow Hood`
InvtglProductStorageCpbl	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the features of the investigational product store available at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `Access Controlled` `Back-Up Power` `Minimum and Maximum Temperature Monitoring` `Temperature Alarm` `Temperature Monitoring` `Temperature Monitoring Log Generation`
IsAfflWithSiteMgmtOrg	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the healthcare facility is affiliated to the site management organization. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
FacilityTypeId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The system-defined code that represents the type of the facility in terms of that functions performed. Referenced Objects CodeSetBundle
IsAlwaysOpen	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the facility is open during all hours.
IsDedResearchStudyRoomAvl	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a dedicated room is available at the healthcare facility to conduct the research study. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
IsDedRsrchStdyMntrRmAvl	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a dedicated room is available at the healthcare facility to monitor the research study. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
IsGoodClnclPracTrnPrvd	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether good clinical practice training is provided at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
IsPgxSpcmnCollAvl	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the pharmacogenoic specimen collection is available at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
IsPkpdSpcmnCollStrgAvl	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether PKPD specimen collection and storage is available at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
IsRsrchEthicalRvwSbmsSupp	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the facility supports the regulatory document submission to the Institutional Review Board (IRB) or Ethics Committee (EC). This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
IsRsrchStudyMtrlStoreAvl	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a store is available at the healthcare facility to keep the research study materials, such as laboratory kits. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
IsSatelliteSite	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the healthcare facility is a satellite site of another healthcare facility (`true`) or not (`false`). This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
IsTrainingProvided	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether a training is provided to the research staff at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. The default value is `false`.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The last date that the record was referenced.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The last date that the record was viewed.
LicensedBedCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of licensed beds the facility has.
LocationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the location record representing the facility’s geolocation. Referenced Objects Location
LocationType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of the facility in terms of its physical structure. Possible values are: `Building` `Facility` `House` `ICU Ward`
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the healthcare facility record.
ParentHealthcareFacilityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The parent facility that the facility is a part of. Examples The hospital that an ER wing is a part of. Referenced Objects HealthcareFacility
PatientAgeRange	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the age range of the patients at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `18 to 64` `Greater than or Equal to 65` `Less than or Equal to 17`
RegulatoryViolationCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of regulatory violations reported during the research study at the site. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
ResearchStudyMethod	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the method of conducting the study at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `Hybrid` `Traditional` `Virtual`
ResearchStudyPhase	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the phases under which the study is conducted. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `Phase 1` `Phase 2` `Phase 3` `Phase 4`
ResearchStudyStartYear	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The start year of the research study at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled.
ResearchStudyType	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the type of research study conducted at the healthcare facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `Expanded Access` `Interventional` `Observational`
RsrchEthicalRvwComteType	Type multipicklist Properties Create, Filter, Nillable, Restricted picklist, Update Description Specifies the type of the Institutional Review Board (IRB) or Ethics Committee (EC). This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. Possible values are: `30 - 60 Days` `61 - 90 Days` `91 - 120 Days` `Greater than 120 Days` `Less than 30 Days`
SourceSystem	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The source system from where the record was brought into Salesforce.
SourceSystemIdentifier	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The identifier of the record in its source system.
SourceSystemModified	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date and time when the record was last modified in its source system.
UnitOfMeasureId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The unit of measure that’s used to calculate the duration of a specific activity at the facility. This field is available in API version 62.0 and later when Site Management (Pilot) is enabled. This field is a relationship field. Relationship Name UnitOfMeasure Refers To UnitOfMeasure

Additional Information for HealthcareFacility in Other Objects

In addition to creating a record using these fields, you can add more details to your HealthcareFacility record by creating records in certain other objects, and referencing your HealthcareFacility record as the parent record. Here’s the list of objects you can associate to HealthcareFacility in this way, the type of information they add, and the field they use to reference HealthcareFacility.

Object	Type of Information	Reference Field
Identifier	Associates an identifier value to the facility.	`ParentRecordId`

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.

HealthcareFacilityChangeEvent (API version 59.0): Change events are available for the object.
HealthcareFacilityFeed: Feed tracking is available for the object.
HealthcareFacilityHistory: History is available for tracked fields of the object.

Life Sciences Cloud Developer Guide

HealthcareFacility

Supported Calls

Fields

Additional Information for HealthcareFacility in Other Objects

Associated Objects