Licensed to be used in conjunction with basebox, only.
// integration
ISiK FHIR
Applies to
Product: Cloud · Server · Audience: Administrator
The ISiK FHIR connector lets the basebox assistant search patients in the hospital information system and read their documents, encounters and treatment history. It uses the ISiK interface (FHIR R4) that every hospital information system in Germany must offer, and changes nothing. This is health data: enable the connector only in apps whose users may see it.
What does the connector do?
Beta
The connector is work in progress. Only organisations with beta features switched on see it.
This and the following sections are generated from the information the connector's image carries. What applies to every connector is described under What applies to every connector.
In the catalog it describes itself as:
Look up patients, their clinical documents and their treatment history in the hospital information system through its ISiK FHIR interface, which every German hospital system must offer.
It gives the assistant these instructions:
Reads patient data from the hospital information system over its ISiK FHIR API. Find the patient with
search_patientsfirst; the other tools take that patient's FHIRid. If a search matches several patients, ask the user which one is meant rather than picking one. This is personal health data: use it only for the user's request.
Settings
The administrator fills in these fields in the connector's settings. They apply to the whole organisation.
| Field | Required | Meaning |
|---|---|---|
| FHIR base URL | yes | The base URL of the hospital information system's ISiK FHIR R4 API, the address below which /Patient and /metadata are found. Example: https://kis.example.org/fhir |
| Help link for signing in | no | Where users can read how to sign in or get their access token, e.g. a page on your intranet. |
Sign-in
The administrator decides how the connector signs in: with Personal sign-in each person signs in with their own account and sees only what they may. With Company account everyone uses one account the administrator enters.
Personal sign-in
- FHIR access token – asks for a token. The OAuth2 access token issued to you for the hospital's FHIR API.
- Username and password – asks for a username and password. Your user name and password for the hospital's FHIR API.
Company account
- Service account's FHIR access token – asks for a token. The OAuth2 access token issued to a dedicated client of the hospital's FHIR API.
- Service account's username and password – asks for a username and password. A dedicated account for the hospital's FHIR API, entitled to the patients every basebox user may see.
A company account gives everyone the same rights
Every basebox user reaches the system with the rights of this one account. Results are not trimmed to what each person may see.
The connector adds:
Every basebox user will see the patients that one token may see. Patient data is subject to medical confidentiality; share a token only if every basebox user is entitled to that access.
Tools
The assistant can call 7 tools.
| Tool | Effect | Description |
|---|---|---|
get_encounter |
reads | Read one encounter — an inpatient stay, outpatient visit or other contact — from the hospital information system by its FHIR id, e.g. to resolve the Encounter/<id> reference of a document, diagnosis or procedure. Returns the FHIR R4 Encounter as JSON: status, class (inpatient, outpatient, …), type, serviceType (the department), period with admission and discharge, hospitalization (admission source and discharge disposition), diagnosis with Condition/<id> references and their use and rank, location, serviceProvider, partOf for a contact within a larger stay, and subject, the patient. |
get_next_page |
reads | Fetch the next page of a FHIR searchset Bundle returned by a patient, encounter, document or treatment-history search of the hospital information system. Takes the url of the Bundle link whose relation is next. Returns the next FHIR R4 searchset Bundle as JSON, with the same kind of entries as the first page and its own next link while more remain. |
get_treatment_history |
reads | Read the treatment history of one patient in the hospital information system. Returns a JSON object with three FHIR R4 searchset Bundles: encounters (stays and visits with status, class, type, period, serviceType and diagnosis references), conditions (diagnoses with ICD-10-GM code, clinicalStatus, recordedDate and encounter) and procedures (with OPS code, status, performed[x] and encounter). Entries refer to each other as Encounter/<id>, Condition/<id>. Takes the patient's FHIR id from a patient search. Each Bundle pages on its own: a link with relation next in one of them means more entries of that kind exist, and its url fetches them with the next-page tool. |
read_document |
reads | Read the text of one clinical document from the hospital information system, such as a discharge letter or findings report, by the id of its DocumentReference from the document search. Returns a line naming the document, its media type and which characters of how many are shown, followed by the text. Long documents are returned in parts: when that line says the text continues at an offset, call again with that offset. Reads PDFs, office documents, HTML, e-mails, JSON and XML including FHIR documents, and other text; scans and images are read through OCR where the server has it. |
search_documents |
reads | Search the clinical documents in the hospital information system — discharge letters, findings, reports and similar — of one patient, of one encounter, or by the document's identifier; at least one of these is required. Narrow the search by status, type (KDL or IHE type code), class (IHE class code) and creation date; several criteria combine with AND. Returns the FHIR R4 searchset Bundle as JSON: each entry's resource is a DocumentReference with the document's type and category codes and display names, status, date, description, the context.encounter it belongs to, and content[].attachment with its MIME type, title, creation date and the url of the document itself. Read a document's text with the read-document tool and the DocumentReference's id. A link with relation next means more documents exist; its url fetches them with the next-page tool. |
search_encounters |
reads | Search the encounters — inpatient stays, outpatient visits and other contacts — in the hospital information system, of one patient or by the encounter's identifier such as the admission number; at least one of these is required. Narrow the search by status, class (inpatient, outpatient, …), type (kind of contact, or whole stay vs. department vs. ward) and the dates it took place; several criteria combine with AND. Returns the FHIR R4 searchset Bundle as JSON: each entry's resource is an Encounter with status, class, type, serviceType (the department), period with admission and discharge, diagnosis with Condition/<id> references, location, and partOf for a contact within a larger stay. Use an Encounter's id to search the documents belonging to it. A link with relation next means more encounters exist; its url fetches them with the next-page tool. |
search_patients |
reads | Search the patients of the hospital information system by name, birth date or an identifier such as the patient number or health insurance number (KVNR). At least one criterion is required; several combine with AND. Returns the FHIR R4 searchset Bundle as JSON: each entry's resource is an ISiKPatient with its id, identifiers, name, gender, birthDate and address. Use the id to fetch the patient's documents or treatment history. total, if present, is the number of matches; a link with relation next means more matches exist than were returned, and its url fetches them with the next-page tool. |
Generated from mcp-isik-fhir:v0.1.1.