> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# InterSystems IRIS for Health

> How to set up the InterSystems IRIS for Health connector, plus the actions that are available.

![InterSystems IRIS for Health](https://stackone-logos.com/api/intersystems/filled/svg)

Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/intersystemsfhir/changelog.md)

[46 actions](#actions) · 4 auth methods

Healthcare

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Basic Authentication · Connector Profile](https://docs.stackone.com/connectors/intersystemsfhir/guides/connector-profile/basic-authentication.md)
>
> Uses the user name and password of an InterSystems IRIS user, so calls run with that user's roles. No client registratio...

> [card] [API Key (InterSystems FHIR Server cloud) · Connector Profile](https://docs.stackone.com/connectors/intersystemsfhir/guides/connector-profile/api-key-intersystems-fhir-server-cloud.md)
>
> For InterSystems FHIR Server, the managed cloud service. Uses an API key created on the deployment, and supports the bul...

> [card] [OAuth 2.0 Client Credentials (System) · Connector Profile](https://docs.stackone.com/connectors/intersystemsfhir/guides/connector-profile/oauth-2-0-client-credentials-system.md)
>
> System-level access with no user sign-in. Requires registering a confidential client on the authorization server your FH...

> [card] [SMART on FHIR (User Sign-In) · Connector Profile](https://docs.stackone.com/connectors/intersystemsfhir/guides/connector-profile/smart-on-fhir-user-sign-in.md)
>
> A clinician or patient signs in, so calls are limited to what that person may see. Requires registering a SMART app on t...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Basic Authentication · Link Account](https://docs.stackone.com/connectors/intersystemsfhir/guides/link-account/basic-authentication.md)

> [card] [API Key (InterSystems FHIR Server cloud) · Link Account](https://docs.stackone.com/connectors/intersystemsfhir/guides/link-account/api-key-intersystems-fhir-server-cloud.md)

> [card] [OAuth 2.0 Client Credentials (System) · Link Account](https://docs.stackone.com/connectors/intersystemsfhir/guides/link-account/oauth-2-0-client-credentials-system.md)

> [card] [SMART on FHIR (User Sign-In) · Link Account](https://docs.stackone.com/connectors/intersystemsfhir/guides/link-account/smart-on-fhir-user-sign-in.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key (InterSystems FHIR Server cloud)

Basic Authentication

OAuth 2.0 Client Credentials (System)

SMART on FHIR (User Sign-In)

No auth methods found

46 actions

ActionDescription

Search Patients`intersystemsfhir_search_patients`

Find patients by name, birth date, identifier (MRN) or contact details

Get Patient`intersystemsfhir_get_patient`

Retrieve a patient's demographics by FHIR ID

Get Patient Chart`intersystemsfhir_get_patient_chart`

Get a patient's whole chart in one call, grouped by record type

Search Practitioners`intersystemsfhir_search_practitioners`

Find clinicians by name or NPI

Search Organizations`intersystemsfhir_search_organizations`

Find hospitals, clinics, payers and other organisations

Search Groups`intersystemsfhir_search_groups`

Find patient groups (cohorts) for bulk export

Search Conditions`intersystemsfhir_search_conditions`

List a patient's problems, diagnoses and health concerns

Create Condition`intersystemsfhir_create_condition`

Add a problem or diagnosis to a patient's record

Search Medication Requests`intersystemsfhir_search_medication_requests`

List a patient's prescriptions and medication orders

Search Allergies`intersystemsfhir_search_allergies`

List a patient's allergies and intolerances

Create Allergy`intersystemsfhir_create_allergy`

Record a new allergy or intolerance for a patient

Search Observations`intersystemsfhir_search_observations`

List a patient's lab results, vital signs and other observations

Create Observation`intersystemsfhir_create_observation`

Record a vital sign, lab value or other measurement for a patient

Get Latest Observations`intersystemsfhir_get_latest_observations`

Get the most recent value of each lab test or vital sign for a patient

Search Diagnostic Reports`intersystemsfhir_search_diagnostic_reports`

List a patient's lab panels, imaging and other reports

Search Procedures`intersystemsfhir_search_procedures`

List a patient's procedures and surgeries

Search Immunizations`intersystemsfhir_search_immunizations`

List a patient's vaccinations

Search Encounters`intersystemsfhir_search_encounters`

List a patient's visits and admissions

Search Appointments`intersystemsfhir_search_appointments`

List a patient's appointments

Search Care Plans`intersystemsfhir_search_care_plans`

List a patient's care plans and planned activities

Search Care Teams`intersystemsfhir_search_care_teams`

List the clinicians and roles on a patient's care teams

Search Goals`intersystemsfhir_search_goals`

List a patient's care goals and their progress

Search Documents`intersystemsfhir_search_documents`

List a patient's clinical notes and documents

Create Clinical Note`intersystemsfhir_create_clinical_note`

Save a clinical note or document to a patient's record

Search Service Requests`intersystemsfhir_search_service_requests`

List a patient's orders and referrals

Search Devices`intersystemsfhir_search_devices`

List a patient's implanted and assigned devices

Search Coverage`intersystemsfhir_search_coverage`

List a patient's insurance coverage

Search Claims (Explanation Of Benefit)`intersystemsfhir_search_claims`

List a patient's adjudicated claims

Create Resource`intersystemsfhir_create_resource`

Create any FHIR resource on the server

Get Resource`intersystemsfhir_get_resource`

Read any FHIR resource by type and ID

Search Resources`intersystemsfhir_search_resources`

Search any FHIR resource type with standard FHIR search parameters

Update Resource`intersystemsfhir_update_resource`

Replace an existing FHIR resource with an updated version

Patch Resource`intersystemsfhir_patch_resource`

Change specific fields of a FHIR resource with JSON Patch

Delete Resource`intersystemsfhir_delete_resource`

Delete a FHIR resource by type and ID

Get Resource History`intersystemsfhir_get_resource_history`

List every version of one FHIR resource

Get Resource Version`intersystemsfhir_get_resource_version`

Read one earlier version of a FHIR resource

Execute Batch Or Transaction`intersystemsfhir_execute_bundle`

Run several FHIR reads and writes in one batch or transaction Bundle

Get Encounter Everything`intersystemsfhir_get_encounter_everything`

Get every record linked to one encounter in a single Bundle

Find Patient List`intersystemsfhir_find_patient_list`

Get a patient's current problems, medications or allergies list

Describe Capabilities`intersystemsfhir_describe_capabilities`

List the resource types, search parameters and operations this FHIR server supports

Expand Value Set`intersystemsfhir_expand_valueset`

List the codes in a FHIR value set, optionally filtered by text

Validate Resource`intersystemsfhir_validate_resource`

Check a FHIR resource against the R4 specification before saving it

Delete Bulk Export`intersystemsfhir_delete_bulk_export`

Delete a bulk export's result files once they have been read

Get Bulk Export File`intersystemsfhir_get_bulk_export_file`

Read the records in one bulk export result file

Get Bulk Export Status`intersystemsfhir_get_bulk_export_status`

Check whether a bulk export has finished and list its result files

Start Bulk Export`intersystemsfhir_start_bulk_export`

Start an asynchronous FHIR bulk export for a patient group, all patients or the whole server


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.