Components installed with the HL7 FHIR Spoke

  • Release version: Australia
  • Updated June 16, 2026
  • 1 minute to read

    • Several types of components are installed with the HL7 FHIR Spoke, including Workflow Studio actions, a Connection & Credential Alias and configuration template, script includes, and application menu modules. The spoke installs no custom tables or roles.

    Flow Designer actions installed

    The spoke installs eight read-only actions, grouped into four Integration Hub categories. For each action's inputs and outputs, see HL7 FHIR Spoke actions reference.

    Category Actions
    Organization Management Look up Organization by ID; Look up Organizations Stream
    Location Management Look up Location by ID; Look up Locations Stream
    Practitioner Management Look up Practitioner by ID; Look up Practitioners Stream
    PractitionerRole Management Look up PractitionerRole by ID; Look up PractitionerRoles Stream

    Connection and credential records installed

    Record Type Description
    HL7 FHIR Connection & Credential Alias

    Shared connectivity point for all eight actions. Stores the FHIR server base URL. Includes an api_version connection attribute (default baseR4) that selects the FHIR R4 URL fragment.
    FHIR Connection Configuration Configuration template

    Attached to the HL7 FHIR alias to provide the guided Add Connection setup. Creates the HTTP connection and an OAuth 2.0 credential (FHIR Spoke Credential, with application registry FHIR Spoke OAuth) that use the authorization code grant with PKCE (S256). The client ID, client secret, and endpoint URL are supplied by the customer during guided setup.

    Script includes installed

    The spoke installs four script includes that perform input validation, FHIR R4 response parsing, and stream query-string assembly for the actions. These classes support the actions internally and are not intended for direct use by other applications; their method signatures may change between releases.

    Script include Description
    OrganizationLookUpUtil Pre- and post-processing for the Organization actions.
    LocationLookUpUtil Pre- and post-processing for the Location actions.
    PractitionerLookUpUtil Pre- and post-processing for the Practitioner actions.
    PractitionerRoleLookUpUtil Pre- and post-processing for the PractitionerRole actions.

    Application menu and modules installed

    The spoke adds a FHIR App application menu, visible to users with the snc_internal role, with two modules: FHIR App Registry (a list of FHIR-related OAuth providers) and Connection Alias (a list of FHIR-related Connection & Credential Aliases). These modules are for administrative inspection during installation and troubleshooting.