Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: OutreachTask

Task FHIR resource for the outreach referral service

Usage:

• Examples for this Resource Profile: Task/OutreachTaskExample
• CapabilityStatements using this Resource Profile: Shared Care FHIR Server Capability Statement

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	Task	A task to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management inv-1: Last modified date must be greater than or equal to authored-on date.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
basedOn	Σ	1..1	Reference(ServiceRequest)	Request fulfilled by this task ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
for	Σ	1..1	Reference(Patient)	Beneficiary of the Task ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Task.status	required	TaskStatus http://hl7.org/fhir/ValueSet/task-status|4.0.1 from the FHIR Standard
Task.intent	required	TaskIntent http://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard

This structure is derived from Task

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	Task	A task to be performed
implicitRules		0..0
language		0..0
contained		0..0
instantiatesCanonical		0..0
instantiatesUri		0..0
basedOn		1..1	Reference(ServiceRequest)	Request fulfilled by this task
groupIdentifier		0..0
partOf		0..0
statusReason		0..0
businessStatus		0..0
code		0..0
focus		0..0
for		1..1	Reference(Patient)	Beneficiary of the Task
encounter		0..0
performerType		0..0
location		0..0
reasonCode		0..0
reasonReference		0..0
insurance		0..0
relevantHistory		0..0
restriction		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	Task	A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date.
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
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
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 (No ValueSet): (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 (No ValueSet): (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

Terminology Bindings

Path	Conformance	ValueSet	URI
Task.status	required	TaskStatus http://hl7.org/fhir/ValueSet/task-status|4.0.1 from the FHIR Standard
Task.intent	required	TaskIntent http://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard
Task.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
Task.input.type	example
Task.output.type	example

This structure is derived from Task

Summary

Mandatory: 2 elements
Prohibited: 19 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	Task	A task to be performed dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management inv-1: Last modified date must be greater than or equal to authored-on date.
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
basedOn	Σ	1..1	Reference(ServiceRequest)	Request fulfilled by this task ele-1: All FHIR elements must have a @value or children
status	?!Σ	1..1	code	draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
for	Σ	1..1	Reference(Patient)	Beneficiary of the Task ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Task.status	required	TaskStatus http://hl7.org/fhir/ValueSet/task-status|4.0.1 from the FHIR Standard
Task.intent	required	TaskIntent http://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard

Differential View

This structure is derived from Task

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	Task	A task to be performed
implicitRules		0..0
language		0..0
contained		0..0
instantiatesCanonical		0..0
instantiatesUri		0..0
basedOn		1..1	Reference(ServiceRequest)	Request fulfilled by this task
groupIdentifier		0..0
partOf		0..0
statusReason		0..0
businessStatus		0..0
code		0..0
focus		0..0
for		1..1	Reference(Patient)	Beneficiary of the Task
encounter		0..0
performerType		0..0
location		0..0
reasonCode		0..0
reasonReference		0..0
insurance		0..0
relevantHistory		0..0
restriction		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	Task	A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date.
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
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
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 (No ValueSet): (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 (No ValueSet): (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

Terminology Bindings

Path	Conformance	ValueSet	URI
Task.status	required	TaskStatus http://hl7.org/fhir/ValueSet/task-status|4.0.1 from the FHIR Standard
Task.intent	required	TaskIntent http://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard
Task.priority	required	RequestPriority http://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard
Task.input.type	example
Task.output.type	example

This structure is derived from Task

Summary

Mandatory: 2 elements
Prohibited: 19 elements

Other representations of profile: CSV, Excel, Schematron