Saltar al contenido principal

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​

NameTypeRequiredDescription
search_paramsjsonNoFHIR search parameters
resource_idtextNoResource id (read)
nhs_numbertextNoVerified NHS Number (patient_search)
family_nametextNo
given_nametextNo
birthdatetextNoYYYY-MM-DD
access_tokentextNoOptional runtime Bearer token

Output ports​

NameTypeRequiredDescription
resultjsonNoBundle/resource (STU3, or canonical R4 when normalize_to_r4) + losses[]
metadatajsonNoresource_type, total, entry_count, normalized, loss_count
successbooleanNoTrue on HTTP 2xx

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
FHIR Base URLbase_urlstringYesCareConnect STU3 FHIR root
OperationoperationenumNosearchsearch, read, patient_search
Resource Typeresource_typestringNoPatient
Normalize to R4normalize_to_r4booleanNofalseConvert STU3 results to canonical R4 (lossy; see result.losses)

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Auth Typeauth_typeenumNononenone, access_token, client_credentials
Access Tokenaccess_tokensecretNoBearer token for auth_type=access_token
Token URLtoken_urlstringNoOAuth2 token endpoint (client_credentials)
Client IDclient_idsecretNo
Client Secretclient_secretsecretNo
ScopesscopesstringNoSpace-separated OAuth2 scopes

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
NHS Number Systemnhs_number_systemstringNohttps://fhir.nhs.uk/Id/nhs-number
Resource IDresource_idstringNo
Search Parameterssearch_paramsjsonNo
CountcountnumberNo
OffsetoffsetnumberNo

Errors​

CodeDescription
MAXIMS_AUTH_FAILEDFailed to obtain/supply a Bearer token
MAXIMS_REQUEST_FAILEDFHIR request failed or returned non-2xx
MAXIMS_MISSING_PARAMRequired config/input missing (base_url, resource_id)
MAXIMS_UNSUPPORTED_OPERATIONOperation 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.

¿Algo no está claro? Envíe sus comentarios sobre la documentación por correo electrónico..