Skip to main content

EMIS Health

Category: EHR & Practice Mgmt
Node id: emis

Standards: GDPR, UK-GDPR, HIPAA-eligible, NHS-Digital, DCB0129

EMIS-X Partner API connector for UK GP primary care. Tier 2 — partner program / OAuth2. Reads the patient clinical record, demographics, patient-matching/sync and appointments, and writes coded data back via FileRecord. Returns raw EMIS JSON (Bronze); EMIS→FHIR mapping is a separate downstream layer.

What it does​

  • OAuth2 client-credentials or injected Bearer token authentication
  • Full clinical record reads (coded record, consultations, medication issues, events, attachments)
  • Patient demographics, matching and incremental change sync
  • Appointment sessions, slots, booking, cancellation and status updates
  • Coded write-back via FileRecord with dry_run safety guard
  • raw_request escape hatch for any endpoint not yet modelled

Use cases​

  • Sync UK GP patient records from EMIS into the Hydra Semantic Medallion
  • Incrementally track changed patients via patientMatching for a sync loop
  • Write structured coded data back into the EMIS record under guardrail control
  • Manage GP appointment slots and bookings from an agentic workflow

Runtime​

  • Performance tier: variable

Input ports​

NameTypeRequiredDescription
queryjsonNoOperation query parameters
bodyjsonNoRequest body for file_record / raw_request (JSON object or raw XML string)
access_tokentextNoOptional runtime Bearer token override

Output ports​

NameTypeRequiredDescription
resultjsonNoParsed JSON response payload from the vendor API
metadatajsonNoOperation, HTTP status code, and content length
successbooleanNoTrue if HTTP 2xx

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
OperationoperationenumYesget_medical_recordget_medical_record, get_coded_record, get_consultation, get_events, get_medication_issues, get_attachments, get_attachments_v2, get_base64_attachment_data, file_record, update_attachment, update_consultation_visibility, get_patient_demographics, get_matched_patients, get_changed_patients, get_changed_patients_mr, get_patient_sequence, get_organisation, get_patient_searches, get_user_by_id, get_appointment_sessions, get_appointment_configuration, get_slots_for_session, get_slots_for_session_v2, get_patient_appointments, get_patient_appointments_v2, get_arrived_patients, get_booked_patients, get_booked_patients_v2, get_sent_in_patients, book_appointment, cancel_appointment, set_appointment_status, set_appointment_status_ex, set_slot_notes, set_slot_type, add_slot_comment, raw_requestEMIS Partner API operation to perform
Application IDapplication_idstringYesEMIS-issued application id, sent as the required applicationId header on every call

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Auth Typeauth_typeenumNoclient_credentialsclient_credentials, access_tokenHow the Bearer token is obtained
Token URLtoken_urlstringNoFull OAuth2 token endpoint (Microsoft identity, separate host) — required for client_credentials
Client IDclient_idsecretNoOAuth2 client id — required for client_credentials
Client Secretclient_secretsecretNoOAuth2 client secret — required for client_credentials
ScopesscopesstringNopapi-cr.read papi-appt.read papi-subjects.read papi-searches.read papi-config.readSpace-separated papi-* scopes
Access Tokenaccess_tokensecretNoPre-obtained Bearer token — required for auth_type=access_token

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Base URLbase_urlstringNohttps://api.platform.emis-x.ukEMIS Partner API host
Dry Rundry_runbooleanNofalseWhen true, mutating operations return the planned request without calling EMIS
Content Typecontent_typestringNoapplication/jsonBody content type for file_record (application/json or application/xml)
Raw MethodmethodstringNoHTTP method for raw_request
Raw PathpathstringNoPath (e.g. /api/v1/...) for raw_request
Extra Headersextra_headersjsonNoAdditional request headers (forward-compat)

Errors​

CodeDescription
EMIS_AUTH_FAILEDFailed to obtain or supply a Bearer token
EMIS_REQUEST_FAILEDHTTP request to the EMIS Partner API failed or returned non-2xx
EMIS_MISSING_PARAMA required query parameter (or raw_request path) was missing
EMIS_UNSUPPORTED_OPERATIONThe requested operation is not recognised

Runtime notes​

  • Output has BOTH result and metadata as separate top-level keys — metadata is NOT inside result.
  • Every call requires the applicationId header (set from application_id config) plus a Bearer token.
  • Token is auto-fetched via OAuth2 client-credentials unless auth_type=access_token (or an access_token input) is supplied.
  • book_appointment and cancel_appointment are HTTP GET but DO mutate state — they are guarded by dry_run.
  • EMIS does not expose FHIR; this node returns raw EMIS JSON for a downstream Mapping Layer.
  • No clinical-safety gate approves EMIS write-back: dry_run is the only node-level write guard. The HG-05 autonomy ceiling treats this node as write (undeclared effect) and refuses it only in pipelines that run a research-only agent or graph; in any other pipeline a write operation with dry_run=false reaches EMIS.

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.