--- schema_version: "1" id: d2f4533cd769a6f0408cbca3e4953dbed9ff2386963aeca50feffec00025f5f8 title: HealthcareFacility collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/hc_r4_api_objects_HealthCareFacility.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_r4_api_objects_HealthCareFacility.htm source_site: developer.salesforce.com content_type: documentation content_hash: 9f6adb43f9396cb4d09ea1e48db01c445233d5d04f03bb4895a9ba26cd4aee42 description: 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. --- # 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() ## 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 | ## Fields ### 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 is enabled. - **Default value**: 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 is enabled. ### AverageActlPtcpEnrlRate - **Type**: double - **Properties**: Create, Filter, Nillable, Sort, Update - **Description**: The average actual participant enrollment rate for all research studies at the site. This field is available in API version 64.0 and later when Site Management 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 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 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 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 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 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 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 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 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 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 is enabled. - **Possible values**: - 30 - 60 Days - 61 - 90 Days - 91 - 120 Days - Greater than 120 Days - Less than 30 Days ### 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 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 is enabled. - **Possible values**: - 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 is enabled. - **Possible values**: - 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 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 is enabled. - **Possible values**: - 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 is enabled. - **Possible values**: - 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 is enabled. - **Possible values**: - 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 is enabled. - **Possible values**: - 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 is enabled. - **Default value**: 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 is enabled. - **Default value**: 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 is enabled. - **Default value**: 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 is enabled. - **Default value**: 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 is enabled. - **Default value**: 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 is enabled. - **Default value**: 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 is enabled. - **Default value**: 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 is enabled. - **Default value**: 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 is enabled. - **Default value**: 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 is enabled. - **Default value**: 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**: - 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 is enabled. - **Possible values**: - 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 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 is enabled. - **Possible values**: - 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 is enabled. - **Possible values**: - 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 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 is enabled. - **Possible values**: - 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 is enabled. - **Possible values**: - 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 is enabled. This field is a relationship field. - **Relationship Name**: UnitOfMeasure - **Refers To**: UnitOfMeasure ## 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](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 59.0) Change events are available for the object. [HealthcareFacilityFeed](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [HealthcareFacilityHistory](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object.