QI-Core Implementation Guide

QI-Core Implementation Guide: STU Ballot (v3.3.0 for FHIR 4.0.0)

Quality Improvement Core Framework (v3.3.0: STU 4 Ballot 1). The current version is 3.2.0 based on FHIR R4. See the Directory of published versions

D.4.1 StructureDefinition-qicore-task

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

Task Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-task

Profile of Task for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile builds on Task.

This profile was published on Wed Aug 22 00:00:00 EDT 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

Text Summary
Differential Table
Snapshot Table
All

Summary

Mandatory: 6 elements
Must-Support: 5 elements

Name	Flags	Card.	Type
Task		0..*
identifier	S	1..*	Identifier
status	S	1..1	code
intent	S	1..1	code
priority	S	1..1	code
code	S	1..1	CodeableConcept
executionPeriod		1..1	Period
reasonCode		0..1	CodeableConcept
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Task	I	0..*		A task to be performed
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) Max Binding: AllLanguages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	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	draft \| requested \| received \| accepted \| + Binding: TaskStatus (required)
statusReason	Σ	0..1	CodeableConcept	Reason for current status Binding: (unbound) (example)
businessStatus	Σ	0..1	CodeableConcept	E.g. "Specimen collected", "IV prepped" Binding: (unbound) (example)
intent	SΣ	1..1	code	unknown \| proposal \| plan \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option Binding: TaskIntent (required)
priority	S	1..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required)
code	SΣ	1..1	CodeableConcept	Task Type Binding: TaskCode (example)
description	Σ	0..1	string	Human-readable explanation of task
focus	Σ	0..1	Reference(Resource)	What task is acting on
for	Σ	0..1	Reference(Resource)	Beneficiary of the Task
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this task originated
executionPeriod	Σ	1..1	Period	Start and end time of execution
authoredOn	I	0..1	dateTime	Task Creation Date
lastModified	ΣI	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)
owner	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| HealthcareService \| Patient \| Device \| RelatedPerson)	Responsible individual
location	Σ	0..1	Reference(Location)	Where task occurs
reasonCode		0..1	CodeableConcept	Why task is needed Binding: (unbound) (example)
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	I	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	I	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: (unbound) (example)
value[x]		1..1		Content to use in performing the task
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical()
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()
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
output	I	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: (unbound) (example)
value[x]		1..1		Result of output
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical()
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()
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
Documentation for this format

Summary

Mandatory: 6 elements
Must-Support: 5 elements

Differential View

Name	Flags	Card.	Type
Task		0..*
identifier	S	1..*	Identifier
status	S	1..1	code
intent	S	1..1	code
priority	S	1..1	code
code	S	1..1	CodeableConcept
executionPeriod		1..1	Period
reasonCode		0..1	CodeableConcept
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Task	I	0..*		A task to be performed
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) Max Binding: AllLanguages
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	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	draft \| requested \| received \| accepted \| + Binding: TaskStatus (required)
statusReason	Σ	0..1	CodeableConcept	Reason for current status Binding: (unbound) (example)
businessStatus	Σ	0..1	CodeableConcept	E.g. "Specimen collected", "IV prepped" Binding: (unbound) (example)
intent	SΣ	1..1	code	unknown \| proposal \| plan \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option Binding: TaskIntent (required)
priority	S	1..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required)
code	SΣ	1..1	CodeableConcept	Task Type Binding: TaskCode (example)
description	Σ	0..1	string	Human-readable explanation of task
focus	Σ	0..1	Reference(Resource)	What task is acting on
for	Σ	0..1	Reference(Resource)	Beneficiary of the Task
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this task originated
executionPeriod	Σ	1..1	Period	Start and end time of execution
authoredOn	I	0..1	dateTime	Task Creation Date
lastModified	ΣI	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)
owner	Σ	0..1	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| HealthcareService \| Patient \| Device \| RelatedPerson)	Responsible individual
location	Σ	0..1	Reference(Location)	Where task occurs
reasonCode		0..1	CodeableConcept	Why task is needed Binding: (unbound) (example)
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	I	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	I	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: (unbound) (example)
value[x]		1..1		Content to use in performing the task
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical()
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()
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
output	I	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: (unbound) (example)
value[x]		1..1		Result of output
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical()
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()
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
Documentation for this format

D.4.1.2 Terminology Bindings

Terminology Bindings

Path	Conformance	ValueSet
Task.language	preferred	CommonLanguages Max Binding: AllLanguages
Task.status:status	required	TaskStatus
Task.statusReason	example
Task.businessStatus	example
Task.intent:intent	required	TaskIntent
Task.priority:priority	required	RequestPriority
Task.code:code	example	TaskCode
Task.performerType	preferred	ProcedurePerformerRoleCodes
Task.reasonCode	example
Task.input.type	example
Task.output.type	example

D.4.1.3 Constraints

Constraints

Id	Path	Details	Requirements
dom-2	Task	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-4	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-3	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-6	Task	A resource should have narrative for robust management : text.div.exists()
dom-5	Task	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
inv-1	Task	Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
ele-1	Task.restriction	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Task.input	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Task.output	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())