Task
The Task resource represents chores and planned work connected to a patient in Open Aidn.
Open Aidn currently exposes selected fields from the base HL7 FHIR R4 Task resource. A formal Aidn profile may be published later.
Standards and profiles
- HL7 FHIR R4: Task
- HL7 FHIR R4 search: FHIR search
Endpoints
| Method | Path | Required scope | Description |
|---|---|---|---|
POST |
/Task/_search |
task.search |
Search using application/x-www-form-urlencoded body parameters. |
GET |
/Task/{id} |
task.read |
Read one Task by ID. |
Search responses are returned as FHIR Bundle resources with type set to searchset.
Search parameters
| Parameter | Type | Description |
|---|---|---|
patient.Identifier |
identifier | Patient identifier used to filter tasks for one patient. |
_include |
token, repeatable | Adds supported referenced resources to the response bundle. |
patient.Identifier is required for search.
Supported includes
_include value |
Included resource | Description |
|---|---|---|
Task:for |
Patient |
Adds referenced patient resources. |
Task:requester |
Practitioner |
Adds referenced requester resources. |
Task:encounter |
Encounter |
Adds referenced encounter resources. |
Response fields
Open Aidn may expand the response over time, but integrations should currently expect data in these fields:
| Field | Description |
|---|---|
id |
Task identifier. |
meta.lastUpdated |
Last update timestamp when available. |
basedOn |
CarePlan reference when the task is owned by a plan element. |
groupIdentifier |
Identifier for the task definition. |
status |
FHIR Task status, such as requested, completed, or cancelled. |
intent |
Task intent. Currently order. |
code |
Task code and effective task name. |
description |
Task description when available. |
for.reference |
Reference to the patient. |
encounter.reference |
Reference to an encounter when available. |
requester.reference |
Reference to the requester practitioner. |
authoredOn |
Time the task was authored. |
lastModified |
Last modification time. |
extension:requestedPeriod |
Requested period for the task. |
Example search
POST /Task/_search HTTP/1.1
Host: <OPEN_AIDN_FHIR_HOST>
Accept: application/fhir+json
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS_TOKEN>
patient.Identifier=<PATIENT_IDENTIFIER>&_include=Task:encounterThe response is a FHIR search bundle with matching Task resources and any requested includes.