Assessment Patient Search Applet
The Assessment Patient Search Applet provides an integrated workflow for finding patients and completing clinical assessment forms. Users can search for patients by demographic criteria or hospital case ID, select a patient from the results, and immediately open the corresponding assessment questionnaire in a dialog.
The applet is fully self-contained — it manages the patient search, result display, questionnaire loading, and form submission in one cohesive flow.
Configuration Overview
The applet is configured via the AssessmentAidboxConfig interface.
Properties Overview
| Property | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Title displayed in the assessment form dialog header |
questionnaireId | string | Yes | ID of the FHIR Questionnaire to render as the assessment form |
token | string | No | JWT token for Aidbox authentication |
sdcConfigId | string | No | SDC Config ID used for form rendering configuration |
hideFooter | boolean | No | Hides the footer of the rendered form |
hideLanguageSelector | boolean | No | Hides the language selector in the form |
theme | string | No | Theme identifier for the form renderer |
searchTitle | string | No | Custom title shown above the search form |
searchDescription | string | No | Custom description shown below the search form title |
searchCount | number | No | Maximum number of results returned per search (default: 250) |
Property Details
title
Type: string (required)
The title displayed in the dialog header when the assessment form is opened.
title: "Pre-Anesthesia Assessment"
questionnaireId
Type: string (required)
The unique ID of the FHIR Questionnaire resource to load and render as the assessment form. The applet fetches the questionnaire and any existing QuestionnaireResponse for the selected patient automatically.
questionnaireId: "patientenstammdaten"
sdcConfigId
Type: string (optional)
References an SDC (Structured Data Capture) configuration resource used to control how the questionnaire is rendered. Omit if no custom rendering configuration is needed.
searchTitle / searchDescription
Type: string (optional)
Custom text displayed above the search form. Useful for providing context-specific instructions to users.
searchTitle: "Find Patient",
searchDescription: "Search by name, date of birth, or hospital case ID to locate the patient."
Search Form
The search form allows users to filter patients by demographic data or hospital case ID. All fields are optional — submitting without criteria returns all available patients (up to 250 results).
Search Criteria
| Field | Type | Description |
|---|---|---|
firstName | string | Patient first name (partial match) |
lastName | string | Patient last name (partial match) |
birthDate | string | Date of birth — future dates are disabled |
caseId | string | Hospital case ID for direct encounter lookup |
If a Case ID is provided, the applet performs a direct encounter lookup and ignores the demographic fields. Otherwise, the demographic fields are used to search for matching patients, and then their encounters are fetched.
Search Behavior
Search by Case ID:
GET /Encounter?identifier={caseId}&_include=Encounter:subject
Search by Patient Criteria:
# Step 1 — Find matching patients
GET /Patient?given:contains={firstName}&family:contains={lastName}&birthdate={birthDate}&_count=250&_elements=id
# Step 2 — Fetch encounters for those patients
GET /Encounter?subject={patientIds}&_include=Encounter:subject&_count=250
The maximum number of returned results per search is controlled by searchCount (default: 250).
Results Table
After a successful search, matching patients are shown in a results table. Each row represents one encounter linked to a patient.
Displayed Data
| Column | Source | Description |
|---|---|---|
| Full Name | Patient.name | First and last name |
| Date of Birth | Patient.birthDate | Formatted as dd.MM.yyyy with calculated age in years |
| MRN | Patient.identifier (type MR) | Medical record number |
| Case ID | Encounter.identifier (use usual or official) | Hospital case identifier |
FHIR Mappings
Patient Demographics
Context
FHIR Resource
| UI Field | FHIR Path | Description | Data Type | Required | Example |
|---|---|---|---|---|---|
| Full Name | Patient | A name associated with the patient | HumanName[] | No | [
{
"use": "official",
"family": "Doe",
"given": [
"John",
"Robert"
]
}
] |
| Date of Birth | Patient | The date of birth for the individual | date | No | 1980-05-15 |
| MRN (type: MR) | Patient | An identifier for this patient | Identifier[] | No | [
{
"use": "usual",
"system": "http://hospital.example.org/patients",
"value": "123456789"
}
] |
Encounter Identifier
Context
FHIR Resource
| UI Field | FHIR Path | Description | Data Type | Required | Example |
|---|---|---|---|---|---|
| Case ID | Encounter | Identifier(s) by which this encounter is known | Identifier[] | No | [
{
"use": "official",
"system": "http://hospital.example.org/encounters",
"value": "ENC-2024-001234"
}
] |