IMS MAXIMS (CareConnect STU3)
Category: EHR & Practice Mgmt
Node id: maxims-fhir
Standards: GDPR, UK-GDPR, NHS-Digital, DCB0129, HIPAA-eligible
IMS MAXIMS EHR via the CareConnect FHIR STU3 REST API (UK/Ireland NHS). Tier 2 — partner program. Reads patient record resources and optionally normalizes STU3→canonical R4 in-line (lossy; losses surfaced).
What it does
- CareConnect FHIR STU3 search/read
- Patient lookup by verified NHS Number
- Optional in-line STU3→R4 normalization with residual-loss reporting
- OAuth2 client-credentials / injected token / open auth
Use cases
- Ingest UK NHS GP/acute records from a MAXIMS CareConnect instance
- Feed canonical R4 into FHIR-to-OMOP / analytics
- Resolve patients by NHS Number
Runtime
- Performance tier:
variable
Input ports
| Name | Type | Required | Description |
|---|---|---|---|
search_params | json | No | FHIR search parameters |
resource_id | text | No | Resource id (read) |
nhs_number | text | No | Verified NHS Number (patient_search) |
family_name | text | No | |
given_name | text | No | |
birthdate | text | No | YYYY-MM-DD |
access_token | text | No | Optional runtime Bearer token |
Output ports
| Name | Type | Required | Description |
|---|---|---|---|
result | json | No | Bundle/resource (STU3, or canonical R4 when normalize_to_r4) + losses[] |
metadata | json | No | resource_type, total, entry_count, normalized, loss_count |
success | boolean | No | True on HTTP 2xx |
Settings
Basic
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| FHIR Base URL | base_url | string | Yes | CareConnect STU3 FHIR root | ||
| Operation | operation | enum | No | search | search, read, patient_search | |
| Resource Type | resource_type | string | No | Patient | ||
| Normalize to R4 | normalize_to_r4 | boolean | No | false | Convert STU3 results to canonical R4 (lossy; see result.losses) |
Auth
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| Auth Type | auth_type | enum | No | none | none, access_token, client_credentials | |
| Access Token | access_token | secret | No | Bearer token for auth_type=access_token | ||
| Token URL | token_url | string | No | OAuth2 token endpoint (client_credentials) | ||
| Client ID | client_id | secret | No | |||
| Client Secret | client_secret | secret | No | |||
| Scopes | scopes | string | No | Space-separated OAuth2 scopes |
Advanced
| Setting | Name | Type | Required | Default | Allowed values | Description |
|---|---|---|---|---|---|---|
| NHS Number System | nhs_number_system | string | No | https://fhir.nhs.uk/Id/nhs-number | ||
| Resource ID | resource_id | string | No | |||
| Search Parameters | search_params | json | No | |||
| Count | count | number | No | |||
| Offset | offset | number | No |
Errors
| Code | Description |
|---|---|
MAXIMS_AUTH_FAILED | Failed to obtain/supply a Bearer token |
MAXIMS_REQUEST_FAILED | FHIR request failed or returned non-2xx |
MAXIMS_MISSING_PARAM | Required config/input missing (base_url, resource_id) |
MAXIMS_UNSUPPORTED_OPERATION | Operation not recognised |
Runtime notes
- Self-contained vendor-direct FHIR STU3 client (not a Connect proxy).
- normalize_to_r4=true converts each resource STU3→R4 via the stu3 mapper; the conversion is LOSSY — inspect result.losses and metadata.loss_count.
- CareConnect mandates a verified NHS Number for Patient; patient_search builds identifier=<nhs_number_system>|<nhs_number>.
- CareConnect is nationally deprecated (BaRS) but deployed MAXIMS instances still serve STU3; validate against the instance CapabilityStatement (discovery tool) before prod.
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.