Skip to main content

Allscripts FHIR

Category: EHR & Practice Mgmt
Node id: allscripts-fhir

Standards: HIPAA, GDPR, SOC2

Integrates with Allscripts EHR via FHIR R4 API for searching, reading, and patient lookup operations

What it does​

  • OAuth2 client credentials authentication for Allscripts
  • FHIR R4 search and read operations
  • Patient-specific search by demographics and identifier
  • Application name header support (X-Allscripts-App-Name)

Use cases​

  • Query patient records from Allscripts EHR for data integration
  • Search Allscripts for patients by name or identifier
  • Feed Allscripts clinical data into downstream FHIR transformation pipelines

Runtime​

  • Performance tier: variable

Input ports​

NameTypeRequiredDescription
search_paramsjsonNoSearch parameters as key-value pairs
resource_idtextNoResource ID for read operations
family_nametextNoPatient family name for patient_search
given_nametextNoPatient given name for patient_search
birthdatetextNoPatient birth date for patient_search
identifiertextNoPatient identifier for patient_search

Output ports​

NameTypeRequiredDescription
resultjsonNoMain result data from the Allscripts FHIR operation
metadatajsonNoResponse metadata including resource type, counts, and operation details
successbooleanNoWhether the operation succeeded

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Allscripts Base URLallscripts_base_urlstringYesBase URL of the Allscripts EHR instance
OperationoperationenumYessearchsearch, read, patient_searchFHIR operation to perform
Resource Typeresource_typestringNoPatientFHIR resource type to operate on

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Client IDclient_idsecretYesOAuth2 client ID for Allscripts authentication
Client Secretclient_secretsecretYesOAuth2 client secret for Allscripts authentication
Application Nameapp_namestringNoAllscripts application name (sent as X-Allscripts-App-Name header)

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Search Parameterssearch_paramsjsonNoDefault search parameters as key-value pairs
Resource IDresource_idstringNoResource ID for read operations (can also come from input)

Errors​

CodeDescription
ALLSCRIPTS_AUTH_FAILEDFailed to obtain OAuth2 token from Allscripts
ALLSCRIPTS_SEARCH_FAILEDAllscripts FHIR search returned an error
ALLSCRIPTS_READ_FAILEDAllscripts FHIR read returned an error
RESOURCE_ID_REQUIREDresource_id is required for read operation

Runtime notes​

  • patient_search returns both a FHIR bundle and a flat patients array for convenience — downstream nodes can use either
  • search_params from the input port are merged with (and override) search_params from config
  • OAuth2 token is fetched automatically via client_credentials grant on every execution
  • The result shape varies by operation: search returns bundle, read returns resource, patient_search returns bundle+patients

See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.

Something unclear? Send documentation feedback by email.