FHIR API

Unified.to's FHIR API serves read-only HL7 FHIR R4 (4.0.1) endpoints over its Healthcare integrations. A FHIR client can search and read patients, practitioners, encounters, observations, conditions, allergies, medication requests, immunizations and diagnostic reports from a connected EHR, lab or practice management system, including systems that don't offer a FHIR API themselves. It's available on every plan.

How does FHIR map onto Healthcare integrations?

Each FHIR call is translated into the connected integration's own API at request time, through the matching Healthcare object, and the result is returned as a FHIR resource. FHIR works on any Healthcare integration; there's no separate FHIR integration to activate. Activate the Healthcare integrations you need and create connections as usual.

FHIR resourceHealthcare object
PatientPatient
PractitionerPractitioner
EncounterEncounter
ObservationObservation
ConditionCondition
AllergyIntoleranceAllergy
MedicationRequestMedication
ImmunizationImmunization
DiagnosticReportReport

What works depends on the integration:

  • Search works wherever the integration lists the object, and read wherever it gets it by ID.
  • Each connection's CapabilityStatement (GET /fhir/{connection_id}/metadata) lists the resources, interactions and search parameters its integration supports, including search parameters the integration requires (some integrations only list clinical records for one patient at a time).
  • A resource type the facade doesn't serve, or a search the integration doesn't support, returns an OperationOutcome with status 404 and code not-supported.

Each integration's Feature Support tab lists its Healthcare objects and methods.

Endpoints

ResourceMethodPathOperation
CapabilityStatementGET/fhir/{connection_id}/metadataGet the CapabilityStatement
PatientGET/fhir/{connection_id}/PatientSearch patients
PatientGET/fhir/{connection_id}/Patient/{id}Read a patient
PractitionerGET/fhir/{connection_id}/PractitionerSearch practitioners
PractitionerGET/fhir/{connection_id}/Practitioner/{id}Read a practitioner
EncounterGET/fhir/{connection_id}/EncounterSearch encounters
EncounterGET/fhir/{connection_id}/Encounter/{id}Read an encounter
ObservationGET/fhir/{connection_id}/ObservationSearch observations
ObservationGET/fhir/{connection_id}/Observation/{id}Read an observation
ConditionGET/fhir/{connection_id}/ConditionSearch conditions
ConditionGET/fhir/{connection_id}/Condition/{id}Read a condition
AllergyIntoleranceGET/fhir/{connection_id}/AllergyIntoleranceSearch allergies
AllergyIntoleranceGET/fhir/{connection_id}/AllergyIntolerance/{id}Read an allergy
MedicationRequestGET/fhir/{connection_id}/MedicationRequestSearch medication requests
MedicationRequestGET/fhir/{connection_id}/MedicationRequest/{id}Read a medication request
ImmunizationGET/fhir/{connection_id}/ImmunizationSearch immunizations
ImmunizationGET/fhir/{connection_id}/Immunization/{id}Read an immunization
DiagnosticReportGET/fhir/{connection_id}/DiagnosticReportSearch diagnostic reports
DiagnosticReportGET/fhir/{connection_id}/DiagnosticReport/{id}Read a diagnostic report

Send your Unified.to API key as a bearer token (Authorization: Bearer <token>). Responses use the application/fhir+json media type. The OpenAPI file is openapi-fhir.json.

Which search parameters are supported?

  • _count: page size. It defaults to, and is capped at, the integration's maximum page size.
  • _offset: the paging offset. Searches return a searchset Bundle; follow its next link for the next page. total is set when the integration reports a total.
  • _lastUpdated: resources updated at or after a time, with the ge prefix only (for example _lastUpdated=ge2024-01-01T00:00:00Z).
  • _id: one resource by ID, as a Bundle with that resource or an empty Bundle.
  • patient or subject: one patient, as Patient/{id} or {id}, on Encounter, Observation, Condition, AllergyIntolerance, MedicationRequest, Immunization and DiagnosticReport.
  • category on Observation: an observation category code such as vital-signs or laboratory, optionally as system|code.

A search parameter the API recognizes but can't serve as asked returns an OperationOutcome with status 400, rather than different results: another _lastUpdated prefix, several values for one parameter, or a modifier such as :missing. Other parameters are ignored and left out of the Bundle's self link, as FHIR allows; send Prefer: handling=strict to get a 400 for them instead.

How complete is the data?

Resources are built from the Healthcare objects, so they carry the data those objects carry:

  • They're valid FHIR R4 base resources, filled the way US Core expects where the data exists (US Core race and ethnicity extensions, condition categories, identifier types). They don't declare US Core profiles.
  • A DiagnosticReport links its results (result), patient (subject) and responsible practitioners (performer) as references, so a client can read the report and then each Observation, Patient and Practitioner it points to.
  • An element FHIR requires that the integration doesn't provide is sent with the data-absent-reason extension instead of a guessed value. For example, MedicationRequest intent is always sent this way.
  • For integrations that use FHIR themselves, extensions and codings the Healthcare objects don't carry aren't passed through. Use the Passthrough API to get the integration's own resources unchanged.

Does the FHIR API send webhooks?

No. The FHIR API doesn't send webhooks. To find out when records change, subscribe to Healthcare webhooks on supported integrations.

Limits

  • Read-only: search and read. Create, update and delete aren't available through the FHIR API.
  • SMART on FHIR authorization isn't available yet; authenticate with a Unified.to API key.
  • Unified.to keeps no customer records at rest; connection credentials and operational metadata are encrypted at rest.

See also

Are we missing anything? Let us know
Was this page helpful?