NHS England FHIR Implementation Guide (deprecated)

Element 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(Reference(NHSDigitalPractitionerRole | NHSDigitalPractitioner | NHSDigitalHealthcareService))

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
rim:N/A

agent

S I

0..1

Element Id

Task.extension:agent

Short description

Provenance of the resource

Alternate names

extensions, user content

Definition

Is used as the author on request resources.

Comments

Data Type

Extension(Reference(NHSDigitalPractitionerRole | NHSDigitalPractitioner | NHSDigitalHealthcareService))

Extension URL

https://fhir.nhs.uk/StructureDefinition/Extension-Provenance-agent

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

prescription

S I

0..1

Extension(Complex)

Element Id

Task.extension:prescription

Short description

EPS Patient Tracker extension

Alternate names

extensions, user content

Definition

"extension":  [
        {
            "url": "https://fhir.nhs.uk/StructureDefinition/Extension-EPS-Prescription",
            "extension":  [
                {
                    "url": "courseOfTherapyType",
                    "valueCoding": {
                        "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-course-of-therapy",
                        "code": "acute",
                        "display": "Acute"
                    }
                }
            ]
        }
    ],

Comments

Data Type

Extension(Complex)

Extension URL

https://fhir.nhs.uk/StructureDefinition/Extension-EPS-Prescription

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

repeatInformation

S I

0..1

Extension(Complex)

Element Id

Task.extension:repeatInformation

Short description

Used in the EPS Prescription Tracker

Alternate names

extensions, user content

Definition

"extension": [
        {
            "url": "https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation",
            "extension": [
                {
                    "url": "numberOfRepeatsAllowed",
                    "valueUnsignedInt": 6
                },
                {
                    "url": "numberOfRepeatsIssued",
                    "valueUnsignedInt": 2
                }
            ]
        },

Comments

Data Type

Extension(Complex)

Extension URL

https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation

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

identifier

0..*

Element Id

Task.identifier

Short description

Task Instance Identifier

Definition

For EPS

A single identifier MUST be present and the value must be a UUID.

"identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "5AC84C11-DB8B-44DA-8FCF-8980B3D13596"
        }
    ],

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
workflow:Request.identifier, Event.identifier
w5:FiveWs.identifier
rim:.id

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.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

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.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

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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

instantiatesCanonical

0..1

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.

Comments

see Canonical References

Data Type

Constraints

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

Mappings

rim:n/a
workflow:Request.instantiatesCanonical, Event.instantiatesCanonical
rim:.outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..1

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.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data Type

Constraints

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

Mappings

rim:n/a
workflow:Event.instantiatesUrl
rim:.outboundRelationship[typeCode=DEFN].target

basedOn

Σ I

0..*

There are no (further) constraints on this element

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.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.basedOn, Event.basedOn
rim:.outboundRelationship[typeCode=FLFS].target[moodCode=INT]

reference

Σ I

0..1

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

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

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

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

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

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

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.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

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

Constraints

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

Mappings

rim:n/a
rim:N/A

groupIdentifier

S Σ

0..1

Element Id

Task.groupIdentifier

Short description

Requisition or grouper id

Definition

EPS Only

An identifier to the original prescription-order MUST be present. Only the short form identifier needs to be supplied.

"groupIdentifier": {
        "system": "https://fhir.nhs.uk/Id/prescription-order-number",
        "value": "88AF6C-C81007-00001C"
    },

Requirements

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
workflow:Request.groupIdentifier
rim:.inboundRelationship[typeCode=COMP].source[moodCode=INT].id

partOf

Σ I

0..*

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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Event.partOf
rim:.inboundRelationship[typeCode=COMP].source[moodCode=INT]

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.partOf.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.partOf.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.partOf.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.partOf.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

Constraints

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

Mappings

rim:n/a
rim:N/A

status

S Σ ?!

1..1

codeBinding

Element Id

Task.status

Short description

draft | requested | received | accepted | +

Definition

These workflow tasks have status which indicates the Task status.

The following diagram reflects the "typical" state machine for Task. Note that not all states will be supported by all workflows and that some workflows may support additional transitions, including transitions from terminal states (e.g. back to "in-progress" from "failed" or "completed").

For example:

A patient requesting a repeat prescription would ask for task with code fulfil used with 103742009 | Renewal of prescription and a status of requested.
Once reviewed (by a clinician), the task status would be changed to accepted. When the task is then picked up (in-progress) and the related MedicationRequest is sent, the status would change to completed.

Requirements

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

Comments

For EPS

Only in-progress is currently supported for reasonCode = 373784005 (Dispensing medication) and focus is a dispense-notification.

rejected / cancelled / failed are supported for reasonCode = 33633005 (Prescription of drug) and focus is a prescription-order.

Data Type

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

rim:n/a
workflow:Request.status, Event.status
w5:FiveWs.status
rim:.statusCode

statusReason

0..1

Element Id

Task.statusReason

Short description

Reason for current status

Definition

For EPS only

reasonCode	focus	status	CodeSystem
373784005 - Dispensing medication	`dispense-notification`	`cancelled`	https://fhir.nhs.uk/CodeSystem/EPS-task-dispense-withdraw-reason
33633005 - Prescription of drug	`prescription-order`	`rejected` / `cancelled` / `failed`	https://fhir.nhs.uk/CodeSystem/EPS-task-dispense-return-status-reason

"statusReason": [{
        "coding":  [
            {
                "system": "https://fhir.nhs.uk/CodeSystem/EPS-task-dispense-withdraw-reason",
                "code": "DA",
                "display": "Dosage Amendments"
            }
        ]
    }]

Comments

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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
rim:.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code="status change"].reasonCode

businessStatus

0..1

There are no (further) constraints on this element

Element 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.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
rim:.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="business status"]

intent

S Σ

1..1

codeBinding

Element Id

Task.intent

Short description

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

Is not processed by EPS and is included for FHIR compliance reasons. The value should always be order.

Data Type

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())

Mappings

rim:n/a
workflow:Request.intent
w5:FiveWs.class
rim:.moodCode

priority

0..1

codeBinding

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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning When Missing

If missing, this task should be performed with normal priority

Data Type

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

rim:n/a
workflow:Request.priority
w5:FiveWs.grade
rim:.priorityCode

code

S Σ

1..1

Element Id

Task.code

Short description

Task Type

Definition

e-RS

A SNOMED CT procedure code to indicate the action

  "code": {
        "coding": [
            {
                "system": "http://snomed.info/sct",
                "code": "386053000",
                "display": "Evaluation procedure"
            }
        ]
    },

EPS

The SNOMED action codes are complemented with order delivery task-code which indicates the type of action to be performed against the focal resource.

For example:

The code fulfil used with 182836005 | Review of medication means a task to review medication. The code approve used with 103742009 | Renewal of prescription is a task for a clinician to approve the issue of a repeat medication.

 "code": {
        "coding":  [
            {
                "system": "http://hl7.org/fhir/CodeSystem/task-code",
                "code": "fulfill",
                "display": "Fulfill the focal request"
            }
        ]

Comments

The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.

Data Type

Binding

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

TaskCode (example)

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow:Request.code, Event.code
w5:FiveWs.what[x]
rim:.code

coding

0..*

Element Id

Task.code.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

Sliced:

Unordered, Open, by system(Value)

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

(All Slices)

There are no (further) constraints on this element

system

1..1

There are no (further) constraints on this element

Element Id

Task.code.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

There are no (further) constraints on this element

Element Id

Task.code.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

SNOMED

0..*

CodingBinding

Element Id

Task.code.coding:SNOMED

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

Data Type

NHSDigital Action Code (extensible)

Binding

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

system

0..1

uriFixed Value

Element Id

Task.code.coding:SNOMED.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data Type

Constraints

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

Fixed Value

http://snomed.info/sct

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:SNOMED.version

Short description

Version of the system - if relevant

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:SNOMED.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:SNOMED.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:SNOMED.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Fulfilment

0..*

CodingBinding

Element Id

Task.code.coding:Fulfilment

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

Data Type

NHSDigital Task Code (extensible)

Binding

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

system

0..1

uriFixed Value

Element Id

Task.code.coding:Fulfilment.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data Type

Constraints

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

Fixed Value

http://hl7.org/fhir/CodeSystem/task-code

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Fulfilment.version

Short description

Version of the system - if relevant

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Fulfilment.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Fulfilment.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Fulfilment.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Worflow

0..*

CodingBinding

Element Id

Task.code.coding:Worflow

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

Data Type

NHSDigital Workflow Code (extensible)

Binding

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

system

0..1

uriFixed Value

Element Id

Task.code.coding:Worflow.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data Type

Constraints

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

Fixed Value

https://fhir.nhs.uk/CodeSystem/Workflow-Code

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Worflow.version

Short description

Version of the system - if relevant

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Worflow.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Worflow.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Worflow.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element Id

Task.code.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

Constraints

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

Mappings

rim:n/a
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

description

0..1

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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
rim:.text

focus

S Σ I

0..1

Reference(NHSDigitalAppointment | NHSDigitalServiceRequest | NHSDigitalBundleFHIRMessage | NHSDigitalMedicationRequest | UK Core Patient)

Element Id

Task.focus

Short description

What task is acting on

Definition

e-RS

Reference to the resource which is the focus of the action

 "focus": {
        "reference": "https://server.fire.ly/ServiceRequest/eb13327f-e990-4667-b37a-89eb93a94c47"
    },

** EPS Only**

This will be the Bundle.identifier of the message this Task is acting on. For Tasks with a reasonCode of 373784005 - Dispensing medication this will be a dispense-notification message. For Tasks with a reasonCode of 33633005 - Prescription of drug this will be the prescription-order message from the Task/$release operation.

"focus": {
        "type": "Bundle",
        "identifier": {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "334a3195-1f6c-497a-8efe-d272ca9c4e38"
        }
    },

Requirements

Used to identify the thing to be done.

Comments

Tasks are often generated as a consequence of other workflows or relate to FHIR Workflow resources. For example a repeat medication request will be related to a previous MedicationRequest or a medication reconciliation may relate to a hospital admissions Encounter/EpisodeOfCare. This is carried in the focus element.

focus can be omitted. For example if an ED generated a Medication Review as a result of COPD Emergency encounter they may chose to include a reference to the Encounter but they may decide instead to use a more specific reasonCode such as 394720003 | Asthma medication review.

Data Type

Reference(NHSDigitalAppointment | NHSDigitalServiceRequest | NHSDigitalBundleFHIRMessage | NHSDigitalMedicationRequest | UK Core Patient)

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
nhsd-taskfocus:focus - An identifier reference or resource reference must be provided
(reference.exists() or identifier.exists())

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5:FiveWs.what[x]
rim:.outboundRelationship[typeCode=SUBJ].target

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.focus.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.focus.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.focus.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.focus.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.focus.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.focus.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.focus.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.focus.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.focus.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.focus.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

Constraints

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

Mappings

rim:n/a
rim:N/A

for

S Σ I

1..1

Element Id

Task.for

Short description

Beneficiary of the Task

Alternate names

Patient

Definition

A reference to the patient the Task is for. This will always be an identifier reference using the Patients NHSNumber.

"for": {
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9446368138"
        }
    },

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.

Comments

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
patient-reference:An identifier reference or resource reference must be provided
(reference.exists() or identifier.exists())
patient-nhs:NHS Number must be in the English and Welsh NHS Number range or length of the number is wrong.
identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists() and identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').value.matches('^([456789]{1}[0-9]{9})$'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.subject, Event.subject
w5:FiveWs.subject[x]
rim:.participation[typeCode=RCT].role
w5:FiveWs.subject

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.for.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.for.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

1..1

There are no (further) constraints on this element

Element Id

Task.for.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.for.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.for.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

1..1

uriFixed Value

Element Id

Task.for.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

Constraints

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

Fixed Value

https://fhir.nhs.uk/Id/nhs-number

Mappings

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

1..1

There are no (further) constraints on this element

Element Id

Task.for.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.for.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.for.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.for.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

Constraints

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

Mappings

rim:n/a
rim:N/A

encounter

Σ I

0..1

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.

Comments

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.context, Event.context
w5:FiveWs.context
rim:.inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.encounter.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.encounter.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.encounter.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.encounter.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

Constraints

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

Mappings

rim:n/a
rim:N/A

executionPeriod

Σ I

0..1

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).

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow:Event.occurrence[x]
w5:FiveWs.done[x]
rim:.effectiveTime

authoredOn

S I

0..1

Element Id

Task.authoredOn

Short description

Task Creation Date

Alternate names

Created Date

Definition

Date and time the task was created.

"authoredOn": "2020-12-21T17:03:20-00:00",

Requirements

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

Data Type

Constraints

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

Mappings

rim:n/a
workflow:Request.authoredOn
w5:FiveWs.recorded
rim:.participation[typeCode=AUT].time

lastModified

Σ I

0..1

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

Constraints

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

Mappings

rim:n/a
rim:.inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime

requester

S Σ I

0..1

Element Id

Task.requester

Short description

Who is asking for task to be done

Definition

Who is created the Request or the Event. In NHSDigital API's this SHOULD always be a PractitionerRole role reference.

 "requester": {
        "reference": "#requester"
    },

This will reference a contained PractitionerRole (note: this resource only contains limited user metadata such as ODS Code, professional code and SDS User Profile Id). This resource should not hold data which is held in SDS, only enough information to identify the SDS Entry,

{
    "resourceType": "Task",
    "id": "bd1ca5c4-ff49-4f2a-9db4-f5dda0112084",
    "meta": {
        "lastUpdated": "2016-07-11T11:07:22+00:00"
    },
    "contained": [
        {
            "resourceType": "PractitionerRole",
            "id": "requester",
            "practitioner": {
                "identifier": {
                    "system": "https://fhir.hl7.org.uk/Id/gmp-number",
                    "value": "G8123456"
                },
                "display": "DR AA BHATIA"
            },
            "organization": {
                "identifier": {
                    "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                    "value": "C81007"
                },
                "display": "VERNON STREET MEDICAL CTR"
            },
            "telecom": [
                {
                    "system": "phone",
                    "use": "work",
                    "value": "01234567890"
                }
            ]
        }
    ],

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).

Comments

Data Type

Allowed aggregation: contained

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.requester
w5:FiveWs.author
rim:.participation[typeCode=AUT].role

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.requester.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.requester.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.requester.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.requester.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.requester.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

1..1

There are no (further) constraints on this element

Element Id

Task.requester.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

1..1

There are no (further) constraints on this element

Element Id

Task.requester.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.requester.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.requester.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.requester.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

Constraints

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

Mappings

rim:n/a
rim:N/A

performerType

0..*

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.

Comments

Data Type

ProcedurePerformerRoleCodes (preferred)

Binding

The type(s) of task performers allowed.

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow:Event.performer.role, Request.performerType
w5:FiveWs.actor
rim:.participation[typeCode=PRF].role.code

owner

S Σ I

0..1

Reference(NHSDigitalPractitionerRole | NHSDigitalOrganization)

Element Id

Task.owner

Short description

Responsible organisation

Alternate names

Performer, Executer

Definition

EPS

Who is responsible for actioning the request Task (e.g. for a prescription-order this will be the pharmacy).

"owner": {
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "FB444"
        },
        "display": "Freds Pharmacy"
    },

e-RS

"owner": {
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/ers-service",
            "value": "12444"
        }
    },

Requirements

Identifies who is expected to perform this task.

Comments

Tasks may be created with an owner not yet identified.

Data Type

Reference(NHSDigitalPractitionerRole | NHSDigitalOrganization)

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Event.performer.actor, Request.performer
w5:FiveWs.actor
rim:.participation[typeCode=PRF].role

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.owner.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.owner.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

1..1

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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

1..1

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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

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.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

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

Reference(UK Core Location)

Constraints

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

Mappings

rim:n/a
rim:N/A

location

Σ I

0..1

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).

Comments

Data Type

Reference(UK Core Location)

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.reasonCode, Event.reasonCode
w5:FiveWs.where[x]
rim:.participation[typeCode=LOC].role

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.location.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.location.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.location.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.location.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.location.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.location.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.location.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.location.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.location.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.location.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

Constraints

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

Mappings

rim:n/a
rim:N/A

reasonCode

0..1

Element Id

Task.reasonCode

Short description

Why task is needed

Definition

In FHIR Task these types of workflow would be represented via reasonCode and/or reasonReference

For medication this is probably SNOMED CT based using codes under the SNOMED CT 182832007 Medication management and includes codes such as:

SNOMED CT	Display
33633005	Prescription of drug
373784005	Dispensing medication

For referral management

SNOMED CT	Display
3457005	Patient Referral
185499000	Expedite appointment

Comments

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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow:Event.location
w5:FiveWs.why[x]
v2:EVN.7
rim:.reasonCode

coding

0..*

Element Id

Task.reasonCode.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

Data Type

Sliced:

Unordered, Open, by system(Value)

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

(All Slices)

There are no (further) constraints on this element

system

1..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

1..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

SNOMED

0..*

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding:SNOMED

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

system

0..1

uriFixed Value

Element Id

Task.reasonCode.coding:SNOMED.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data Type

Constraints

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

Fixed Value

http://snomed.info/sct

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding:SNOMED.version

Short description

Version of the system - if relevant

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding:SNOMED.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding:SNOMED.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.coding:SNOMED.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element Id

Task.reasonCode.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

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
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

reasonReference

0..1

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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.reasonReference, Event.reasonReference
w5:FiveWs.why[x]
rim:.outboundRelationship[typeCode=RSON].target

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.reasonReference.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.reasonReference.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.reasonReference.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.reasonReference.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.reasonReference.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.reasonReference.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.reasonReference.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.reasonReference.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.reasonReference.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.reasonReference.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

Constraints

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

Mappings

rim:n/a
rim:N/A

insurance

0..*

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.

Comments

Data Type

Reference(Coverage | ClaimResponse)

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.insurance
v2:IN1/IN2
rim:.outboundRelationship[typeCode=COVBY].target

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.insurance.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.insurance.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.insurance.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.insurance.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.insurance.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.insurance.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.insurance.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.insurance.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.insurance.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.insurance.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

Constraints

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

Mappings

rim:n/a
rim:N/A

note

0..*

Element Id

Task.note

Short description

Comments made about the task

Definition

EPS Only

This may contain cancellation reason.

e-RS

Used to add notes to the worklist items

"note": [
    {
      "text": "Optional comments"
    }
  ]

Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Data Type

Reference(UK Core Provenance)

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Act
workflow:Request.note, Event.note
rim:.inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code="annotation"].value(string)

relevantHistory

0..*

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(UK Core Provenance)

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.relevantHistory
rim:.inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.relevantHistory.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.relevantHistory.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.relevantHistory.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.relevantHistory.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.relevantHistory.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.relevantHistory.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.relevantHistory.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.relevantHistory.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.relevantHistory.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.relevantHistory.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

Constraints

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

Mappings

rim:n/a
rim:N/A

restriction

0..1

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

Constraints

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

Mappings

rim:n/a
rim:Instead of pointing to request, would point to component of request, having these characteristics

repetitions

0..1

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.

Comments

32 bit number; for values larger than this, use decimal

Data Type

Constraints

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

Mappings

rim:n/a
rim:.repeatNumber

period

0..1

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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
rim:.effectiveTime(IVL<TS>)

start

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.restriction.period.start

Short description

Starting time with inclusive boundary

Definition

The start of the period. The boundary is inclusive.

Comments

If the low element is missing, the meaning is that the low boundary is not known.

Data Type

Constraints

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

Mappings

rim:n/a
v2:DR.1
rim:./low

end

S Σ I

0..1

Element Id

Task.restriction.period.end

Short description

End time with inclusive boundary, if not ongoing

Definition

In e-RS this is also known as the review date due.

Comments

e-RS

If deferred to provider (because there were no appointments available for a directly bookable service) then this is the date by which the provide should resolve the appointment slot issue; or
If the referral was sent to a triage service then this is the date by which the provider should have reviewed the referral

Meaning When Missing

If the end of the period is missing, it means that the period is ongoing

Data Type

Constraints

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

Mappings

rim:n/a
v2:DR.2
rim:./high

recipient

0..*

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?

Comments

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim:.participation[typeCode=SBJ].role

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.restriction.recipient.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

Constraints

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

Mappings

rim:n/a
rim:N/A

input

0..*

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

Constraints

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

Mappings

rim:n/a
rim:???

type

1..1

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

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.

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
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:n/a
rim:???

valueBase64Binary

There are no (further) constraints on this element

Data Type

valueBoolean

There are no (further) constraints on this element

Data Type

valueCanonical

There are no (further) constraints on this element

Data Type

valueCode

There are no (further) constraints on this element

Data Type

valueDate

There are no (further) constraints on this element

Data Type

valueDateTime

There are no (further) constraints on this element

Data Type

valueDecimal

There are no (further) constraints on this element

Data Type

valueId

There are no (further) constraints on this element

Data Type

valueInstant

There are no (further) constraints on this element

Data Type

valueInteger

There are no (further) constraints on this element

Data Type

valueMarkdown

There are no (further) constraints on this element

Data Type

valueOid

There are no (further) constraints on this element

Data Type

valuePositiveInt

There are no (further) constraints on this element

Data Type

valueString

There are no (further) constraints on this element

Data Type

valueTime

There are no (further) constraints on this element

Data Type

valueUnsignedInt

There are no (further) constraints on this element

Data Type

valueUri

There are no (further) constraints on this element

Data Type

valueUrl

There are no (further) constraints on this element

Data Type

valueUuid

There are no (further) constraints on this element

Data Type

valueAddress

There are no (further) constraints on this element

Data Type

valueAge

There are no (further) constraints on this element

Data Type

valueAnnotation

There are no (further) constraints on this element

Data Type

valueAttachment

There are no (further) constraints on this element

Data Type

valueCodeableConcept

There are no (further) constraints on this element

Data Type

valueCoding

There are no (further) constraints on this element

Data Type

valueContactPoint

There are no (further) constraints on this element

Data Type

valueCount

There are no (further) constraints on this element

Data Type

valueDistance

There are no (further) constraints on this element

Data Type

valueDuration

There are no (further) constraints on this element

Data Type

valueHumanName

There are no (further) constraints on this element

Data Type

valueIdentifier

There are no (further) constraints on this element

Data Type

valueMoney

There are no (further) constraints on this element

Data Type

valuePeriod

There are no (further) constraints on this element

Data Type

valueQuantity

There are no (further) constraints on this element

Data Type

valueRange

There are no (further) constraints on this element

Data Type

valueRatio

There are no (further) constraints on this element

Data Type

valueSampledData

There are no (further) constraints on this element

Data Type

valueSignature

There are no (further) constraints on this element

Data Type

valueTiming

There are no (further) constraints on this element

Data Type

valueContactDetail

There are no (further) constraints on this element

Data Type

valueContributor

There are no (further) constraints on this element

Data Type

valueDataRequirement

There are no (further) constraints on this element

Data Type

valueExpression

There are no (further) constraints on this element

Data Type

valueParameterDefinition

There are no (further) constraints on this element

Data Type

valueRelatedArtifact

There are no (further) constraints on this element

Data Type

valueTriggerDefinition

There are no (further) constraints on this element

Data Type

valueUsageContext

There are no (further) constraints on this element

Data Type

valueDosage

There are no (further) constraints on this element

Data Type

valueMeta

There are no (further) constraints on this element

Data Type

valueReference

There are no (further) constraints on this element

Data Type

output

0..*

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

Constraints

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

Mappings

rim:n/a
rim:???

type

1..1

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.

Comments

Data Type

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.

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
rim:???

value[x]

1..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:n/a
rim:???

valueBase64Binary

There are no (further) constraints on this element

Data Type

valueBoolean

There are no (further) constraints on this element

Data Type

valueCanonical

There are no (further) constraints on this element

Data Type

valueCode

There are no (further) constraints on this element

Data Type

valueDate

There are no (further) constraints on this element

Data Type

valueDateTime

There are no (further) constraints on this element

Data Type

valueDecimal

There are no (further) constraints on this element

Data Type

valueId

There are no (further) constraints on this element

Data Type

valueInstant

There are no (further) constraints on this element

Data Type

valueInteger

There are no (further) constraints on this element

Data Type

valueMarkdown

There are no (further) constraints on this element

Data Type

valueOid

There are no (further) constraints on this element

Data Type

valuePositiveInt

There are no (further) constraints on this element

Data Type

valueString

There are no (further) constraints on this element

Data Type

valueTime

There are no (further) constraints on this element

Data Type

valueUnsignedInt

There are no (further) constraints on this element

Data Type

valueUri

There are no (further) constraints on this element

Data Type

valueUrl

There are no (further) constraints on this element

Data Type

valueUuid

There are no (further) constraints on this element

Data Type

valueAddress

There are no (further) constraints on this element

Data Type

valueAge

There are no (further) constraints on this element

Data Type

valueAnnotation

There are no (further) constraints on this element

Data Type

valueAttachment

There are no (further) constraints on this element

Data Type

valueCodeableConcept

There are no (further) constraints on this element

Data Type

valueCoding

There are no (further) constraints on this element

Data Type

valueContactPoint

There are no (further) constraints on this element

Data Type

valueCount

There are no (further) constraints on this element

Data Type

valueDistance

There are no (further) constraints on this element

Data Type

valueDuration

There are no (further) constraints on this element

Data Type

valueHumanName

There are no (further) constraints on this element

Data Type

valueIdentifier

There are no (further) constraints on this element

Data Type

valueMoney

There are no (further) constraints on this element

Data Type

valuePeriod

There are no (further) constraints on this element

Data Type

valueQuantity

There are no (further) constraints on this element

Data Type

valueRange

There are no (further) constraints on this element

Data Type

valueRatio

There are no (further) constraints on this element

Data Type

valueSampledData

There are no (further) constraints on this element

Data Type

valueSignature

There are no (further) constraints on this element

Data Type

valueTiming

There are no (further) constraints on this element

Data Type

valueContactDetail

There are no (further) constraints on this element

Data Type

valueContributor

There are no (further) constraints on this element

Data Type

valueDataRequirement

There are no (further) constraints on this element

Data Type

valueExpression

There are no (further) constraints on this element

Data Type

valueParameterDefinition

There are no (further) constraints on this element

Data Type

valueRelatedArtifact

There are no (further) constraints on this element

Data Type

valueTriggerDefinition

There are no (further) constraints on this element

Data Type

valueUsageContext

There are no (further) constraints on this element

Data Type

valueDosage

There are no (further) constraints on this element

Data Type

valueMeta

There are no (further) constraints on this element

Data Type

valueReference

There are no (further) constraints on this element

Data Type

Task

Element Id

Task

Short description

A task to be performed

Definition

FHIR Task usage and scope is defined as

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. Note that there are a variety of processes associated with making and processing orders. Some orders may be handled immediately by automated systems but most require real world actions by one or more humans. Some orders can only be processed when other real world actions happen, such as a patient presenting themselves so that the action to be performed can actually be performed. Often these real world dependencies are only implicit in the order details.

A Task resource often exists in parallel with clinical resources.

Comments

Task has three main uses:

basic delivery of an order resource (e.g. MedicationRequest or ServiceRequest)
minor workflow requests (e.g. phone patient, complete form or validate a referral)
workflow support (centred around complex workflow support and may involves a workflow engine)

Order Fulfilment

Examples:

Task.code	Task.status	Task.focus	Task.requester	Meaning
fulfill	rejected	MedicationRequest	dispenser	The dispenser is rejecting the fulfilment/deliver of a referenced MedicationRequest. The MedicationRequest is not cancelled
fullfill	cancelled	MedicationRequest	any	The requested fulfilment of the MedicationRequest is cancelled. The referenced MedicationRequest is not cancelled
fullfill	accepted	MedicationRequest	dispenser	The dispenser is taking responsibility of fulfilling the referenced MedicationRequest.
fullfill	completed	MedicationRequest	dispenser	The requested fulfilment of the MedicationRequest is completed. The referenced MedicationRequest can now be changed to completed.

See the section on status for more details.

Minor Workflow Requests

This is used to implement additional around an order or to record specific workflow requests. These may not have a focused resource reference. It is anticipated they are coded using SNOMED CT.

Examples:

Task.code	Task.focus	Task.requester	Task.owner	Task.reasonCode	Meaning
413292001 Assessment for referral	ServiceRequest	referrer	clinician	3457005 Patient Referral	Check the referenced referral is valid.
182836005 Review of medication		clinician	GP	151715009 Emergency admission, asthma	Request to review medication following an emergency admission.
103742009 Renewal of prescription	MedicationRequest	patient	GP		Request for a reissue/refill of a medication
324861000000109 Review of patient laboratory test report	DiagnosticReport	consultant			Request for a lab report to be reviewed. See also UHS Lab Reports

The Task.status can be used to indicate fulfilment/delivery status.

Workflow Support

More advanced workflow is supported, this adds in the use of Task.input and Task.output. This allows the passage of inputs and outputs which may be found in automated workflow activities.

Data Type

Task

Constraints

dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6:A resource should have narrative for robust management
text.`div`.exists()
dom-5:If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()
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]

extension

0..*

Element Id

Task.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data Type

Extension(Reference(NHSDigitalPractitionerRole | NHSDigitalPractitioner | NHSDigitalHealthcareService))

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
rim:N/A

agent

S I

0..1

Element Id

Task.extension:agent

Short description

Provenance of the resource

Alternate names

extensions, user content

Definition

Is used as the author on request resources.

Comments

Data Type

Extension(Reference(NHSDigitalPractitionerRole | NHSDigitalPractitioner | NHSDigitalHealthcareService))

Extension URL

https://fhir.nhs.uk/StructureDefinition/Extension-Provenance-agent

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

prescription

S I

0..1

Extension(Complex)

Element Id

Task.extension:prescription

Short description

EPS Patient Tracker extension

Alternate names

extensions, user content

Definition

"extension":  [
        {
            "url": "https://fhir.nhs.uk/StructureDefinition/Extension-EPS-Prescription",
            "extension":  [
                {
                    "url": "courseOfTherapyType",
                    "valueCoding": {
                        "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-course-of-therapy",
                        "code": "acute",
                        "display": "Acute"
                    }
                }
            ]
        }
    ],

Comments

Data Type

Extension(Complex)

Extension URL

https://fhir.nhs.uk/StructureDefinition/Extension-EPS-Prescription

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

repeatInformation

S I

0..1

Extension(Complex)

Element Id

Task.extension:repeatInformation

Short description

Used in the EPS Prescription Tracker

Alternate names

extensions, user content

Definition

"extension": [
        {
            "url": "https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation",
            "extension": [
                {
                    "url": "numberOfRepeatsAllowed",
                    "valueUnsignedInt": 6
                },
                {
                    "url": "numberOfRepeatsIssued",
                    "valueUnsignedInt": 2
                }
            ]
        },

Comments

Data Type

Extension(Complex)

Extension URL

https://fhir.nhs.uk/StructureDefinition/Extension-EPS-RepeatInformation

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

identifier

0..*

Element Id

Task.identifier

Short description

Task Instance Identifier

Definition

For EPS

A single identifier MUST be present and the value must be a UUID.

"identifier":  [
        {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "5AC84C11-DB8B-44DA-8FCF-8980B3D13596"
        }
    ],

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
workflow:Request.identifier, Event.identifier
w5:FiveWs.identifier
rim:.id

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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

instantiatesCanonical

0..1

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.

Comments

see Canonical References

Data Type

Constraints

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

Mappings

rim:n/a
workflow:Request.instantiatesCanonical, Event.instantiatesCanonical
rim:.outboundRelationship[typeCode=DEFN].target

instantiatesUri

0..1

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.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data Type

Constraints

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

Mappings

rim:n/a
workflow:Event.instantiatesUrl
rim:.outboundRelationship[typeCode=DEFN].target

basedOn

Σ I

0..*

There are no (further) constraints on this element

Element Id

Task.basedOn

Short description

Request fulfilled by this task

Definition

Comments

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.basedOn, Event.basedOn
rim:.outboundRelationship[typeCode=FLFS].target[moodCode=INT]

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.basedOn.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.basedOn.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

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.

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

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

Constraints

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

Mappings

rim:n/a
rim:N/A

groupIdentifier

S Σ

0..1

Element Id

Task.groupIdentifier

Short description

Requisition or grouper id

Definition

EPS Only

An identifier to the original prescription-order MUST be present. Only the short form identifier needs to be supplied.

"groupIdentifier": {
        "system": "https://fhir.nhs.uk/Id/prescription-order-number",
        "value": "88AF6C-C81007-00001C"
    },

Requirements

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
workflow:Request.groupIdentifier
rim:.inboundRelationship[typeCode=COMP].source[moodCode=INT].id

partOf

Σ I

0..*

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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Event.partOf
rim:.inboundRelationship[typeCode=COMP].source[moodCode=INT]

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.partOf.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.partOf.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.partOf.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.partOf.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.partOf.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

Constraints

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

Mappings

rim:n/a
rim:N/A

status

S Σ ?!

1..1

codeBinding

Element Id

Task.status

Short description

draft | requested | received | accepted | +

Definition

These workflow tasks have status which indicates the Task status.

For example:

Requirements

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

Comments

For EPS

Only in-progress is currently supported for reasonCode = 373784005 (Dispensing medication) and focus is a dispense-notification.

rejected / cancelled / failed are supported for reasonCode = 33633005 (Prescription of drug) and focus is a prescription-order.

Data Type

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

rim:n/a
workflow:Request.status, Event.status
w5:FiveWs.status
rim:.statusCode

statusReason

0..1

Element Id

Task.statusReason

Short description

Reason for current status

Definition

For EPS only

reasonCode	focus	status	CodeSystem
373784005 - Dispensing medication	`dispense-notification`	`cancelled`	https://fhir.nhs.uk/CodeSystem/EPS-task-dispense-withdraw-reason
33633005 - Prescription of drug	`prescription-order`	`rejected` / `cancelled` / `failed`	https://fhir.nhs.uk/CodeSystem/EPS-task-dispense-return-status-reason

"statusReason": [{
        "coding":  [
            {
                "system": "https://fhir.nhs.uk/CodeSystem/EPS-task-dispense-withdraw-reason",
                "code": "DA",
                "display": "Dosage Amendments"
            }
        ]
    }]

Comments

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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
rim:.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code="status change"].reasonCode

businessStatus

0..1

There are no (further) constraints on this element

Element 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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
rim:.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="business status"]

intent

S Σ

1..1

codeBinding

Element Id

Task.intent

Short description

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

Is not processed by EPS and is included for FHIR compliance reasons. The value should always be order.

Data Type

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())

Mappings

rim:n/a
workflow:Request.intent
w5:FiveWs.class
rim:.moodCode

priority

0..1

codeBinding

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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning When Missing

If missing, this task should be performed with normal priority

Data Type

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

rim:n/a
workflow:Request.priority
w5:FiveWs.grade
rim:.priorityCode

code

S Σ

1..1

Element Id

Task.code

Short description

Task Type

Definition

e-RS

A SNOMED CT procedure code to indicate the action

  "code": {
        "coding": [
            {
                "system": "http://snomed.info/sct",
                "code": "386053000",
                "display": "Evaluation procedure"
            }
        ]
    },

EPS

The SNOMED action codes are complemented with order delivery task-code which indicates the type of action to be performed against the focal resource.

For example:

 "code": {
        "coding":  [
            {
                "system": "http://hl7.org/fhir/CodeSystem/task-code",
                "code": "fulfill",
                "display": "Fulfill the focal request"
            }
        ]

Comments

The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.

Data Type

Binding

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

TaskCode (example)

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow:Request.code, Event.code
w5:FiveWs.what[x]
rim:.code

coding

0..*

Element Id

Task.code.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

Data Type

Sliced:

Unordered, Open, by system(Value)

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

(All Slices)

There are no (further) constraints on this element

system

1..1

There are no (further) constraints on this element

Element Id

Task.code.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

There are no (further) constraints on this element

Element Id

Task.code.coding.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

SNOMED

0..*

CodingBinding

Element Id

Task.code.coding:SNOMED

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

Data Type

NHSDigital Action Code (extensible)

Binding

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

system

0..1

uriFixed Value

Element Id

Task.code.coding:SNOMED.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data Type

Constraints

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

Fixed Value

http://snomed.info/sct

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:SNOMED.version

Short description

Version of the system - if relevant

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:SNOMED.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:SNOMED.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:SNOMED.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Fulfilment

0..*

CodingBinding

Element Id

Task.code.coding:Fulfilment

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

Data Type

NHSDigital Task Code (extensible)

Binding

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

system

0..1

uriFixed Value

Element Id

Task.code.coding:Fulfilment.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data Type

Constraints

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

Fixed Value

http://hl7.org/fhir/CodeSystem/task-code

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Fulfilment.version

Short description

Version of the system - if relevant

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Fulfilment.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Fulfilment.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Fulfilment.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Worflow

0..*

CodingBinding

Element Id

Task.code.coding:Worflow

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

Data Type

NHSDigital Workflow Code (extensible)

Binding

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim:CV
orim:fhir:Coding rdfs:subClassOf dt:CDCoding
v2:C*E.1-8, C*E.10-22
rim:union(., ./translation)
orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

system

0..1

uriFixed Value

Element Id

Task.code.coding:Worflow.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data Type

Constraints

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

Fixed Value

https://fhir.nhs.uk/CodeSystem/Workflow-Code

Mappings

rim:n/a
v2:C*E.3
rim:./codeSystem
orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Worflow.version

Short description

Version of the system - if relevant

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.7
rim:./codeSystemVersion
orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Worflow.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.1
rim:./code
orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Worflow.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
v2:C*E.2 - but note this is not well followed
rim:CV.displayName
orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element Id

Task.code.coding:Worflow.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data Type

Constraints

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

Mappings

rim:n/a
v2:Sometimes implied by being first
rim:CD.codingRationale
orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

There are no (further) constraints on this element

Element Id

Task.code.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

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
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

description

0..1

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.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data Type

Constraints

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

Mappings

rim:n/a
rim:.text

focus

S Σ I

0..1

Reference(NHSDigitalAppointment | NHSDigitalServiceRequest | NHSDigitalBundleFHIRMessage | NHSDigitalMedicationRequest | UK Core Patient)

Element Id

Task.focus

Short description

What task is acting on

Definition

e-RS

Reference to the resource which is the focus of the action

 "focus": {
        "reference": "https://server.fire.ly/ServiceRequest/eb13327f-e990-4667-b37a-89eb93a94c47"
    },

** EPS Only**

"focus": {
        "type": "Bundle",
        "identifier": {
            "system": "https://tools.ietf.org/html/rfc4122",
            "value": "334a3195-1f6c-497a-8efe-d272ca9c4e38"
        }
    },

Requirements

Used to identify the thing to be done.

Comments

Data Type

Reference(NHSDigitalAppointment | NHSDigitalServiceRequest | NHSDigitalBundleFHIRMessage | NHSDigitalMedicationRequest | UK Core Patient)

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
nhsd-taskfocus:focus - An identifier reference or resource reference must be provided
(reference.exists() or identifier.exists())

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5:FiveWs.what[x]
rim:.outboundRelationship[typeCode=SUBJ].target

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.focus.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.focus.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.focus.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.focus.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.focus.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.focus.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.focus.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.focus.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.focus.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.focus.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

Constraints

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

Mappings

rim:n/a
rim:N/A

for

S Σ I

1..1

Element Id

Task.for

Short description

Beneficiary of the Task

Alternate names

Patient

Definition

A reference to the patient the Task is for. This will always be an identifier reference using the Patients NHSNumber.

"for": {
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9446368138"
        }
    },

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.

Comments

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
patient-reference:An identifier reference or resource reference must be provided
(reference.exists() or identifier.exists())
patient-nhs:NHS Number must be in the English and Welsh NHS Number range or length of the number is wrong.
identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists() and identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').value.matches('^([456789]{1}[0-9]{9})$'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.subject, Event.subject
w5:FiveWs.subject[x]
rim:.participation[typeCode=RCT].role
w5:FiveWs.subject

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.for.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.for.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

1..1

There are no (further) constraints on this element

Element Id

Task.for.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.for.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.for.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

1..1

uriFixed Value

Element Id

Task.for.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

Constraints

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

Fixed Value

https://fhir.nhs.uk/Id/nhs-number

Mappings

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

1..1

There are no (further) constraints on this element

Element Id

Task.for.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.for.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.for.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.for.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

Constraints

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

Mappings

rim:n/a
rim:N/A

encounter

Σ I

0..1

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.

Comments

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.context, Event.context
w5:FiveWs.context
rim:.inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.encounter.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.

Comments

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
rim:N/A

identifier

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

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

Data Type

Constraints

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

Mappings

rim:n/a
v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd:Identifier
rim:.identifier

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element Id

Task.encounter.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

Binding

Identifies the purpose for this identifier, if known .

Constraints

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

Mappings

rim:n/a
v2:N/A
rim:Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element Id

Task.encounter.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

Data Type

Binding

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

Constraints

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

Mappings

rim:n/a
v2:CE/CNE/CWE
rim:CD
orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
v2:CX.5
rim:Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.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

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

rim:n/a
v2:CX.4 / EI-2-4
rim:II.root or Role.id.root
servd:./IdentifierType

value

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.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

Data Type

Constraints

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

Examples

General

Mappings

rim:n/a
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

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2:CX.7 + CX.8
rim:Role.effectiveTime or implied by context
servd:./StartDate and ./EndDate

assigner

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.encounter.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

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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..1

There are no (further) constraints on this element

Element Id

Task.encounter.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

Constraints

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

Mappings

rim:n/a
rim:N/A

executionPeriod

Σ I

0..1

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).

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data Type

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1:If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim:n/a
v2:DR
rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow:Event.occurrence[x]
w5:FiveWs.done[x]
rim:.effectiveTime

authoredOn

S I

0..1

Element Id

Task.authoredOn

Short description

Task Creation Date

Alternate names

Created Date

Definition

Date and time the task was created.

"authoredOn": "2020-12-21T17:03:20-00:00",

Requirements

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

Data Type

Constraints

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

Mappings

rim:n/a
workflow:Request.authoredOn
w5:FiveWs.recorded
rim:.participation[typeCode=AUT].time

lastModified

Σ I

0..1

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

Constraints

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

Mappings

rim:n/a
rim:.inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime

requester

S Σ I

0..1

Element Id

Task.requester

Short description

Who is asking for task to be done

Definition

Who is created the Request or the Event. In NHSDigital API's this SHOULD always be a PractitionerRole role reference.

 "requester": {
        "reference": "#requester"
    },

{
    "resourceType": "Task",
    "id": "bd1ca5c4-ff49-4f2a-9db4-f5dda0112084",
    "meta": {
        "lastUpdated": "2016-07-11T11:07:22+00:00"
    },
    "contained": [
        {
            "resourceType": "PractitionerRole",
            "id": "requester",
            "practitioner": {
                "identifier": {
                    "system": "https://fhir.hl7.org.uk/Id/gmp-number",
                    "value": "G8123456"
                },
                "display": "DR AA BHATIA"
            },
            "organization": {
                "identifier": {
                    "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                    "value": "C81007"
                },
                "display": "VERNON STREET MEDICAL CTR"
            },
            "telecom": [
                {
                    "system": "phone",
                    "use": "work",
                    "value": "01234567890"
                }
            ]
        }
    ],

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).

Comments

Data Type

Allowed aggregation: contained

Constraints

ele-1:All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1:SHALL have a contained resource if a local reference is provided
reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Mappings

rim:n/a
rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow:Request.requester
w5:FiveWs.author
rim:.participation[typeCode=AUT].role

reference

Σ I

0..1

There are no (further) constraints on this element

Element Id

Task.requester.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

Data Type

Constraints

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

Mappings

rim:n/a
rim:N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element Id

Task.requester.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.

Comments

Data Type

Binding

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