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
| Name | Type | Required | Description |
|---|---|---|---|
query | json | No | Operation query parameters |
body | json | No | Request body for file_record / raw_request (JSON object or raw XML string) |
access_token | text | No | Optional runtime Bearer token override |
Output ports
| Name | Type | Required | Description |
|---|---|---|---|
result | json | No | Parsed JSON response payload from the vendor API |
metadata | json | No | Operation, HTTP status code, and content length |
success | boolean | No | True if HTTP 2xx |
Settings
Basic
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Operation | operation | enum | Yes | get_medical_record | get_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_request | EMIS Partner API operation to perform |
| Application ID | application_id | string | Yes | EMIS-issued application id, sent as the required applicationId header on every call |
Auth
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Auth Type | auth_type | enum | No | client_credentials | client_credentials, access_token | How the Bearer token is obtained |
| Token URL | token_url | string | No | Full OAuth2 token endpoint (Microsoft identity, separate host) — required for client_credentials | ||
| Client ID | client_id | secret | No | OAuth2 client id — required for client_credentials | ||
| Client Secret | client_secret | secret | No | OAuth2 client secret — required for client_credentials | ||
| Scopes | scopes | string | No | papi-cr.read papi-appt.read papi-subjects.read papi-searches.read papi-config.read | Space-separated papi-* scopes | |
| Access Token | access_token | secret | No | Pre-obtained Bearer token — required for auth_type=access_token |
Advanced
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Base URL | base_url | string | No | https://api.platform.emis-x.uk | EMIS Partner API host | |
| Dry Run | dry_run | boolean | No | false | When true, mutating operations return the planned request without calling EMIS | |
| Content Type | content_type | string | No | application/json | Body content type for file_record (application/json or application/xml) | |
| Raw Method | method | string | No | HTTP method for raw_request | ||
| Raw Path | path | string | No | Path (e.g. /api/v1/...) for raw_request | ||
| Extra Headers | extra_headers | json | No | Additional request headers (forward-compat) |
Errors
| Code | Description |
|---|---|
EMIS_AUTH_FAILED | Failed to obtain or supply a Bearer token |
EMIS_REQUEST_FAILED | HTTP request to the EMIS Partner API failed or returned non-2xx |
EMIS_MISSING_PARAM | A required query parameter (or raw_request path) was missing |
EMIS_UNSUPPORTED_OPERATION | The 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.
Etwas unklar? Senden Sie Feedback zur Dokumentation per E-Mail..