External Source IDs for Facilities Best Practices
For API integrations, the External Source IDs section defines the information needed to map facilities. This configuration determines how the data is routed, managed, and processed for your environment.
External Source Name
Each facility should have one or more inbound sources configured.
Only one outbound source is allowed per facility.
The outbound source must correspond to the HL7 Agent. This configuration is specific to each instance and must be defined within the External Source Configuration Settings.
External ID
The External ID field defines the facility identifier used in data exchanges. This ID should ideally match the Facility ADT ID used in the Capacity Management Suite, especially for systems that support ADT messaging.
While the system sending data might use its own internal IDs, this field lets you map those external IDs to the CMS ADT ID, which is what the platform expects.
In most cases, external systems already know the ADT ID and can send it directly — in which case, the inbound and outbound External IDs will be the same.
Best Practice: Always match the External ID in both inbound and outbound configurations with the Facility ADT ID.
This field is required for API integrations, even though it is not enforced by the user interface.
Example: FacilityExternalId