Skip to main content

Task

Trial Use 2 Workflow

A task to be performed.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Task
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​

ElementType(s)CardinalityDescription
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 | + modifier
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
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
authored-onstringhttp://hl7.org/fhir/SearchParameter/Task-authored-on
based-onstringhttp://hl7.org/fhir/SearchParameter/Task-based-on
business-statusstringhttp://hl7.org/fhir/SearchParameter/Task-business-status
codestringhttp://hl7.org/fhir/SearchParameter/Task-code
due-datestringhttps://medplum.com/fhir/SearchParameter/Task-due-date
encounterstringhttp://hl7.org/fhir/SearchParameter/Task-encounter
focusstringhttp://hl7.org/fhir/SearchParameter/Task-focus
group-identifierstringhttp://hl7.org/fhir/SearchParameter/Task-group-identifier
identifierstringhttp://hl7.org/fhir/SearchParameter/Task-identifier
intentstringhttp://hl7.org/fhir/SearchParameter/Task-intent
modifiedstringhttp://hl7.org/fhir/SearchParameter/Task-modified
ownerstringhttp://hl7.org/fhir/SearchParameter/Task-owner
part-ofstringhttp://hl7.org/fhir/SearchParameter/Task-part-of
patientstringhttp://hl7.org/fhir/SearchParameter/Task-patient
performerstringhttp://hl7.org/fhir/SearchParameter/Task-performer
periodstringhttp://hl7.org/fhir/SearchParameter/Task-period
prioritystringhttp://hl7.org/fhir/SearchParameter/Task-priority
priority-orderstringhttps://medplum.com/fhir/SearchParameter/priority-order
requesterstringhttp://hl7.org/fhir/SearchParameter/Task-requester
statusstringhttp://hl7.org/fhir/SearchParameter/Task-status
subjectstringhttp://hl7.org/fhir/SearchParameter/Task-subject

Reference​

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