--- sourceDocument: Australia Workflow Data Fabric sourceDocumentLink: https://www.servicenow.com/docs/r/australia/integrate-applications Release : - australia ft:locale : - en-US ft:publication_title : - Australia Workflow Data Fabric ft:clusterId : - crint bundleId : - crint workflow : - Creator --- # HL7 FHIR Spoke # HL7 FHIR Spoke {#ariaid-title1} Release version: Australia Updated June 16, 2026 ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read Summarize ![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete. ## Summary of HL7 FHIR Spoke The HL7 FHIR Spoke enables ServiceNow customers to integrate their instance with any HL7 FHIR R4-conformant server, specifically targeting provider-directory resources such as Organization, Location, Practitioner, and PractitionerRole. It simplifies access to FHIR data by providing typed, paginated, and error-handled Workflow Studio actions that retrieve these resources without requiring custom REST message configurations or scripting. Show full answer Show less This spoke is read-only and returns raw FHIR data as Workflow Studio data pills, leaving data persistence and mapping decisions to the consuming workflows or downstream applications like Healthcare Operations HL7 FHIR Integration. ## Key Features * **Integration Hub Action Pack:** Offers eight read-only Workflow Studio actions---each resource has a look-up-by-ID action and a search-and-stream action with automatic pagination handling. * **FHIR R4 Compatibility:** Supports any HL7 FHIR R4 server with configurable API versioning via a connection attribute, enabling easy redirection to different FHIR API paths. * **OAuth 2.0 Authentication:** Uses OAuth 2.0 client credentials with authorization code grant and PKCE (S256) for secure access to FHIR servers. * **Centralized Connection Management:** All actions utilize a single Connection \& Credential Alias named "HL7 FHIR," simplifying credential management across environments. * **Dependent Plugins:** Requires active Workflow Studio, Flow Designer Action Step --- CORE, REST step type, and Integration Hub Action Template --- Data Stream plugins, some of which may require licenses. ## Actions Provided * **Organization:** Look up by ID and stream search with pagination. * **Location:** Look up by ID and stream search with pagination. * **Practitioner:** Look up by ID and stream search with pagination. * **PractitionerRole:** Look up by ID and stream search with pagination. All actions perform HTTP GET requests and do not support write operations, event triggers, or other FHIR resources beyond the four provider-directory types. ## Practical Benefits for ServiceNow Customers * Eliminates the need for custom REST message development and complex scripting to access FHIR provider-directory data. * Enables rapid workflow development with typed, error-handled actions that handle pagination and FHIR API intricacies. * Maintains flexibility by providing raw FHIR data, allowing customers to tailor data mapping and persistence according to their specific requirements. * Simplifies credential and connection management with reusable aliases, facilitating multi-environment deployments. ## Requirements and Next Steps * An Integration Hub subscription is required to use this spoke. * Access to an HL7 FHIR R4-conformant server with OAuth 2.0 client credentials configured. * Activate the HL7 FHIR Spoke and ensure all dependent plugins are installed and licensed as needed. * For detailed action inputs, outputs, and configuration guidance, refer to the HL7 FHIR Spoke actions reference and activation documentation. Integrate ServiceNow with any HL7 FHIR R4-conformant server. The HL7 FHIR Spoke gives Workflow Studio authors a typed, paginated, error-handled way to read FHIR R4 provider-directory resources --- Organization, Location, Practitioner, and PractitionerRole --- from your ServiceNow instance. The HL7 FHIR Spoke is an Integration Hub action pack that exposes eight read-only Workflow Studio actions --- a look-up-by-ID action and a search-and-stream action for each of the four FHIR R4 provider-directory resources. Health systems expose practitioner, organizational, and location data through HL7 FHIR R4 APIs, but Workflow Studio has no native way to query those endpoints. Without this spoke, workflow builders write custom REST messages, script includes, and JSON parsers. The HL7 FHIR Spoke closes that gap. The spoke is FHIR-agnostic: it returns raw FHIR field values as Workflow Studio data pills and does not map them to any ServiceNow data model. Downstream applications, such as the Healthcare Operations HL7 FHIR Integration, compose these actions inside their own flows to persist FHIR data into ServiceNow tables. ## Request apps on the Store {#fhir-spoke-landing__section_fhir_spk_send} Visit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the [ServiceNow Store version history release notes](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).{#fhir-spoke-landing__inline-send-to-store} ## Integration Hub subscription {#fhir-spoke-landing__section_fhir_spk_ihub} This spoke requires an Integration Hub subscription. For more information, see [Legal schedules - IntegrationHub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf). ## Spoke version {#fhir-spoke-landing__section_fhir_spk_version} HL7 FHIR Spoke v2.0.0 is the latest version. For version history of the spoke, see [HL7 FHIR Spoke release notes](https://www.servicenow.com/docs/r/store-release-notes/store-rn-csm-hl7-fhir-spoke.html?contentId=v38STcRtksTASS8uRyyy1g).{#fhir-spoke-landing__hl7-fhir-ver} ## Supported versions {#fhir-spoke-landing__section_fhir_spk_supported} This spoke was built for HL7 FHIR R4 and connects to any FHIR R4-conformant server. A connection attribute named `api_version` selects the FHIR R4 URL fragment (default `baseR4`), so you can re-point all actions to a different API path without re-authoring any flow. ## Spoke requirements {#fhir-spoke-landing__section_fhir_spk_requirements} * Access to an HL7 FHIR R4-conformant server and its base URL. * OAuth 2.0 client credentials registered for your instance: the authorization, token, and revoke-token endpoint URLs and the client ID and client secret. The provider uses the authorization code grant with PKCE (`S256`). {#fhir-spoke-landing__ul_fhir_spk_req} ## Spoke dependencies {#fhir-spoke-landing__section_fhir_spk_dependencies} If you're having trouble installing the app, ensure that these dependent plugins are active: * Workflow Studio (com.glide.hub) * Flow Designer Action Step --- CORE (com.glide.hub.action_step.core) * REST step type (com.glide.hub.action_step.rest) * Integration Hub Action Template --- Data Stream (com.glide.hub.action_type.datastream) {#fhir-spoke-landing__ul_fhir_spk_dep} Note: Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation. ## Spoke actions {#fhir-spoke-landing__section_fhir_spk_actions} The HL7 FHIR Spoke provides actions to read FHIR R4 provider-directory resources from your ServiceNow instance. For each resource, a look-up-by-ID action retrieves a single resource by its FHIR logical ID, and a stream action searches the resource with optional FHIR R4 search parameters and streams one resource per item, following each FHIR Bundle `next` link automatically until the server stops paging. Available actions include:{#fhir-spoke-landing__table_fhir_spk_actions__entry__3} | Category | Action | Description | |-|-|-| | Organization Management | Look up Organization by ID | Retrieves a single FHIR Organization resource by its logical ID. | | Organization Management | Look up Organizations Stream | Searches and streams Organization resources with automatic pagination. | | Location Management | Look up Location by ID | Retrieves a single FHIR Location resource by its logical ID. | | Location Management | Look up Locations Stream | Searches and streams Location resources with automatic pagination. | | Practitioner Management | Look up Practitioner by ID | Retrieves a single FHIR Practitioner resource by its logical ID. | | Practitioner Management | Look up Practitioners Stream | Searches and streams Practitioner resources with automatic pagination. | | PractitionerRole Management | Look up PractitionerRole by ID | Retrieves a single FHIR PractitionerRole resource by its logical ID. | | PractitionerRole Management | Look up PractitionerRoles Stream | Searches and streams PractitionerRole resources with automatic pagination. | [ ] {#fhir-spoke-landing__table_fhir_spk_actions} All actions are read-only (HTTP GET). Write operations, real-time event triggers such as CDS Hooks or FHIR subscriptions, and FHIR resources beyond the four provider-directory resources are out of scope. For the inputs and outputs of each action, see [HL7 FHIR Spoke actions reference](https://www.servicenow.com/docs/iWPgmh0jWL~i7lMTsFvJaw "The HL7 FHIR Spoke provides eight read-only Workflow Studio actions — a look-up-by-ID action and a stream action for each of the four FHIR R4 provider-directory resources. This reference lists the key inputs and outputs of each action."). Note: Spoke actions return raw FHIR field values; the consuming flow owns all persistence and field mapping. ## Connection and credential alias requirements {#fhir-spoke-landing__section_fhir_spk_aliases} Integration Hub uses aliases to manage connection and credential information. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection. For more information, see [Connections and Credentials](https://www.servicenow.com/docs/access?context=r-credentials&version=australia&pubname=australia-platform-security&ft:locale=en-US). All eight actions route through a single Connection \& Credential Alias named `HL7 FHIR`, so the FHIR server URL and OAuth credentials are bound once at install time and reused by every action. For information about setting up the spoke, see [Activate the HL7 FHIR Spoke](https://www.servicenow.com/docs/SZVKlv~7TXofhQBboZwLhA#fhir-spoke-activate "Install the HL7 FHIR Spoke from the ServiceNow Store and verify that the required platform plugins are active so that the eight FHIR actions are available in Workflow Studio.").