Skip to main content

Assessment Overview Applet

The Assessment Overview Applet provides a configurable interface for managing various clinical assessment workflows. This page documents the FHIR resources and their relationships used to implement assessment processes.

The applet supports different assessment types through dynamic configuration, allowing healthcare facilities to customize it for their specific workflows.

Supported Assessment Types

The Assessment Overview Applet supports various clinical assessment workflows through dynamic configuration. The following table shows examples of assessment types that can be configured:

Assessment TypeSystemCodeDisplay
Pre-Anesthesia Assessmenthttp://snomed.info/sct182770003Pre-anaesthetic assessment (procedure)
info

This list is not exhaustive. The applet can be configured to support additional assessment types based on your facility's specific workflows and requirements.

Resource Workflow

The following diagram shows how FHIR resources are connected in an assessment workflow:

Workflow explanation:

  1. A ServiceRequest for the assessment is created
  2. The assessment process generates Observations (relevant clinical data based on assessment type)
  3. A DiagnosticReport is created to summarize the assessment findings
  4. The report references the assessment ServiceRequest and includes all relevant observations

Assessment Overview Table

The overview table displays patients with pending or active assessments and their current status. The specific assessment type and displayed information depend on the configured workflow. The table columns map to FHIR resources as follows:

Patient Information

Displays patient name, gender, and date of birth.

Patient Demographics

💡Context
Basic patient identification displayed in the overview table. The name is typically shown in 'Family, Given' format.
📋FHIR Resource
Patient: Demographics and other administrative information about an individual receiving care or other health-related services.
UI FieldFHIR PathDescriptionData TypeRequiredExample
Patient NamePatient.nameA name associated with the patientHumanName[]No[ { "use": "official", "family": "Doe", "given": [ "John", "Robert" ] } ]
GenderPatient.genderAdministrative gendercodeNomale
Date of BirthPatient.birthDateThe date of birth for the individualdateNo1980-05-15
Common Usage: patient identification, display names, demographic data, clinical considerations, age calculation

Encounter Case ID

Unique identifier for the patient's hospital encounter/case.

Case Identifier

💡Context
The encounter identifier serves as the case number throughout the patient's hospital stay. Use the identifier with system matching your hospital's case management system.
📋FHIR Resource
Encounter: An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
UI FieldFHIR PathDescriptionData TypeRequiredExample
Case IDEncounter.identifierIdentifier(s) by which this encounter is knownIdentifier[]No[ { "use": "official", "system": "http://hospital.example.org/encounters", "value": "ENC-2024-001234" } ]
Common Usage: case identification, encounter tracking

Patient ID

Hospital-specific patient identifier (medical record number).

Patient Identifier

💡Context
Use the identifier with 'use: official' and your hospital's patient identifier system (e.g., 'http://hospital.example.org/patients').
📋FHIR Resource
Patient: Demographics and other administrative information about an individual receiving care or other health-related services.
UI FieldFHIR PathDescriptionData TypeRequiredExample
Patient IDPatient.identifierAn identifier for this patientIdentifier[]No[ { "use": "usual", "system": "http://hospital.example.org/patients", "value": "123456789" } ]
Common Usage: patient identification, medical record number

Assessment Status

Current state of the assessment request.

Assessment Request Status

💡Context
The ServiceRequest tracks the assessment workflow status. Use appropriate SNOMED CT or LOINC codes in the code field to identify the specific assessment type (e.g., SNOMED CT 182770003 for pre-anaesthetic assessment).
📋FHIR Resource
ServiceRequest: A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
UI FieldFHIR PathDescriptionData TypeRequiredExample
Assessment StatusServiceRequest.statusCurrent state of the service requestcodeYesactive
Service TypeServiceRequest.codeWhat is being requested/orderedCodeableConceptYes{ "text": "Appendectomy", "coding": [ { "system": "http://snomed.info/sct", "code": "80146002", "display": "Appendectomy" } ] }
Common Usage: workflow management, status tracking, surgery planning, procedure documentation, premedication

Status values and their meaning:

StatusUI Display
draftRequested
activeIn Progress
on-holdOn-hold
completedCompleted
revokedCancelled

Implementation Examples

The following examples demonstrate how to implement assessment workflows using FHIR resources. These examples use pre-anesthesia assessment as a reference case, but the same patterns apply to other assessment types.

Querying the Overview Table Data

To populate the assessment overview table, use a single FHIR query with _include parameters to fetch all related resources in one Bundle:

GET /ServiceRequest?code={assessment-code}&_include=ServiceRequest:encounter&_include:iterate=Encounter:subject

Query Parameters:

  • code - Filter by assessment type code(s), can be comma-separated for multiple types
  • _include=ServiceRequest:encounter - Include the referenced Encounter resources
  • _include:iterate=Encounter:subject - Include the Patient resources referenced by the Encounters

Optional Parameters:

  • subject:Patient.name:contains={searchString} - Filter by patient name (partial match)

This returns a Bundle containing all ServiceRequests matching the assessment code(s), along with their associated Encounters and Patients in a single response.

Creating an Assessment ServiceRequest

Example: Pre-Anesthesia Assessment

{
"resourceType": "ServiceRequest",
"status": "draft",
"intent": "order",
"code": {
"coding": [{
"system": "http://snomed.info/sct",
"code": "182770003",
"display": "Pre-anaesthetic assessment (procedure)"
}]
},
"subject": { "reference": "Patient/123456" },
"encounter": { "reference": "Encounter/ENC-2024-001234" },
"occurrenceDateTime": "2024-03-14T10:00:00Z"
}
tip

For other assessment types, use the appropriate SNOMED CT or LOINC code in the code.coding field to identify the specific assessment type.

Referenced Resources

FHIR resources used in assessment workflows:

  • Patient - Demographics and identification
  • Encounter - Case/episode management
  • ServiceRequest - Assessment requests and workflow tracking
  • DiagnosticReport - Assessment findings and conclusions
  • Observation - Detailed clinical data and measurements