Task - 903

3.112 StructureDefinition: PrescribeIT® RX 903 Task profile

The official URL for this profile is:

http://prescribeit.ca/fhir/StructureDefinition/task-903

3.112.2 Formal Views of Profile Content

Download Excel representation

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

This structure is derived from Task

Name	Card.	Type	Constraints and Usage
Task	0..*	Task	inv-2: A Failure reason may be present only when a task has failed. inv-1: Last modified date must be greater than or equal to created date. Definition: A task to be performed.
id	1..1	id	Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application.
type	1..1	Shared Health CodeableConcept Code	Binding: PrescriptionTaskType (20190315) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments:
coding	1..*	Coding	Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.
system	1..1	uri	Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding.
code	1..1	code	Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding.
display	0..1	string	Definition: A representation of the meaning of the code in the system, following the rules of the system.
subject	1..1	Reference(PrescribeIT® Prescription 903) {b }	Definition: A reference from one resource to another. Comments: Identifies the medication order tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message)
reference	1..1	string	Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
creator	1..1	Reference(Shared Health Practitioner - 903) {b }	Definition: The creator of the task. Comments: This is who is submitting the task and asking it be done
reference	1..1	string	Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
owner	1..1	Reference(Shared Health - eRx Service Location) {b }	Definition: The owner of this task. The participant who can execute this task. Comments: This information duplicates what appear in Provenance but is often needs to be more accessible.
reference	1..1	string	Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the pharmacy Organization being requested to act. This value will be returned from the Provider Registry query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}'

This structure is derived from Task

Summary

Mandatory: 8 elements
Must-Support: 9 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

This structure is derived from Task

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	Task	A task to be performed
id	S	1..1	id	Logical id of this artifact
meta
security		0..0
type	S	1..1	Shared Health CodeableConcept Code	Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20190315) (required)
coding
display	S	0..1	string	Representation defined by the system
subject	S	1..1	Reference(PrescribeIT® Prescription 903) {b }	Focus of task
reference	S	1..1	string	Relative, internal or absolute URL reference
creator	S	1..1	Reference(Shared Health Practitioner - 903) {b }	Task Creator
reference	S	1..1	string	Relative, internal or absolute URL reference
owner	S	1..1	Reference(Shared Health - eRx Service Location) {b }	Task Owner
reference	S	1..1	string	Relative, internal or absolute URL reference
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Task	I	0..*	Task	A task to be performed
id	SΣ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
profile	Σ	0..*	uri	Profiles this resource claims to conform to
tag	Σ	0..*	Coding	Tags applied to this resource Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language.
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..1	Identifier	Task Instance Identifier
type	S	1..1	Shared Health CodeableConcept Code	Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20190315) (required)
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
coding	SΣ	1..*	Coding	Code defined by a terminology system
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
system	SΣ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
description	Σ	0..1	string	Task Description
performerType		0..*	Coding	requester \| dispatcher \| scheduler \| performer \| monitor \| manager \| acquirer \| reviewer Binding: TaskPerformerType (preferred): The type(s) of task performers allowed
priority		0..1	code	low \| normal \| high Binding: TaskPriority (required): The task's priority
status	ΣI	1..1	code	draft \| requested \| received \| accepted \| + Binding: TaskStatus (required): The current status of the task.
failureReason	ΣI	0..1	CodeableConcept	Task Failure Reason
subject	S	1..1	Reference(PrescribeIT® Prescription 903) {b }	Focus of task
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
reference	SΣI	1..1	string	Relative, internal or absolute URL reference
display	Σ	0..1	string	Text alternative for the resource
for	Σ	0..1	Reference(Resource)	Beneficiary of the Task
definition	Σ	0..1	uri	Task Definition
created	I	1..1	dateTime	Task Creation Date
lastModified	ΣI	1..1	dateTime	Task Last Modified Date
creator	S	1..1	Reference(Shared Health Practitioner - 903) {b }	Task Creator
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
reference	SΣI	1..1	string	Relative, internal or absolute URL reference
display	Σ	0..1	string	Text alternative for the resource
owner	S	1..1	Reference(Shared Health - eRx Service Location) {b }	Task Owner
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
reference	SΣI	1..1	string	Relative, internal or absolute URL reference
display	Σ	0..1	string	Text alternative for the resource
parent		0..1	Reference(Task)	Composite task
input		0..*	BackboneElement	Task Input
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name		1..1	string	Input Name
value[x]		1..1		Input Value
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueBase64Binary			base64Binary
valueInstant			instant
valueString			string
valueUri			uri
valueDate			date
valueDateTime			dateTime
valueTime			time
valueCode			code
valueOid			oid
valueId			id
valueUnsignedInt			unsignedInt
valuePositiveInt			positiveInt
valueMarkdown			markdown
valueAnnotation			Annotation
valueAttachment			Attachment
valueIdentifier			Identifier
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueQuantity			Quantity
valueRange			Range
valuePeriod			Period
valueRatio			Ratio
valueSampledData			SampledData
valueSignature			Signature
valueHumanName			HumanName
valueAddress			Address
valueContactPoint			ContactPoint
valueTiming			Timing
valueReference			Reference(Any)
valueMeta			Meta
output		0..*	BackboneElement	Task Output
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name		1..1	string	Output Name
value[x]		1..1		Output Value
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueBase64Binary			base64Binary
valueInstant			instant
valueString			string
valueUri			uri
valueDate			date
valueDateTime			dateTime
valueTime			time
valueCode			code
valueOid			oid
valueId			id
valueUnsignedInt			unsignedInt
valuePositiveInt			positiveInt
valueMarkdown			markdown
valueAnnotation			Annotation
valueAttachment			Attachment
valueIdentifier			Identifier
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueQuantity			Quantity
valueRange			Range
valuePeriod			Period
valueRatio			Ratio
valueSampledData			SampledData
valueSignature			Signature
valueHumanName			HumanName
valueAddress			Address
valueContactPoint			ContactPoint
valueTiming			Timing
valueReference			Reference(Any)
valueMeta			Meta
Documentation for this format

Grid View

This structure is derived from Task

Name	Card.	Type	Constraints and Usage
Task	0..*	Task	inv-2: A Failure reason may be present only when a task has failed. inv-1: Last modified date must be greater than or equal to created date. Definition: A task to be performed.
id	1..1	id	Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application.
type	1..1	Shared Health CodeableConcept Code	Binding: PrescriptionTaskType (20190315) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments:
coding	1..*	Coding	Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.
system	1..1	uri	Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding.
code	1..1	code	Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding.
display	0..1	string	Definition: A representation of the meaning of the code in the system, following the rules of the system.
subject	1..1	Reference(PrescribeIT® Prescription 903) {b }	Definition: A reference from one resource to another. Comments: Identifies the medication order tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message)
reference	1..1	string	Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
creator	1..1	Reference(Shared Health Practitioner - 903) {b }	Definition: The creator of the task. Comments: This is who is submitting the task and asking it be done
reference	1..1	string	Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
owner	1..1	Reference(Shared Health - eRx Service Location) {b }	Definition: The owner of this task. The participant who can execute this task. Comments: This information duplicates what appear in Provenance but is often needs to be more accessible.
reference	1..1	string	Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the pharmacy Organization being requested to act. This value will be returned from the Provider Registry query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}'

This structure is derived from Task

Summary

Mandatory: 8 elements
Must-Support: 9 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Task

Name	Flags	Card.	Type	Description & Constraints
Task		0..*	Task	A task to be performed
id	S	1..1	id	Logical id of this artifact
meta
security		0..0
type	S	1..1	Shared Health CodeableConcept Code	Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20190315) (required)
coding
display	S	0..1	string	Representation defined by the system
subject	S	1..1	Reference(PrescribeIT® Prescription 903) {b }	Focus of task
reference	S	1..1	string	Relative, internal or absolute URL reference
creator	S	1..1	Reference(Shared Health Practitioner - 903) {b }	Task Creator
reference	S	1..1	string	Relative, internal or absolute URL reference
owner	S	1..1	Reference(Shared Health - eRx Service Location) {b }	Task Owner
reference	S	1..1	string	Relative, internal or absolute URL reference
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Task	I	0..*	Task	A task to be performed
id	SΣ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
profile	Σ	0..*	uri	Profiles this resource claims to conform to
tag	Σ	0..*	Coding	Tags applied to this resource Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language.
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..1	Identifier	Task Instance Identifier
type	S	1..1	Shared Health CodeableConcept Code	Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20190315) (required)
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
coding	SΣ	1..*	Coding	Code defined by a terminology system
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
system	SΣ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	SΣ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
description	Σ	0..1	string	Task Description
performerType		0..*	Coding	requester \| dispatcher \| scheduler \| performer \| monitor \| manager \| acquirer \| reviewer Binding: TaskPerformerType (preferred): The type(s) of task performers allowed
priority		0..1	code	low \| normal \| high Binding: TaskPriority (required): The task's priority
status	ΣI	1..1	code	draft \| requested \| received \| accepted \| + Binding: TaskStatus (required): The current status of the task.
failureReason	ΣI	0..1	CodeableConcept	Task Failure Reason
subject	S	1..1	Reference(PrescribeIT® Prescription 903) {b }	Focus of task
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
reference	SΣI	1..1	string	Relative, internal or absolute URL reference
display	Σ	0..1	string	Text alternative for the resource
for	Σ	0..1	Reference(Resource)	Beneficiary of the Task
definition	Σ	0..1	uri	Task Definition
created	I	1..1	dateTime	Task Creation Date
lastModified	ΣI	1..1	dateTime	Task Last Modified Date
creator	S	1..1	Reference(Shared Health Practitioner - 903) {b }	Task Creator
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
reference	SΣI	1..1	string	Relative, internal or absolute URL reference
display	Σ	0..1	string	Text alternative for the resource
owner	S	1..1	Reference(Shared Health - eRx Service Location) {b }	Task Owner
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
reference	SΣI	1..1	string	Relative, internal or absolute URL reference
display	Σ	0..1	string	Text alternative for the resource
parent		0..1	Reference(Task)	Composite task
input		0..*	BackboneElement	Task Input
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name		1..1	string	Input Name
value[x]		1..1		Input Value
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueBase64Binary			base64Binary
valueInstant			instant
valueString			string
valueUri			uri
valueDate			date
valueDateTime			dateTime
valueTime			time
valueCode			code
valueOid			oid
valueId			id
valueUnsignedInt			unsignedInt
valuePositiveInt			positiveInt
valueMarkdown			markdown
valueAnnotation			Annotation
valueAttachment			Attachment
valueIdentifier			Identifier
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueQuantity			Quantity
valueRange			Range
valuePeriod			Period
valueRatio			Ratio
valueSampledData			SampledData
valueSignature			Signature
valueHumanName			HumanName
valueAddress			Address
valueContactPoint			ContactPoint
valueTiming			Timing
valueReference			Reference(Any)
valueMeta			Meta
output		0..*	BackboneElement	Task Output
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name		1..1	string	Output Name
value[x]		1..1		Output Value
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueBase64Binary			base64Binary
valueInstant			instant
valueString			string
valueUri			uri
valueDate			date
valueDateTime			dateTime
valueTime			time
valueCode			code
valueOid			oid
valueId			id
valueUnsignedInt			unsignedInt
valuePositiveInt			positiveInt
valueMarkdown			markdown
valueAnnotation			Annotation
valueAttachment			Attachment
valueIdentifier			Identifier
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueQuantity			Quantity
valueRange			Range
valuePeriod			Period
valueRatio			Ratio
valueSampledData			SampledData
valueSignature			Signature
valueHumanName			HumanName
valueAddress			Address
valueContactPoint			ContactPoint
valueTiming			Timing
valueReference			Reference(Any)
valueMeta			Meta
Documentation for this format

Other representations of profile: Schematron

3.112.3 Terminology Bindings

Terminology Bindings

Path	Conformance	ValueSet
Task.meta.tag	example
Task.language	required	http://tools.ietf.org/html/bcp47
Task.type	required	PrescriptionTaskType
Task.performerType	preferred	TaskPerformerType
Task.priority	required	TaskPriority
Task.status	required	TaskStatus

3.112.4 Constraints

Constraints

Id	Path	Details	Requirements
inv-2	Task	A Failure reason may be present only when a task has failed. : failureReason.empty() or status = 'failed'
inv-1	Task	Last modified date must be greater than or equal to created date. : lastModified >= created