Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build
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
| Draft as of 2026-08-20 |
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. |
| 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)icr-task-h2h-outputs: House-to-house tally outputs (houses-visited, eligible-present, eligible-absent, children-already-marked) belong on house-to-house tasks — strategy determines which data elements exist (§8 principle 1), now machine-checkable. Warning severity: a mismatch is a data-quality signal, not always a recording error. ( extension('https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy').value.ofType(CodeableConcept).coding.exists(code = 'house-to-house') or output.type.coding.where(code = 'houses-visited' or code = 'eligible-present' or code = 'eligible-absent' or code = 'children-already-marked').empty())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.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. |
| Short | ExtensionAdditional 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 | 20..* |
| 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()) |
| Slicing | This element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Task.extension:deliveryStrategy | |
| Slice Name | deliveryStrategy |
| Definition | How this activity/task reaches its target population. First-class and coded because a single campaign routinely mixes strategies, and the strategy governs which data elements exist. The protocol lists the options (1..*), the Task records the choice (1..1), the activity is an optional pin — the strategy is campaign programme state and deliberately does NOT live on Location: per the georegistry rule a site's durable kind is Location.type (facility, temporary-post, school…), and which strategy a site serves in a given campaign belongs to that campaign's Tasks (working doc §3). |
| Short | Delivery Strategy |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Delivery Strategy) (Extension 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())) 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 Name | taskOrigin |
| 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). |
| Short | Task Origin |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Task Origin) (Extension Type: code) |
| 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())) 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:dataLineage | |
| Slice Name | dataLineage |
| 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). |
| Short | Real-time vs Reconciled |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(Real-time vs Reconciled) (Extension Type: code) |
| Is Modifier | false |
| Summary | false |
| 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())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 12. 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()) |
| 14. 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. |
| Short | The activity this task carries out — the structured definition-to-execution link (same convention as CarePlan → Protocol). Carries the work definition (product, dose, intervention code) so multi-activity campaigns stay queryable per activity; Task.code is only the human-readable label. Optional: an ad-hoc field task may have no single activityFormal definition of task |
| Control | 0..1 |
| Type | canonical(ICR Campaign Activity, 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())) |
| 16. 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. |
| Short | The campaign (round) this task executes. Tasks point at the campaign — the CarePlan is never updated as tasks are createdRequest fulfilled by this task |
| Control | 10..1* |
| Type | Reference(ICR Campaign, Resource) |
| 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())) |
| 18. Task.status | |
| Definition | The current status of the task. |
| Short | requested → in-progress → completed / faileddraft | requested | received | accepted | + |
| 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|4.0.1)The current status of the task. |
| 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.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. |
| Short | unknown | 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". |
| 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 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. Task.code | |
| Definition | A name or code (or both) briefly describing what the task involves. |
| Short | The activity being performedTask Type |
| Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. |
| Control | 10..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())) |
| 24. Task.for | |
| Definition | The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
| Short | What the task acts on: a delivery-unit Group where the unit has members (household, community, school cohort) or a Location where it does not (site, structure, area); a Patient only for person-targeted follow-up tasksBeneficiary of the Task |
| Control | 10..1 |
| Type | Reference(ICR Delivery Unit (Household / Community / School Cohort), ICR Location, Patient, Resource) |
| Is Modifier | false |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| 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())) |
| 26. 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). |
| Short | Start and end time of execution |
| 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())) |
| 28. Task.owner | |
| Definition | Individual organization or Device currently responsible for task execution. |
| Short | The 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. |
| Control | 0..1 |
| Type | Reference(ICR Care Team, 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())) |
| 30. Task.location | |
| Definition | Principal physical location where the this task is performed. |
| Short | Where the work happens: settlement, school, post, or dwellingWhere task occurs |
| Control | 10..1 |
| Type | Reference(ICR Location, 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())) |
| 32. Task.reasonCode | |
| Definition | A description or code indicating why this task needs to be performed. |
| Short | The disease/programme this Task serves — scopes a Task to one disease where a community runs several concurrent programmes (per-village disease scoping in co-endemic MDA)Why 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. |
| 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())) |
| 34. Task.output | |
| Definition | Outputs produced by the Task. |
| Short | Everything the visit produced, as coded entries: the scalar tally (treated-count), the house-to-house axes (houses-visited, eligible-present/absent, children-already-marked), reason codes (missed/refusal/exclusion), revisit outcome, and references to delivery events and the stratified coverage reportInformation produced as part of task |
| 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())) |
| Slicing | This element introduces a set of slices on Task.output. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 36. 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()) |
| 38. Task.output.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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())) |
| 40. 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())) |
| 42. Task.output:treatedCount | |
| Slice Name | treatedCount |
| Definition | Outputs produced by the Task. |
| Short | Information produced as part of task |
| Control | 0..1* |
| Type | BackboneElement |
| Is Modifier | false |
| 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())) |
| 44. Task.output:treatedCount.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()) |
| 46. Task.output:treatedCount.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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 |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. Task.output:treatedCount.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Type | unsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time |
| [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())) |
| 50. Task.output:housesVisited | |
| Slice Name | housesVisited |
| Definition | Outputs produced by the Task. |
| Short | (house-to-house, area/team-day granularity) Houses visitedInformation produced as part of task |
| Control | 0..1* |
| Type | BackboneElement |
| Is Modifier | false |
| 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())) |
| 52. Task.output:housesVisited.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()) |
| 54. Task.output:housesVisited.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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 |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. Task.output:housesVisited.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Type | unsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time |
| [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())) |
| 58. Task.output:eligiblePresent | |
| Slice Name | eligiblePresent |
| Definition | Outputs produced by the Task. |
| Short | (house-to-house) Eligible persons present — program-neutral: under-5s for polio, household members for ITN registration, the eligible band for MDAInformation produced as part of task |
| Control | 0..1* |
| Type | BackboneElement |
| Is Modifier | false |
| 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())) |
| 60. Task.output:eligiblePresent.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()) |
| 62. Task.output:eligiblePresent.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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 |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. Task.output:eligiblePresent.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Type | unsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time |
| [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())) |
| 66. Task.output:eligibleAbsent | |
| Slice Name | eligibleAbsent |
| Definition | Outputs produced by the Task. |
| Short | (house-to-house) Eligible persons absent — feeds same-day mop-up listsInformation produced as part of task |
| Control | 0..1* |
| Type | BackboneElement |
| Is Modifier | false |
| 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())) |
| 68. Task.output:eligibleAbsent.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.output:eligibleAbsent.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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 |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. Task.output:eligibleAbsent.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Type | unsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time |
| [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())) |
| 74. Task.output:childrenAlreadyMarked | |
| Slice Name | childrenAlreadyMarked |
| Definition | Outputs produced by the Task. |
| Short | (house-to-house) Children found already finger-marked on arrival — a count, since a visit sees several children (replaces the retired boolean finger-marked extension)Information produced as part of task |
| Control | 0..1* |
| Type | BackboneElement |
| Is Modifier | false |
| 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:childrenAlreadyMarked.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:childrenAlreadyMarked.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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 |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. Task.output:childrenAlreadyMarked.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Type | unsignedInt, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, time |
| [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())) |
| 82. Task.output:missedReason | |
| Slice Name | missedReason |
| Definition | Outputs produced by the Task. |
| Short | Why eligible person(s) were missed — person-level (absent, sleeping) and area-level (insecurity, shortage, access) causesInformation produced as part of task |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| 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())) |
| 84. Task.output:missedReason.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()) |
| 86. Task.output:missedReason.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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 |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. Task.output:missedReason.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see ICR Missed Reason (extensible to https://icr.healthcampaigns.org/ValueSet/icr-missed-reason) |
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| 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())) |
| 90. Task.output:noncomplianceReason | |
| Slice Name | noncomplianceReason |
| Definition | Outputs produced by the Task. |
| Short | Why the household/caregiver refused (WHO IDHC 'intervention refusal')Information produced as part of task |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| 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())) |
| 92. Task.output:noncomplianceReason.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()) |
| 94. Task.output:noncomplianceReason.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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 |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 96. Task.output:noncomplianceReason.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see ICR Refusal Reason (extensible to https://icr.healthcampaigns.org/ValueSet/icr-noncompliance-reason) |
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| 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())) |
| 98. Task.output:exclusionReason | |
| Slice Name | exclusionReason |
| Definition | Outputs produced by the Task. |
| Short | Why a present, age-eligible person was clinically excluded this round (under-height/age, pregnant, breastfeeding)Information produced as part of task |
| Control | 0..* |
| Type | BackboneElement |
| Is Modifier | false |
| 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())) |
| 100. Task.output:exclusionReason.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()) |
| 102. Task.output:exclusionReason.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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 |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 104. Task.output:exclusionReason.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see ICR Exclusion Reason (extensible to https://icr.healthcampaigns.org/ValueSet/icr-exclusion-reason) |
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| 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())) |
| 106. Task.output:revisitOutcome | |
| Slice Name | revisitOutcome |
| Definition | Outputs produced by the Task. |
| Short | On a person-targeted follow-up Task: already-vaccinated | vaccinated-on-revisit | still-missingInformation produced as part of task |
| Control | 0..1* |
| Type | BackboneElement |
| Is Modifier | false |
| 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())) |
| 108. Task.output:revisitOutcome.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()) |
| 110. Task.output:revisitOutcome.type | |
| Definition | The name of the Output parameter. |
| Short | Label for output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 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 |
| Pattern Value | { |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 112. Task.output:revisitOutcome.value[x] | |
| Definition | The value of the Output parameter as a basic type. |
| Short | Result of output |
| Control | 1..1 |
| Binding | Unless not suitable, these codes SHALL be taken from For codes, see ICR Revisit Outcome (extensible to https://icr.healthcampaigns.org/ValueSet/icr-revisit-outcome) |
| Type | CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| 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 | icr-task-h2h-outputs: House-to-house tally outputs (houses-visited, eligible-present, eligible-absent, children-already-marked) belong on house-to-house tasks — strategy determines which data elements exist (§8 principle 1), now machine-checkable. Warning severity: a mismatch is a data-quality signal, not always a recording error. (extension('https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy').value.ofType(CodeableConcept).coding.exists(code = 'house-to-house') or output.type.coding.where(code = 'houses-visited' or code = 'eligible-present' or code = 'eligible-absent' or code = 'children-already-marked').empty()) |
| 2. Task.extension | |
| Control | 2..? |
| Slicing | This element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Task.extension:deliveryStrategy | |
| Slice Name | deliveryStrategy |
| Control | 1..1 |
| Type | Extension(Delivery Strategy) (Extension Type: CodeableConcept) |
| Must Support | true |
| 6. Task.extension:taskOrigin | |
| Slice Name | taskOrigin |
| Control | 1..1 |
| Type | Extension(Task Origin) (Extension Type: code) |
| Must Support | true |
| 8. Task.extension:dataLineage | |
| Slice Name | dataLineage |
| Control | 0..1 |
| Type | Extension(Real-time vs Reconciled) (Extension Type: code) |
| 10. Task.instantiatesCanonical | |
| Short | The activity this task carries out — the structured definition-to-execution link (same convention as CarePlan → Protocol). Carries the work definition (product, dose, intervention code) so multi-activity campaigns stay queryable per activity; Task.code is only the human-readable label. Optional: an ad-hoc field task may have no single activity |
| Type | canonical(ICR Campaign Activity) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 12. Task.basedOn | |
| Short | The campaign (round) this task executes. Tasks point at the campaign — the CarePlan is never updated as tasks are created |
| Control | 1..1 |
| Type | Reference(ICR Campaign) |
| Must Support | true |
| 14. Task.status | |
| Short | requested → in-progress → completed / failed |
| Must Support | true |
| 16. Task.intent | |
| Must Support | true |
| 18. Task.code | |
| Short | The activity being performed |
| Control | 1..? |
| Must Support | true |
| 20. Task.for | |
| Short | What the task acts on: a delivery-unit Group where the unit has members (household, community, school cohort) or a Location where it does not (site, structure, area); a Patient only for person-targeted follow-up tasks |
| Control | 1..? |
| Type | Reference(ICR Delivery Unit (Household / Community / School Cohort), ICR Location, Patient) |
| Must Support | true |
| Must Support Types | No must-support rules about the choice of types/profiles |
| 22. Task.executionPeriod | |
| Must Support | true |
| 24. Task.owner | |
| Short | The assigned ICRCareTeam — a real join, not a display string (v0.20.0): 'who worked this' and (via the supervisor) 'who reports this' |
| Type | Reference(ICR Care Team) |
| Must Support | true |
| 26. Task.location | |
| Short | Where the work happens: settlement, school, post, or dwelling |
| Control | 1..? |
| Type | Reference(ICR Location) |
| Must Support | true |
| 28. Task.reasonCode | |
| Short | The disease/programme this Task serves — scopes a Task to one disease where a community runs several concurrent programmes (per-village disease scoping in co-endemic MDA) |
| Must Support | true |
| 30. Task.output | |
| Short | Everything the visit produced, as coded entries: the scalar tally (treated-count), the house-to-house axes (houses-visited, eligible-present/absent, children-already-marked), reason codes (missed/refusal/exclusion), revisit outcome, and references to delivery events and the stratified coverage report |
| Must Support | true |
| Slicing | This element introduces a set of slices on Task.output. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 32. Task.output.type | |
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) |
| 34. Task.output:treatedCount | |
| Slice Name | treatedCount |
| Control | 0..1 |
| 36. Task.output:treatedCount.type | |
| Pattern Value | { |
| 38. Task.output:treatedCount.value[x] | |
| Type | unsignedInt |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 40. Task.output:housesVisited | |
| Slice Name | housesVisited |
| Short | (house-to-house, area/team-day granularity) Houses visited |
| Control | 0..1 |
| 42. Task.output:housesVisited.type | |
| Pattern Value | { |
| 44. Task.output:housesVisited.value[x] | |
| Type | unsignedInt |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 46. Task.output:eligiblePresent | |
| Slice Name | eligiblePresent |
| Short | (house-to-house) Eligible persons present — program-neutral: under-5s for polio, household members for ITN registration, the eligible band for MDA |
| Control | 0..1 |
| 48. Task.output:eligiblePresent.type | |
| Pattern Value | { |
| 50. Task.output:eligiblePresent.value[x] | |
| Type | unsignedInt |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 52. Task.output:eligibleAbsent | |
| Slice Name | eligibleAbsent |
| Short | (house-to-house) Eligible persons absent — feeds same-day mop-up lists |
| Control | 0..1 |
| 54. Task.output:eligibleAbsent.type | |
| Pattern Value | { |
| 56. Task.output:eligibleAbsent.value[x] | |
| Type | unsignedInt |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 58. Task.output:childrenAlreadyMarked | |
| Slice Name | childrenAlreadyMarked |
| Short | (house-to-house) Children found already finger-marked on arrival — a count, since a visit sees several children (replaces the retired boolean finger-marked extension) |
| Control | 0..1 |
| 60. Task.output:childrenAlreadyMarked.type | |
| Pattern Value | { |
| 62. Task.output:childrenAlreadyMarked.value[x] | |
| Type | unsignedInt |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 64. Task.output:missedReason | |
| Slice Name | missedReason |
| Short | Why eligible person(s) were missed — person-level (absent, sleeping) and area-level (insecurity, shortage, access) causes |
| Control | 0..* |
| 66. Task.output:missedReason.type | |
| Pattern Value | { |
| 68. Task.output:missedReason.value[x] | |
| Binding | Unless not suitable, these codes SHALL be taken from ICR Missed Reason (extensible to https://icr.healthcampaigns.org/ValueSet/icr-missed-reason) |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 70. Task.output:noncomplianceReason | |
| Slice Name | noncomplianceReason |
| Short | Why the household/caregiver refused (WHO IDHC 'intervention refusal') |
| Control | 0..* |
| 72. Task.output:noncomplianceReason.type | |
| Pattern Value | { |
| 74. Task.output:noncomplianceReason.value[x] | |
| Binding | Unless not suitable, these codes SHALL be taken from ICR Refusal Reason (extensible to https://icr.healthcampaigns.org/ValueSet/icr-noncompliance-reason) |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 76. Task.output:exclusionReason | |
| Slice Name | exclusionReason |
| Short | Why a present, age-eligible person was clinically excluded this round (under-height/age, pregnant, breastfeeding) |
| Control | 0..* |
| 78. Task.output:exclusionReason.type | |
| Pattern Value | { |
| 80. Task.output:exclusionReason.value[x] | |
| Binding | Unless not suitable, these codes SHALL be taken from ICR Exclusion Reason (extensible to https://icr.healthcampaigns.org/ValueSet/icr-exclusion-reason) |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| 82. Task.output:revisitOutcome | |
| Slice Name | revisitOutcome |
| Short | On a person-targeted follow-up Task: already-vaccinated | vaccinated-on-revisit | still-missing |
| Control | 0..1 |
| 84. Task.output:revisitOutcome.type | |
| Pattern Value | { |
| 86. Task.output:revisitOutcome.value[x] | |
| Binding | Unless not suitable, these codes SHALL be taken from ICR Revisit Outcome (extensible to https://icr.healthcampaigns.org/ValueSet/icr-revisit-outcome) |
| Type | CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
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)icr-task-h2h-outputs: House-to-house tally outputs (houses-visited, eligible-present, eligible-absent, children-already-marked) belong on house-to-house tasks — strategy determines which data elements exist (§8 principle 1), now machine-checkable. Warning severity: a mismatch is a data-quality signal, not always a recording error. ( extension('https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy').value.ofType(CodeableConcept).coding.exists(code = 'house-to-house') or output.type.coding.where(code = 'houses-visited' or code = 'eligible-present' or code = 'eligible-absent' or code = 'children-already-marked').empty()) | ||||
| 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 | An Extension | ||||
| Short | Extension | ||||
| Control | 2..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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()) | ||||
| Slicing | This element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. Task.extension:deliveryStrategy | |||||
| Slice Name | deliveryStrategy | ||||
| Definition | How this activity/task reaches its target population. First-class and coded because a single campaign routinely mixes strategies, and the strategy governs which data elements exist. The protocol lists the options (1..*), the Task records the choice (1..1), the activity is an optional pin — the strategy is campaign programme state and deliberately does NOT live on Location: per the georegistry rule a site's durable kind is Location.type (facility, temporary-post, school…), and which strategy a site serves in a given campaign belongs to that campaign's Tasks (working doc §3). | ||||
| Short | Delivery Strategy | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Delivery Strategy) (Extension 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()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. Task.extension:taskOrigin | |||||
| Slice Name | taskOrigin | ||||
| 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). | ||||
| Short | Task Origin | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Task Origin) (Extension Type: code) | ||||
| 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()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. Task.extension:dataLineage | |||||
| Slice Name | dataLineage | ||||
| 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). | ||||
| Short | Real-time vs Reconciled | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Real-time vs Reconciled) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| 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()) | ||||
| 22. 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()) | ||||
| 24. Task.identifier | |||||
| Definition | The business identifier for this task. | ||||
| Short | Task Instance Identifier | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. 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. | ||||
| Short | The activity this task carries out — the structured definition-to-execution link (same convention as CarePlan → Protocol). Carries the work definition (product, dose, intervention code) so multi-activity campaigns stay queryable per activity; Task.code is only the human-readable label. Optional: an ad-hoc field task may have no single activity | ||||
| Control | 0..1 | ||||
| Type | canonical(ICR Campaign Activity) | ||||
| 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())) | ||||
| 28. 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. | ||||
| Short | Formal definition of task | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 30. 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. | ||||
| Short | The campaign (round) this task executes. Tasks point at the campaign — the CarePlan is never updated as tasks are created | ||||
| Control | 1..1 | ||||
| Type | Reference(ICR Campaign) | ||||
| 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())) | ||||
| 32. Task.groupIdentifier | |||||
| Definition | An identifier that links together multiple tasks and other requests that were created in the same context. | ||||
| Short | Requisition or grouper id | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 34. Task.partOf | |||||
| Definition | Task that this particular task is part of. | ||||
| Short | Composite task | ||||
| Comments | This should usually be 0..1. | ||||
| Control | 0..* | ||||
| Type | Reference(Task) | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 36. Task.status | |||||
| Definition | The current status of the task. | ||||
| Short | requested → in-progress → completed / failed | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from TaskStatus (required to http://hl7.org/fhir/ValueSet/task-status|4.0.1)The current status of the task. | ||||
| 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())) | ||||
| 38. Task.statusReason | |||||
| Definition | An explanation as to why this task is held, failed, was refused, etc. | ||||
| Short | Reason for current status | ||||
| Comments | 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 | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. Task.businessStatus | |||||
| Definition | Contains business-specific nuances of the business state. | ||||
| Short | E.g. "Specimen collected", "IV prepped" | ||||
| 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 | ||||
| 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())) | ||||
| 42. 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. | ||||
| Short | unknown | 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". | ||||
| 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 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. Task.priority | |||||
| Definition | Indicates how quickly the Task should be addressed with respect to other requests. | ||||
| Short | routine | urgent | asap | stat | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)The task's priority. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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())) | ||||
| 46. Task.code | |||||
| Definition | A name or code (or both) briefly describing what the task involves. | ||||
| Short | The activity being performed | ||||
| Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. | ||||
| Control | 1..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())) | ||||
| 48. Task.description | |||||
| Definition | A free-text description of what is to be performed. | ||||
| Short | Human-readable explanation of task | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 50. Task.focus | |||||
| Definition | The request being actioned or the resource being manipulated by this task. | ||||
| Short | What 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.). | ||||
| Control | 0..1 | ||||
| Type | Reference(Resource) | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 52. Task.for | |||||
| Definition | The entity who benefits from the performance of the service specified in the task (e.g., the patient). | ||||
| Short | What the task acts on: a delivery-unit Group where the unit has members (household, community, school cohort) or a Location where it does not (site, structure, area); a Patient only for person-targeted follow-up tasks | ||||
| Control | 1..1 | ||||
| Type | Reference(ICR Delivery Unit (Household / Community / School Cohort), ICR Location, Patient) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Must Support Types | No must-support rules about the choice of types/profiles | ||||
| 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())) | ||||
| 54. Task.encounter | |||||
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. | ||||
| Short | Healthcare event during which this task originated | ||||
| Control | 0..1 | ||||
| Type | Reference(Encounter) | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 56. 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). | ||||
| Short | Start and end time of execution | ||||
| 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())) | ||||
| 58. Task.authoredOn | |||||
| Definition | The date and time this task was created. | ||||
| Short | Task Creation Date | ||||
| 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 | ||||
| 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())) | ||||
| 60. Task.lastModified | |||||
| Definition | The date and time of last modification to this task. | ||||
| Short | Task Last Modified Date | ||||
| 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 | ||||
| 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())) | ||||
| 62. Task.requester | |||||
| Definition | The creator of the task. | ||||
| Short | Who is asking for task to be done | ||||
| Control | 0..1 | ||||
| Type | Reference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson) | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 64. Task.performerType | |||||
| Definition | The kind of participant that should perform the task. | ||||
| Short | Requested performer | ||||
| 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 | ||||
| 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())) | ||||
| 66. Task.owner | |||||
| Definition | Individual organization or Device currently responsible for task execution. | ||||
| Short | The 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. | ||||
| Control | 0..1 | ||||
| Type | Reference(ICR Care Team) | ||||
| 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())) | ||||
| 68. Task.location | |||||
| Definition | Principal physical location where the this task is performed. | ||||
| Short | Where the work happens: settlement, school, post, or dwelling | ||||
| Control | 1..1 | ||||
| Type | Reference(ICR 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())) | ||||
| 70. Task.reasonCode | |||||
| Definition | A description or code indicating why this task needs to be performed. | ||||
| Short | The disease/programme this Task serves — scopes a Task to one disease where a community runs several concurrent programmes (per-village disease scoping in co-endemic MDA) | ||||
| Comments | 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())) | ||||
| 72. Task.reasonReference | |||||
| Definition | A resource reference indicating why this task needs to be performed. | ||||
| Short | Why 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 | ||||
| Control | 0..1 | ||||
| Type | Reference(Resource) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. Task.insurance | |||||
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. | ||||
| Short | Associated insurance coverage | ||||
| Control | 0..* | ||||
| Type | Reference(Coverage, ClaimResponse) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. Task.note | |||||
| Definition | Free-text information captured about the task as it progresses. | ||||
| Short | Comments made about the task | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 78. 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. | ||||
| Short | Key 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. | ||||
| Control | 0..* | ||||
| Type | Reference(Provenance) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | Status History | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 80. 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. | ||||
| Short | Constraints on fulfillment tasks | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 82. 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 | ||||
| 84. 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()) | ||||
| 86. 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()) | ||||
| 88. 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())) | ||||
| 90. 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())) | ||||
| 92. 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())) | ||||
| 94. Task.input | |||||
| Definition | Additional information that may be needed in the execution of the task. | ||||
| Short | Information used to perform task | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 96. 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 | ||||
| 98. 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()) | ||||
| 100. 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()) | ||||
| 102. 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())) | ||||
| 104. 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())) | ||||
| 106. Task.output | |||||
| Definition | Outputs produced by the Task. | ||||
| Short | Everything the visit produced, as coded entries: the scalar tally (treated-count), the house-to-house axes (houses-visited, eligible-present/absent, children-already-marked), reason codes (missed/refusal/exclusion), revisit outcome, and references to delivery events and the stratified coverage report | ||||
| 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())) | ||||
| Slicing | This element introduces a set of slices on Task.output. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 108. 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 | ||||
| 110. 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()) | ||||
| 112. 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()) | ||||
| 114. Task.output.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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())) | ||||
| 116. 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())) | ||||
| 118. Task.output:treatedCount | |||||
| Slice Name | treatedCount | ||||
| Definition | Outputs produced by the Task. | ||||
| Short | Information produced as part of task | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 120. Task.output:treatedCount.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 | ||||
| 122. Task.output:treatedCount.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()) | ||||
| 124. Task.output:treatedCount.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()) | ||||
| 126. Task.output:treatedCount.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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 | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 128. Task.output:treatedCount.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Type | unsignedInt | ||||
| [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())) | ||||
| 130. Task.output:housesVisited | |||||
| Slice Name | housesVisited | ||||
| Definition | Outputs produced by the Task. | ||||
| Short | (house-to-house, area/team-day granularity) Houses visited | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 132. Task.output:housesVisited.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 | ||||
| 134. Task.output:housesVisited.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()) | ||||
| 136. Task.output:housesVisited.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()) | ||||
| 138. Task.output:housesVisited.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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 | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 140. Task.output:housesVisited.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Type | unsignedInt | ||||
| [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())) | ||||
| 142. Task.output:eligiblePresent | |||||
| Slice Name | eligiblePresent | ||||
| Definition | Outputs produced by the Task. | ||||
| Short | (house-to-house) Eligible persons present — program-neutral: under-5s for polio, household members for ITN registration, the eligible band for MDA | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 144. Task.output:eligiblePresent.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 | ||||
| 146. Task.output:eligiblePresent.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()) | ||||
| 148. Task.output:eligiblePresent.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()) | ||||
| 150. Task.output:eligiblePresent.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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 | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 152. Task.output:eligiblePresent.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Type | unsignedInt | ||||
| [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())) | ||||
| 154. Task.output:eligibleAbsent | |||||
| Slice Name | eligibleAbsent | ||||
| Definition | Outputs produced by the Task. | ||||
| Short | (house-to-house) Eligible persons absent — feeds same-day mop-up lists | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 156. Task.output:eligibleAbsent.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 | ||||
| 158. Task.output:eligibleAbsent.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()) | ||||
| 160. Task.output:eligibleAbsent.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()) | ||||
| 162. Task.output:eligibleAbsent.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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 | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 164. Task.output:eligibleAbsent.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Type | unsignedInt | ||||
| [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())) | ||||
| 166. Task.output:childrenAlreadyMarked | |||||
| Slice Name | childrenAlreadyMarked | ||||
| Definition | Outputs produced by the Task. | ||||
| Short | (house-to-house) Children found already finger-marked on arrival — a count, since a visit sees several children (replaces the retired boolean finger-marked extension) | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 168. Task.output:childrenAlreadyMarked.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 | ||||
| 170. Task.output:childrenAlreadyMarked.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()) | ||||
| 172. Task.output:childrenAlreadyMarked.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()) | ||||
| 174. Task.output:childrenAlreadyMarked.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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 | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 176. Task.output:childrenAlreadyMarked.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Type | unsignedInt | ||||
| [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())) | ||||
| 178. Task.output:missedReason | |||||
| Slice Name | missedReason | ||||
| Definition | Outputs produced by the Task. | ||||
| Short | Why eligible person(s) were missed — person-level (absent, sleeping) and area-level (insecurity, shortage, access) causes | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 180. Task.output:missedReason.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 | ||||
| 182. Task.output:missedReason.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()) | ||||
| 184. Task.output:missedReason.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()) | ||||
| 186. Task.output:missedReason.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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 | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 188. Task.output:missedReason.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Missed Reason (extensible to https://icr.healthcampaigns.org/ValueSet/icr-missed-reason) | ||||
| Type | CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 190. Task.output:noncomplianceReason | |||||
| Slice Name | noncomplianceReason | ||||
| Definition | Outputs produced by the Task. | ||||
| Short | Why the household/caregiver refused (WHO IDHC 'intervention refusal') | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 192. Task.output:noncomplianceReason.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 | ||||
| 194. Task.output:noncomplianceReason.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()) | ||||
| 196. Task.output:noncomplianceReason.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()) | ||||
| 198. Task.output:noncomplianceReason.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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 | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 200. Task.output:noncomplianceReason.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Refusal Reason (extensible to https://icr.healthcampaigns.org/ValueSet/icr-noncompliance-reason) | ||||
| Type | CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 202. Task.output:exclusionReason | |||||
| Slice Name | exclusionReason | ||||
| Definition | Outputs produced by the Task. | ||||
| Short | Why a present, age-eligible person was clinically excluded this round (under-height/age, pregnant, breastfeeding) | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 204. Task.output:exclusionReason.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 | ||||
| 206. Task.output:exclusionReason.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()) | ||||
| 208. Task.output:exclusionReason.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()) | ||||
| 210. Task.output:exclusionReason.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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 | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 212. Task.output:exclusionReason.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Exclusion Reason (extensible to https://icr.healthcampaigns.org/ValueSet/icr-exclusion-reason) | ||||
| Type | CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 214. Task.output:revisitOutcome | |||||
| Slice Name | revisitOutcome | ||||
| Definition | Outputs produced by the Task. | ||||
| Short | On a person-targeted follow-up Task: already-vaccinated | vaccinated-on-revisit | still-missing | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| 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())) | ||||
| 216. Task.output:revisitOutcome.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 | ||||
| 218. Task.output:revisitOutcome.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()) | ||||
| 220. Task.output:revisitOutcome.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()) | ||||
| 222. Task.output:revisitOutcome.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Task Output Type (extensible to https://icr.healthcampaigns.org/ValueSet/icr-task-output-type) | ||||
| 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 | ||||
| Pattern Value | { | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 224. Task.output:revisitOutcome.value[x] | |||||
| Definition | The value of the Output parameter as a basic type. | ||||
| Short | Result of output | ||||
| Control | 1..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ICR Revisit Outcome (extensible to https://icr.healthcampaigns.org/ValueSet/icr-revisit-outcome) | ||||
| Type | CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| 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())) | ||||