Skip to main content

Task

A task to be performed.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

InteractionMethodPath
ReadGET/fhir/R4/Task/[id]
VreadGET/fhir/R4/Task/[id]/_history/[vid]
UpdatePUT/fhir/R4/Task/[id]
PatchPATCH/fhir/R4/Task/[id]
DeleteDELETE/fhir/R4/Task/[id]
CreatePOST/fhir/R4/Task
SearchGET/fhir/R4/Task
HistoryGET/fhir/R4/Task/[id]/_history

Top-level elements​

ElementTypeCardinalityDescription
idstring0..1Logical id of this artifact
metaMeta0..1Metadata about the resource
implicitRulesuri0..1A set of rules under which this content was created
languagecode0..1Language of the resource content
textNarrative0..1Text summary of the resource, for human interpretation
containedResource0..*Contained, inline Resources
extensionExtension0..*Additional content defined by implementations
modifierExtensionExtension0..*Extensions that cannot be ignored
identifierIdentifier0..*Task Instance Identifier
instantiatesCanonicalcanonical0..1Formal definition of task
instantiatesUriuri0..1Formal definition of task
basedOnReference0..*Request fulfilled by this task
groupIdentifierIdentifier0..1Requisition or grouper id
partOfReference0..*Composite task
statuscode1..1draft | requested | received | accepted | +
statusReasonCodeableConcept0..1Reason for current status
businessStatusCodeableConcept0..1E.g. "Specimen collected", "IV prepped"
intentcode1..1unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
prioritycode0..1routine | urgent | asap | stat
codeCodeableConcept0..1Task Type
descriptionstring0..1Human-readable explanation of task
focusReference0..1What task is acting on
forReference0..1Beneficiary of the Task
encounterReference0..1Healthcare event during which this task originated
executionPeriodPeriod0..1Start and end time of execution
authoredOndateTime0..1Task Creation Date
lastModifieddateTime0..1Task Last Modified Date
requesterReference0..1Who is asking for task to be done
performerTypeCodeableConcept0..*Requested performer
ownerReference0..1Responsible individual
locationReference0..1Where task occurs
reasonCodeCodeableConcept0..1Why task is needed
reasonReferenceReference0..1Why task is needed
insuranceReference0..*Associated insurance coverage
noteAnnotation0..*Comments made about the task
relevantHistoryReference0..*Key events in history of the Task
restrictionBackboneElement0..1Constraints on fulfillment tasks
inputBackboneElement0..*Information used to perform task
outputBackboneElement0..*Information produced as part of task

Resource-specific search parameters​

ParameterTypeDescription
authored-ondateSearch by creation date
based-onreferenceSearch by requests this task is based on
business-statustokenSearch by business status
codetokenSearch by task code
encounterreferenceSearch by encounter
focusreferenceSearch by task focus
group-identifiertokenSearch by group identifier
identifiertokenSearch for a task instance by its business identifier
intenttokenSearch by task intent
modifieddateSearch by last modification date
ownerreferenceSearch by task owner
part-ofreferenceSearch by task this task is part of
patientreferenceSearch by patient
performertokenSearch by recommended type of performer (e.g., Requester, Performer, Scheduler).
perioddateSearch by period Task is/was underway
prioritytokenSearch by task priority
requesterreferenceSearch by task requester
statustokenSearch by task status
subjectreferenceSearch by subject

Reference​

Official FHIR R4 spec: Task.
Maturity: Trial Use 2 (FMM 2).