Skip to main content
InterSystems IRIS for Health
Previewv0.1.0
46 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.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

Basic Authentication · Connector Profile

Uses the user name and password of an InterSystems IRIS user, so calls run with that user’s roles. No client registratio…

API Key (InterSystems FHIR Server cloud) · Connector Profile

For InterSystems FHIR Server, the managed cloud service. Uses an API key created on the deployment, and supports the bul…

OAuth 2.0 Client Credentials (System) · Connector Profile

System-level access with no user sign-in. Requires registering a confidential client on the authorization server your FH…

SMART on FHIR (User Sign-In) · Connector Profile

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 (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Basic Authentication · Link Account

API Key (InterSystems FHIR Server cloud) · Link Account

OAuth 2.0 Client Credentials (System) · Link Account

SMART on FHIR (User Sign-In) · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
46 actions
Action
Description
Search Patients
Find patients by name, birth date, identifier (MRN) or contact details
Get Patient
Retrieve a patient’s demographics by FHIR ID
Get Patient Chart
Get a patient’s whole chart in one call, grouped by record type
Search Practitioners
Find clinicians by name or NPI
Search Organizations
Find hospitals, clinics, payers and other organisations
Search Groups
Find patient groups (cohorts) for bulk export
Search Conditions
List a patient’s problems, diagnoses and health concerns
Create Condition
Add a problem or diagnosis to a patient’s record
Search Medication Requests
List a patient’s prescriptions and medication orders
Search Allergies
List a patient’s allergies and intolerances
Create Allergy
Record a new allergy or intolerance for a patient
Search Observations
List a patient’s lab results, vital signs and other observations
Create Observation
Record a vital sign, lab value or other measurement for a patient
Get Latest Observations
Get the most recent value of each lab test or vital sign for a patient
Search Diagnostic Reports
List a patient’s lab panels, imaging and other reports
Search Procedures
List a patient’s procedures and surgeries
Search Immunizations
List a patient’s vaccinations
Search Encounters
List a patient’s visits and admissions
Search Appointments
List a patient’s appointments
Search Care Plans
List a patient’s care plans and planned activities
Search Care Teams
List the clinicians and roles on a patient’s care teams
Search Goals
List a patient’s care goals and their progress
Search Documents
List a patient’s clinical notes and documents
Create Clinical Note
Save a clinical note or document to a patient’s record
Search Service Requests
List a patient’s orders and referrals
Search Devices
List a patient’s implanted and assigned devices
Search Coverage
List a patient’s insurance coverage
Search Claims (Explanation Of Benefit)
List a patient’s adjudicated claims
Create Resource
Create any FHIR resource on the server
Get Resource
Read any FHIR resource by type and ID
Search Resources
Search any FHIR resource type with standard FHIR search parameters
Update Resource
Replace an existing FHIR resource with an updated version
Patch Resource
Change specific fields of a FHIR resource with JSON Patch
Delete Resource
Delete a FHIR resource by type and ID
Get Resource History
List every version of one FHIR resource
Get Resource Version
Read one earlier version of a FHIR resource
Execute Batch Or Transaction
Run several FHIR reads and writes in one batch or transaction Bundle
Get Encounter Everything
Get every record linked to one encounter in a single Bundle
Find Patient List
Get a patient’s current problems, medications or allergies list
Describe Capabilities
List the resource types, search parameters and operations this FHIR server supports
Expand Value Set
List the codes in a FHIR value set, optionally filtered by text
Validate Resource
Check a FHIR resource against the R4 specification before saving it
Delete Bulk Export
Delete a bulk export’s result files once they have been read
Get Bulk Export File
Read the records in one bulk export result file
Get Bulk Export Status
Check whether a bulk export has finished and list its result files
Start Bulk Export
Start an asynchronous FHIR bulk export for a patient group, all patients or the whole server