Components installed with the EMR Provider Directory Sync
Summarize
Summary of Components installed with the EMR Provider Directory Sync
The EMR Provider Directory Sync installation includes multiple components designed to facilitate the integration and synchronization of healthcare provider data using FHIR standards. These components enable automated, scheduled imports of provider-related information from electronic medical records (EMR) into the ServiceNow platform, supporting data accuracy and operational efficiency.
Show less
Key Features
- Roles:
The HCO FHIR Integration Admin role (snhcointgfhir.admin) allows users to manage and trigger synchronization runs, edit schedules and classification decision tables, and access sync log records. This role is inherited by users with the broader snhco.admin role.
- Tables:
The FHIR Sync Log table records detailed sync run information per resource type, including timing, status, counts of processed/skipped records, correlation ID, and error messages. The application also interacts with existing tables for Healthcare Organization, Location, Practitioner, and related entities without installing them.
- Scheduled Jobs:
A daily scheduled job named FHIR Sync — Daily runs by default at 3:00 AM to initiate the import orchestration. It is installed in an inactive state and requires activation before use. Admins can also trigger sync runs on demand.
- Flows and Subflows:
The import process is orchestrated through a main subflow and multiple subflows that handle distinct resource types: Organizations, Locations, Practitioners, and PractitionerRoles. Shared subflows manage sync log entries and delta synchronization markers. Child subflows perform per-record processing and upsert operations, with recovery mechanisms for Organizations and Locations.
- Business Rules:
A business rule automatically stamps the end timestamp on sync log records when their status changes from Running, ensuring accurate tracking of sync durations.
- Flow Actions:
Two key flow actions support the synchronization:
- Format FHIR Last-Updated Filter: Converts timestamps into FHIR-compliant filters for delta sync operations.
- Parse FHIR Reference: Extracts logical IDs from FHIR references by removing resource-type prefixes.
- Decision Tables:
The FhirOrgTypeToBusinessLocationClass decision table classifies imported FHIR Organizations as internal or external business locations based on organization type. This table is editable by admins to tailor classification logic.
- Spoke Components:
The synchronization uses read-only actions from the HL7 FHIR Spoke to retrieve provider directory data. These actions perform lookups and streaming of Organizations, Locations, Practitioners, and PractitionerRoles by ID. All calls authenticate via a shared HL7 FHIR connection and credential alias configured in the spoke.
- System Properties:
No system properties are installed with this application. Sync cadence is managed by the scheduled job record, and organization classification is controlled by the decision table.
What This Enables ServiceNow Customers to Do
ServiceNow customers can use the EMR Provider Directory Sync components to automate the import and synchronization of provider-related FHIR resources into their ServiceNow instance. This setup ensures timely, accurate updates to healthcare organization, location, practitioner, and role data within the platform. The included roles and flows provide control and transparency over sync operations, while decision tables allow customization of business logic such as organization classification. The integration with HL7 FHIR Spoke actions facilitates standardized, secure data retrieval from external EMR systems.
By leveraging these components, customers can improve data integrity for healthcare operations, streamline provider directory management, and reduce manual efforts associated with maintaining provider data.
Several types of components are installed with the EMR Provider Directory Sync, including a user role, a sync log table, a scheduled job, flows, a business rule, flow actions, and a decision table.
Roles installed
| Role title [name] | Description | Contains roles |
|---|---|---|
|
HCO FHIR Integration Admin [ |
Operates the FHIR sync: triggers runs, edits the sync schedule and the organization classification decision table, and reads, creates, and updates FHIR Sync Log rows. |
Inherited by users with |
Tables installed
| Table | Description |
|---|---|
|
FHIR Sync Log [ |
Records one row per resource type per sync run, with start and end times, processed and skipped counts, status, correlation ID, and a transport error message. For field details, see FHIR Sync Log fields. |
The application also writes to tables owned by other applications — including the Healthcare Organization, Location, and Practitioner tables, the business location tables, the user table, and the service organization member tables — but does not install them. See FHIR-to-HCLS field mappings.
Scheduled jobs installed
| Scheduled job | Description |
|---|---|
| FHIR Sync — Daily |
Runs daily (by default at 03:00 instance time) and starts the Import FHIR Resources orchestration subflow. Admins can also run it on demand with Execute Now. Installed inactive. Set Active to true on the job record before first use. |
Flows and subflows installed
| Subflow | Description |
|---|---|
| Import FHIR Resources | Orchestration subflow that sets a correlation ID and runs the four per-resource imports in dependency order, stopping if any fails. |
| Import Organizations | Imports FHIR Organizations into Healthcare Organization records and internal or external business locations. |
| Import Locations | Imports FHIR Locations into platform and Healthcare Location records and associates them with a managing organization. |
| Import Practitioners | Imports FHIR Practitioners into user and Healthcare Practitioner records and grants the care-team-member role. |
| Import PractitionerRoles | Imports FHIR PractitionerRoles into service organization member and responsibility records. |
| Start Sync Log Entry / End Sync Log Entry | Shared subflows that open and close a FHIR Sync Log row and provide the delta-sync watermark. |
Each per-resource import decomposes into additional child subflows — a per-record processor and a shared upsert subflow, plus a one-level parent-recovery subflow for Organizations and Locations.
Business rules installed
| Business rule | Table | Description |
|---|---|---|
| Stamp ended on status transition | sn_hco_intg_fhir_sync_log |
Before update — stamps the ended timestamp when
a sync log row transitions out of the Running status. |
Flow actions installed
| Action | Description |
|---|---|
| Format FHIR Last-Updated Filter | Converts the previous run's timestamp into a FHIR
last updated search filter for delta syncs. |
| Parse FHIR Reference | Strips the resource-type prefix from a FHIR reference to return the bare logical ID. |
Decision tables installed
| Decision table | Description |
|---|---|
FhirOrgTypeToBusinessLocationClass |
Classifies an imported FHIR Organization as an internal or external business location based on its organization type. Editable by admins. See Configure the organization classification decision table. |
Spoke components used
EMR Provider Directory Sync uses read-only actions from the HL7 FHIR Spoke to fetch provider-directory data. The following FHIR Spoke actions are called by the import subflows:
- Look up Organization by ID
- Look up Organizations Stream
- Look up Location by ID
- Look up Locations Stream
- Look up Practitioner by ID
- Look up Practitioners Stream
- Look up PractitionerRole by ID
- Look up PractitionerRoles Stream
All eight actions authenticate through the shared HL7 FHIR
Connection & Credential Alias defined in the HL7 FHIR Spoke. For setup
details, see HL7 FHIR
Spoke.
System properties installed
The application installs no system properties. The sync cadence is controlled by the scheduled job record, and the organization classification is controlled by the decision table.