Integrated Campaign Registry (ICR) Implementation Guide
0.1.0 - ci-build
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
| Official URL: https://icr.healthcampaigns.org/StructureDefinition/ICRCampaignTask | Version: 0.1.0 | |||
| Draft as of 2026-08-07 | Computable Name: ICRCampaignTask | |||
The assignable, trackable operational unit of work — one Task per site-session (Type A, focus = the site Location) or per household (Type B, focus = the household Group). Tasks may be pre-planned from the microplan or field-registered on discovery (the required task-origin code records which). Whether Tasks are assigned at village or household level is a configuration choice (working doc §7.4).
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Task |
C | 0..* | Task | A task to be performed Constraints: inv-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:deliveryStrategy |
S | 1..1 | CodeableConcept | Delivery Strategy URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy Binding: ICR Delivery Strategy (required) |
| extension:taskOrigin |
S | 1..1 | code | Task Origin URL: https://icr.healthcampaigns.org/StructureDefinition/task-origin Binding: ICR Task Origin (required) |
| extension:housesVisited |
0..1 | unsignedInt | Houses Visited URL: https://icr.healthcampaigns.org/StructureDefinition/houses-visited | |
| extension:eligiblePresent |
0..1 | unsignedInt | Eligible Persons Present URL: https://icr.healthcampaigns.org/StructureDefinition/eligible-present | |
| extension:eligibleAbsent |
0..1 | unsignedInt | Eligible Persons Absent URL: https://icr.healthcampaigns.org/StructureDefinition/eligible-absent | |
| extension:missedReason |
0..* | CodeableConcept | Missed Reason URL: https://icr.healthcampaigns.org/StructureDefinition/missed-reason Binding: ICR Missed Reason (extensible) | |
| extension:noncomplianceReason |
0..* | CodeableConcept | Refusal Reason URL: https://icr.healthcampaigns.org/StructureDefinition/noncompliance-reason Binding: ICR Refusal Reason (extensible) | |
| extension:exclusionReason |
0..* | CodeableConcept | Exclusion Reason URL: https://icr.healthcampaigns.org/StructureDefinition/exclusion-reason Binding: ICR Exclusion Reason (extensible) | |
| extension:fingerMarked |
0..1 | boolean | Finger Marked URL: https://icr.healthcampaigns.org/StructureDefinition/finger-marked | |
| extension:dataLineage |
0..1 | code | Real-time vs Reconciled URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) | |
 extension:revisitOutcome |
0..1 | CodeableConcept | On a person-targeted follow-up Task: outcome of the revisit — already-vaccinated | vaccinated-on-revisit | still-missing (v0.21.0) URL: https://icr.healthcampaigns.org/StructureDefinition/revisit-outcome Binding: ICR Revisit Outcome (extensible) | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | requested → in-progress → completed / failed Binding: TaskStatus (required): The current status of the task. |
| intent |
SΣ | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. |
 code |
SΣ | 1..1 | CodeableConcept | The activity being performed Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. |
 focus |
SΣ | 1..1 | Reference(ICR Delivery Unit (Household / Community) | ICR Location | Patient) | What the task acts on: household/community delivery-unit Group (Type B/C — the norm) or site Location (Type A); a Patient only for person-targeted follow-up tasks |
| for |
SΣ | 0..1 | Reference(Resource) | The target subject/population |
| executionPeriod |
SΣ | 0..1 | Period | Start and end time of execution |
| owner |
SΣ | 0..1 | Reference(ICR Care Team) | The assigned ICRCareTeam — a real join, not a display string (v0.20.0): 'who worked this' and (via the supervisor) 'who reports this' |
| location |
SΣ | 1..1 | Reference(ICR Location) | Where the work happens: settlement, school, post, or dwelling |
 output |
S | 0..* | BackboneElement | Delivery results: references to Immunization / MedicationAdministration / SupplyDelivery, or aggregate counts |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | Label for output Binding Description: (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. | |
 value[x] |
1..1 | Result of output | ||
| valueBase64Binary |
base64Binary | |||
| valueBoolean |
boolean | |||
| valueCanonical |
canonical(Any) | |||
| valueCode |
code | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueDecimal |
decimal | |||
| valueId |
id | |||
| valueInstant |
instant | |||
| valueInteger |
integer | |||
| valueMarkdown |
markdown | |||
| valueOid |
oid | |||
| valuePositiveInt |
positiveInt | |||
| valueString |
string | |||
| valueTime |
time | |||
| valueUnsignedInt |
unsignedInt | |||
| valueUri |
uri | |||
| valueUrl |
url | |||
| valueUuid |
uuid | |||
| valueAddress |
Address | |||
| valueAge |
Age | |||
| valueAnnotation |
Annotation | |||
| valueAttachment |
Attachment | |||
| valueCodeableConcept |
CodeableConcept | |||
| valueCoding |
Coding | |||
| valueContactPoint |
ContactPoint | |||
| valueCount |
Count | |||
| valueDistance |
Distance | |||
| valueDuration |
Duration | |||
| valueHumanName |
HumanName | |||
| valueIdentifier |
Identifier | |||
| valueMoney |
Money | |||
| valuePeriod |
Period | |||
| valueQuantity |
Quantity | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueReference |
Reference(Any) | |||
| valueSampledData |
SampledData | |||
| valueSignature |
Signature | |||
| valueTiming |
Timing | |||
| valueContactDetail |
ContactDetail | |||
| valueContributor |
Contributor | |||
| valueDataRequirement |
DataRequirement | |||
| valueExpression |
Expression | |||
| valueParameterDefinition |
ParameterDefinition | |||
| valueRelatedArtifact |
RelatedArtifact | |||
| valueTriggerDefinition |
TriggerDefinition | |||
| valueUsageContext |
UsageContext | |||
| valueDosage |
Dosage | |||
 valueMeta |
Meta | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Task.status | Base | required | TaskStatus | 📍4.0.1 | FHIR Std. |
| Task.intent | Base | required | TaskIntent | 📍4.0.1 | FHIR Std. |
| Task.code | Base | example | Task Codes | 📍4.0.1 | FHIR Std. |
| Task.output.type | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Task | 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 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Task | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. |
lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
|
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | Task | A task to be performed Constraints: inv-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:deliveryStrategy |
S | 1..1 | CodeableConcept | Delivery Strategy URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy Binding: ICR Delivery Strategy (required) | ||||
| extension:taskOrigin |
S | 1..1 | code | Task Origin URL: https://icr.healthcampaigns.org/StructureDefinition/task-origin Binding: ICR Task Origin (required) | ||||
| extension:housesVisited |
0..1 | unsignedInt | Houses Visited URL: https://icr.healthcampaigns.org/StructureDefinition/houses-visited | |||||
| extension:eligiblePresent |
0..1 | unsignedInt | Eligible Persons Present URL: https://icr.healthcampaigns.org/StructureDefinition/eligible-present | |||||
| extension:eligibleAbsent |
0..1 | unsignedInt | Eligible Persons Absent URL: https://icr.healthcampaigns.org/StructureDefinition/eligible-absent | |||||
| extension:missedReason |
0..* | CodeableConcept | Missed Reason URL: https://icr.healthcampaigns.org/StructureDefinition/missed-reason Binding: ICR Missed Reason (extensible) | |||||
| extension:noncomplianceReason |
0..* | CodeableConcept | Refusal Reason URL: https://icr.healthcampaigns.org/StructureDefinition/noncompliance-reason Binding: ICR Refusal Reason (extensible) | |||||
| extension:exclusionReason |
0..* | CodeableConcept | Exclusion Reason URL: https://icr.healthcampaigns.org/StructureDefinition/exclusion-reason Binding: ICR Exclusion Reason (extensible) | |||||
| extension:fingerMarked |
0..1 | boolean | Finger Marked URL: https://icr.healthcampaigns.org/StructureDefinition/finger-marked | |||||
| extension:dataLineage |
0..1 | code | Real-time vs Reconciled URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) | |||||
| extension:revisitOutcome |
0..1 | CodeableConcept | On a person-targeted follow-up Task: outcome of the revisit — already-vaccinated | vaccinated-on-revisit | still-missing (v0.21.0) URL: https://icr.healthcampaigns.org/StructureDefinition/revisit-outcome Binding: ICR Revisit Outcome (extensible) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Task Instance Identifier | |||||
| instantiatesCanonical |
Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
| instantiatesUri |
Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn |
Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| partOf |
Σ | 0..* | Reference(Task) | Composite task | ||||
| status |
?!SΣ | 1..1 | code | requested → in-progress → completed / failed Binding: TaskStatus (required): The current status of the task. | ||||
| statusReason |
Σ | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
| businessStatus |
Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding Description: (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| intent |
SΣ | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. | ||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | |||||
| code |
SΣ | 1..1 | CodeableConcept | The activity being performed Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||||
| description |
Σ | 0..1 | string | Human-readable explanation of task | ||||
| focus |
SΣ | 1..1 | Reference(ICR Delivery Unit (Household / Community) | ICR Location | Patient) | What the task acts on: household/community delivery-unit Group (Type B/C — the norm) or site Location (Type A); a Patient only for person-targeted follow-up tasks | ||||
| for |
SΣ | 0..1 | Reference(Resource) | The target subject/population | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
| executionPeriod |
SΣ | 0..1 | Period | Start and end time of execution | ||||
| authoredOn |
C | 0..1 | dateTime | Task Creation Date | ||||
| lastModified |
ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
| requester |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who is asking for task to be done | ||||
| performerType |
0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
| owner |
SΣ | 0..1 | Reference(ICR Care Team) | The assigned ICRCareTeam — a real join, not a display string (v0.20.0): 'who worked this' and (via the supervisor) 'who reports this' | ||||
| location |
SΣ | 1..1 | Reference(ICR Location) | Where the work happens: settlement, school, post, or dwelling | ||||
| reasonCode |
0..1 | CodeableConcept | Why task is needed Binding Description: (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
| reasonReference |
0..1 | Reference(Resource) | Why task is needed | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note |
0..* | Annotation | Comments made about the task | |||||
| relevantHistory |
0..* | Reference(Provenance) | Key events in history of the Task | |||||
| restriction |
0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| repetitions |
0..1 | positiveInt | How many times to repeat | |||||
| period |
0..1 | Period | When fulfillment sought | |||||
| recipient |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
| input |
0..* | BackboneElement | Information used to perform task | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (example): 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. | |||||
| value[x] |
1..1 | Content to use in performing the task | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| output |
S | 0..* | BackboneElement | Delivery results: references to Immunization / MedicationAdministration / SupplyDelivery, or aggregate counts | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for output Binding Description: (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. | |||||
| value[x] |
1..1 | Result of output | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Task.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Task.status | Base | required | TaskStatus | 📍4.0.1 | FHIR Std. |
| Task.statusReason | Base | example | Not State | Unknown | |
| Task.businessStatus | Base | example | Not State | Unknown | |
| Task.intent | Base | required | TaskIntent | 📍4.0.1 | FHIR Std. |
| Task.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Task.code | Base | example | Task Codes | 📍4.0.1 | FHIR Std. |
| Task.performerType | Base | preferred | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| Task.reasonCode | Base | example | Not State | Unknown | |
| Task.input.type | Base | example | Not State | Unknown | |
| Task.output.type | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Task | 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 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Task | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. |
lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
|
This structure is derived from Task
Summary
Mandatory: 5 elements
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Task |
C | 0..* | Task | A task to be performed Constraints: inv-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:deliveryStrategy |
S | 1..1 | CodeableConcept | Delivery Strategy URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy Binding: ICR Delivery Strategy (required) |
| extension:taskOrigin |
S | 1..1 | code | Task Origin URL: https://icr.healthcampaigns.org/StructureDefinition/task-origin Binding: ICR Task Origin (required) |
| extension:housesVisited |
0..1 | unsignedInt | Houses Visited URL: https://icr.healthcampaigns.org/StructureDefinition/houses-visited | |
| extension:eligiblePresent |
0..1 | unsignedInt | Eligible Persons Present URL: https://icr.healthcampaigns.org/StructureDefinition/eligible-present | |
| extension:eligibleAbsent |
0..1 | unsignedInt | Eligible Persons Absent URL: https://icr.healthcampaigns.org/StructureDefinition/eligible-absent | |
| extension:missedReason |
0..* | CodeableConcept | Missed Reason URL: https://icr.healthcampaigns.org/StructureDefinition/missed-reason Binding: ICR Missed Reason (extensible) | |
| extension:noncomplianceReason |
0..* | CodeableConcept | Refusal Reason URL: https://icr.healthcampaigns.org/StructureDefinition/noncompliance-reason Binding: ICR Refusal Reason (extensible) | |
| extension:exclusionReason |
0..* | CodeableConcept | Exclusion Reason URL: https://icr.healthcampaigns.org/StructureDefinition/exclusion-reason Binding: ICR Exclusion Reason (extensible) | |
| extension:fingerMarked |
0..1 | boolean | Finger Marked URL: https://icr.healthcampaigns.org/StructureDefinition/finger-marked | |
| extension:dataLineage |
0..1 | code | Real-time vs Reconciled URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) | |
| extension:revisitOutcome |
0..1 | CodeableConcept | On a person-targeted follow-up Task: outcome of the revisit — already-vaccinated | vaccinated-on-revisit | still-missing (v0.21.0) URL: https://icr.healthcampaigns.org/StructureDefinition/revisit-outcome Binding: ICR Revisit Outcome (extensible) | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| status |
?!SΣ | 1..1 | code | requested → in-progress → completed / failed Binding: TaskStatus (required): The current status of the task. |
| intent |
SΣ | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. |
| code |
SΣ | 1..1 | CodeableConcept | The activity being performed Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. |
| focus |
SΣ | 1..1 | Reference(ICR Delivery Unit (Household / Community) | ICR Location | Patient) | What the task acts on: household/community delivery-unit Group (Type B/C — the norm) or site Location (Type A); a Patient only for person-targeted follow-up tasks |
| for |
SΣ | 0..1 | Reference(Resource) | The target subject/population |
| executionPeriod |
SΣ | 0..1 | Period | Start and end time of execution |
| owner |
SΣ | 0..1 | Reference(ICR Care Team) | The assigned ICRCareTeam — a real join, not a display string (v0.20.0): 'who worked this' and (via the supervisor) 'who reports this' |
| location |
SΣ | 1..1 | Reference(ICR Location) | Where the work happens: settlement, school, post, or dwelling |
| output |
S | 0..* | BackboneElement | Delivery results: references to Immunization / MedicationAdministration / SupplyDelivery, or aggregate counts |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type |
1..1 | CodeableConcept | Label for output Binding Description: (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. | |
| value[x] |
1..1 | Result of output | ||
| valueBase64Binary |
base64Binary | |||
| valueBoolean |
boolean | |||
| valueCanonical |
canonical(Any) | |||
| valueCode |
code | |||
| valueDate |
date | |||
| valueDateTime |
dateTime | |||
| valueDecimal |
decimal | |||
| valueId |
id | |||
| valueInstant |
instant | |||
| valueInteger |
integer | |||
| valueMarkdown |
markdown | |||
| valueOid |
oid | |||
| valuePositiveInt |
positiveInt | |||
| valueString |
string | |||
| valueTime |
time | |||
| valueUnsignedInt |
unsignedInt | |||
| valueUri |
uri | |||
| valueUrl |
url | |||
| valueUuid |
uuid | |||
| valueAddress |
Address | |||
| valueAge |
Age | |||
| valueAnnotation |
Annotation | |||
| valueAttachment |
Attachment | |||
| valueCodeableConcept |
CodeableConcept | |||
| valueCoding |
Coding | |||
| valueContactPoint |
ContactPoint | |||
| valueCount |
Count | |||
| valueDistance |
Distance | |||
| valueDuration |
Duration | |||
| valueHumanName |
HumanName | |||
| valueIdentifier |
Identifier | |||
| valueMoney |
Money | |||
| valuePeriod |
Period | |||
| valueQuantity |
Quantity | |||
| valueRange |
Range | |||
| valueRatio |
Ratio | |||
| valueReference |
Reference(Any) | |||
| valueSampledData |
SampledData | |||
| valueSignature |
Signature | |||
| valueTiming |
Timing | |||
| valueContactDetail |
ContactDetail | |||
| valueContributor |
Contributor | |||
| valueDataRequirement |
DataRequirement | |||
| valueExpression |
Expression | |||
| valueParameterDefinition |
ParameterDefinition | |||
| valueRelatedArtifact |
RelatedArtifact | |||
| valueTriggerDefinition |
TriggerDefinition | |||
| valueUsageContext |
UsageContext | |||
| valueDosage |
Dosage | |||
| valueMeta |
Meta | |||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Task.status | Base | required | TaskStatus | 📍4.0.1 | FHIR Std. |
| Task.intent | Base | required | TaskIntent | 📍4.0.1 | FHIR Std. |
| Task.code | Base | example | Task Codes | 📍4.0.1 | FHIR Std. |
| Task.output.type | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Task | 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 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Task | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. |
lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
|
Differential View
This structure is derived from Task
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | Task | A task to be performed Constraints: inv-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:deliveryStrategy |
S | 1..1 | CodeableConcept | Delivery Strategy URL: https://icr.healthcampaigns.org/StructureDefinition/delivery-strategy Binding: ICR Delivery Strategy (required) | ||||
| extension:taskOrigin |
S | 1..1 | code | Task Origin URL: https://icr.healthcampaigns.org/StructureDefinition/task-origin Binding: ICR Task Origin (required) | ||||
| extension:housesVisited |
0..1 | unsignedInt | Houses Visited URL: https://icr.healthcampaigns.org/StructureDefinition/houses-visited | |||||
| extension:eligiblePresent |
0..1 | unsignedInt | Eligible Persons Present URL: https://icr.healthcampaigns.org/StructureDefinition/eligible-present | |||||
| extension:eligibleAbsent |
0..1 | unsignedInt | Eligible Persons Absent URL: https://icr.healthcampaigns.org/StructureDefinition/eligible-absent | |||||
| extension:missedReason |
0..* | CodeableConcept | Missed Reason URL: https://icr.healthcampaigns.org/StructureDefinition/missed-reason Binding: ICR Missed Reason (extensible) | |||||
| extension:noncomplianceReason |
0..* | CodeableConcept | Refusal Reason URL: https://icr.healthcampaigns.org/StructureDefinition/noncompliance-reason Binding: ICR Refusal Reason (extensible) | |||||
| extension:exclusionReason |
0..* | CodeableConcept | Exclusion Reason URL: https://icr.healthcampaigns.org/StructureDefinition/exclusion-reason Binding: ICR Exclusion Reason (extensible) | |||||
| extension:fingerMarked |
0..1 | boolean | Finger Marked URL: https://icr.healthcampaigns.org/StructureDefinition/finger-marked | |||||
| extension:dataLineage |
0..1 | code | Real-time vs Reconciled URL: https://icr.healthcampaigns.org/StructureDefinition/realtime-vs-reconciled Binding: ICR Data Lineage (required) | |||||
| extension:revisitOutcome |
0..1 | CodeableConcept | On a person-targeted follow-up Task: outcome of the revisit — already-vaccinated | vaccinated-on-revisit | still-missing (v0.21.0) URL: https://icr.healthcampaigns.org/StructureDefinition/revisit-outcome Binding: ICR Revisit Outcome (extensible) | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Task Instance Identifier | |||||
| instantiatesCanonical |
Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
| instantiatesUri |
Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn |
Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| partOf |
Σ | 0..* | Reference(Task) | Composite task | ||||
| status |
?!SΣ | 1..1 | code | requested → in-progress → completed / failed Binding: TaskStatus (required): The current status of the task. | ||||
| statusReason |
Σ | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
| businessStatus |
Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding Description: (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| intent |
SΣ | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. | ||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | |||||
| code |
SΣ | 1..1 | CodeableConcept | The activity being performed Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||||
| description |
Σ | 0..1 | string | Human-readable explanation of task | ||||
| focus |
SΣ | 1..1 | Reference(ICR Delivery Unit (Household / Community) | ICR Location | Patient) | What the task acts on: household/community delivery-unit Group (Type B/C — the norm) or site Location (Type A); a Patient only for person-targeted follow-up tasks | ||||
| for |
SΣ | 0..1 | Reference(Resource) | The target subject/population | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
| executionPeriod |
SΣ | 0..1 | Period | Start and end time of execution | ||||
| authoredOn |
C | 0..1 | dateTime | Task Creation Date | ||||
| lastModified |
ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
| requester |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who is asking for task to be done | ||||
| performerType |
0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
| owner |
SΣ | 0..1 | Reference(ICR Care Team) | The assigned ICRCareTeam — a real join, not a display string (v0.20.0): 'who worked this' and (via the supervisor) 'who reports this' | ||||
| location |
SΣ | 1..1 | Reference(ICR Location) | Where the work happens: settlement, school, post, or dwelling | ||||
| reasonCode |
0..1 | CodeableConcept | Why task is needed Binding Description: (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
| reasonReference |
0..1 | Reference(Resource) | Why task is needed | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note |
0..* | Annotation | Comments made about the task | |||||
| relevantHistory |
0..* | Reference(Provenance) | Key events in history of the Task | |||||
| restriction |
0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| repetitions |
0..1 | positiveInt | How many times to repeat | |||||
| period |
0..1 | Period | When fulfillment sought | |||||
| recipient |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
| input |
0..* | BackboneElement | Information used to perform task | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (example): 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. | |||||
| value[x] |
1..1 | Content to use in performing the task | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| output |
S | 0..* | BackboneElement | Delivery results: references to Immunization / MedicationAdministration / SupplyDelivery, or aggregate counts | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for output Binding Description: (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. | |||||
| value[x] |
1..1 | Result of output | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Task.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Task.status | Base | required | TaskStatus | 📍4.0.1 | FHIR Std. |
| Task.statusReason | Base | example | Not State | Unknown | |
| Task.businessStatus | Base | example | Not State | Unknown | |
| Task.intent | Base | required | TaskIntent | 📍4.0.1 | FHIR Std. |
| Task.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Task.code | Base | example | Task Codes | 📍4.0.1 | FHIR Std. |
| Task.performerType | Base | preferred | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| Task.reasonCode | Base | example | Not State | Unknown | |
| Task.input.type | Base | example | Not State | Unknown | |
| Task.output.type | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Task | 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 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Task | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. |
lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
|
This structure is derived from Task
Summary
Mandatory: 5 elements
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
