NCPI FHIR Implementation Guide - Local Development build (v0.2.0). See the Directory of published versions

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

Resource Profile: Research Task

A FHIR analysis task that takes at least one specimen as input and produces at least one document.

Usage:

• Examples for this Resource Profile: Task/task-example-2

Formal Views of Profile Content

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

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

This structure is derived from Task

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	Task	A task to be performed
focus		1..1	Reference(Specimen)	What task is acting on
for		1..1	Reference(Patient)	Beneficiary of the Task
owner		1..1	Reference(Organization)	Responsible individual
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	Task	A task to be performed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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.
focus	Σ	1..1	Reference(Specimen)	What task is acting on
for	Σ	1..1	Reference(Patient)	Beneficiary of the Task
owner	Σ	1..1	Reference(Organization)	Responsible individual
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Task.status	required	TaskStatus
Task.intent	required	TaskIntent

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	Task	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): A human language. Additional Bindings Purpose AllLanguages Max Binding
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		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	?!Σ	1..1	code	draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task.
statusReason	Σ	0..1	CodeableConcept	Reason for current status Binding: (unbound) (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: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
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.
code	Σ	0..1	CodeableConcept	Task Type 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	Σ	1..1	Reference(Specimen)	What task is acting on
for	Σ	1..1	Reference(Patient)	Beneficiary of the Task
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this task originated
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
performerType		0..*	CodeableConcept	Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.
owner	Σ	1..1	Reference(Organization)	Responsible individual
location	Σ	0..1	Reference(Location)	Where task occurs
reasonCode		0..1	CodeableConcept	Why task is needed Binding: (unbound) (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: (unbound) (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: (unbound) (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
Task.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Task.status	required	TaskStatus
Task.statusReason	example
Task.businessStatus	example
Task.intent	required	TaskIntent
Task.priority	required	RequestPriority
Task.code	example	TaskCode
Task.performerType	preferred	ProcedurePerformerRoleCodes
Task.reasonCode	example
Task.input.type	example
Task.output.type	example

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from Task

Summary

Mandatory: 3 elements

Differential View

This structure is derived from Task

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	Task	A task to be performed
focus		1..1	Reference(Specimen)	What task is acting on
for		1..1	Reference(Patient)	Beneficiary of the Task
owner		1..1	Reference(Organization)	Responsible individual
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	Task	A task to be performed
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
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.
focus	Σ	1..1	Reference(Specimen)	What task is acting on
for	Σ	1..1	Reference(Patient)	Beneficiary of the Task
owner	Σ	1..1	Reference(Organization)	Responsible individual
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Task.status	required	TaskStatus
Task.intent	required	TaskIntent

Constraints

Id	Grade	Path(s)	Details	Requirements
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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Task	C	0..*	Task	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): A human language. Additional Bindings Purpose AllLanguages Max Binding
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		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	?!Σ	1..1	code	draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task.
statusReason	Σ	0..1	CodeableConcept	Reason for current status Binding: (unbound) (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: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
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.
code	Σ	0..1	CodeableConcept	Task Type 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	Σ	1..1	Reference(Specimen)	What task is acting on
for	Σ	1..1	Reference(Patient)	Beneficiary of the Task
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this task originated
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
performerType		0..*	CodeableConcept	Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.
owner	Σ	1..1	Reference(Organization)	Responsible individual
location	Σ	0..1	Reference(Location)	Where task occurs
reasonCode		0..1	CodeableConcept	Why task is needed Binding: (unbound) (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: (unbound) (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: (unbound) (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
Task.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Task.status	required	TaskStatus
Task.statusReason	example
Task.businessStatus	example
Task.intent	required	TaskIntent
Task.priority	required	RequestPriority
Task.code	example	TaskCode
Task.performerType	preferred	ProcedurePerformerRoleCodes
Task.reasonCode	example
Task.input.type	example
Task.output.type	example

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from Task

Summary

Mandatory: 3 elements

Other representations of profile: CSV, Excel, Schematron