tasks

Create Task

post
/organizations/{organizationId}/fhir/3/Task

A task to be performed.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringTaskThis is a Task resource
identifierarray(Identifier)The business identifier for this task.
definitionUristringA reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
definitionReferenceReferenceA reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
basedOnarray(Reference)BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
groupIdentifierIdentifierAn identifier that links together multiple tasks and other requests that were created in the same context.
partOfarray(Reference)Task that this particular task is part of.
statusstringdraft|requested|received|accepted|rejected|ready|cancelled|in-progress|on-hold|failed|completed|entered-in-errorThe current status of the task.
statusReasonCodeableConceptAn explanation as to why this task is held, failed, was refused, etc.
businessStatusCodeableConceptContains business-specific nuances of the business state.
intentstringIndicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
prioritystringIndicates how quickly the Task should be addressed with respect to other requests.
codeCodeableConceptA name or code (or both) briefly describing what the task involves.
descriptionstringA free-text description of what is to be performed.
focusReferenceThe request being actioned or the resource being manipulated by this task.
forReferenceThe entity who benefits from the performance of the service specified in the task (e.g., the patient).
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
executionPeriodPeriodIdentifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
authoredOnstringThe date and time this task was created.
lastModifiedstringThe date and time of last modification to this task.
requesterTask_RequesterThe creator of the task.
performerTypearray(CodeableConcept)The type of participant that can execute the task.
ownerReferenceIndividual organization or Device currently responsible for task execution.
reasonCodeableConceptA description or code indicating why this task needs to be performed.
notearray(Annotation)Free-text information captured about the task as it progresses.
relevantHistoryarray(Reference)Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
restrictionTask_RestrictionIf the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
inputarray(Task_Input)Additional information that may be needed in the execution of the task.
outputarray(Task_Output)Outputs produced by the Task.

Response

Patch Task

patch
/organizations/{organizationId}/fhir/3/Task/{resourceId}

A task to be performed.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringTaskThis is a Task resource
identifierarray(Identifier)The business identifier for this task.
definitionUristringA reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
definitionReferenceReferenceA reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
basedOnarray(Reference)BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
groupIdentifierIdentifierAn identifier that links together multiple tasks and other requests that were created in the same context.
partOfarray(Reference)Task that this particular task is part of.
statusstringdraft|requested|received|accepted|rejected|ready|cancelled|in-progress|on-hold|failed|completed|entered-in-errorThe current status of the task.
statusReasonCodeableConceptAn explanation as to why this task is held, failed, was refused, etc.
businessStatusCodeableConceptContains business-specific nuances of the business state.
intentstringIndicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
prioritystringIndicates how quickly the Task should be addressed with respect to other requests.
codeCodeableConceptA name or code (or both) briefly describing what the task involves.
descriptionstringA free-text description of what is to be performed.
focusReferenceThe request being actioned or the resource being manipulated by this task.
forReferenceThe entity who benefits from the performance of the service specified in the task (e.g., the patient).
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
executionPeriodPeriodIdentifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
authoredOnstringThe date and time this task was created.
lastModifiedstringThe date and time of last modification to this task.
requesterTask_RequesterThe creator of the task.
performerTypearray(CodeableConcept)The type of participant that can execute the task.
ownerReferenceIndividual organization or Device currently responsible for task execution.
reasonCodeableConceptA description or code indicating why this task needs to be performed.
notearray(Annotation)Free-text information captured about the task as it progresses.
relevantHistoryarray(Reference)Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
restrictionTask_RestrictionIf the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
inputarray(Task_Input)Additional information that may be needed in the execution of the task.
outputarray(Task_Output)Outputs produced by the Task.

Response

Read Task

get
/organizations/{organizationId}/fhir/3/Task/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Task

get
/organizations/{organizationId}/fhir/3/Task/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Task

get
/organizations/{organizationId}/fhir/3/Task/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Task

delete
/organizations/{organizationId}/fhir/3/Task/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Task

get
/organizations/{organizationId}/fhir/3/Task

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authored-onstring
based-onstring
business-statusstring
codestring
contextstring
focusstring
group-identifierstring
identifierstring
intentstring
modifiedstring
organizationstring
ownerstring
part-ofstring
patientstring
performerstring
periodstring
pertains-tostring
prioritystring
reason-codestring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Task

get
/organizations/{organizationId}/fhir/3/Task/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Task

post
/organizations/{organizationId}/fhir/3/Task/_search

A task to be performed.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authored-onstring
based-onstring
business-statusstring
codestring
contextstring
focusstring
group-identifierstring
identifierstring
intentstring
modifiedstring
organizationstring
ownerstring
part-ofstring
patientstring
performerstring
periodstring
pertains-tostring
prioritystring
reason-codestring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringTaskThis is a Task resource
identifierarray(Identifier)The business identifier for this task.
definitionUristringA reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
definitionReferenceReferenceA reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
basedOnarray(Reference)BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
groupIdentifierIdentifierAn identifier that links together multiple tasks and other requests that were created in the same context.
partOfarray(Reference)Task that this particular task is part of.
statusstringdraft|requested|received|accepted|rejected|ready|cancelled|in-progress|on-hold|failed|completed|entered-in-errorThe current status of the task.
statusReasonCodeableConceptAn explanation as to why this task is held, failed, was refused, etc.
businessStatusCodeableConceptContains business-specific nuances of the business state.
intentstringIndicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
prioritystringIndicates how quickly the Task should be addressed with respect to other requests.
codeCodeableConceptA name or code (or both) briefly describing what the task involves.
descriptionstringA free-text description of what is to be performed.
focusReferenceThe request being actioned or the resource being manipulated by this task.
forReferenceThe entity who benefits from the performance of the service specified in the task (e.g., the patient).
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
executionPeriodPeriodIdentifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
authoredOnstringThe date and time this task was created.
lastModifiedstringThe date and time of last modification to this task.
requesterTask_RequesterThe creator of the task.
performerTypearray(CodeableConcept)The type of participant that can execute the task.
ownerReferenceIndividual organization or Device currently responsible for task execution.
reasonCodeableConceptA description or code indicating why this task needs to be performed.
notearray(Annotation)Free-text information captured about the task as it progresses.
relevantHistoryarray(Reference)Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
restrictionTask_RestrictionIf the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
inputarray(Task_Input)Additional information that may be needed in the execution of the task.
outputarray(Task_Output)Outputs produced by the Task.

Response

Update Task

put
/organizations/{organizationId}/fhir/3/Task/{resourceId}

A task to be performed.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringTaskThis is a Task resource
identifierarray(Identifier)The business identifier for this task.
definitionUristringA reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
definitionReferenceReferenceA reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
basedOnarray(Reference)BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
groupIdentifierIdentifierAn identifier that links together multiple tasks and other requests that were created in the same context.
partOfarray(Reference)Task that this particular task is part of.
statusstringdraft|requested|received|accepted|rejected|ready|cancelled|in-progress|on-hold|failed|completed|entered-in-errorThe current status of the task.
statusReasonCodeableConceptAn explanation as to why this task is held, failed, was refused, etc.
businessStatusCodeableConceptContains business-specific nuances of the business state.
intentstringIndicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
prioritystringIndicates how quickly the Task should be addressed with respect to other requests.
codeCodeableConceptA name or code (or both) briefly describing what the task involves.
descriptionstringA free-text description of what is to be performed.
focusReferenceThe request being actioned or the resource being manipulated by this task.
forReferenceThe entity who benefits from the performance of the service specified in the task (e.g., the patient).
contextReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
executionPeriodPeriodIdentifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
authoredOnstringThe date and time this task was created.
lastModifiedstringThe date and time of last modification to this task.
requesterTask_RequesterThe creator of the task.
performerTypearray(CodeableConcept)The type of participant that can execute the task.
ownerReferenceIndividual organization or Device currently responsible for task execution.
reasonCodeableConceptA description or code indicating why this task needs to be performed.
notearray(Annotation)Free-text information captured about the task as it progresses.
relevantHistoryarray(Reference)Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
restrictionTask_RestrictionIf the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
inputarray(Task_Input)Additional information that may be needed in the execution of the task.
outputarray(Task_Output)Outputs produced by the Task.

Response