Polaris FHIR Implementation Guide
1.9.2 - ci-build
Polaris FHIR Implementation Guide - Local Development build (v1.9.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Page standards status: Draft |
Definitions for the polaris-core-clinical-task resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Task | |
| Definition | A task to be performed. |
| Short | A task to be performed |
| Control | 0..* |
| Is Modifier | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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 (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) inv-1: Last modified date must be greater than or equal to authored-on date. ( lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn)polaris-task-identifier: Task must have at least one identifier with a Polaris canonical system URI ( identifier.where(system.startsWith('https://fhir.apps.health')).exists())inv-1: Last modified date must be greater than or equal to authored-on date. (lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn) |
| 2. Task.implicitRules | |
| 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Task.modifierExtension | |
| 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 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). |
| Short | Extensions that cannot be ignored |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Summary | false |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 6. Task.identifier | |
| Definition | System-assigned unique identifier for task tracking and audit. Must include at least one identifier with a canonical Polaris system URI. The business identifier for this task. |
| Short | Unique task identifier following Polaris naming patternTask Instance Identifier |
| Comments | Each task must have at least one identifier for tracking. Additional identifiers may be used for integration with external systems. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 10..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Task.instantiatesCanonical | |
| Definition | References to formal protocols, guidelines, or ActivityDefinitions that this task follows. The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. |
| Short | Formal definition of task (canonical) |
| Comments | MERT requirement for protocol-based task execution. |
| Control | 0..1 |
| Type | canonical(ActivityDefinition) |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Enables a formal definition of how he task is to be performed, enabling automation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Task.instantiatesUri | |
| Definition | URI references to external protocols, guidelines, or specifications. The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. |
| Short | Formal definition of task (URI) |
| Comments | MERT requirement for external protocol references. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. Task.basedOn | |
| Definition | The request, order, or authorization that initiated this task. 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. |
| Short | Request fulfilled by this task |
| Comments | MERT requirement for linking tasks to originating clinical orders. |
| Control | 0..* |
| Type | Reference(ServiceRequest, MedicationRequest, CarePlan, SupplyRequest, Resource) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Task.groupIdentifier | |
| Definition | Identifier for grouping related tasks together for batch processing or workflow management. An identifier that links together multiple tasks and other requests that were created in the same context. |
| Short | Requisition or grouper identifier |
| Comments | MERT requirement for task batch management. |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. Task.partOf | |
| Definition | Reference to parent task when this task is part of a larger workflow or represents a sub-task. Task that this particular task is part of. |
| Short | Parent task for sub-tasks and branchesComposite task |
| Comments | Supports Polaris workflow branching and task hierarchy. This should usually be 0..1. |
| Control | 0..* |
| Type | Reference(Polaris Clinical Task Core, Task) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. Task.status | |
| Definition | Task lifecycle states aligned with clinical workflow:
The current status of the task. |
| Short | draft | requested | ready | in-progress | completed | cancelled | faileddraft | requested | received | accepted | + |
| Comments | The status drives workflow and UI presentation. Ready/requested tasks appear in active inboxes. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/task-status) |
| Type | code |
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. Task.statusReason | |
| Definition | Captures why the task is in its current state, particularly for cancelled or failed states. An explanation as to why this task is held, failed, was refused, etc. |
| Short | Reason for current status |
| Comments | MERT requirement for status change rationale. This applies to the current status. Look at the history of the task to see reasons for past statuses. |
| Control | 0..1 |
| Binding | Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Task.businessStatus | |
| Definition | Business-specific status information that supplements the standard lifecycle status. Contains business-specific nuances of the business state. |
| Short | Task business statusE.g. "Specimen collected", "IV prepped" |
| Comments | MERT requirement for additional status context beyond standard FHIR states. |
| Control | 0..1 |
| Binding | The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. Task.intent | |
| Definition | Clinical tasks in EMR workflows are always orders requiring action, not proposals or plans. Indicates 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. |
| Short | Always 'order' for clinical tasks requiring actionunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option |
| Comments | Fixed to 'order' to ensure clinical tasks have clear actionable intent. This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". |
| Control | 1..1 |
| Binding | The codes SHALL be taken from TaskIntenthttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 (required to http://hl7.org/fhir/ValueSet/task-intent|4.0.1)Distinguishes whether the task is a proposal, plan or full order. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Pattern Value | order |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. Task.priority | |
| Definition | Clinical priority level for workflow triage and routing. Indicates how quickly the Task should be addressed with respect to other requests. |
| Short | Clinical priority: routine | urgent | asap | statroutine | urgent | asap | stat |
| Comments | Used for inbox sorting and urgent task highlighting in UI. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 (required to http://hl7.org/fhir/ValueSet/request-priority) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Requirements | Used to identify the service level expected while performing a task. |
| Meaning if Missing | If missing, this task should be performed with normal priority |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. Task.code | |
| Definition | Coding that identifies the type of task being performed for workflow routing and automation. A name or code (or both) briefly describing what the task involves. |
| Short | Task type classificationTask Type |
| Comments | Added for MERT compatibility - enables automated task routing and classification. The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. |
| Control | 0..1 |
| Binding | For example codes, see TaskCodehttp://hl7.org/fhir/ValueSet/task-code|4.0.1 (example to http://hl7.org/fhir/ValueSet/task-code|4.0.1)Codes to identify what the task involves. These will typically be specific to a particular workflow. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. Task.description | |
| Definition | Canonical task description that provides the core content and remains stable throughout the task lifecycle. May include structured forms (lab requisition, referral, etc.) and supports Markdown formatting for rich content. A free-text description of what is to be performed. |
| Short | Original task content that remains stable throughout lifecycleHuman-readable explanation of task |
| Comments | Polaris requires description (1..1) vs MERT optional (0..1) to prevent ambiguous work items. |
| Control | 10..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. Task.focus | |
| Definition | The request being actioned or the resource being manipulated by this task. |
| Short | What task is aboutWhat task is acting on |
| Comments | MERT requirement for specifying the primary focus of task activity. If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.). |
| Control | 0..1 |
| Type | Reference(Resource) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Used to identify the thing to be done. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. Task.for | |
| Definition | All clinical tasks must have clear patient context for safety and clinical decision-making. The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
| Short | Patient this task is aboutBeneficiary of the Task |
| Comments | Polaris requires patient context (1..1) vs MERT optional (0..1) to prevent clinical errors from missing patient links. |
| Control | 10..1 |
| Type | Reference(Polaris Patient Core, Resource) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| 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. |
| Alternate Names | Patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. Task.encounter | |
| Definition | Links the task to the specific clinical encounter that generated it. The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. |
| Short | Healthcare encounter during which task was createdHealthcare event during which this task originated |
| Comments | Provides clinical context for task creation and helps with documentation workflow. |
| Control | 0..1 |
| Type | Reference(Polaris Encounter Profile Core, Encounter) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | For some tasks it may be important to know the link between the encounter the task originated within. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. Task.executionPeriod | |
| Definition | Expected or actual time period during which the task is to be or was executed. 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). |
| Short | Start and end time of execution |
| Comments | MERT requirement for task timing management. |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. Task.authoredOn | |
| Definition | Timestamp when the task was initially created for complete audit trail. The date and time this task was created. |
| Short | When task was first createdTask Creation Date |
| Comments | Polaris requires creation timestamp (1..1) vs MERT optional (0..1) for audit compliance. |
| Control | 10..1 This element is affected by the following invariants: inv-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | false |
| Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. |
| Alternate Names | Created Date |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. Task.lastModified | |
| Definition | Most recent timestamp when the task was modified. The date and time of last modification to this task. |
| Short | Task last modified dateTask Last Modified Date |
| Comments | MERT requirement for modification tracking. |
| Control | 0..1 This element is affected by the following invariants: inv-1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. |
| Alternate Names | Update Date |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. Task.requester | |
| Definition | The person, system, or organization that initiated this task. The creator of the task. |
| Short | Who originally requested this taskWho is asking for task to be done |
| Comments | Polaris requires requester (1..1) vs MERT optional (0..1) for clear accountability chain. |
| Control | 10..1 |
| Type | Reference(Polaris PractitionerRole Core, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| 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). |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. Task.performerType | |
| Definition | The type of performer (person, device, organization) required to complete the task. The kind of participant that should perform the task. |
| Short | Requested performer type |
| Comments | MERT requirement for specifying required performer characteristics. |
| Control | 0..* |
| Binding | The codes SHOULD be taken from ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role|4.0.1 (preferred to http://hl7.org/fhir/ValueSet/performer-role|4.0.1)The type(s) of task performers allowed. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Requirements | Use to distinguish tasks on different activity queues. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. Task.owner | |
| Definition | Implements hot potato principle - always exactly one owner for clear accountability:
Individual organization or Device currently responsible for task execution. |
| Short | Current task owner - exactly one person/systemResponsible individual |
| Comments | The owner is responsible for the next action on this task. Ownership transfers with each significant action (forward, reply, etc.). Tasks may be created with an owner not yet identified. |
| Control | 10..1 |
| Type | Reference(Polaris PractitionerRole Core, Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Identifies who is expected to perform this task. |
| Alternate Names | Performer, Executer |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 50. Task.location | |
| Definition | Principal physical location where the task is to be performed. Principal physical location where the this task is performed. |
| Short | Where task should be performedWhere task occurs |
| Comments | MERT requirement for task location specification. |
| Control | 0..1 |
| Type | Reference(Polaris Location Core, Location) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Requirements | Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. Task.reasonCode | |
| Definition | Coded indication of why the task was created. A description or code indicating why this task needs to be performed. |
| Short | Why task is needed (coded) |
| Comments | MERT requirement for coded task rationale. This should only be included if there is no focus or if it differs from the reason indicated on the focus. |
| Control | 0..1 |
| Binding | Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. Task.reasonReference | |
| Definition | Reference to clinical condition, observation, or other resource that justifies the task. A resource reference indicating why this task needs to be performed. |
| Short | Clinical reason for this taskWhy task is needed |
| Comments | Links task to specific clinical findings or conditions. Tasks 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 |
| Control | 0..1 |
| Type | Reference(Condition, Observation, DiagnosticReport, DocumentReference, Resource) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. Task.insurance | |
| Definition | Insurance coverage that is relevant to the performance of this task. Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. |
| Short | Associated insurance coverage |
| Comments | MERT requirement for insurance context. |
| Control | 0..* |
| Type | Reference(Coverage, Coverage, ClaimResponse) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. Task.note | |
| Definition | Free-text notes providing additional context, instructions, or information not captured elsewhere. Free-text information captured about the task as it progresses. |
| Short | Additional task information and contextComments made about the task |
| Comments | Supports rich clinical context and special instructions. |
| Control | 0..* |
| Type | Annotation |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. Task.relevantHistory | |
| Definition | Links to Provenance resources that document key events in the task lifecycle. 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. |
| Short | Key events in history of taskKey events in history of the Task |
| Comments | MERT requirement for historical context. 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. |
| Control | 0..* |
| Type | Reference(Provenance) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Alternate Names | Status History |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. Task.restriction | |
| Definition | Constraints that apply to the fulfillment of the task. 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. |
| Short | Constraints on fulfillment tasks |
| Comments | MERT requirement for task execution constraints. |
| Control | 0..1 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. Task.restriction.modifierExtension | |
| 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 in which it is contained 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 can 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 66. Task.input | |
| Definition | Structured input data, parameters, or resources required for task execution. Additional information that may be needed in the execution of the task. |
| Short | Task input parameters and dataInformation used to perform task |
| Comments | Supports structured clinical workflows and forms. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| 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. |
| Alternate Names | Supporting Information |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 68. Task.input.modifierExtension | |
| 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 in which it is contained 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 can 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 70. Task.input.type | |
| Definition | A code or description indicating how the input is intended to be used as part of the task execution. |
| Short | Label for the input |
| Comments | 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. |
| Control | 1..1 |
| Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | false |
| Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. |
| Alternate Names | Name |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. Task.input.value[x] | |
| Definition | The value of the input parameter as a basic type. |
| Short | Content to use in performing the task |
| Control | 1..1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. Task.output | |
| Definition | Results, outcomes, or deliverables produced by completing this task. Outputs produced by the Task. |
| Short | Task output results and outcomesInformation produced as part of task |
| Comments | Captures structured task outcomes and deliverables. |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. Task.output.modifierExtension | |
| 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 in which it is contained 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 can 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). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 78. Task.output.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | 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. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | false |
| Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. |
| Alternate Names | Name |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. Task.output.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Requirements | Task outputs can take any form. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Task | |
| Invariants | polaris-task-identifier: Task must have at least one identifier with a Polaris canonical system URI (identifier.where(system.startsWith('https://fhir.apps.health')).exists()) |
| 2. Task.identifier | |
| Definition | System-assigned unique identifier for task tracking and audit. Must include at least one identifier with a canonical Polaris system URI. |
| Short | Unique task identifier following Polaris naming pattern |
| Comments | Each task must have at least one identifier for tracking. Additional identifiers may be used for integration with external systems. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..? |
| Must Support | true |
| 4. Task.instantiatesCanonical | |
| Definition | References to formal protocols, guidelines, or ActivityDefinitions that this task follows. |
| Short | Formal definition of task (canonical) |
| Comments | MERT requirement for protocol-based task execution. |
| Must Support | true |
| 6. Task.instantiatesUri | |
| Definition | URI references to external protocols, guidelines, or specifications. |
| Short | Formal definition of task (URI) |
| Comments | MERT requirement for external protocol references. |
| Must Support | true |
| 8. Task.basedOn | |
| Definition | The request, order, or authorization that initiated this task. |
| Comments | MERT requirement for linking tasks to originating clinical orders. |
| Type | Reference(ServiceRequest, MedicationRequest, CarePlan, SupplyRequest) |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| 10. Task.groupIdentifier | |
| Definition | Identifier for grouping related tasks together for batch processing or workflow management. |
| Short | Requisition or grouper identifier |
| Comments | MERT requirement for task batch management. |
| Must Support | true |
| 12. Task.partOf | |
| Definition | Reference to parent task when this task is part of a larger workflow or represents a sub-task. |
| Short | Parent task for sub-tasks and branches |
| Comments | Supports Polaris workflow branching and task hierarchy. |
| Type | Reference(Polaris Clinical Task Core) |
| Must Support | true |
| 14. Task.status | |
| Definition | Task lifecycle states aligned with clinical workflow:
|
| Short | draft | requested | ready | in-progress | completed | cancelled | failed |
| Comments | The status drives workflow and UI presentation. Ready/requested tasks appear in active inboxes. |
| Binding | The codes SHALL be taken from TaskStatus (required to http://hl7.org/fhir/ValueSet/task-status) |
| Must Support | true |
| 16. Task.statusReason | |
| Definition | Captures why the task is in its current state, particularly for cancelled or failed states. |
| Comments | MERT requirement for status change rationale. |
| Must Support | true |
| 18. Task.businessStatus | |
| Definition | Business-specific status information that supplements the standard lifecycle status. |
| Short | Task business status |
| Comments | MERT requirement for additional status context beyond standard FHIR states. |
| Must Support | true |
| 20. Task.intent | |
| Definition | Clinical tasks in EMR workflows are always orders requiring action, not proposals or plans. |
| Short | Always 'order' for clinical tasks requiring action |
| Comments | Fixed to 'order' to ensure clinical tasks have clear actionable intent. |
| Must Support | true |
| Pattern Value | order |
| 22. Task.priority | |
| Definition | Clinical priority level for workflow triage and routing. |
| Short | Clinical priority: routine | urgent | asap | stat |
| Comments | Used for inbox sorting and urgent task highlighting in UI. |
| Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority) |
| Must Support | true |
| 24. Task.code | |
| Definition | Coding that identifies the type of task being performed for workflow routing and automation. |
| Short | Task type classification |
| Comments | Added for MERT compatibility - enables automated task routing and classification. |
| Must Support | true |
| 26. Task.description | |
| Definition | Canonical task description that provides the core content and remains stable throughout the task lifecycle. May include structured forms (lab requisition, referral, etc.) and supports Markdown formatting for rich content. |
| Short | Original task content that remains stable throughout lifecycle |
| Comments | Polaris requires description (1..1) vs MERT optional (0..1) to prevent ambiguous work items. |
| Control | 1..? |
| Must Support | true |
| 28. Task.focus | |
| Short | What task is about |
| Comments | MERT requirement for specifying the primary focus of task activity. |
| Must Support | true |
| 30. Task.for | |
| Definition | All clinical tasks must have clear patient context for safety and clinical decision-making. |
| Short | Patient this task is about |
| Comments | Polaris requires patient context (1..1) vs MERT optional (0..1) to prevent clinical errors from missing patient links. |
| Control | 1..? |
| Type | Reference(Polaris Patient Core) |
| Must Support | true |
| 32. Task.encounter | |
| Definition | Links the task to the specific clinical encounter that generated it. |
| Short | Healthcare encounter during which task was created |
| Comments | Provides clinical context for task creation and helps with documentation workflow. |
| Type | Reference(Polaris Encounter Profile Core) |
| Must Support | true |
| 34. Task.executionPeriod | |
| Definition | Expected or actual time period during which the task is to be or was executed. |
| Comments | MERT requirement for task timing management. |
| Must Support | true |
| 36. Task.authoredOn | |
| Definition | Timestamp when the task was initially created for complete audit trail. |
| Short | When task was first created |
| Comments | Polaris requires creation timestamp (1..1) vs MERT optional (0..1) for audit compliance. |
| Control | 1..? |
| Must Support | true |
| 38. Task.lastModified | |
| Definition | Most recent timestamp when the task was modified. |
| Short | Task last modified date |
| Comments | MERT requirement for modification tracking. |
| Must Support | true |
| 40. Task.requester | |
| Definition | The person, system, or organization that initiated this task. |
| Short | Who originally requested this task |
| Comments | Polaris requires requester (1..1) vs MERT optional (0..1) for clear accountability chain. |
| Control | 1..? |
| Type | Reference(Polaris PractitionerRole Core) |
| Must Support | true |
| 42. Task.performerType | |
| Definition | The type of performer (person, device, organization) required to complete the task. |
| Short | Requested performer type |
| Comments | MERT requirement for specifying required performer characteristics. |
| Must Support | true |
| 44. Task.owner | |
| Definition | Implements hot potato principle - always exactly one owner for clear accountability:
|
| Short | Current task owner - exactly one person/system |
| Comments | The owner is responsible for the next action on this task. Ownership transfers with each significant action (forward, reply, etc.). |
| Control | 1..? |
| Type | Reference(Polaris PractitionerRole Core) |
| Must Support | true |
| 46. Task.location | |
| Definition | Principal physical location where the task is to be performed. |
| Short | Where task should be performed |
| Comments | MERT requirement for task location specification. |
| Type | Reference(Polaris Location Core) |
| Must Support | true |
| 48. Task.reasonCode | |
| Definition | Coded indication of why the task was created. |
| Short | Why task is needed (coded) |
| Comments | MERT requirement for coded task rationale. |
| Must Support | true |
| 50. Task.reasonReference | |
| Definition | Reference to clinical condition, observation, or other resource that justifies the task. |
| Short | Clinical reason for this task |
| Comments | Links task to specific clinical findings or conditions. |
| Type | Reference(Condition, Observation, DiagnosticReport, DocumentReference) |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| 52. Task.insurance | |
| Definition | Insurance coverage that is relevant to the performance of this task. |
| Comments | MERT requirement for insurance context. |
| Type | Reference(Coverage) |
| Must Support | true |
| 54. Task.note | |
| Definition | Free-text notes providing additional context, instructions, or information not captured elsewhere. |
| Short | Additional task information and context |
| Comments | Supports rich clinical context and special instructions. |
| Must Support | true |
| 56. Task.relevantHistory | |
| Definition | Links to Provenance resources that document key events in the task lifecycle. |
| Short | Key events in history of task |
| Comments | MERT requirement for historical context. |
| Must Support | true |
| 58. Task.restriction | |
| Definition | Constraints that apply to the fulfillment of the task. |
| Comments | MERT requirement for task execution constraints. |
| Must Support | true |
| 60. Task.input | |
| Definition | Structured input data, parameters, or resources required for task execution. |
| Short | Task input parameters and data |
| Comments | Supports structured clinical workflows and forms. |
| Must Support | true |
| 62. Task.output | |
| Definition | Results, outcomes, or deliverables produced by completing this task. |
| Short | Task output results and outcomes |
| Comments | Captures structured task outcomes and deliverables. |
| Must Support | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Task | |||||
| Definition | A task to be performed. | ||||
| Short | A task to be performed | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: 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 ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())inv-1: Last modified date must be greater than or equal to authored-on date. ( lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn)polaris-task-identifier: Task must have at least one identifier with a Polaris canonical system URI ( identifier.where(system.startsWith('https://fhir.apps.health')).exists()) | ||||
| 2. Task.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. Task.meta | |||||
| 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. Task.implicitRules | |||||
| 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. Task.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | 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). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 10. Task.text | |||||
| Definition | A 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | 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 information is added later. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. Task.contained | |||||
| 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. | ||||
| Short | Contained, inline Resources | ||||
| Comments | 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. Task.extension | |||||
| Definition | 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 16. Task.modifierExtension | |||||
| 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 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). | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. Task.identifier | |||||
| Definition | System-assigned unique identifier for task tracking and audit. Must include at least one identifier with a canonical Polaris system URI. | ||||
| Short | Unique task identifier following Polaris naming pattern | ||||
| Comments | Each task must have at least one identifier for tracking. Additional identifiers may be used for integration with external systems. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 1..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. Task.instantiatesCanonical | |||||
| Definition | References to formal protocols, guidelines, or ActivityDefinitions that this task follows. | ||||
| Short | Formal definition of task (canonical) | ||||
| Comments | MERT requirement for protocol-based task execution. | ||||
| Control | 0..1 | ||||
| Type | canonical(ActivityDefinition) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Enables a formal definition of how he task is to be performed, enabling automation. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. Task.instantiatesUri | |||||
| Definition | URI references to external protocols, guidelines, or specifications. | ||||
| Short | Formal definition of task (URI) | ||||
| Comments | MERT requirement for external protocol references. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. Task.basedOn | |||||
| Definition | The request, order, or authorization that initiated this task. | ||||
| Short | Request fulfilled by this task | ||||
| Comments | MERT requirement for linking tasks to originating clinical orders. | ||||
| Control | 0..* | ||||
| Type | Reference(ServiceRequest, MedicationRequest, CarePlan, SupplyRequest) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. Task.groupIdentifier | |||||
| Definition | Identifier for grouping related tasks together for batch processing or workflow management. | ||||
| Short | Requisition or grouper identifier | ||||
| Comments | MERT requirement for task batch management. | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. Task.partOf | |||||
| Definition | Reference to parent task when this task is part of a larger workflow or represents a sub-task. | ||||
| Short | Parent task for sub-tasks and branches | ||||
| Comments | Supports Polaris workflow branching and task hierarchy. | ||||
| Control | 0..* | ||||
| Type | Reference(Polaris Clinical Task Core) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 30. Task.status | |||||
| Definition | Task lifecycle states aligned with clinical workflow:
| ||||
| Short | draft | requested | ready | in-progress | completed | cancelled | failed | ||||
| Comments | The status drives workflow and UI presentation. Ready/requested tasks appear in active inboxes. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from TaskStatus (required to http://hl7.org/fhir/ValueSet/task-status) | ||||
| Type | code | ||||
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 32. Task.statusReason | |||||
| Definition | Captures why the task is in its current state, particularly for cancelled or failed states. | ||||
| Short | Reason for current status | ||||
| Comments | MERT requirement for status change rationale. | ||||
| Control | 0..1 | ||||
| Binding | Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 34. Task.businessStatus | |||||
| Definition | Business-specific status information that supplements the standard lifecycle status. | ||||
| Short | Task business status | ||||
| Comments | MERT requirement for additional status context beyond standard FHIR states. | ||||
| Control | 0..1 | ||||
| Binding | The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. Task.intent | |||||
| Definition | Clinical tasks in EMR workflows are always orders requiring action, not proposals or plans. | ||||
| Short | Always 'order' for clinical tasks requiring action | ||||
| Comments | Fixed to 'order' to ensure clinical tasks have clear actionable intent. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from TaskIntent (required to http://hl7.org/fhir/ValueSet/task-intent|4.0.1)Distinguishes whether the task is a proposal, plan or full order. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Pattern Value | order | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. Task.priority | |||||
| Definition | Clinical priority level for workflow triage and routing. | ||||
| Short | Clinical priority: routine | urgent | asap | stat | ||||
| Comments | Used for inbox sorting and urgent task highlighting in UI. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority) | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Requirements | Used to identify the service level expected while performing a task. | ||||
| Meaning if Missing | If missing, this task should be performed with normal priority | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. Task.code | |||||
| Definition | Coding that identifies the type of task being performed for workflow routing and automation. | ||||
| Short | Task type classification | ||||
| Comments | Added for MERT compatibility - enables automated task routing and classification. | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see TaskCode (example to http://hl7.org/fhir/ValueSet/task-code|4.0.1)Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. Task.description | |||||
| Definition | Canonical task description that provides the core content and remains stable throughout the task lifecycle. May include structured forms (lab requisition, referral, etc.) and supports Markdown formatting for rich content. | ||||
| Short | Original task content that remains stable throughout lifecycle | ||||
| Comments | Polaris requires description (1..1) vs MERT optional (0..1) to prevent ambiguous work items. | ||||
| Control | 1..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. Task.focus | |||||
| Definition | The request being actioned or the resource being manipulated by this task. | ||||
| Short | What task is about | ||||
| Comments | MERT requirement for specifying the primary focus of task activity. | ||||
| Control | 0..1 | ||||
| Type | Reference(Resource) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Used to identify the thing to be done. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. Task.for | |||||
| Definition | All clinical tasks must have clear patient context for safety and clinical decision-making. | ||||
| Short | Patient this task is about | ||||
| Comments | Polaris requires patient context (1..1) vs MERT optional (0..1) to prevent clinical errors from missing patient links. | ||||
| Control | 1..1 | ||||
| Type | Reference(Polaris Patient Core) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| 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. | ||||
| Alternate Names | Patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. Task.encounter | |||||
| Definition | Links the task to the specific clinical encounter that generated it. | ||||
| Short | Healthcare encounter during which task was created | ||||
| Comments | Provides clinical context for task creation and helps with documentation workflow. | ||||
| Control | 0..1 | ||||
| Type | Reference(Polaris Encounter Profile Core) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | For some tasks it may be important to know the link between the encounter the task originated within. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. Task.executionPeriod | |||||
| Definition | Expected or actual time period during which the task is to be or was executed. | ||||
| Short | Start and end time of execution | ||||
| Comments | MERT requirement for task timing management. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. Task.authoredOn | |||||
| Definition | Timestamp when the task was initially created for complete audit trail. | ||||
| Short | When task was first created | ||||
| Comments | Polaris requires creation timestamp (1..1) vs MERT optional (0..1) for audit compliance. | ||||
| Control | 1..1 This element is affected by the following invariants: inv-1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. | ||||
| Alternate Names | Created Date | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. Task.lastModified | |||||
| Definition | Most recent timestamp when the task was modified. | ||||
| Short | Task last modified date | ||||
| Comments | MERT requirement for modification tracking. | ||||
| Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. | ||||
| Alternate Names | Update Date | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. Task.requester | |||||
| Definition | The person, system, or organization that initiated this task. | ||||
| Short | Who originally requested this task | ||||
| Comments | Polaris requires requester (1..1) vs MERT optional (0..1) for clear accountability chain. | ||||
| Control | 1..1 | ||||
| Type | Reference(Polaris PractitionerRole Core) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| 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). | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 58. Task.performerType | |||||
| Definition | The type of performer (person, device, organization) required to complete the task. | ||||
| Short | Requested performer type | ||||
| Comments | MERT requirement for specifying required performer characteristics. | ||||
| Control | 0..* | ||||
| Binding | The codes SHOULD be taken from ProcedurePerformerRoleCodes (preferred to http://hl7.org/fhir/ValueSet/performer-role|4.0.1)The type(s) of task performers allowed. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Requirements | Use to distinguish tasks on different activity queues. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 60. Task.owner | |||||
| Definition | Implements hot potato principle - always exactly one owner for clear accountability:
| ||||
| Short | Current task owner - exactly one person/system | ||||
| Comments | The owner is responsible for the next action on this task. Ownership transfers with each significant action (forward, reply, etc.). | ||||
| Control | 1..1 | ||||
| Type | Reference(Polaris PractitionerRole Core) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Identifies who is expected to perform this task. | ||||
| Alternate Names | Performer, Executer | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 62. Task.location | |||||
| Definition | Principal physical location where the task is to be performed. | ||||
| Short | Where task should be performed | ||||
| Comments | MERT requirement for task location specification. | ||||
| Control | 0..1 | ||||
| Type | Reference(Polaris Location Core) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Requirements | Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 64. Task.reasonCode | |||||
| Definition | Coded indication of why the task was created. | ||||
| Short | Why task is needed (coded) | ||||
| Comments | MERT requirement for coded task rationale. | ||||
| Control | 0..1 | ||||
| Binding | Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 66. Task.reasonReference | |||||
| Definition | Reference to clinical condition, observation, or other resource that justifies the task. | ||||
| Short | Clinical reason for this task | ||||
| Comments | Links task to specific clinical findings or conditions. | ||||
| Control | 0..1 | ||||
| Type | Reference(Condition, Observation, DiagnosticReport, DocumentReference) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. Task.insurance | |||||
| Definition | Insurance coverage that is relevant to the performance of this task. | ||||
| Short | Associated insurance coverage | ||||
| Comments | MERT requirement for insurance context. | ||||
| Control | 0..* | ||||
| Type | Reference(Coverage) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 70. Task.note | |||||
| Definition | Free-text notes providing additional context, instructions, or information not captured elsewhere. | ||||
| Short | Additional task information and context | ||||
| Comments | Supports rich clinical context and special instructions. | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 72. Task.relevantHistory | |||||
| Definition | Links to Provenance resources that document key events in the task lifecycle. | ||||
| Short | Key events in history of task | ||||
| Comments | MERT requirement for historical context. | ||||
| Control | 0..* | ||||
| Type | Reference(Provenance) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Alternate Names | Status History | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. Task.restriction | |||||
| Definition | Constraints that apply to the fulfillment of the task. | ||||
| Short | Constraints on fulfillment tasks | ||||
| Comments | MERT requirement for task execution constraints. | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. Task.restriction.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 78. Task.restriction.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 80. Task.restriction.modifierExtension | |||||
| 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 in which it is contained 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 can 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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 82. Task.restriction.repetitions | |||||
| Definition | Indicates the number of times the requested action should occur. | ||||
| Short | How many times to repeat | ||||
| Control | 0..1 | ||||
| Type | positiveInt | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | E.g. order that requests monthly lab tests, fulfillment is sought for 1. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 84. Task.restriction.period | |||||
| Definition | Over what time-period is fulfillment sought. | ||||
| Short | When fulfillment sought | ||||
| Comments | Note that period.high is the due date representing the time by which the task should be completed. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. Task.restriction.recipient | |||||
| Definition | For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought? | ||||
| Short | For whom is fulfillment sought? | ||||
| Control | 0..* | ||||
| Type | Reference(Patient, Practitioner, PractitionerRole, RelatedPerson, Group, Organization) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 88. Task.input | |||||
| Definition | Structured input data, parameters, or resources required for task execution. | ||||
| Short | Task input parameters and data | ||||
| Comments | Supports structured clinical workflows and forms. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| 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. | ||||
| Alternate Names | Supporting Information | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 90. Task.input.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 92. Task.input.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 94. Task.input.modifierExtension | |||||
| 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 in which it is contained 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 can 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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 96. Task.input.type | |||||
| Definition | A code or description indicating how the input is intended to be used as part of the task execution. | ||||
| Short | Label for the input | ||||
| Comments | 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. | ||||
| Control | 1..1 | ||||
| Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. | ||||
| Alternate Names | Name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 98. Task.input.value[x] | |||||
| Definition | The value of the input parameter as a basic type. | ||||
| Short | Content to use in performing the task | ||||
| Control | 1..1 | ||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 100. Task.output | |||||
| Definition | Results, outcomes, or deliverables produced by completing this task. | ||||
| Short | Task output results and outcomes | ||||
| Comments | Captures structured task outcomes and deliverables. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| 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. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 102. Task.output.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 104. Task.output.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 106. Task.output.modifierExtension | |||||
| 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 in which it is contained 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 can 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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 108. Task.output.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | 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. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. | ||||
| Alternate Names | Name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 110. Task.output.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Requirements | Task outputs can take any form. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||