Recare Search FHIR Implementation Guide
0.1.0 - ci-build Germany flag

Recare Search FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Home

Official URL: http://fhir.recareai.com/ImplementationGuide/de.recare.search Version: 0.1.0
Active as of 2026-04-15 Computable Name: RecareSearch

Recare Search FHIR Implementation Guide

This Implementation Guide (IG) defines the FHIR profiles, extensions, code systems, value sets, and naming systems used by the Recare API for search and care coordination workflows. It covers the FHIR representation of webhook event payloads exchanged between Recare and integrating systems.

Scope

This IG defines resources for the following Recare API domains:

  • Admissions API — webhook events triggered when a patient request is created or updated. Each event is delivered as a FHIR Bundle carrying a care request (ServiceRequest), patient data (encrypted), insurance coverage, and care provider organization.
  • Shared profiles — common FHIR profiles, identifiers, code systems, and terminology reused across API domains.

Webhook Event Types

Webhook events are identified by the Bundle.identifier.system, which references the RecareEventType code system. The following event types are defined:

Code Display
search_attributed Search Attributed
search_attribution_cancelled Search Attribution Cancelled
document_sent Document Sent
document_revoked Document Revoked

Key Profiles

Admissions API

Profile Base Resource Description
Recare Patient Request Event Bundle Top-level event bundle for patient care requests
Recare Patient Request ServiceRequest The care request itself, including care type, clinical details, and care provider
​Recare Admissions Care Provider Organization The receiving care provider organization
Recare Free Text Diagnosis Condition Free-text diagnosis associated with a request
Recare Guardian RelatedPerson Legal guardian acting as requester
Recare Decrypted Data Binary Decrypted patient data payload

Shared Profiles

Profile Base Resource Description
Recare Patient Patient Patient demographics
Recare Care Level Observation Nursing care level (Pflegegrad)
Recare Statutory Health Insurance Coverage GKV insurance coverage
Recare Private Health Insurance Coverage PKV insurance coverage
Recare Other Insurance Coverage Other insurance types
Recare Encrypted Data Binary Encrypted patient data
Recare Encrypted Secrets Binary Encryption key material

Getting Started

Use one of these two entry points, depending on how you prefer to learn the model:

  1. Start with key profiles
    • Begin with Recare Patient Request Event as the outer event Bundle.
    • Then review Recare Patient Request and the referenced shared resources (Patient, Coverage, Binary).
    • Use the profile differential and cardinalities to understand mandatory vs optional elements.
  2. Start with examples and event types
    • Open the example bundles in the Artifacts Index and inspect how resources are linked via entry.fullUrl and references.
    • Compare the bundle identifier (system/value) with the event types listed in the table above.
    • Follow the flow from the outer patient-request event bundle to the inner decrypted-data bundle to understand payload composition.

Dependencies

This IG depends on the following packages:

  • de.basisprofil.r4 1.6.0-ballot2 — German base profiles (KBV, gematik)
  • de.gematik.isik-basismodul 3.1.1 — ISiK base module
  • de.gematik.isik-dokumentenaustausch 3.1.1 — ISiK document exchange
  • de.gematik.isik-vitalparameter 3.1.1 — ISiK vital parameters
  • de.gematik.isip 1.0.2 — ISiP (Intersektorale Patientenversorgung)