Visit the HL7 website
Visit the FHIR website

Pan-Canadian eReferral-eConsult (CA:eReC) v1.1.0-DFT-Ballot

1.1.0-DFT-Ballot   Canada flag
  • Index
  • Home
  • Business Context
    • Business Models
    • Use Cases
    • Business Events
    • Business Rules
    • Privacy and Security Guidance
    • Provincial Considerations
  • Technical Context
    • Technical Foundation
    • Integration Patterns
    • Messaging
    • Sequence Diagrams
    • Conformance Requirements
  • FHIR Artifacts
    • Messaging Events
    • Resource Profiles
    • Extensions
    • Terminology
    • Examples
    • Capability Statements
    • Downloads
    • ---
    • Appointment (CA:eReC)
    • Bundle (CA:eReC)
    • Communication (CA:eReC)
    • DocumentReference (CA:eReC)
    • Location (CA:eReC)
    • MessageHeader (CA:eReC)
    • Organization (CA:eReC)
    • Patient (CA:eReC)
    • Practitioner (CA:eReC)
    • PractitionerRole (CA:eReC)
    • HealthcareService (CA:eReC)
    • QuestionnaireResponse (CA:eReC)
    • ServiceRequest (CA:eReC)
    • Task (CA:eReC)
  • Change Log
    1. Index
    2. FHIR Artifacts
    3. Task (CA:eReC)

preBallot - The specification is currently in ballot review and subject to change. . . . For a full list of available versions, see the Directory of published versions

Task (CA:eReC)

Links

Profile

CA-eReC-Task

Derived from

http://hl7.org/fhir/StructureDefinition/Task

Description

A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity.

References to this resource

MessageHeader

Resource Content

  • Overview
  • Tree view
  • XML
  • JSON
TaskTask
There are no (further) constraints on this element
Data type

Task

extension
There are no (further) constraints on this element
Element id

Task.extension

Sliced:

Unordered, Open, by url(Value)

PatientNeedsToBeSeen0..1Extension(boolean)
There are no (further) constraints on this element
Element id

Task.extension:PatientNeedsToBeSeen

Comments

Used to support the eConsult use case where a patient is referred to a care provider. Used for when the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway.

Data type

Extension(boolean)

Extension URL

http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-patient-needs-to-be-seen-EXT

basedOnS1..1Reference(ServiceRequest)
There are no (further) constraints on this element
Element id

Task.basedOn

Data type

Reference(ServiceRequest)

referenceS
There are no (further) constraints on this element
Element id

Task.basedOn.reference

identifierS
There are no (further) constraints on this element
Element id

Task.basedOn.identifier

useS1..
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.use

systemS1..
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.system

valueS1..
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.value

statusS
There are no (further) constraints on this element
Element id

Task.status

businessStatusSBinding
There are no (further) constraints on this element
Element id

Task.businessStatus

Binding

TaskBusinessStatus (extensible)

StatusReasonS0..1Extension(CodeableConcept)
There are no (further) constraints on this element
Element id

Task.businessStatus.extension:StatusReason

Data type

Extension(CodeableConcept)

Extension URL

http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-task-business-status-reason-EXT

intentSPattern
There are no (further) constraints on this element
Element id

Task.intent

Pattern

proposal

codeSBinding
There are no (further) constraints on this element
Element id

Task.code

Comments
Binding

TaskCode (extensible)

authoredOnS
There are no (further) constraints on this element
Element id

Task.authoredOn

ownerSReference(PractitionerRole | HealthcareService)
There are no (further) constraints on this element
Element id

Task.owner

Comments

When the owner of the task is the CAT, then HealthcareService can be used to identify the owner.

Data type

Reference(PractitionerRole | HealthcareService)

referenceS
There are no (further) constraints on this element
Element id

Task.owner.reference

identifierS
There are no (further) constraints on this element
Element id

Task.owner.identifier

systemS1..
There are no (further) constraints on this element
Element id

Task.owner.identifier.system

valueS1..
There are no (further) constraints on this element
Element id

Task.owner.identifier.value

outputS
There are no (further) constraints on this element
Element id

Task.output

value[x]S
There are no (further) constraints on this element
Element id

Task.output.value[x]

valueStringstring
There are no (further) constraints on this element
Data type

string

valueCodecode
There are no (further) constraints on this element
Data type

code

valueReferenceReference(Communication)
There are no (further) constraints on this element
Data type

Reference(Communication)

TaskITask
There are no (further) constraints on this element
Element id

Task

Short description

A task to be performed

Definition

A task to be performed.

Data type

Task

Constraints
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • 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
    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: 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: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
  • inv-1: Last modified date must be greater than or equal to authored-on date.
    lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
Mappings
  • rim: Entity. Role, or Act
  • workflow: Request, Event
  • rim: ControlAct[moodCode=INT]
idΣ0..1string
There are no (further) constraints on this element
Element id

Task.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

string

metaΣ0..1Meta
There are no (further) constraints on this element
Element id

Task.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Data type

Meta

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
implicitRulesΣ ?!0..1uri
There are no (further) constraints on this element
Element id

Task.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
language0..1codeBinding
There are no (further) constraints on this element
Element id

Task.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
text0..1Narrative
There are no (further) constraints on this element
Element id

Task.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
contained0..*Resource
There are no (further) constraints on this element
Element id

Task.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings
  • rim: N/A
extensionI0..*ExtensionElement id

Task.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
PatientNeedsToBeSeenS I0..1Extension(boolean)Element id

Task.extension:PatientNeedsToBeSeen

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Following a consult, used to communicate if a patient needs to be seen in person.

Comments

Used to support the eConsult use case where a patient is referred to a care provider. Used for when the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway.

Data type

Extension(boolean)

Extension URL

http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-patient-needs-to-be-seen-EXT

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
modifierExtension?! I0..*Extension
There are no (further) constraints on this element
Element id

Task.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
identifier0..*Identifier
There are no (further) constraints on this element
Element id

Task.identifier

Short description

Task Instance Identifier

Definition

The business identifier for this task.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.identifier, Event.identifier
  • w5: FiveWs.identifier
  • rim: .id
instantiatesCanonicalΣ0..1canonical(ActivityDefinition)
There are no (further) constraints on this element
Element id

Task.instantiatesCanonical

Short description

Formal definition of task

Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

Requirements

Enables a formal definition of how he task is to be performed, enabling automation.

Data type

canonical(ActivityDefinition)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.instantiatesCanonical, Event.instantiatesCanonical
  • rim: .outboundRelationship[typeCode=DEFN].target
instantiatesUriΣ0..1uri
There are no (further) constraints on this element
Element id

Task.instantiatesUri

Short description

Formal definition of task

Definition

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

Requirements

Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.instantiatesUrl
  • rim: .outboundRelationship[typeCode=DEFN].target
basedOnS Σ1..1Reference(ServiceRequest)Element id

Task.basedOn

Short description

Request fulfilled by this task

Definition

BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.

Data type

Reference(ServiceRequest)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.basedOn, Event.basedOn
  • rim: .outboundRelationship[typeCode=FLFS].target[moodCode=INT]
id0..1string
There are no (further) constraints on this element
Element id

Task.basedOn.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Task.basedOn.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
referenceS Σ I0..1string
There are no (further) constraints on this element
Element id

Task.basedOn.reference

Short description

Literal reference, Relative, internal or absolute URL

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.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id

Task.basedOn.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
identifierS Σ0..1Identifier
There are no (further) constraints on this element
Element id

Task.basedOn.identifier

Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
id0..1string
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
useS Σ ?!1..1codeBinding
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
systemS Σ1..1uri
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

http://www.acme.com/identifiers/patient


Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
valueS Σ1..1string
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
periodΣ0..1Period
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ0..1Reference(Organization)
There are no (further) constraints on this element
Element id

Task.basedOn.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
displayΣ0..1string
There are no (further) constraints on this element
Element id

Task.basedOn.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
groupIdentifierΣ0..1Identifier
There are no (further) constraints on this element
Element id

Task.groupIdentifier

Short description

Requisition or grouper id

Definition

An identifier that links together multiple tasks and other requests that were created in the same context.

Requirements

Billing and/or reporting can be linked to whether multiple requests were created as a single unit.

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.groupIdentifier
  • rim: .inboundRelationship[typeCode=COMP].source[moodCode=INT].id
partOfΣ0..*Reference(Task)
There are no (further) constraints on this element
Element id

Task.partOf

Short description

Composite task

Definition

Task that this particular task is part of.

Requirements

Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).

Comments

This should usually be 0..1.

Data type

Reference(Task)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.partOf
  • rim: .inboundRelationship[typeCode=COMP].source[moodCode=INT]
statusS Σ ?!1..1codeBinding
There are no (further) constraints on this element
Element id

Task.status

Short description

draft | requested | received | accepted | +

Definition

The current status of the task.

Requirements

These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.

Data type

code

Binding

The current status of the task.

TaskStatus (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.status, Event.status
  • w5: FiveWs.status
  • rim: .statusCode
statusReasonΣ0..1CodeableConcept
There are no (further) constraints on this element
Element id

Task.statusReason

Short description

Reason for current status

Definition

An explanation as to why this task is held, failed, was refused, etc.

Comments

This applies to the current status. Look at the history of the task to see reasons for past statuses.

Data type

CodeableConcept

Binding

Codes to identify the reason for current status. These will typically be specific to a particular workflow.

(unbound) (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code="status change"].reasonCode
businessStatusS Σ0..1CodeableConceptBindingElement id

Task.businessStatus

Short description

E.g. "Specimen collected", "IV prepped"

Definition

Contains business-specific nuances of the business state.

Requirements

There's often a need to track substates of a task - this is often variable by specific workflow implementation.

Data type

CodeableConcept

Binding

The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.

TaskBusinessStatus (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="business status"]
id0..1string
There are no (further) constraints on this element
Element id

Task.businessStatus.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Task.businessStatus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
StatusReasonS I0..1Extension(CodeableConcept)Element id

Task.businessStatus.extension:StatusReason

Short description

BusinessStatusReason

Alternate names

extensions, user content

Definition

A reason for why the business reason is as it is.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension(CodeableConcept)

Extension URL

http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-task-business-status-reason-EXT

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
codingΣ0..*Coding
There are no (further) constraints on this element
Element id

Task.businessStatus.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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 labeled as UserSelected = true.

Data type

Coding

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
textΣ0..1string
There are no (further) constraints on this element
Element id

Task.businessStatus.text

Short description

Plain text representation of the concept

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
intentS Σ1..1codeBindingPatternElement id

Task.intent

Short description

unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option

Definition

Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.

Comments

This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.

In most cases, Tasks will have an intent of "order".

Data type

code

Binding

Distinguishes whether the task is a proposal, plan or full order.

TaskIntent (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Pattern

proposal

Mappings
  • workflow: Request.intent
  • w5: FiveWs.class
  • rim: .moodCode
priority0..1codeBinding
There are no (further) constraints on this element
Element id

Task.priority

Short description

routine | urgent | asap | stat

Definition

Indicates how quickly the Task should be addressed with respect to other requests.

Requirements

Used to identify the service level expected while performing a task.

Meaning when missing

If missing, this task should be performed with normal priority

Data type

code

Binding

The task's priority.

RequestPriority (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.priority
  • w5: FiveWs.grade
  • rim: .priorityCode
codeS Σ0..1CodeableConceptBindingElement id

Task.code

Short description

Task Type

Definition

A name or code (or both) briefly describing what the task involves.

Comments
Data type

CodeableConcept

Binding

Codes to identify what the task involves. These will typically be specific to a particular workflow.

TaskCode (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.code, Event.code
  • w5: FiveWs.what[x]
  • rim: .code
descriptionΣ0..1string
There are no (further) constraints on this element
Element id

Task.description

Short description

Human-readable explanation of task

Definition

A free-text description of what is to be performed.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .text
focusΣ0..1Reference(Resource)
There are no (further) constraints on this element
Element id

Task.focus

Short description

What task is acting on

Definition

The request being actioned or the resource being manipulated by this task.

Requirements

Used to identify the thing to be done.

Comments

If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).

Data type

Reference(Resource)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
  • rim: .outboundRelationship[typeCode=SUBJ].target
forΣ0..1Reference(Resource)
There are no (further) constraints on this element
Element id

Task.for

Short description

Beneficiary of the Task

Alternate names

Patient

Definition

The entity who benefits from the performance of the service specified in the task (e.g., the patient).

Requirements

Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.

Data type

Reference(Resource)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.subject, Event.subject
  • w5: FiveWs.subject[x]
  • rim: .participation[typeCode=RCT].role
  • w5: FiveWs.subject
encounterΣ0..1Reference(Encounter)
There are no (further) constraints on this element
Element id

Task.encounter

Short description

Healthcare event during which this task originated

Definition

The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.

Requirements

For some tasks it may be important to know the link between the encounter the task originated within.

Data type

Reference(Encounter)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.context, Event.context
  • w5: FiveWs.context
  • rim: .inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]
executionPeriodΣ0..1Period
There are no (further) constraints on this element
Element id

Task.executionPeriod

Short description

Start and end time of execution

Definition

Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.occurrence[x]
  • w5: FiveWs.done[x]
  • rim: .effectiveTime
authoredOnS I0..1dateTime
There are no (further) constraints on this element
Element id

Task.authoredOn

Short description

Task Creation Date

Alternate names

Created Date

Definition

The date and time this task was created.

Requirements

Most often used along with lastUpdated to track duration of task to supporting monitoring and management.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.authoredOn
  • w5: FiveWs.recorded
  • rim: .participation[typeCode=AUT].time
lastModifiedΣ I0..1dateTime
There are no (further) constraints on this element
Element id

Task.lastModified

Short description

Task Last Modified Date

Alternate names

Update Date

Definition

The date and time of last modification to this task.

Requirements

Used along with history to track task activity and time in a particular task state. This enables monitoring and management.

Data type

dateTime

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime
requesterΣ0..1Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
There are no (further) constraints on this element
Element id

Task.requester

Short description

Who is asking for task to be done

Definition

The creator of the task.

Requirements

Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).

Data type

Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.requester
  • w5: FiveWs.author
  • rim: .participation[typeCode=AUT].role
performerType0..*CodeableConceptBinding
There are no (further) constraints on this element
Element id

Task.performerType

Short description

Requested performer

Definition

The kind of participant that should perform the task.

Requirements

Use to distinguish tasks on different activity queues.

Data type

CodeableConcept

Binding

The type(s) of task performers allowed.

ProcedurePerformerRoleCodes (preferred)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.performer.role, Request.performerType
  • w5: FiveWs.actor
  • rim: .participation[typeCode=PRF].role.code
ownerS Σ0..1Reference(PractitionerRole | HealthcareService)Element id

Task.owner

Short description

Responsible individual

Alternate names

Performer, Executer

Definition

Individual organization or Device currently responsible for task execution.

Requirements

Identifies who is expected to perform this task.

Comments

When the owner of the task is the CAT, then HealthcareService can be used to identify the owner.

Data type

Reference(PractitionerRole | HealthcareService)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.performer.actor, Request.performer
  • w5: FiveWs.actor
  • rim: .participation[typeCode=PRF].role
id0..1string
There are no (further) constraints on this element
Element id

Task.owner.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Task.owner.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
referenceS Σ I0..1string
There are no (further) constraints on this element
Element id

Task.owner.reference

Short description

Literal reference, Relative, internal or absolute URL

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.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
typeΣ0..1uriBinding
There are no (further) constraints on this element
Element id

Task.owner.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Data type

uri

Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
identifierS Σ0..1Identifier
There are no (further) constraints on this element
Element id

Task.owner.identifier

Short description

Logical reference, when literal reference is not known

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Data type

Identifier

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
id0..1string
There are no (further) constraints on this element
Element id

Task.owner.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Task.owner.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
useΣ ?!0..1codeBinding
There are no (further) constraints on this element
Element id

Task.owner.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
typeΣ0..1CodeableConceptBinding
There are no (further) constraints on this element
Element id

Task.owner.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

CodeableConcept

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
systemS Σ1..1uri
There are no (further) constraints on this element
Element id

Task.owner.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Data type

uri

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

http://www.acme.com/identifiers/patient


Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
valueS Σ1..1string
There are no (further) constraints on this element
Element id

Task.owner.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
periodΣ0..1Period
There are no (further) constraints on this element
Element id

Task.owner.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
assignerΣ0..1Reference(Organization)
There are no (further) constraints on this element
Element id

Task.owner.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
displayΣ0..1string
There are no (further) constraints on this element
Element id

Task.owner.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Data type

string

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
locationΣ0..1Reference(Location)
There are no (further) constraints on this element
Element id

Task.location

Short description

Where task occurs

Definition

Principal physical location where the this task is performed.

Requirements

Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).

Data type

Reference(Location)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.reasonCode, Event.reasonCode
  • w5: FiveWs.where[x]
  • rim: .participation[typeCode=LOC].role
reasonCode0..1CodeableConcept
There are no (further) constraints on this element
Element id

Task.reasonCode

Short description

Why task is needed

Definition

A description or code indicating why this task needs to be performed.

Comments

This should only be included if there is no focus or if it differs from the reason indicated on the focus.

Data type

CodeableConcept

Binding

Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

(unbound) (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Event.location
  • w5: FiveWs.why[x]
  • v2: EVN.7
  • rim: .reasonCode
reasonReference0..1Reference(Resource)
There are no (further) constraints on this element
Element id

Task.reasonReference

Short description

Why task is needed

Definition

A resource reference indicating why this task needs to be performed.

Comments

Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in Task.reasonCode if the data is free (uncoded) text.

Data type

Reference(Resource)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.reasonReference, Event.reasonReference
  • w5: FiveWs.why[x]
  • rim: .outboundRelationship[typeCode=RSON].target
insurance0..*Reference(Coverage | ClaimResponse)
There are no (further) constraints on this element
Element id

Task.insurance

Short description

Associated insurance coverage

Definition

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.

Data type

Reference(Coverage | ClaimResponse)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.insurance
  • v2: IN1/IN2
  • rim: .outboundRelationship[typeCode=COVBY].target
note0..*Annotation
There are no (further) constraints on this element
Element id

Task.note

Short description

Comments made about the task

Definition

Free-text information captured about the task as it progresses.

Data type

Annotation

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.note, Event.note
  • rim: .inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code="annotation"].value(string)
relevantHistory0..*Reference(Provenance)
There are no (further) constraints on this element
Element id

Task.relevantHistory

Short description

Key events in history of the Task

Alternate names

Status History

Definition

Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.

Comments

This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.

Data type

Reference(Provenance)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.relevantHistory
  • rim: .inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]
restriction0..1BackboneElement
There are no (further) constraints on this element
Element id

Task.restriction

Short description

Constraints on fulfillment tasks

Definition

If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.

Requirements

Sometimes when fulfillment is sought, you don't want full fulfillment.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Instead of pointing to request, would point to component of request, having these characteristics
id0..1string
There are no (further) constraints on this element
Element id

Task.restriction.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Task.restriction.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! I0..*Extension
There are no (further) constraints on this element
Element id

Task.restriction.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
repetitions0..1positiveInt
There are no (further) constraints on this element
Element id

Task.restriction.repetitions

Short description

How many times to repeat

Definition

Indicates the number of times the requested action should occur.

Requirements

E.g. order that requests monthly lab tests, fulfillment is sought for 1.

Data type

positiveInt

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .repeatNumber
period0..1Period
There are no (further) constraints on this element
Element id

Task.restriction.period

Short description

When fulfillment sought

Definition

Over what time-period is fulfillment sought.

Requirements

E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.

Comments

Note that period.high is the due date representing the time by which the task should be completed.

Data type

Period

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .effectiveTime(IVL<TS>)
recipient0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization)
There are no (further) constraints on this element
Element id

Task.restriction.recipient

Short description

For whom is fulfillment sought?

Definition

For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?

Data type

Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .participation[typeCode=SBJ].role
input0..*BackboneElement
There are no (further) constraints on this element
Element id

Task.input

Short description

Information used to perform task

Alternate names

Supporting Information

Definition

Additional information that may be needed in the execution of the task.

Requirements

Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: ???
id0..1string
There are no (further) constraints on this element
Element id

Task.input.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Task.input.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! I0..*Extension
There are no (further) constraints on this element
Element id

Task.input.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
type1..1CodeableConcept
There are no (further) constraints on this element
Element id

Task.input.type

Short description

Label for the input

Alternate names

Name

Definition

A code or description indicating how the input is intended to be used as part of the task execution.

Requirements

Inputs are named to enable task automation to bind data and pass it from one task to the next.

Comments

If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.

Data type

CodeableConcept

Binding

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.

(unbound) (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: ???
value[x]1..1
There are no (further) constraints on this element
Element id

Task.input.value[x]

Short description

Content to use in performing the task

Definition

The value of the input parameter as a basic type.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: ???
valueBase64Binarybase64Binary
There are no (further) constraints on this element
Data type

base64Binary

valueBooleanboolean
There are no (further) constraints on this element
Data type

boolean

valueCanonicalcanonical()
There are no (further) constraints on this element
Data type

canonical()

valueCodecode
There are no (further) constraints on this element
Data type

code

valueDatedate
There are no (further) constraints on this element
Data type

date

valueDateTimedateTime
There are no (further) constraints on this element
Data type

dateTime

valueDecimaldecimal
There are no (further) constraints on this element
Data type

decimal

valueIdid
There are no (further) constraints on this element
Data type

id

valueInstantinstant
There are no (further) constraints on this element
Data type

instant

valueIntegerinteger
There are no (further) constraints on this element
Data type

integer

valueMarkdownmarkdown
There are no (further) constraints on this element
Data type

markdown

valueOidoid
There are no (further) constraints on this element
Data type

oid

valuePositiveIntpositiveInt
There are no (further) constraints on this element
Data type

positiveInt

valueStringstring
There are no (further) constraints on this element
Data type

string

valueTimetime
There are no (further) constraints on this element
Data type

time

valueUnsignedIntunsignedInt
There are no (further) constraints on this element
Data type

unsignedInt

valueUriuri
There are no (further) constraints on this element
Data type

uri

valueUrlurl
There are no (further) constraints on this element
Data type

url

valueUuiduuid
There are no (further) constraints on this element
Data type

uuid

valueAddressAddress
There are no (further) constraints on this element
Data type

Address

valueAgeAge
There are no (further) constraints on this element
Data type

Age

valueAnnotationAnnotation
There are no (further) constraints on this element
Data type

Annotation

valueAttachmentAttachment
There are no (further) constraints on this element
Data type

Attachment

valueCodeableConceptCodeableConcept
There are no (further) constraints on this element
Data type

CodeableConcept

valueCodingCoding
There are no (further) constraints on this element
Data type

Coding

valueContactPointContactPoint
There are no (further) constraints on this element
Data type

ContactPoint

valueCountCount
There are no (further) constraints on this element
Data type

Count

valueDistanceDistance
There are no (further) constraints on this element
Data type

Distance

valueDurationDuration
There are no (further) constraints on this element
Data type

Duration

valueHumanNameHumanName
There are no (further) constraints on this element
Data type

HumanName

valueIdentifierIdentifier
There are no (further) constraints on this element
Data type

Identifier

valueMoneyMoney
There are no (further) constraints on this element
Data type

Money

valuePeriodPeriod
There are no (further) constraints on this element
Data type

Period

valueQuantityQuantity
There are no (further) constraints on this element
Data type

Quantity

valueRangeRange
There are no (further) constraints on this element
Data type

Range

valueRatioRatio
There are no (further) constraints on this element
Data type

Ratio

valueSampledDataSampledData
There are no (further) constraints on this element
Data type

SampledData

valueSignatureSignature
There are no (further) constraints on this element
Data type

Signature

valueTimingTiming
There are no (further) constraints on this element
Data type

Timing

valueContactDetailContactDetail
There are no (further) constraints on this element
Data type

ContactDetail

valueContributorContributor
There are no (further) constraints on this element
Data type

Contributor

valueDataRequirementDataRequirement
There are no (further) constraints on this element
Data type

DataRequirement

valueExpressionExpression
There are no (further) constraints on this element
Data type

Expression

valueParameterDefinitionParameterDefinition
There are no (further) constraints on this element
Data type

ParameterDefinition

valueRelatedArtifactRelatedArtifact
There are no (further) constraints on this element
Data type

RelatedArtifact

valueTriggerDefinitionTriggerDefinition
There are no (further) constraints on this element
Data type

TriggerDefinition

valueUsageContextUsageContext
There are no (further) constraints on this element
Data type

UsageContext

valueDosageDosage
There are no (further) constraints on this element
Data type

Dosage

valueMetaMeta
There are no (further) constraints on this element
Data type

Meta

valueReferenceReference()
There are no (further) constraints on this element
Data type

Reference()

outputS0..*BackboneElement
There are no (further) constraints on this element
Element id

Task.output

Short description

Information produced as part of task

Definition

Outputs produced by the Task.

Requirements

Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.

Data type

BackboneElement

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: ???
id0..1string
There are no (further) constraints on this element
Element id

Task.output.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionI0..*Extension
There are no (further) constraints on this element
Element id

Task.output.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
modifierExtensionΣ ?! I0..*Extension
There are no (further) constraints on this element
Element id

Task.output.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
type1..1CodeableConcept
There are no (further) constraints on this element
Element id

Task.output.type

Short description

Label for output

Alternate names

Name

Definition

The name of the Output parameter.

Requirements

Outputs are named to enable task automation to bind data and pass it from one task to the next.

Data type

CodeableConcept

Binding

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.

(unbound) (example)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: ???
value[x]S1..1
There are no (further) constraints on this element
Element id

Task.output.value[x]

Short description

Result of output

Definition

The value of the Output parameter as a basic type.

Requirements

Task outputs can take any form.

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: ???
valueStringstringData type

string

valueCodecodeData type

code

valueReferenceReference(Communication)Data type

Reference(Communication)

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="CA-eReC-Task" />
    <url value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Task" />
    <name value="Task" />
    <title value="Task" />
    <status value="draft" />
    <description value="A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="Task" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Task" />
    <derivation value="constraint" />
    <differential>
        <element id="Task.extension">
            <path value="Task.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
        </element>
        <element id="Task.extension:PatientNeedsToBeSeen">
            <path value="Task.extension" />
            <sliceName value="PatientNeedsToBeSeen" />
            <comment value="Used to support the eConsult use case where a patient is referred to a care provider. Used for when the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-patient-needs-to-be-seen-EXT" />
            </type>
        </element>
        <element id="Task.basedOn">
            <path value="Task.basedOn" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Task.basedOn.reference">
            <path value="Task.basedOn.reference" />
            <mustSupport value="true" />
        </element>
        <element id="Task.basedOn.identifier">
            <path value="Task.basedOn.identifier" />
            <mustSupport value="true" />
        </element>
        <element id="Task.basedOn.identifier.use">
            <path value="Task.basedOn.identifier.use" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Task.basedOn.identifier.system">
            <path value="Task.basedOn.identifier.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Task.basedOn.identifier.value">
            <path value="Task.basedOn.identifier.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Task.status">
            <path value="Task.status" />
            <mustSupport value="true" />
        </element>
        <element id="Task.businessStatus">
            <path value="Task.businessStatus" />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/task-business-status" />
            </binding>
        </element>
        <element id="Task.businessStatus.extension:StatusReason">
            <path value="Task.businessStatus.extension" />
            <sliceName value="StatusReason" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-task-business-status-reason-EXT" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Task.intent">
            <path value="Task.intent" />
            <patternCode value="proposal" />
            <mustSupport value="true" />
        </element>
        <element id="Task.code">
            <path value="Task.code" />
            <comment value="-" />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="http://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/task-code" />
            </binding>
        </element>
        <element id="Task.authoredOn">
            <path value="Task.authoredOn" />
            <mustSupport value="true" />
        </element>
        <element id="Task.owner">
            <path value="Task.owner" />
            <comment value="When the owner of the task is the CAT, then HealthcareService can be used to identify the owner." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-HealthcareService" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Task.owner.reference">
            <path value="Task.owner.reference" />
            <mustSupport value="true" />
        </element>
        <element id="Task.owner.identifier">
            <path value="Task.owner.identifier" />
            <mustSupport value="true" />
        </element>
        <element id="Task.owner.identifier.system">
            <path value="Task.owner.identifier.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Task.owner.identifier.value">
            <path value="Task.owner.identifier.value" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Task.output">
            <path value="Task.output" />
            <mustSupport value="true" />
        </element>
        <element id="Task.output.value[x]">
            <path value="Task.output.value[x]" />
            <type>
                <code value="Reference" />
                <targetProfile value="http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Communication" />
            </type>
            <type>
                <code value="string" />
            </type>
            <type>
                <code value="code" />
            </type>
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "CA-eReC-Task",
    "url": "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Task",
    "name": "Task",
    "title": "Task",
    "status": "draft",
    "description": "A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Task",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Task",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Task.extension",
                "path": "Task.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                }
            },
            {
                "id": "Task.extension:PatientNeedsToBeSeen",
                "path": "Task.extension",
                "sliceName": "PatientNeedsToBeSeen",
                "comment": "Used to support the eConsult use case where a patient is referred to a care provider. Used for when the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-patient-needs-to-be-seen-EXT"
                        ]
                    }
                ]
            },
            {
                "id": "Task.basedOn",
                "path": "Task.basedOn",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-ServiceRequest"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Task.basedOn.reference",
                "path": "Task.basedOn.reference",
                "mustSupport": true
            },
            {
                "id": "Task.basedOn.identifier",
                "path": "Task.basedOn.identifier",
                "mustSupport": true
            },
            {
                "id": "Task.basedOn.identifier.use",
                "path": "Task.basedOn.identifier.use",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Task.basedOn.identifier.system",
                "path": "Task.basedOn.identifier.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Task.basedOn.identifier.value",
                "path": "Task.basedOn.identifier.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Task.status",
                "path": "Task.status",
                "mustSupport": true
            },
            {
                "id": "Task.businessStatus",
                "path": "Task.businessStatus",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/task-business-status"
                }
            },
            {
                "id": "Task.businessStatus.extension:StatusReason",
                "path": "Task.businessStatus.extension",
                "sliceName": "StatusReason",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-task-business-status-reason-EXT"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Task.intent",
                "path": "Task.intent",
                "patternCode": "proposal",
                "mustSupport": true
            },
            {
                "id": "Task.code",
                "path": "Task.code",
                "comment": "-",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/task-code"
                }
            },
            {
                "id": "Task.authoredOn",
                "path": "Task.authoredOn",
                "mustSupport": true
            },
            {
                "id": "Task.owner",
                "path": "Task.owner",
                "comment": "When the owner of the task is the CAT, then HealthcareService can be used to identify the owner.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-PractitionerRole",
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-HealthcareService"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Task.owner.reference",
                "path": "Task.owner.reference",
                "mustSupport": true
            },
            {
                "id": "Task.owner.identifier",
                "path": "Task.owner.identifier",
                "mustSupport": true
            },
            {
                "id": "Task.owner.identifier.system",
                "path": "Task.owner.identifier.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Task.owner.identifier.value",
                "path": "Task.owner.identifier.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Task.output",
                "path": "Task.output",
                "mustSupport": true
            },
            {
                "id": "Task.output.value[x]",
                "path": "Task.output.value[x]",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Communication"
                        ]
                    },
                    {
                        "code": "string"
                    },
                    {
                        "code": "code"
                    }
                ],
                "mustSupport": true
            }
        ]
    }
}

Terminology bindings

PathConformanceValueSet
Task.businessStatusextensiblehttp://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/task-business-status
Task.codeextensiblehttp://fhir.infoway-inforoute.ca/io/CA-eReC/ValueSet/task-code

Constraints

PathIdGradeDetailsExpression
Task; Task; Task; Task; Task; Task; Task.meta; Task.implicitRules; Task.language; Task.text; Task.extension; Task.extension; Task.extension:PatientNeedsToBeSeen; Task.extension:PatientNeedsToBeSeen; Task.modifierExtension; Task.modifierExtension; Task.identifier; Task.instantiatesCanonical; Task.instantiatesUri; Task.basedOn; Task.basedOn.extension; Task.basedOn.extension; Task.basedOn.reference; Task.basedOn.type; Task.basedOn.identifier; Task.basedOn.identifier.extension; Task.basedOn.identifier.extension; Task.basedOn.identifier.use; Task.basedOn.identifier.type; Task.basedOn.identifier.system; Task.basedOn.identifier.value; Task.basedOn.identifier.period; Task.basedOn.identifier.assigner; Task.basedOn.display; Task.groupIdentifier; Task.partOf; Task.status; Task.statusReason; Task.businessStatus; Task.businessStatus.extension; Task.businessStatus.extension; Task.businessStatus.extension:StatusReason; Task.businessStatus.extension:StatusReason; Task.businessStatus.coding; Task.businessStatus.text; Task.intent; Task.priority; Task.code; Task.description; Task.focus; Task.for; Task.encounter; Task.executionPeriod; Task.authoredOn; Task.lastModified; Task.requester; Task.performerType; Task.owner; Task.owner.extension; Task.owner.extension; Task.owner.reference; Task.owner.type; Task.owner.identifier; Task.owner.identifier.extension; Task.owner.identifier.extension; Task.owner.identifier.use; Task.owner.identifier.type; Task.owner.identifier.system; Task.owner.identifier.value; Task.owner.identifier.period; Task.owner.identifier.assigner; Task.owner.display; Task.location; Task.reasonCode; Task.reasonReference; Task.insurance; Task.note; Task.relevantHistory; Task.restriction; Task.restriction.extension; Task.restriction.extension; Task.restriction.modifierExtension; Task.restriction.modifierExtension; Task.restriction.repetitions; Task.restriction.period; Task.restriction.recipient; Task.input; Task.input.extension; Task.input.extension; Task.input.modifierExtension; Task.input.modifierExtension; Task.input.type; Task.input.value[x]; Task.output; Task.output.extension; Task.output.extension; Task.output.modifierExtension; Task.output.modifierExtension; Task.output.type; Task.output.value[x]dom-2; dom-3; dom-4; dom-5; dom-6; inv-1; ele-1; ele-1; ele-1; ele-1; ele-1; ext-1; ele-1; ext-1; ele-1; ext-1; ele-1; ele-1; ele-1; ele-1; ele-1; ext-1; ele-1; ele-1; ele-1; ele-1; ext-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ext-1; ele-1; ext-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ext-1; ele-1; ele-1; ele-1; ele-1; ext-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ele-1; ext-1; ele-1; ext-1; ele-1; ele-1; ele-1; ele-1; ele-1; ext-1; ele-1; ext-1; ele-1; ele-1; ele-1; ele-1; ext-1; ele-1; ext-1; ele-1; ele-1error; error; error; error; warning; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; error; errorIf the resource is contained in another resource, it SHALL NOT contain nested Resources; 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; If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated; If a resource is contained in another resource, it SHALL NOT have a security label; A resource should have narrative for robust management; Last modified date must be greater than or equal to authored-on date.; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; Must have either extensions or value[x], not both; All FHIR elements must have a @value or children; All FHIR elements must have a @value or childrencontained.contained.empty(); 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(); contained.meta.versionId.empty() and contained.meta.lastUpdated.empty(); contained.meta.security.empty(); text.`div`.exists(); lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn; hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); extension.exists() != value.exists(); hasValue() or (children().count() > id.count()); hasValue() or (children().count() > id.count())

Usage

The Task resource is used as follows in this IG:

  • a "Process Request" Task ("Task.code": "process-request") SHALL be used by a Target System to track and communicate the status of a referral request to the Source System

  • a "Process Request Consult" Task ("Task.code": "process-request-consult") SHALL be used by a Target System to track and communicate the status of a consult request to the Source System

Each Task SHALL reference the ServiceRequest it is basedOn.

Notes

.id

  • used to uniquely identify the resource
  • if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)

extension:PatientNeedsToBeSeen

  • Used in the Ontario iGuide to support the eConsult use case where a patient is referred to a care provider, the care provider responds with an eConsult rather than accept the referral, but the patient wants a referral anyway.

.basedOn

  • used to associate the Task with the ServiceRequest being performed
  • SHALL be populated with a reference to the ServiceRequest being performed
  • if the Task is being transmitted via messaging, this element SHALL be populated with either:
    • a .reference to a resource included in the message as a Bundle.entry, or
    • an .identifier populated with the use, system and value elements populated with the official ServiceRequest.identifier received from the Source System

.status

  • for a "Process Request" Task, used to track the status of the ServiceRequest being performed as work progresses through to completion
  • for a "Request for Information" Task, used to track the status of the request for information

.businessStatus

  • used to convey the business status of the Task, which can be different from the .status. It can be more finegrained and is implementation-specific.

.businessStatus.extension:StatusReason

  • provides a coded reason for the .businessStatus

.intent

  • only "proposal" SHALL be supported
  • "plan" and "order" MAY be populated, and systems that do not understand "plan" or "order" codes will treat the value as "proposal"

.code

  • identifies the type of task
  • SHALL always be populated
    • with "process-request" for a "Process Request" Task
    • with "process-request-consult" for a "Process Request" eConsult Task

.authoredOn

  • indicates the dateTime that the eReferral was received
  • usually the same as ServiceRequest.authoredOn, except in cases when ServiceRequest.authoredOn is used to record that a request was signed by the requester before the transmission took place

.lastModified

  • indicates the dateTime when an update of note/significance was made to the referral (i.e., related resources such as ServiceRequest, patient, Task, Appointment, etc...)

.owner

  • a reference to the PractitionerRole or HealthcareService responsible for handling the referral
  • if the Task is being transmitted via messaging, this element SHALL contain a .reference a resource included in the message as a Bundle.entry

.output

  • MAY to used to provide the outcome of a Referral
  • SHALL contain a reference to Communication when an eConsult is provided by a specialist

Table of Contents | IG © based on FHIR R4 | Package package:ca.infoway.io.erec@1.1.1-dft-ballot | Version History
HL7® and FHIR® are the registered trademarks of Health Level Seven International