Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutreachTask | Version: 0.1.3 | |||
| Active as of 2026-10-13 | Computable Name: OutreachTask | |||
Task FHIR resource for the outreach referral service
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 |
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 basedOn |
1..1 | Reference(ServiceRequest) | Request fulfilled by this task | |
 status |
1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. | |
| intent |
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. | |
 for |
1..1 | Reference(Patient) | Beneficiary of the Task | |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Task |
0..* | Task | A task to be performed | |
 implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Contained, inline Resources | ||
| instantiatesCanonical |
0..0 | Formal definition of task | ||
| instantiatesUri |
0..0 | Formal definition of task | ||
| basedOn |
1..1 | Reference(ServiceRequest) | Request fulfilled by this task | |
| partOf |
0..0 | Composite task | ||
| statusReason |
0..0 | Reason for current status | ||
| businessStatus |
0..0 | E.g. "Specimen collected", "IV prepped" | ||
| code |
0..0 | Task Type | ||
| focus |
0..0 | What task is acting on | ||
| for |
1..1 | Reference(Patient) | Beneficiary of the Task | |
| encounter |
0..0 | Healthcare event during which this task originated | ||
| performerType |
0..0 | Requested performer | ||
| location |
0..0 | Where task occurs | ||
| reasonCode |
0..0 | Why task is needed | ||
| reasonReference |
0..0 | Why task is needed | ||
| insurance |
0..0 | Associated insurance coverage | ||
| relevantHistory |
0..0 | Key events in history of the Task | ||
| restriction |
0..0 | Constraints on fulfillment tasks | ||
| Documentation for this format | ||||
| 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 | |
| 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 | |
 extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | Task Instance Identifier | |
| basedOn |
1..1 | Reference(ServiceRequest) | Request fulfilled by this task | |
| groupIdentifier |
0..1 | Identifier | Requisition or grouper id | |
| status |
1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. | |
| intent |
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. | |
| description |
0..1 | string | Human-readable explanation of task | |
| for |
1..1 | Reference(Patient) | Beneficiary of the Task | |
| executionPeriod |
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 | |
| owner |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual | |
| note |
0..* | Annotation | Comments made about the task | |
 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 |
0..* | BackboneElement | Information produced as part of 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 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.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Task.input.type | Base | example | Not State | Unknown | |
| Task.output.type | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Task
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Task |
C | 0..* | Task | A task to be performed Constraints: inv-1 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| basedOn |
1..1 | Reference(ServiceRequest) | Request fulfilled by this task | |
| status |
1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. | |
| intent |
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. | |
| for |
1..1 | Reference(Patient) | Beneficiary of the Task | |
| 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. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Task |
0..* | Task | A task to be performed | |
| implicitRules |
0..0 | A set of rules under which this content was created | ||
| language |
0..0 | Language of the resource content | ||
| contained |
0..0 | Contained, inline Resources | ||
| instantiatesCanonical |
0..0 | Formal definition of task | ||
| instantiatesUri |
0..0 | Formal definition of task | ||
| basedOn |
1..1 | Reference(ServiceRequest) | Request fulfilled by this task | |
| partOf |
0..0 | Composite task | ||
| statusReason |
0..0 | Reason for current status | ||
| businessStatus |
0..0 | E.g. "Specimen collected", "IV prepped" | ||
| code |
0..0 | Task Type | ||
| focus |
0..0 | What task is acting on | ||
| for |
1..1 | Reference(Patient) | Beneficiary of the Task | |
| encounter |
0..0 | Healthcare event during which this task originated | ||
| performerType |
0..0 | Requested performer | ||
| location |
0..0 | Where task occurs | ||
| reasonCode |
0..0 | Why task is needed | ||
| reasonReference |
0..0 | Why task is needed | ||
| insurance |
0..0 | Associated insurance coverage | ||
| relevantHistory |
0..0 | Key events in history of the Task | ||
| restriction |
0..0 | Constraints on fulfillment tasks | ||
| Documentation for this format | ||||
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 | |
| 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 | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | Task Instance Identifier | |
| basedOn |
1..1 | Reference(ServiceRequest) | Request fulfilled by this task | |
| groupIdentifier |
0..1 | Identifier | Requisition or grouper id | |
| status |
1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. | |
| intent |
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. | |
| description |
0..1 | string | Human-readable explanation of task | |
| for |
1..1 | Reference(Patient) | Beneficiary of the Task | |
| executionPeriod |
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 | |
| owner |
0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual | |
| note |
0..* | Annotation | Comments made about the task | |
| 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 |
0..* | BackboneElement | Information produced as part of 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 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.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Task.input.type | Base | example | Not State | Unknown | |
| Task.output.type | Base | example | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Task
Other representations of profile: CSV, Excel, Schematron