Task

The Task resource represents care tasks and planned work associated with a patient in Open Aidn.

Open Aidn supports selected fields from the base HL7 FHIR R4 Task resource. A formal Aidn profile may be published later.

Standards and profiles

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 results are returned in a FHIR Bundle with type set to searchset.

Search parameters

Parameter Type Description
patient.Identifier identifier Patient identifier used to filter Task resources for one patient.
_include token, repeatable Adds supported referenced resources to the response Bundle.

patient.Identifier is required for search.

Supported included resources

_include value Included resource Description
Task:for Patient Adds referenced patient resources.
Task:requester Practitioner Adds referenced resources for the requester.
Task:encounter Encounter Adds referenced encounter resources.

Response fields

Open Aidn may add fields over time. Integrations should expect the following fields to be available:

Field Description
id Task identifier.
meta.lastUpdated Last update timestamp when available.
basedOn Reference to a CarePlan when the task is part of a plan.
groupIdentifier Identifier for the task definition.
status FHIR Task status, such as requested, completed, or cancelled.
intent Task intent. It’s set to order.
code Task code and 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 created.
lastModified Last modification time.
extension:requestedPeriod Requested period for the task. 
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:encounter

The response is a FHIR Bundle containing matching Task resources and any requested included resources.

Back to home