Task Resource
Task is a FHIR resource that is part of the Workflow Module. Task is used to represent an activity that is to be performed,and track the completion of said activity.
A number of different communication patterns use the Task resource, including the placing and fulfilling laboratory orders..
The OpenMRS data model does not contain a natural mapping of this concept support. In order to support workflows requiring Task, the OpenMRS FHIR module extends the data model with a representation of the Task resource that is stored in the fhir_task table.
Supported Elements
Task.id - The logical identifier of the Task resource
Task.status - The current status of the Task, represented using states from this state machine. The OpenMRS implementation supports requested, accepted, rejected, and completed states.
Task.intent - Represents the actionability of the Task. The current OpenMRS implementation supports only the order value for this element.
Task.basedOn - A reference to the ServiceRequest resource that represents the order that caused the creation of this Task.
Task.encounter - The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created
Task.for - The entity who benefits from the performance of the service specified in the task (e.g., the patient).
Task.owner - Individual organization or Device currently responsible for task execution.
Task.input- Information needed for performing the Task.
Task.output - Information produced by performing the Task.
OpenMRS Data Model Support
FhirTaskInput ↔ https://www.hl7.org/fhir/task-definitions.html#Task.input
FhirTaskOutput ↔ https://www.hl7.org/fhir/task-definitions.html#Task.output
FhirTaskReference ↔ https://www.hl7.org/fhir/references.html#Reference
OpenMRS ↔ FHIR Mappings
OpenMRS Data Model | FHIR Resource Element |
---|---|
FhirTask.id | Task.id |
FhirTask.status | Task.status |
FhirTask.intent | Task.intent |
FhirTask.basedOn Collection<FhirReference> | Task.basedOn List<Reference> |
FhirTask.encounter FhirReference | Task.encounter Reference |
FhirTask.for FhirReference | Task.for Reference |
FhirTask.owner FhirReference | Task.owner Reference |
FhirTask.input Collection<FhirTaskInput> | Task.input List<ParameterComponent> |
FhirTask.output Collection<FhirTaskOutput> | Task.output List<TaskOutputComponent> |
FhirTask.dateCreated | Task.authoredOn |
FhirTask.dateChanged | Task.lastModified |
Task.status State Machine
Supported States: REQUESTED, REJECTED, ACCEPTED, COMPLETED
Targeted OpenMRS Use Cases
Available RESTful Endpoints
Note: placeholder "{release}" below must be replaced by the FHIR Release - currently "R3" and "R4" are implemented. See more on the FHIR Release support page.
Method | URL | Description |
---|---|---|
GET | /ws/fhir2/{release}/Task/{uuid} | |
POST | /ws/fhir2/{release}/Task | |
PUT | /ws/fhir2/{release}/Task/{uuid} |
Available Search Parameters
Parameter | Value Type | Example |
---|---|---|
based-on | reference | |
owner | reference | |
status | token | requested |