HL7 FHIR Spoke actions reference

  • Release version: Australia
  • Updated June 16, 2026
  • 2 minutes to read
    • Summarize
    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 actions reference

    The HL7 FHIR Spoke in ServiceNow offers eight read-only Workflow Studio actions designed to facilitate interaction with four key FHIR R4 provider-directory resources: Organization, Location, Practitioner, and PractitionerRole. These actions enable ServiceNow customers to perform look-up-by-ID queries and stream searches on these resources, supporting integration and automation within healthcare workflows.

    Show full answer Show less

    Key Features

    • Look-up-by-ID actions: Retrieve detailed information about a single resource by providing its unique ID. These actions include a Don't treat as error option, allowing workflows to continue gracefully if the specified resource is not found.
    • Stream actions: Perform paginated searches across multiple resources using FHIR R4 search parameters. Outputs include per-item resource data, page and item counts, and transport-level status and error information.
    • FHIR R4 Compliance: Search inputs correspond directly to FHIR R4 search parameters, ensuring adherence to the HL7 FHIR R4 specification for provider-directory data queries.

    Key Outcomes

    By utilizing these actions, ServiceNow customers can:

    • Integrate and automate retrieval of provider-directory data from HL7 FHIR R4-compliant sources within ServiceNow workflows.
    • Access comprehensive data fields for Organizations, Locations, Practitioners, and PractitionerRoles, supporting operational and clinical use cases.
    • Implement robust error handling and pagination when querying provider-directory resources, enhancing workflow reliability and efficiency.

    Action Details by Resource

    • Organization: Look up by Organization ID or stream search by parameters like name, active status, type, identifier, and address. Outputs include identifiers, contact details, and hierarchical relationships.
    • Location: Look up by Location ID or stream search using criteria such as name, status, operational status, type, managing organization, and geographic proximity. Outputs cover detailed location attributes including coordinates and status.
    • Practitioner: Look up by Practitioner ID or stream search with filters like name, active status, gender, communication language, and contact information. Outputs provide full practitioner identity, qualifications, and communication details.
    • PractitionerRole: Look up by PractitionerRole ID or stream search using parameters such as practitioner, organization, role, specialty, and active status. Outputs include role-specific codes, period of validity, and availability exceptions.

    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.

    Outputs common to all actions

    Every action returns an action status (a code and a message). Look-up-by-ID actions also expose a Don't treat as error option that lets a flow continue when a resource is not found. Stream actions additionally return page and item counts and transport status code, error code, and error message outputs.

    Stream-action search inputs map directly to FHIR R4 search parameters. For the complete parameter set and prefix syntax, see the HL7 FHIR R4 search specification.

    Organization actions

    Action Key inputs Key outputs
    Look up Organization by ID Organization ID (required) id, active, name, alias, type code and display, telecom, address, part of, contact
    Look up Organizations Stream Page size (required); optional: name, active, type, identifier, part of, address fields, last updated, and other FHIR R4 search parameters Per-item Organization fields (as above); page count, item count, count

    Location actions

    Action Key inputs Key outputs
    Look up Location by ID Location ID (required) id, name, description, status, operational status, mode, physical type, type, telecom, address, latitude, longitude, managing organization, part of
    Look up Locations Stream Page size (required); optional: name, status, operational status, location type, identifier, managing organization, part of, near, address fields, and other FHIR R4 search parameters Per-item Location fields (as above); page count, item count, count

    Practitioner actions

    Action Key inputs Key outputs
    Look up Practitioner by ID Practitioner ID (required) id, name text, family, given, prefix, suffix, gender, birth date, active, telecom, address, communication language, qualification code and display and issuer
    Look up Practitioners Stream Page size (required); optional: name, given name, family name, identifier, active, gender, communication language, email, phone, address fields, and other FHIR R4 search parameters Per-item Practitioner fields (as above); page count, item count, count

    PractitionerRole actions

    Action Key inputs Key outputs
    Look up PractitionerRole by ID PractitionerRole ID (required) id, role code and display, specialty code and display, active, practitioner reference, organization reference, location reference, period start and end, telecom, availability exception
    Look up PractitionerRoles Stream Page size (required); optional: practitioner, organization, location, role, specialty, identifier, active, date, phone, email, and other FHIR R4 search parameters Per-item PractitionerRole fields (as above); page count, item count, count