HL7 FHIR® Implementation Guide: Electronic Case Reporting (eCR)

This page is part of the electronic Case Reporting (eCR) (v1.0.0: STU 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

SD.5 StructureDefinition-ecr-task

This Task profile represents the state of completion of the eCR activity. It is used in both the messaging and RESTful paradigms. to support the eCR messaging paradigm. The focus of an eCR Task is either the eICR document Bundle or the RR Communication.

SD.5.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/us/ecr/StructureDefinition/ecr-task

Published on Wed Jan 29 20:30:08 UTC 2020 as a active by HL7 Public Health Work Group.

This profile builds on Task

Text Summary
Differential Table
Snapshot Table
All

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	Task
status	S	1..1	code
businessStatus	S	0..1	CodeableConcept	Binding: eCR Task BusinessStatus Value Set (extensible)
focus	S	1..1	Reference(eICR Document Bundle \| Reportability Response Communication)
authoredOn	S	0..1	dateTime
owner	S	1..1	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| HealthcareService \| Patient \| Device \| RelatedPerson)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Task	I	0..*	Task	A task to be performed
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	I	0..*	Identifier	Task Instance Identifier
instantiatesCanonical	ΣI	0..1	canonical(ActivityDefinition)	Formal definition of task
instantiatesUri	ΣI	0..1	uri	Formal definition of task
basedOn	ΣI	0..*	Reference(Resource)	Request fulfilled by this task
groupIdentifier	ΣI	0..1	Identifier	Requisition or grouper id
partOf	ΣI	0..*	Reference(Task)	Composite task
status	?!SΣI	1..1	code	draft \| requested \| received \| accepted \| + Binding: TaskStatus (required)
statusReason	ΣI	0..1	CodeableConcept	Reason for current status Binding: (unbound) (example)
businessStatus	SΣI	0..1	CodeableConcept	E.g. "Specimen collected", "IV prepped" Binding: eCR Task BusinessStatus Value Set (extensible)
intent	ΣI	1..1	code	unknown \| proposal \| plan \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option Binding: TaskIntent (required)
priority	I	0..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required)
code	ΣI	0..1	CodeableConcept	Task Type Binding: TaskCode (example)
description	ΣI	0..1	string	Human-readable explanation of task
focus	SΣI	1..1	Reference(eICR Document Bundle \| Reportability Response Communication)	What task is acting on
for	ΣI	0..1	Reference(Resource)	Beneficiary of the Task
encounter	ΣI	0..1	Reference(Encounter)	Healthcare event during which this task originated
executionPeriod	ΣI	0..1	Period	Start and end time of execution
authoredOn	SI	0..1	dateTime	Task Creation Date
lastModified	ΣI	0..1	dateTime	Task Last Modified Date
requester	ΣI	0..1	Reference(Device \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)	Who is asking for task to be done
performerType	I	0..*	CodeableConcept	Requested performer Binding: ProcedurePerformerRoleCodes (preferred)
owner	SΣI	1..1	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| HealthcareService \| Patient \| Device \| RelatedPerson)	Responsible individual
location	ΣI	0..1	Reference(Location)	Where task occurs
reasonCode	I	0..1	CodeableConcept	Why task is needed Binding: (unbound) (example)
reasonReference	I	0..1	Reference(Resource)	Why task is needed
insurance	I	0..*	Reference(Coverage \| ClaimResponse)	Associated insurance coverage
note	I	0..*	Annotation	Comments made about the task
relevantHistory	I	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	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
repetitions	I	0..1	positiveInt	How many times to repeat
period	I	0..1	Period	When fulfillment sought
recipient	I	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	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	I	1..1	CodeableConcept	Label for the input Binding: (unbound) (example)
value[x]	I	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	I	0..*	BackboneElement	Information produced as part of task
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	I	1..1	CodeableConcept	Label for output Binding: (unbound) (example)
value[x]	I	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

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

http://hl7.org/fhir/us/ecr/StructureDefinition/eicr-document-bundle

Differential View

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	Task
status	S	1..1	code
businessStatus	S	0..1	CodeableConcept	Binding: eCR Task BusinessStatus Value Set (extensible)
focus	S	1..1	Reference(eICR Document Bundle \| Reportability Response Communication)
authoredOn	S	0..1	dateTime
owner	S	1..1	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| HealthcareService \| Patient \| Device \| RelatedPerson)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Task	I	0..*	Task	A task to be performed
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	I	0..*	Identifier	Task Instance Identifier
instantiatesCanonical	ΣI	0..1	canonical(ActivityDefinition)	Formal definition of task
instantiatesUri	ΣI	0..1	uri	Formal definition of task
basedOn	ΣI	0..*	Reference(Resource)	Request fulfilled by this task
groupIdentifier	ΣI	0..1	Identifier	Requisition or grouper id
partOf	ΣI	0..*	Reference(Task)	Composite task
status	?!SΣI	1..1	code	draft \| requested \| received \| accepted \| + Binding: TaskStatus (required)
statusReason	ΣI	0..1	CodeableConcept	Reason for current status Binding: (unbound) (example)
businessStatus	SΣI	0..1	CodeableConcept	E.g. "Specimen collected", "IV prepped" Binding: eCR Task BusinessStatus Value Set (extensible)
intent	ΣI	1..1	code	unknown \| proposal \| plan \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option Binding: TaskIntent (required)
priority	I	0..1	code	routine \| urgent \| asap \| stat Binding: RequestPriority (required)
code	ΣI	0..1	CodeableConcept	Task Type Binding: TaskCode (example)
description	ΣI	0..1	string	Human-readable explanation of task
focus	SΣI	1..1	Reference(eICR Document Bundle \| Reportability Response Communication)	What task is acting on
for	ΣI	0..1	Reference(Resource)	Beneficiary of the Task
encounter	ΣI	0..1	Reference(Encounter)	Healthcare event during which this task originated
executionPeriod	ΣI	0..1	Period	Start and end time of execution
authoredOn	SI	0..1	dateTime	Task Creation Date
lastModified	ΣI	0..1	dateTime	Task Last Modified Date
requester	ΣI	0..1	Reference(Device \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)	Who is asking for task to be done
performerType	I	0..*	CodeableConcept	Requested performer Binding: ProcedurePerformerRoleCodes (preferred)
owner	SΣI	1..1	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| HealthcareService \| Patient \| Device \| RelatedPerson)	Responsible individual
location	ΣI	0..1	Reference(Location)	Where task occurs
reasonCode	I	0..1	CodeableConcept	Why task is needed Binding: (unbound) (example)
reasonReference	I	0..1	Reference(Resource)	Why task is needed
insurance	I	0..*	Reference(Coverage \| ClaimResponse)	Associated insurance coverage
note	I	0..*	Annotation	Comments made about the task
relevantHistory	I	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	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
repetitions	I	0..1	positiveInt	How many times to repeat
period	I	0..1	Period	When fulfillment sought
recipient	I	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	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	I	1..1	CodeableConcept	Label for the input Binding: (unbound) (example)
value[x]	I	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	I	0..*	BackboneElement	Information produced as part of task
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	I	1..1	CodeableConcept	Label for output Binding: (unbound) (example)
value[x]	I	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

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron