tasks

Create Task

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

A task to be performed.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Task resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)The business identifier for this task.
instantiatesCanonicalcanonicalThe URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
instantiatesUriuriThe URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
basedOnarray(Reference)BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill 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.
statusdraft|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.
intentunknown|proposal|plan|order|original-order|reflex-order|filler-order|instance-order|optionIndicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
prioritycodeIndicates 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).
encounterReferenceThe 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).
authoredOndateTimeThe date and time this task was created.
lastModifieddateTimeThe date and time of last modification to this task.
requesterReferenceThe creator of the task.
performerTypearray(CodeableConcept)The kind of participant that should perform the task.
ownerReferenceIndividual organization or Device currently responsible for task execution.
locationReferencePrincipal physical location where the this task is performed.
reasonCodeCodeableConceptA description or code indicating why this task needs to be performed.
reasonReferenceReferenceA resource reference indicating why this task needs to be performed.
insurancearray(Reference)Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
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/4/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*This is a Task resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)The business identifier for this task.
instantiatesCanonicalcanonicalThe URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
instantiatesUriuriThe URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
basedOnarray(Reference)BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill 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.
statusdraft|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.
intentunknown|proposal|plan|order|original-order|reflex-order|filler-order|instance-order|optionIndicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
prioritycodeIndicates 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).
encounterReferenceThe 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).
authoredOndateTimeThe date and time this task was created.
lastModifieddateTimeThe date and time of last modification to this task.
requesterReferenceThe creator of the task.
performerTypearray(CodeableConcept)The kind of participant that should perform the task.
ownerReferenceIndividual organization or Device currently responsible for task execution.
locationReferencePrincipal physical location where the this task is performed.
reasonCodeCodeableConceptA description or code indicating why this task needs to be performed.
reasonReferenceReferenceA resource reference indicating why this task needs to be performed.
insurancearray(Reference)Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
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/4/Task/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Task

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Task/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Task

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Task

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

Request

Headers

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

Query params

_idstring
_languagestring
authored-onstring
based-onstring
business-statusstring
codestring
encounterstring
focusstring
group-identifierstring
identifierstring
intentstring
modifiedstring
ownerstring
part-ofstring
patientstring
performerstring
periodstring
prioritystring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Response

Search History Task

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/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
encounterstring
focusstring
group-identifierstring
identifierstring
intentstring
modifiedstring
ownerstring
part-ofstring
patientstring
performerstring
periodstring
prioritystring
requesterstring
statusstring
subjectstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Task resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)The business identifier for this task.
instantiatesCanonicalcanonicalThe URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
instantiatesUriuriThe URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
basedOnarray(Reference)BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill 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.
statusdraft|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.
intentunknown|proposal|plan|order|original-order|reflex-order|filler-order|instance-order|optionIndicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
prioritycodeIndicates 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).
encounterReferenceThe 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).
authoredOndateTimeThe date and time this task was created.
lastModifieddateTimeThe date and time of last modification to this task.
requesterReferenceThe creator of the task.
performerTypearray(CodeableConcept)The kind of participant that should perform the task.
ownerReferenceIndividual organization or Device currently responsible for task execution.
locationReferencePrincipal physical location where the this task is performed.
reasonCodeCodeableConceptA description or code indicating why this task needs to be performed.
reasonReferenceReferenceA resource reference indicating why this task needs to be performed.
insurancearray(Reference)Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
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/4/Task/{resourceId}

A task to be performed.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Task resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)The business identifier for this task.
instantiatesCanonicalcanonicalThe URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
instantiatesUriuriThe URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
basedOnarray(Reference)BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill 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.
statusdraft|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.
intentunknown|proposal|plan|order|original-order|reflex-order|filler-order|instance-order|optionIndicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
prioritycodeIndicates 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).
encounterReferenceThe 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).
authoredOndateTimeThe date and time this task was created.
lastModifieddateTimeThe date and time of last modification to this task.
requesterReferenceThe creator of the task.
performerTypearray(CodeableConcept)The kind of participant that should perform the task.
ownerReferenceIndividual organization or Device currently responsible for task execution.
locationReferencePrincipal physical location where the this task is performed.
reasonCodeCodeableConceptA description or code indicating why this task needs to be performed.
reasonReferenceReferenceA resource reference indicating why this task needs to be performed.
insurancearray(Reference)Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
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