This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Orders and Observations Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for task
{ "resourceType": "StructureDefinition", "id": "Task", "meta": { "lastUpdated": "2017-12-20T15:52:34.818+11:00" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "oo" } ], "url": "http://hl7.org/fhir/StructureDefinition/Task", "name": "Task", "status": "draft", "date": "2017-12-20T15:52:34+11:00", "publisher": "Health Level Seven International (Orders and Observations)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] }, { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/orders/index.cfm" } ] } ], "description": "A task to be performed.", "fhirVersion": "3.2.0", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping" } ], "kind": "resource", "abstract": false, "type": "Task", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource", "derivation": "specialization", "snapshot": { "element": [ { "id": "Task", "path": "Task", "short": "A task to be performed", "definition": "A task to be performed.", "min": 0, "max": "*", "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource" }, { "key": "dom-1", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "expression": "contained.text.empty()", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource" }, { "key": "dom-3", "severity": "error", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())", "xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))", "source": "DomainResource" }, { "key": "inv-1", "severity": "error", "human": "Last modified date must be greater than or equal to authored-on date.", "expression": "lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn", "xpath": "not(exists(f:lastModified/@value)) or not(exists(f:authoredOn/@value)) or f:lastModified/@value >= f:authoredOn/@value" } ], "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "workflow", "map": "Request, Event" }, { "identity": "rim", "map": "ControlAct[moodCode=INT]" }, { "identity": "w5", "map": "workflow.order" } ] }, { "id": "Task.id", "path": "Task.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "isSummary": true }, { "id": "Task.meta", "path": "Task.meta", "short": "Metadata about the resource", "definition": "The 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.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "isSummary": true }, { "id": "Task.implicitRules", "path": "Task.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "id": "Task.language", "path": "Task.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "extensible", "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } } }, { "id": "Task.text", "path": "Task.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may 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.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "id": "Task.contained", "path": "Task.contained", "short": "Contained, inline Resources", "definition": "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.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Task.extension", "path": "Task.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Task.modifierExtension", "path": "Task.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "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. Usually modifier elements provide negation or qualification. In order 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Task.identifier", "path": "Task.identifier", "short": "Task Instance Identifier", "definition": "The business identifier for this task.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "workflow", "map": "Request.identifier, Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "id": "Task.instantiates[x]", "path": "Task.instantiates[x]", "short": "Formal definition of task", "definition": "A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.", "requirements": "Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation) to be associated with a task, enabling automation.", "min": 0, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.instantiates, Event.instantiates" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "Task.basedOn", "path": "Task.basedOn", "short": "Request fulfilled by this task", "definition": "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 fulfil. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.basedOn, Event.basedOn" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target[moodCode=INT]" } ] }, { "id": "Task.groupIdentifier", "path": "Task.groupIdentifier", "short": "Requisition or grouper id", "definition": "An identifier that links together multiple tasks and other requests that were created in the same context.", "requirements": "Billing and/or reporting can be linked to whether multiple requests were created as a single unit.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.groupIdentifier" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=INT].id" } ] }, { "id": "Task.partOf", "path": "Task.partOf", "short": "Composite task", "definition": "Task that this particular task is part of.", "comment": "This should usually be 0..1.", "requirements": "Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Task" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=INT]" } ] }, { "id": "Task.status", "path": "Task.status", "short": "draft | requested | received | accepted | +", "definition": "The current status of the task.", "requirements": "These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskStatus" } ], "strength": "required", "description": "The current status of the task.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/task-status" } }, "mapping": [ { "identity": "workflow", "map": "Request.status, Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] }, { "id": "Task.statusReason", "path": "Task.statusReason", "short": "Reason for current status", "definition": "An explanation as to why this task is held, failed, was refused, etc.", "comment": "This applies to the current status. Look at the history of the task to see reasons for past statuses.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskStatusReason" } ], "strength": "example", "description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow." }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code=\"status change\"].reasonCode" } ] }, { "id": "Task.businessStatus", "path": "Task.businessStatus", "short": "E.g. \"Specimen collected\", \"IV prepped\"", "definition": "Contains business-specific nuances of the business state.", "requirements": "There's often a need to track substates of a task - this is often variable by specific workflow implementation.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskBusinessStatus" } ], "strength": "example", "description": "The domain-specific business-contextual sub-state of the task. For example: \"Blood drawn\", \"IV inserted\", \"Awaiting physician signature\", etc." }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"business status\"]" } ] }, { "id": "Task.intent", "path": "Task.intent", "short": "proposal | plan | order +", "definition": "Indicates the \"level\" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.", "comment": "This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.\n\nIn most cases, Tasks will have an intent of \"order\".", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskIntent" } ], "strength": "required", "description": "Distinguishes whether the task is a proposal, plan or full order", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-intent" } }, "mapping": [ { "identity": "workflow", "map": "Request.intent" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".moodCode" }, { "identity": "w5", "map": "class" } ] }, { "id": "Task.priority", "path": "Task.priority", "short": "normal | urgent | asap | stat", "definition": "Indicates how quickly the Task should be addressed with respect to other requests.", "requirements": "Used to identify the service level expected while performing a task.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this task should be performed with normal priority", "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskPriority" } ], "strength": "required", "description": "The task's priority", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "FiveWs.grade" }, { "identity": "rim", "map": ".priorityCode" }, { "identity": "w5", "map": "grade" } ] }, { "id": "Task.code", "path": "Task.code", "short": "Task Type", "definition": "A name or code (or both) briefly describing what the task involves.", "comment": "The title (eg \"My Tasks\", \"Outstanding Tasks for Patient X\") should go into the code.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskCode" } ], "strength": "example", "description": "Codes to identify what the task involves. These will typically be specific to a particular workflow." }, "mapping": [ { "identity": "workflow", "map": "Request.code, Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] }, { "id": "Task.description", "path": "Task.description", "short": "Human-readable explanation of task", "definition": "A free-text description of what is to be performed.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" } ] }, { "id": "Task.focus", "path": "Task.focus", "short": "What task is acting on", "definition": "The request being actioned or the resource being manipulated by this task.", "comment": "If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).", "requirements": "Used to identify the thing to be done.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=SUBJ].target" }, { "identity": "w5", "map": "what" } ] }, { "id": "Task.for", "path": "Task.for", "short": "Beneficiary of the Task", "definition": "The entity who benefits from the performance of the service specified in the task (e.g., the patient).", "requirements": "Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.", "alias": [ "Patient" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.subject, Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "rim", "map": ".participation[typeCode=RCT].role" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "Task.context", "path": "Task.context", "short": "Healthcare event during which this task originated", "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.", "requirements": "For some tasks it may be important to know the link between the task or episode of care the task originated within.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.context, Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] }, { "id": "Task.executionPeriod", "path": "Task.executionPeriod", "short": "Start and end time of execution", "definition": "Identifies 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).", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" } ] }, { "id": "Task.authoredOn", "path": "Task.authoredOn", "short": "Task Creation Date", "definition": "The date and time this task was created.", "requirements": "Most often used along with lastUpdated to track duration of task to supporting monitoring and management.", "alias": [ "Created Date" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "condition": [ "inv-1" ], "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "Task.lastModified", "path": "Task.lastModified", "short": "Task Last Modified Date", "definition": "The date and time of last modification to this task.", "requirements": "Used along with history to track task activity and time in a particular task state. This enables monitoring and management.", "alias": [ "Update Date" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "condition": [ "inv-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime" } ] }, { "id": "Task.requester", "path": "Task.requester", "short": "Who is asking for task to be done", "definition": "The creator of the task.", "requirements": "Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester" }, { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.author" } ] }, { "id": "Task.performerType", "path": "Task.performerType", "short": "requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer", "definition": "The type of participant that can execute the task.", "requirements": "Use to distinguish tasks on different activity queues.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskPerformerType" } ], "strength": "preferred", "description": "The type(s) of task performers allowed", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/task-performer-type" } }, "mapping": [ { "identity": "workflow", "map": "Event.performer.role, Request.performerType" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role.code" }, { "identity": "w5", "map": "who.actor" } ] }, { "id": "Task.owner", "path": "Task.owner", "short": "Responsible individual", "definition": "Individual organization or Device currently responsible for task execution.", "comment": "Tasks may be created with an owner not yet identified.", "requirements": "Identifies who is expected to perform this task.", "alias": [ "Performer", "Executer" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor, Request.performer" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role" }, { "identity": "w5", "map": "who.actor" } ] }, { "id": "Task.reasonCode", "path": "Task.reasonCode", "short": "Why task is needed", "definition": "A description or code indicating why this task needs to be performed.", "comment": "This should only be included if there is no focus or if it differs from the reason indicated on the focus.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskReason" } ], "strength": "example", "description": "Indicates why the task is needed. E.g. Suspended because patient admitted to hospital." }, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode, Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] }, { "id": "Task.reasonReference", "path": "Task.reasonReference", "short": "Why task is needed", "definition": "A resource reference indicating why this task needs to be performed.", "comment": "Task's might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Task.reasonCode` if the data is free (uncoded) text.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.reasonReference, Event.reasonReference" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] }, { "id": "Task.note", "path": "Task.note", "short": "Comments made about the task", "definition": "Free-text information captured about the task as it progresses.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "workflow", "map": "Request.note, Event.note" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value(string)" } ] }, { "id": "Task.relevantHistory", "path": "Task.relevantHistory", "short": "Key events in history of the Task", "definition": "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.", "comment": "This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.", "alias": [ "Status History" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance" } ], "mapping": [ { "identity": "workflow", "map": "Request.relevantHistory" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]" } ] }, { "id": "Task.restriction", "path": "Task.restriction", "short": "Constraints on fulfillment tasks", "definition": "If 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.", "requirements": "Sometimes when fulfillment is sought, you don't want full fulfillment.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "Instead of pointing to request, would point to component of request, having these characteristics" } ] }, { "id": "Task.restriction.id", "path": "Task.restriction.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Task.restriction.extension", "path": "Task.restriction.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Task.restriction.modifierExtension", "path": "Task.restriction.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Task.restriction.repetitions", "path": "Task.restriction.repetitions", "short": "How many times to repeat", "definition": "Indicates the number of times the requested action should occur.", "requirements": "E.g. order that requests monthly lab tests, fulfillment is sought for 1.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "rim", "map": ".repeatNumber" } ] }, { "id": "Task.restriction.period", "path": "Task.restriction.period", "short": "When fulfillment sought", "definition": "Over what time-period is fulfillment sought.", "comment": "Note that period.high is the due date representing the time by which the task should be completed.", "requirements": "E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime(IVL<TS>)" } ] }, { "id": "Task.restriction.recipient", "path": "Task.restriction.recipient", "short": "For whom is fulfillment sought?", "definition": "For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" } ] }, { "id": "Task.input", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Parameter" } ], "path": "Task.input", "short": "Information used to perform task", "definition": "Additional information that may be needed in the execution of the task.", "requirements": "Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.", "alias": [ "Supporting Information" ], "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.input.id", "path": "Task.input.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Task.input.extension", "path": "Task.input.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Task.input.modifierExtension", "path": "Task.input.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Task.input.type", "path": "Task.input.type", "short": "Label for the input", "definition": "A code or description indicating how the input is intended to be used as part of the task execution.", "comment": "If referencing a BPMN workflow or Protocol, the \"system\" is the URL for the workflow definition and the code is the \"name\" of the required input.", "requirements": "Inputs are named to enable task automation to bind data and pass it from one task to the next.", "alias": [ "Name" ], "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskInputParameterType" } ], "strength": "example", "description": "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Comparison source\", \"Applicable consent\", \"Concommitent Medications\", etc." }, "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.input.value[x]", "path": "Task.input.value[x]", "short": "Content to use in performing the task", "definition": "The value of the input parameter as a basic type.", "min": 1, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "Dosage" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Meta" } ], "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.output", "path": "Task.output", "short": "Information produced as part of task", "definition": "Outputs produced by the Task.", "requirements": "Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() | (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "Element" } ], "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.output.id", "path": "Task.output.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Task.output.extension", "path": "Task.output.extension", "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Task.output.modifierExtension", "path": "Task.output.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "Task.output.type", "path": "Task.output.type", "short": "Label for output", "definition": "The name of the Output parameter.", "requirements": "Outputs are named to enable task automation to bind data and pass it from one task to the next.", "alias": [ "Name" ], "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskOutputParameterType" } ], "strength": "example", "description": "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Identified issues\", \"Preliminary results\", \"Filler order\", \"Final results\", etc." }, "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.output.value[x]", "path": "Task.output.value[x]", "short": "Result of output", "definition": "The value of the Output parameter as a basic type.", "requirements": "Task outputs can take any form.", "min": 1, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "Dosage" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Meta" } ], "mapping": [ { "identity": "rim", "map": "???" } ] } ] }, "differential": { "element": [ { "id": "Task", "path": "Task", "short": "A task to be performed", "definition": "A task to be performed.", "min": 0, "max": "*", "constraint": [ { "key": "inv-1", "severity": "error", "human": "Last modified date must be greater than or equal to authored-on date.", "expression": "lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn", "xpath": "not(exists(f:lastModified/@value)) or not(exists(f:authoredOn/@value)) or f:lastModified/@value >= f:authoredOn/@value" } ], "mapping": [ { "identity": "workflow", "map": "Request, Event" }, { "identity": "rim", "map": "ControlAct[moodCode=INT]" }, { "identity": "w5", "map": "workflow.order" } ] }, { "id": "Task.identifier", "path": "Task.identifier", "short": "Task Instance Identifier", "definition": "The business identifier for this task.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "mapping": [ { "identity": "workflow", "map": "Request.identifier, Event.identifier" }, { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "rim", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "id": "Task.instantiates[x]", "path": "Task.instantiates[x]", "short": "Formal definition of task", "definition": "A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.", "requirements": "Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation) to be associated with a task, enabling automation.", "min": 0, "max": "1", "type": [ { "code": "uri" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.instantiates, Event.instantiates" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=DEFN].target" } ] }, { "id": "Task.basedOn", "path": "Task.basedOn", "short": "Request fulfilled by this task", "definition": "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 fulfil. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.basedOn, Event.basedOn" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=FLFS].target[moodCode=INT]" } ] }, { "id": "Task.groupIdentifier", "path": "Task.groupIdentifier", "short": "Requisition or grouper id", "definition": "An identifier that links together multiple tasks and other requests that were created in the same context.", "requirements": "Billing and/or reporting can be linked to whether multiple requests were created as a single unit.", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.groupIdentifier" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=INT].id" } ] }, { "id": "Task.partOf", "path": "Task.partOf", "short": "Composite task", "definition": "Task that this particular task is part of.", "comment": "This should usually be 0..1.", "requirements": "Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Task" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.partOf" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[moodCode=INT]" } ] }, { "id": "Task.status", "path": "Task.status", "short": "draft | requested | received | accepted | +", "definition": "The current status of the task.", "requirements": "These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskStatus" } ], "strength": "required", "description": "The current status of the task.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/task-status" } }, "mapping": [ { "identity": "workflow", "map": "Request.status, Event.status" }, { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": ".statusCode" }, { "identity": "w5", "map": "status" } ] }, { "id": "Task.statusReason", "path": "Task.statusReason", "short": "Reason for current status", "definition": "An explanation as to why this task is held, failed, was refused, etc.", "comment": "This applies to the current status. Look at the history of the task to see reasons for past statuses.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskStatusReason" } ], "strength": "example", "description": "Codes to identify the reason for current status. These will typically be specific to a particular workflow." }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code=\"status change\"].reasonCode" } ] }, { "id": "Task.businessStatus", "path": "Task.businessStatus", "short": "E.g. \"Specimen collected\", \"IV prepped\"", "definition": "Contains business-specific nuances of the business state.", "requirements": "There's often a need to track substates of a task - this is often variable by specific workflow implementation.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskBusinessStatus" } ], "strength": "example", "description": "The domain-specific business-contextual sub-state of the task. For example: \"Blood drawn\", \"IV inserted\", \"Awaiting physician signature\", etc." }, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"business status\"]" } ] }, { "id": "Task.intent", "path": "Task.intent", "short": "proposal | plan | order +", "definition": "Indicates the \"level\" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.", "comment": "This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.\n\nIn most cases, Tasks will have an intent of \"order\".", "min": 1, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskIntent" } ], "strength": "required", "description": "Distinguishes whether the task is a proposal, plan or full order", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-intent" } }, "mapping": [ { "identity": "workflow", "map": "Request.intent" }, { "identity": "w5", "map": "FiveWs.class" }, { "identity": "rim", "map": ".moodCode" }, { "identity": "w5", "map": "class" } ] }, { "id": "Task.priority", "path": "Task.priority", "short": "normal | urgent | asap | stat", "definition": "Indicates how quickly the Task should be addressed with respect to other requests.", "requirements": "Used to identify the service level expected while performing a task.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "meaningWhenMissing": "If missing, this task should be performed with normal priority", "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskPriority" } ], "strength": "required", "description": "The task's priority", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/request-priority" } }, "mapping": [ { "identity": "workflow", "map": "Request.priority" }, { "identity": "w5", "map": "FiveWs.grade" }, { "identity": "rim", "map": ".priorityCode" }, { "identity": "w5", "map": "grade" } ] }, { "id": "Task.code", "path": "Task.code", "short": "Task Type", "definition": "A name or code (or both) briefly describing what the task involves.", "comment": "The title (eg \"My Tasks\", \"Outstanding Tasks for Patient X\") should go into the code.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskCode" } ], "strength": "example", "description": "Codes to identify what the task involves. These will typically be specific to a particular workflow." }, "mapping": [ { "identity": "workflow", "map": "Request.code, Event.code" }, { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "rim", "map": ".code" }, { "identity": "w5", "map": "what" } ] }, { "id": "Task.description", "path": "Task.description", "short": "Human-readable explanation of task", "definition": "A free-text description of what is to be performed.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" } ] }, { "id": "Task.focus", "path": "Task.focus", "short": "What task is acting on", "definition": "The request being actioned or the resource being manipulated by this task.", "comment": "If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).", "requirements": "Used to identify the thing to be done.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.what[x]" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=SUBJ].target" }, { "identity": "w5", "map": "what" } ] }, { "id": "Task.for", "path": "Task.for", "short": "Beneficiary of the Task", "definition": "The entity who benefits from the performance of the service specified in the task (e.g., the patient).", "requirements": "Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.", "alias": [ "Patient" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.subject, Event.subject" }, { "identity": "w5", "map": "FiveWs.subject[x]" }, { "identity": "rim", "map": ".participation[typeCode=RCT].role" }, { "identity": "w5", "map": "who.focus" } ] }, { "id": "Task.context", "path": "Task.context", "short": "Healthcare event during which this task originated", "definition": "The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.", "requirements": "For some tasks it may be important to know the link between the task or episode of care the task originated within.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.context, Event.context" }, { "identity": "w5", "map": "FiveWs.context" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]" }, { "identity": "w5", "map": "context" } ] }, { "id": "Task.executionPeriod", "path": "Task.executionPeriod", "short": "Start and end time of execution", "definition": "Identifies 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).", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.occurrence[x]" }, { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "rim", "map": ".effectiveTime" }, { "identity": "w5", "map": "when.done" } ] }, { "id": "Task.authoredOn", "path": "Task.authoredOn", "short": "Task Creation Date", "definition": "The date and time this task was created.", "requirements": "Most often used along with lastUpdated to track duration of task to supporting monitoring and management.", "alias": [ "Created Date" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "condition": [ "inv-1" ], "mapping": [ { "identity": "workflow", "map": "Request.authoredOn" }, { "identity": "w5", "map": "FiveWs.recorded" }, { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" } ] }, { "id": "Task.lastModified", "path": "Task.lastModified", "short": "Task Last Modified Date", "definition": "The date and time of last modification to this task.", "requirements": "Used along with history to track task activity and time in a particular task state. This enables monitoring and management.", "alias": [ "Update Date" ], "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "condition": [ "inv-1" ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime" } ] }, { "id": "Task.requester", "path": "Task.requester", "short": "Who is asking for task to be done", "definition": "The creator of the task.", "requirements": "Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Request.requester" }, { "identity": "w5", "map": "FiveWs.author" }, { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.author" } ] }, { "id": "Task.performerType", "path": "Task.performerType", "short": "requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer", "definition": "The type of participant that can execute the task.", "requirements": "Use to distinguish tasks on different activity queues.", "min": 0, "max": "*", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskPerformerType" } ], "strength": "preferred", "description": "The type(s) of task performers allowed", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/task-performer-type" } }, "mapping": [ { "identity": "workflow", "map": "Event.performer.role, Request.performerType" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role.code" }, { "identity": "w5", "map": "who.actor" } ] }, { "id": "Task.owner", "path": "Task.owner", "short": "Responsible individual", "definition": "Individual organization or Device currently responsible for task execution.", "comment": "Tasks may be created with an owner not yet identified.", "requirements": "Identifies who is expected to perform this task.", "alias": [ "Performer", "Executer" ], "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/PractitionerRole" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/HealthcareService" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" } ], "isSummary": true, "mapping": [ { "identity": "workflow", "map": "Event.performer.actor, Request.performer" }, { "identity": "w5", "map": "FiveWs.actor" }, { "identity": "rim", "map": ".participation[typeCode=PRF].role" }, { "identity": "w5", "map": "who.actor" } ] }, { "id": "Task.reasonCode", "path": "Task.reasonCode", "short": "Why task is needed", "definition": "A description or code indicating why this task needs to be performed.", "comment": "This should only be included if there is no focus or if it differs from the reason indicated on the focus.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskReason" } ], "strength": "example", "description": "Indicates why the task is needed. E.g. Suspended because patient admitted to hospital." }, "mapping": [ { "identity": "workflow", "map": "Request.reasonCode, Event.reasonCode" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".reasonCode" }, { "identity": "w5", "map": "why" } ] }, { "id": "Task.reasonReference", "path": "Task.reasonReference", "short": "Why task is needed", "definition": "A resource reference indicating why this task needs to be performed.", "comment": "Task's might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Task.reasonCode` if the data is free (uncoded) text.", "min": 0, "max": "1", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource" } ], "mapping": [ { "identity": "workflow", "map": "Request.reasonReference, Event.reasonReference" }, { "identity": "w5", "map": "FiveWs.why[x]" }, { "identity": "rim", "map": ".outboundRelationship[typeCode=RSON].target" }, { "identity": "w5", "map": "why" } ] }, { "id": "Task.note", "path": "Task.note", "short": "Comments made about the task", "definition": "Free-text information captured about the task as it progresses.", "min": 0, "max": "*", "type": [ { "code": "Annotation" } ], "mapping": [ { "identity": "workflow", "map": "Request.note, Event.note" }, { "identity": "rim", "map": ".inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value(string)" } ] }, { "id": "Task.relevantHistory", "path": "Task.relevantHistory", "short": "Key events in history of the Task", "definition": "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.", "comment": "This element does not point to the Provenance associated with the *current* version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.", "alias": [ "Status History" ], "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance" } ], "mapping": [ { "identity": "workflow", "map": "Request.relevantHistory" }, { "identity": "rim", "map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]" } ] }, { "id": "Task.restriction", "path": "Task.restriction", "short": "Constraints on fulfillment tasks", "definition": "If 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.", "requirements": "Sometimes when fulfillment is sought, you don't want full fulfillment.", "min": 0, "max": "1", "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": "Instead of pointing to request, would point to component of request, having these characteristics" } ] }, { "id": "Task.restriction.repetitions", "path": "Task.restriction.repetitions", "short": "How many times to repeat", "definition": "Indicates the number of times the requested action should occur.", "requirements": "E.g. order that requests monthly lab tests, fulfillment is sought for 1.", "min": 0, "max": "1", "type": [ { "code": "positiveInt" } ], "mapping": [ { "identity": "rim", "map": ".repeatNumber" } ] }, { "id": "Task.restriction.period", "path": "Task.restriction.period", "short": "When fulfillment sought", "definition": "Over what time-period is fulfillment sought.", "comment": "Note that period.high is the due date representing the time by which the task should be completed.", "requirements": "E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "rim", "map": ".effectiveTime(IVL<TS>)" } ] }, { "id": "Task.restriction.recipient", "path": "Task.restriction.recipient", "short": "For whom is fulfillment sought?", "definition": "For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?", "min": 0, "max": "*", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group" }, { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "rim", "map": ".participation[typeCode=SBJ].role" } ] }, { "id": "Task.input", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "Parameter" } ], "path": "Task.input", "short": "Information used to perform task", "definition": "Additional information that may be needed in the execution of the task.", "requirements": "Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.", "alias": [ "Supporting Information" ], "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.input.type", "path": "Task.input.type", "short": "Label for the input", "definition": "A code or description indicating how the input is intended to be used as part of the task execution.", "comment": "If referencing a BPMN workflow or Protocol, the \"system\" is the URL for the workflow definition and the code is the \"name\" of the required input.", "requirements": "Inputs are named to enable task automation to bind data and pass it from one task to the next.", "alias": [ "Name" ], "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskInputParameterType" } ], "strength": "example", "description": "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Comparison source\", \"Applicable consent\", \"Concommitent Medications\", etc." }, "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.input.value[x]", "path": "Task.input.value[x]", "short": "Content to use in performing the task", "definition": "The value of the input parameter as a basic type.", "min": 1, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "Dosage" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Meta" } ], "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.output", "path": "Task.output", "short": "Information produced as part of task", "definition": "Outputs produced by the Task.", "requirements": "Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.", "min": 0, "max": "*", "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.output.type", "path": "Task.output.type", "short": "Label for output", "definition": "The name of the Output parameter.", "requirements": "Outputs are named to enable task automation to bind data and pass it from one task to the next.", "alias": [ "Name" ], "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "TaskOutputParameterType" } ], "strength": "example", "description": "Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. \"Identified issues\", \"Preliminary results\", \"Filler order\", \"Final results\", etc." }, "mapping": [ { "identity": "rim", "map": "???" } ] }, { "id": "Task.output.value[x]", "path": "Task.output.value[x]", "short": "Result of output", "definition": "The value of the Output parameter as a basic type.", "requirements": "Task outputs can take any form.", "min": 1, "max": "1", "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "Dosage" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Meta" } ], "mapping": [ { "identity": "rim", "map": "???" } ] } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.