Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build International flag

Integrated Campaign Registry (ICR) Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ICRCampaignTask - Detailed Descriptions

Draft as of 2026-08-07

Definitions for the ICRCampaignTask resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Task
Definition

A task to be performed.

ShortA task to be performed
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-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)
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.

ShortA 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.

Control0..1
Typeuri
Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Task.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional 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.

Control20..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Task.extension:deliveryStrategy
    Slice NamedeliveryStrategy
    Definition

    How this activity/site/task reaches its target population. First-class and coded because a single campaign routinely mixes strategies, and the strategy governs which data elements exist (working doc §3).

    ShortDelivery Strategy
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Delivery Strategy) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. Task.extension:taskOrigin
    Slice NametaskOrigin
    Definition

    Whether this Task was generated in advance from the microplan or registered in the field on discovery. REQUIRED on ICRCampaignTask — field-registered counts per area measure how incomplete the microplan's enumeration was, feeding the next round's denominators (working doc §10 q1).

    ShortTask Origin
    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Task Origin) (Extension Type: code)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. Task.extension:housesVisited
    Slice NamehousesVisited
    Definition

    Number of houses visited — aggregate output of a house-to-house task.

    ShortHouses Visited
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Houses Visited) (Extension Type: unsignedInt)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Task.extension:eligiblePresent
    Slice NameeligiblePresent
    Definition

    Number of eligible persons — per the campaign protocol's target definition — present at the visit(s). Program-neutral by design: children under 5 for polio, household members for ITN registration, the eligible age band for MDA or vitamin A.

    ShortEligible Persons Present
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Eligible Persons Present) (Extension Type: unsignedInt)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. Task.extension:eligibleAbsent
    Slice NameeligibleAbsent
    Definition

    Number of eligible persons absent at the visit(s) — feeds same-day mop-up lists. Program-neutral counterpart of eligible-present.

    ShortEligible Persons Absent
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Eligible Persons Absent) (Extension Type: unsignedInt)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. Task.extension:missedReason
    Slice NamemissedReason
    Definition

    Why eligible person(s) were missed at this visit. House-to-house campaigns produce this natively (working doc §3.1).

    ShortMissed Reason
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Missed Reason) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. Task.extension:noncomplianceReason
    Slice NamenoncomplianceReason
    Definition

    Why the household/caregiver refused the intervention (WHO IDHC: 'intervention refusal') — drives social mobilization and mop-up targeting.

    ShortRefusal Reason
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Refusal Reason) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. Task.extension:exclusionReason
    Slice NameexclusionReason
    Definition

    Why a present, age-eligible person was clinically excluded from the intervention this round (under dose-pole height/age, pregnant, breastfeeding, acutely ill). Distinct from missed (not reached) and refusal (declined): the person was there and age-eligible but contraindicated. MDA treatment forms tally these per drug (espen.md rec 2 / §17.4).

    ShortExclusion Reason
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(Exclusion Reason) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    22. Task.extension:fingerMarked
    Slice NamefingerMarked
    Definition

    Whether the child was finger-marked — the in-field 'already covered' flag of house-to-house campaigns.

    ShortFinger Marked
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Finger Marked) (Extension Type: boolean)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    24. Task.extension:dataLineage
    Slice NamedataLineage
    Definition

    Data lineage of this record: the real-time operational stream or the post-campaign reconciled stream. One structure serves both; consumers filter by lineage — dashboards read realtime, JAP exports read reconciled (working doc §4.3). Default semantics: ABSENT MEANS REALTIME — live-stream records may omit the flag, but reconciled records must carry it, and coverage MeasureReports always carry it (1..1 on both coverage profiles).

    ShortReal-time vs Reconciled
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Real-time vs Reconciled) (Extension Type: code)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    26. Task.extension:revisitOutcome
    Slice NamerevisitOutcome
    Definition

    Outcome of a follow-up revisit to a previously-missed household/person (already-vaccinated | vaccinated-on-revisit | still-missing) — the 'outcome of the revisit' of the missed-children recording forms. Set on the person-targeted follow-up Task (Task.for = Patient, Task.focus = the originating Task that missed them) (forms-v1 / jul3-form-analysis §Aggregate #4).

    ShortOn a person-targeted follow-up Task: outcome of the revisit — already-vaccinated | vaccinated-on-revisit | still-missing (v0.21.0)
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Revisit Outcome) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    28. 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).

    ShortExtensions 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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    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 Namesextensions, user content
    Invariantsele-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())
    30. Task.status
    Definition

    The current status of the task.

    Shortrequested → in-progress → completed / faileddraft | requested | received | accepted | +
    Control1..1
    BindingThe codes SHALL be taken from TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/task-status|4.0.1)

    The current status of the task.

    Typecode
    Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Task.intent
    Definition

    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.

    Shortunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
    Comments

    This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.

    In most cases, Tasks will have an intent of "order".

    Control1..1
    BindingThe 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.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Task.code
    Definition

    A name or code (or both) briefly describing what the task involves.

    ShortThe activity being performedTask Type
    Comments

    The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.

    Control10..1
    BindingFor 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.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. Task.focus
    Definition

    The request being actioned or the resource being manipulated by this task.

    ShortWhat the task acts on: household/community delivery-unit Group (Type B/C — the norm) or site Location (Type A); a Patient only for person-targeted follow-up tasksWhat task is acting on
    Comments

    If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).

    Control10..1
    TypeReference(ICR Delivery Unit (Household / Community), ICR Location, Patient, Resource)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Requirements

    Used to identify the thing to be done.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. Task.for
    Definition

    The entity who benefits from the performance of the service specified in the task (e.g., the patient).

    ShortThe target subject/populationBeneficiary of the Task
    Control0..1
    TypeReference(Resource)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    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 NamesPatient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Task.executionPeriod
    Definition

    Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).

    ShortStart and end time of execution
    Control0..1
    TypePeriod
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. Task.owner
    Definition

    Individual organization or Device currently responsible for task execution.

    ShortThe assigned ICRCareTeam — a real join, not a display string (v0.20.0): 'who worked this' and (via the supervisor) 'who reports this'Responsible individual
    Comments

    Tasks may be created with an owner not yet identified.

    Control0..1
    TypeReference(ICR Care Team, Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Identifies who is expected to perform this task.

    Alternate NamesPerformer, Executer
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Task.location
    Definition

    Principal physical location where the this task is performed.

    ShortWhere the work happens: settlement, school, post, or dwellingWhere task occurs
    Control10..1
    TypeReference(ICR Location, Location)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    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).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Task.output
    Definition

    Outputs produced by the Task.

    ShortDelivery results: references to Immunization / MedicationAdministration / SupplyDelivery, or aggregate countsInformation produced as part of task
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    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.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. 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).

    ShortExtensions 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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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 Namesextensions, user content, modifiers
    Invariantsele-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())
    50. Task.output.type
    Definition

    The name of the Output parameter.

    ShortLabel for output
    Control1..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.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Requirements

    Outputs are named to enable task automation to bind data and pass it from one task to the next.

    Alternate NamesName
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. Task.output.value[x]
    Definition

    The value of the Output parameter as a basic type.

    ShortResult of output
    Control1..1
    TypeChoice 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Requirements

    Task outputs can take any form.

    Invariantsele-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
    2. Task.extension
    Control2..?
    SlicingThis element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Task.extension:deliveryStrategy
      Slice NamedeliveryStrategy
      Control1..1
      TypeExtension(Delivery Strategy) (Extension Type: CodeableConcept)
      Must Supporttrue
      6. Task.extension:taskOrigin
      Slice NametaskOrigin
      Control1..1
      TypeExtension(Task Origin) (Extension Type: code)
      Must Supporttrue
      8. Task.extension:housesVisited
      Slice NamehousesVisited
      Control0..1
      TypeExtension(Houses Visited) (Extension Type: unsignedInt)
      10. Task.extension:eligiblePresent
      Slice NameeligiblePresent
      Control0..1
      TypeExtension(Eligible Persons Present) (Extension Type: unsignedInt)
      12. Task.extension:eligibleAbsent
      Slice NameeligibleAbsent
      Control0..1
      TypeExtension(Eligible Persons Absent) (Extension Type: unsignedInt)
      14. Task.extension:missedReason
      Slice NamemissedReason
      Control0..*
      TypeExtension(Missed Reason) (Extension Type: CodeableConcept)
      16. Task.extension:noncomplianceReason
      Slice NamenoncomplianceReason
      Control0..*
      TypeExtension(Refusal Reason) (Extension Type: CodeableConcept)
      18. Task.extension:exclusionReason
      Slice NameexclusionReason
      Control0..*
      TypeExtension(Exclusion Reason) (Extension Type: CodeableConcept)
      20. Task.extension:fingerMarked
      Slice NamefingerMarked
      Control0..1
      TypeExtension(Finger Marked) (Extension Type: boolean)
      22. Task.extension:dataLineage
      Slice NamedataLineage
      Control0..1
      TypeExtension(Real-time vs Reconciled) (Extension Type: code)
      24. Task.extension:revisitOutcome
      Slice NamerevisitOutcome
      ShortOn a person-targeted follow-up Task: outcome of the revisit — already-vaccinated | vaccinated-on-revisit | still-missing (v0.21.0)
      Control0..1
      TypeExtension(Revisit Outcome) (Extension Type: CodeableConcept)
      26. Task.status
      Shortrequested → in-progress → completed / failed
      Must Supporttrue
      28. Task.intent
      Must Supporttrue
      30. Task.code
      ShortThe activity being performed
      Control1..?
      Must Supporttrue
      32. Task.focus
      ShortWhat the task acts on: household/community delivery-unit Group (Type B/C — the norm) or site Location (Type A); a Patient only for person-targeted follow-up tasks
      Control1..?
      TypeReference(ICR Delivery Unit (Household / Community), ICR Location, Patient)
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      34. Task.for
      ShortThe target subject/population
      Must Supporttrue
      36. Task.executionPeriod
      Must Supporttrue
      38. Task.owner
      ShortThe assigned ICRCareTeam — a real join, not a display string (v0.20.0): 'who worked this' and (via the supervisor) 'who reports this'
      TypeReference(ICR Care Team)
      Must Supporttrue
      40. Task.location
      ShortWhere the work happens: settlement, school, post, or dwelling
      Control1..?
      TypeReference(ICR Location)
      Must Supporttrue
      42. Task.output
      ShortDelivery results: references to Immunization / MedicationAdministration / SupplyDelivery, or aggregate counts
      Must Supporttrue

      Guidance on how to interpret the contents of this table can be foundhere

      0. Task
      Definition

      A task to be performed.

      ShortA task to be performed
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Invariantsdom-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)
      2. Task.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical 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.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      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.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-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.

      ShortA 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.

      Control0..1
      Typeuri
      Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-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.

      ShortLanguage 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).

      Control0..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-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.

      ShortText 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.

      Control0..1
      TypeNarrative
      Is Modifierfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-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.

      ShortContained, 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.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. Task.extension
      Definition

      An Extension

      ShortExtension
      Control2..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-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())
      SlicingThis element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. Task.extension:deliveryStrategy
        Slice NamedeliveryStrategy
        Definition

        How this activity/site/task reaches its target population. First-class and coded because a single campaign routinely mixes strategies, and the strategy governs which data elements exist (working doc §3).

        ShortDelivery Strategy
        Control1..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Delivery Strategy) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-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.extension:taskOrigin
        Slice NametaskOrigin
        Definition

        Whether this Task was generated in advance from the microplan or registered in the field on discovery. REQUIRED on ICRCampaignTask — field-registered counts per area measure how incomplete the microplan's enumeration was, feeding the next round's denominators (working doc §10 q1).

        ShortTask Origin
        Control1..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Task Origin) (Extension Type: code)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-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())
        20. Task.extension:housesVisited
        Slice NamehousesVisited
        Definition

        Number of houses visited — aggregate output of a house-to-house task.

        ShortHouses Visited
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Houses Visited) (Extension Type: unsignedInt)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        22. Task.extension:eligiblePresent
        Slice NameeligiblePresent
        Definition

        Number of eligible persons — per the campaign protocol's target definition — present at the visit(s). Program-neutral by design: children under 5 for polio, household members for ITN registration, the eligible age band for MDA or vitamin A.

        ShortEligible Persons Present
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Eligible Persons Present) (Extension Type: unsignedInt)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        24. Task.extension:eligibleAbsent
        Slice NameeligibleAbsent
        Definition

        Number of eligible persons absent at the visit(s) — feeds same-day mop-up lists. Program-neutral counterpart of eligible-present.

        ShortEligible Persons Absent
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Eligible Persons Absent) (Extension Type: unsignedInt)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        26. Task.extension:missedReason
        Slice NamemissedReason
        Definition

        Why eligible person(s) were missed at this visit. House-to-house campaigns produce this natively (working doc §3.1).

        ShortMissed Reason
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Missed Reason) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        28. Task.extension:noncomplianceReason
        Slice NamenoncomplianceReason
        Definition

        Why the household/caregiver refused the intervention (WHO IDHC: 'intervention refusal') — drives social mobilization and mop-up targeting.

        ShortRefusal Reason
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Refusal Reason) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        30. Task.extension:exclusionReason
        Slice NameexclusionReason
        Definition

        Why a present, age-eligible person was clinically excluded from the intervention this round (under dose-pole height/age, pregnant, breastfeeding, acutely ill). Distinct from missed (not reached) and refusal (declined): the person was there and age-eligible but contraindicated. MDA treatment forms tally these per drug (espen.md rec 2 / §17.4).

        ShortExclusion Reason
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension(Exclusion Reason) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        32. Task.extension:fingerMarked
        Slice NamefingerMarked
        Definition

        Whether the child was finger-marked — the in-field 'already covered' flag of house-to-house campaigns.

        ShortFinger Marked
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Finger Marked) (Extension Type: boolean)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        34. Task.extension:dataLineage
        Slice NamedataLineage
        Definition

        Data lineage of this record: the real-time operational stream or the post-campaign reconciled stream. One structure serves both; consumers filter by lineage — dashboards read realtime, JAP exports read reconciled (working doc §4.3). Default semantics: ABSENT MEANS REALTIME — live-stream records may omit the flag, but reconciled records must carry it, and coverage MeasureReports always carry it (1..1 on both coverage profiles).

        ShortReal-time vs Reconciled
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Real-time vs Reconciled) (Extension Type: code)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        36. Task.extension:revisitOutcome
        Slice NamerevisitOutcome
        Definition

        Outcome of a follow-up revisit to a previously-missed household/person (already-vaccinated | vaccinated-on-revisit | still-missing) — the 'outcome of the revisit' of the missed-children recording forms. Set on the person-targeted follow-up Task (Task.for = Patient, Task.focus = the originating Task that missed them) (forms-v1 / jul3-form-analysis §Aggregate #4).

        ShortOn a person-targeted follow-up Task: outcome of the revisit — already-vaccinated | vaccinated-on-revisit | still-missing (v0.21.0)
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Revisit Outcome) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-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())
        38. 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).

        ShortExtensions 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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Summaryfalse
        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 Namesextensions, user content
        Invariantsele-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())
        40. Task.identifier
        Definition

        The business identifier for this task.

        ShortTask Instance Identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. Task.instantiatesCanonical
        Definition

        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.

        ShortFormal definition of task
        Control0..1
        Typecanonical(ActivityDefinition)
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Enables a formal definition of how he task is to be performed, enabling automation.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        44. Task.instantiatesUri
        Definition

        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.

        ShortFormal definition of task
        Control0..1
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        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.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        46. Task.basedOn
        Definition

        BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to 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.

        ShortRequest fulfilled by this task
        Control0..*
        TypeReference(Resource)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        48. Task.groupIdentifier
        Definition

        An identifier that links together multiple tasks and other requests that were created in the same context.

        ShortRequisition or grouper id
        Control0..1
        TypeIdentifier
        Is Modifierfalse
        Summarytrue
        Requirements

        Billing and/or reporting can be linked to whether multiple requests were created as a single unit.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        50. Task.partOf
        Definition

        Task that this particular task is part of.

        ShortComposite task
        Comments

        This should usually be 0..1.

        Control0..*
        TypeReference(Task)
        Is Modifierfalse
        Summarytrue
        Requirements

        Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        52. Task.status
        Definition

        The current status of the task.

        Shortrequested → in-progress → completed / failed
        Control1..1
        BindingThe codes SHALL be taken from TaskStatus
        (required to http://hl7.org/fhir/ValueSet/task-status|4.0.1)

        The current status of the task.

        Typecode
        Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Requirements

        These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        54. Task.statusReason
        Definition

        An explanation as to why this task is held, failed, was refused, etc.

        ShortReason for current status
        Comments

        This applies to the current status. Look at the history of the task to see reasons for past statuses.

        Control0..1
        Binding

        Codes to identify the reason for current status. These will typically be specific to a particular workflow.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        56. Task.businessStatus
        Definition

        Contains business-specific nuances of the business state.

        ShortE.g. "Specimen collected", "IV prepped"
        Control0..1
        Binding

        The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Requirements

        There's often a need to track substates of a task - this is often variable by specific workflow implementation.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        58. Task.intent
        Definition

        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.

        Shortunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
        Comments

        This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.

        In most cases, Tasks will have an intent of "order".

        Control1..1
        BindingThe 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.

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        60. Task.priority
        Definition

        Indicates how quickly the Task should be addressed with respect to other requests.

        Shortroutine | urgent | asap | stat
        Control0..1
        BindingThe codes SHALL be taken from RequestPriority
        (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

        The task's priority.

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Requirements

        Used to identify the service level expected while performing a task.

        Meaning if MissingIf missing, this task should be performed with normal priority
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        62. Task.code
        Definition

        A name or code (or both) briefly describing what the task involves.

        ShortThe activity being performed
        Comments

        The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.

        Control1..1
        BindingFor 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.

        TypeCodeableConcept
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        64. Task.description
        Definition

        A free-text description of what is to be performed.

        ShortHuman-readable explanation of task
        Control0..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        66. Task.focus
        Definition

        The request being actioned or the resource being manipulated by this task.

        ShortWhat the task acts on: household/community delivery-unit Group (Type B/C — the norm) or site Location (Type A); a Patient only for person-targeted follow-up tasks
        Comments

        If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).

        Control1..1
        TypeReference(ICR Delivery Unit (Household / Community), ICR Location, Patient)
        Is Modifierfalse
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Summarytrue
        Requirements

        Used to identify the thing to be done.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        68. Task.for
        Definition

        The entity who benefits from the performance of the service specified in the task (e.g., the patient).

        ShortThe target subject/population
        Control0..1
        TypeReference(Resource)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        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 NamesPatient
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        70. Task.encounter
        Definition

        The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.

        ShortHealthcare event during which this task originated
        Control0..1
        TypeReference(Encounter)
        Is Modifierfalse
        Summarytrue
        Requirements

        For some tasks it may be important to know the link between the encounter the task originated within.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        72. Task.executionPeriod
        Definition

        Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).

        ShortStart and end time of execution
        Control0..1
        TypePeriod
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        74. Task.authoredOn
        Definition

        The date and time this task was created.

        ShortTask Creation Date
        Control0..1
        This element is affected by the following invariants: inv-1
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Requirements

        Most often used along with lastUpdated to track duration of task to supporting monitoring and management.

        Alternate NamesCreated Date
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        76. Task.lastModified
        Definition

        The date and time of last modification to this task.

        ShortTask Last Modified Date
        Control0..1
        This element is affected by the following invariants: inv-1
        TypedateTime
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

        Used along with history to track task activity and time in a particular task state. This enables monitoring and management.

        Alternate NamesUpdate Date
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        78. Task.requester
        Definition

        The creator of the task.

        ShortWho is asking for task to be done
        Control0..1
        TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
        Is Modifierfalse
        Summarytrue
        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).

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        80. Task.performerType
        Definition

        The kind of participant that should perform the task.

        ShortRequested performer
        Control0..*
        BindingThe 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.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        Use to distinguish tasks on different activity queues.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        82. Task.owner
        Definition

        Individual organization or Device currently responsible for task execution.

        ShortThe assigned ICRCareTeam — a real join, not a display string (v0.20.0): 'who worked this' and (via the supervisor) 'who reports this'
        Comments

        Tasks may be created with an owner not yet identified.

        Control0..1
        TypeReference(ICR Care Team)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Identifies who is expected to perform this task.

        Alternate NamesPerformer, Executer
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        84. Task.location
        Definition

        Principal physical location where the this task is performed.

        ShortWhere the work happens: settlement, school, post, or dwelling
        Control1..1
        TypeReference(ICR Location)
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        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).

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        86. Task.reasonCode
        Definition

        A description or code indicating why this task needs to be performed.

        ShortWhy task is needed
        Comments

        This should only be included if there is no focus or if it differs from the reason indicated on the focus.

        Control0..1
        Binding

        Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        88. Task.reasonReference
        Definition

        A resource reference indicating why this task needs to be performed.

        ShortWhy task is needed
        Comments

        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 Task.reasonCode if the data is free (uncoded) text.

        Control0..1
        TypeReference(Resource)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        90. Task.insurance
        Definition

        Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.

        ShortAssociated insurance coverage
        Control0..*
        TypeReference(Coverage, ClaimResponse)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        92. Task.note
        Definition

        Free-text information captured about the task as it progresses.

        ShortComments made about the task
        Control0..*
        TypeAnnotation
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        94. Task.relevantHistory
        Definition

        Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.

        ShortKey events in history of the Task
        Comments

        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.

        Control0..*
        TypeReference(Provenance)
        Is Modifierfalse
        Summaryfalse
        Alternate NamesStatus History
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        96. Task.restriction
        Definition

        If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.

        ShortConstraints on fulfillment tasks
        Control0..1
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        Requirements

        Sometimes when fulfillment is sought, you don't want full fulfillment.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        98. 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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        100. 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.

        ShortAdditional 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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        102. 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).

        ShortExtensions 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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        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 Namesextensions, user content, modifiers
        Invariantsele-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())
        104. Task.restriction.repetitions
        Definition

        Indicates the number of times the requested action should occur.

        ShortHow many times to repeat
        Control0..1
        TypepositiveInt
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Requirements

        E.g. order that requests monthly lab tests, fulfillment is sought for 1.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        106. Task.restriction.period
        Definition

        Over what time-period is fulfillment sought.

        ShortWhen fulfillment sought
        Comments

        Note that period.high is the due date representing the time by which the task should be completed.

        Control0..1
        TypePeriod
        Is Modifierfalse
        Summaryfalse
        Requirements

        E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        108. Task.restriction.recipient
        Definition

        For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?

        ShortFor whom is fulfillment sought?
        Control0..*
        TypeReference(Patient, Practitioner, PractitionerRole, RelatedPerson, Group, Organization)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        110. Task.input
        Definition

        Additional information that may be needed in the execution of the task.

        ShortInformation used to perform task
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Summaryfalse
        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 NamesSupporting Information
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        112. 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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        114. 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.

        ShortAdditional 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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        116. 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).

        ShortExtensions 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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        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 Namesextensions, user content, modifiers
        Invariantsele-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())
        118. Task.input.type
        Definition

        A code or description indicating how the input is intended to be used as part of the task execution.

        ShortLabel 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.

        Control1..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.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        Inputs are named to enable task automation to bind data and pass it from one task to the next.

        Alternate NamesName
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        120. Task.input.value[x]
        Definition

        The value of the input parameter as a basic type.

        ShortContent to use in performing the task
        Control1..1
        TypeChoice 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        122. Task.output
        Definition

        Outputs produced by the Task.

        ShortDelivery results: references to Immunization / MedicationAdministration / SupplyDelivery, or aggregate counts
        Control0..*
        TypeBackboneElement
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        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.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        124. 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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        126. 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.

        ShortAdditional 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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        128. 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).

        ShortExtensions 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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        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 Namesextensions, user content, modifiers
        Invariantsele-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())
        130. Task.output.type
        Definition

        The name of the Output parameter.

        ShortLabel for output
        Control1..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.

        TypeCodeableConcept
        Is Modifierfalse
        Summaryfalse
        Requirements

        Outputs are named to enable task automation to bind data and pass it from one task to the next.

        Alternate NamesName
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        132. Task.output.value[x]
        Definition

        The value of the Output parameter as a basic type.

        ShortResult of output
        Control1..1
        TypeChoice 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] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summaryfalse
        Requirements

        Task outputs can take any form.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))