Task |
|
0..* |
Task |
There are no (further) constraints on this element Element Id
Short description
A task to be performed Definition
Data Type
Task Constraints
- dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
- dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.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
contained.where(('#'+id in %resource.descendants().reference).not()).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]
- w5:workflow.order
|
identifier |
|
0..* |
Identifier |
There are no (further) constraints on this element Element Id
Short description
Task Instance Identifier Definition
The business identifier for this task.
Data Type
Identifier Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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
- rim:.id
- w5:id
|
definition[x] |
Σ |
0..1 |
|
There are no (further) constraints on this element Element Id
Short description
Formal definition of task Definition
A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
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
Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:Request.definition, Event.definition
- rim:.outboundRelationship[typeCode=DEFN].target
|
definitionUri |
|
|
uri |
There are no (further) constraints on this element Data Type
uri
|
definitionReference |
|
|
Reference(ActivityDefinition) |
There are no (further) constraints on this element Data Type
Reference(ActivityDefinition)
|
basedOn |
Σ |
0..* |
Reference(Resource) |
Element Id
Short description
Reference to the related transaction when the task is started in response to a previous transaction Definition
BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil 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
Reference(Resource) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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, Definition.basedOn
- rim:.outboundRelationship[typeCode=FLFS].target[moodCode=INT]
|
reference |
Σ |
0..1 |
string |
There are no (further) constraints on this element Element Id
Short description
Literal reference, Relative, internal or absolute URL Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
identifier |
Σ |
1..1 |
Identifier |
Element Id
Short description
ZD number of the related transaction Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.
Data Type
Identifier Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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 (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
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type
code Binding
IdentifierUse (required) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type
CodeableConcept Binding
Identifier Type Codes (extensible) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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.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
see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data Type
uri Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Fixed Value
http://zorgdomein.nl/zdnumber
Mappings
- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value |
Σ |
1..1 |
string |
There are no (further) constraints on this element Element Id
Task.basedOn.identifier.value
Short description
The value that is unique Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Examples
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 |
Σ |
0..1 |
Period |
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
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
Data Type
Period Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- per-1:If present, start SHALL have a lower value than end
start.empty() or end.empty() 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 |
Σ |
0..1 |
Reference(Organization) |
There are no (further) constraints on this element Element Id
Task.basedOn.identifier.assigner
Short description
Organization that issued id (may be just text) Definition
Organization that issued/manages the identifier.
Comments
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type
Reference(Organization) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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 |
string |
There are no (further) constraints on this element Element Id
Short description
Text alternative for the resource Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comments
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
groupIdentifier |
Σ |
0..1 |
Identifier |
There are no (further) constraints on this element Element Id
Short description
Requisition or grouper id Definition
An identifier that links together multiple tasks and other requests that were created in the same context.
Requirements
Billing and/or reporting can be linked to whether multiple requests were created as a single unit.
Data Type
Identifier Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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 |
Σ |
0..* |
Reference(Task) |
There are no (further) constraints on this element Element Id
Short description
Composite task Definition
Task that this particular task is part of.
Requirements
Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).
Comments
This should usually be 0..1.
Data Type
Reference(Task) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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]
|
status |
Σ |
1..1 |
codeBinding |
There are no (further) constraints on this element Element Id
Short description
draft | requested | received | accepted | + Definition
The current status of the task.
Requirements
These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.
Comments
Note that FHIR strings may not exceed 1MB in size
Data Type
code Binding
TaskStatus (required) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:Request.status, Event.status
- rim:.statusCode
- w5:status
|
statusReason |
Σ |
0..1 |
CodeableConcept |
There are no (further) constraints on this element Element Id
Short description
Reason for current status Definition
An explanation as to why this task is held, failed, was refused, etc.
Comments
This applies to the current status. Look at the history of the task to see reasons for past statuses.
Data Type
CodeableConcept Binding
(unbound) (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 |
CodeableConcept |
There are no (further) constraints on this element Element Id
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
CodeableConcept Binding
(unbound) (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 |
Σ |
1..1 |
codeBinding |
There are no (further) constraints on this element Element Id
Short description
proposal | plan | order + Definition
Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
Comments
This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.
In most cases, Tasks will have an intent of "order".
Data Type
code Binding
RequestIntent (required) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:Request.intent
- rim:.moodCode
- w5:class
|
priority |
|
0..1 |
codeBinding |
There are no (further) constraints on this element Element Id
Short description
normal | 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 may not exceed 1MB in size
Data Type
code Binding
RequestPriority (required) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:Request.priority
- rim:.priorityCode
- w5:grade
|
code |
Σ |
1..1 |
CodeableConceptBinding |
Element Id
Short description
Specifies the task the user intents to perform when launching ZorgDomein Definition
A name or code (or both) briefly describing what the task involves.
Comments
The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.
Data Type
CodeableConcept Binding
Launch intent (extensible) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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
- rim:.code
- w5:what
|
description |
Σ |
0..1 |
string |
There are no (further) constraints on this element Element Id
Short description
Human-readable explanation of task Definition
A free-text description of what is to be performed.
Comments
Note that FHIR strings may not exceed 1MB in size
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
focus |
Σ |
0..1 |
Reference(Resource) |
There are no (further) constraints on this element Element Id
Short description
What task is acting on Definition
The request being actioned or the resource being manipulated by this task.
Requirements
Used to identify the thing to be done.
Comments
If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).
Data Type
Reference(Resource) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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:.outboundRelationship[typeCode=SUBJ].target
- w5:what
|
for |
Σ |
0..1 |
Reference(ZD Patient) |
Element Id
Short description
Patient for whom this task is started Alternate names
Patient Definition
The entity who benefits from the performance of the service specified in the task (e.g., the patient).
Requirements
Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.
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
Reference(ZD Patient) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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.subject, Event.subject
- rim:.participation[typeCode=RCT].role
- w5:who.focus
|
context |
Σ |
0..1 |
Reference(Encounter | EpisodeOfCare) |
There are no (further) constraints on this element Element Id
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 task or episode of care the task originated within.
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
Reference(Encounter | EpisodeOfCare) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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
- rim:.inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]
- w5:context
|
executionPeriod |
Σ |
0..1 |
Period |
There are no (further) constraints on this element Element Id
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
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
Data Type
Period Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- per-1:If present, start SHALL have a lower value than end
start.empty() or end.empty() 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]
- rim:.effectiveTime
- w5:when.done
|
authoredOn |
|
0..1 |
dateTime |
There are no (further) constraints on this element Element Id
Short description
Task Creation Date Alternate names
Created Date Definition
The date and time this task was created.
Requirements
Most often used along with lastUpdated to track duration of task to supporting monitoring and management.
Data Type
dateTime Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:Request.authoredOn
- rim:.participation[typeCode=AUT].time
- w5:when.recorded
|
lastModified |
Σ |
0..1 |
dateTime |
There are no (further) constraints on this element Element Id
Short description
Task Last Modified Date Alternate names
Update Date Definition
The date and time of last modification to this task.
Requirements
Used along with history to track task activity and time in a particular task state. This enables monitoring and management.
Data Type
dateTime Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- rim:.inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime
|
requester |
Σ |
0..1 |
BackboneElement |
There are no (further) constraints on this element Element Id
Short description
Who is asking for task to be done Definition
Requirements
Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).
Data Type
BackboneElement Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- workflow:Request.requester
- rim:.participation[typeCode=AUT].role
|
agent |
Σ |
1..1 |
Reference(Device | Organization | Patient | Practitioner | RelatedPerson) |
There are no (further) constraints on this element Element Id
Short description
Individual asking for task Alternate names
Initiator, Author Definition
The device, practitioner, etc. who initiated the task.
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
Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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.agent
- rim:.player
- w5:who.author
|
onBehalfOf |
|
0..1 |
Reference(Organization) |
There are no (further) constraints on this element Element Id
Task.requester.onBehalfOf
Short description
Organization individual is acting for Definition
The organization the device or practitioner was acting on behalf of when they initiated the task.
Requirements
Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.
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
Reference(Organization) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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.onBehalfOf
- rim:.scoper
|
performerType |
|
0..* |
CodeableConceptBinding |
There are no (further) constraints on this element Element Id
Short description
requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer Definition
The type of participant that can execute the task.
Requirements
Use to distinguish tasks on different activity queues.
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
CodeableConcept Binding
TaskPerformerType (preferred) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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
- rim:.participation[typeCode=PRF].role.code
- w5:who.actor
|
owner |
Σ |
0..1 |
Reference(Device | Organization | Patient | Practitioner | RelatedPerson) |
Element Id
Short description
Intended recipient of the transaction Alternate names
Performer, Executer Definition
Individual organization or Device currently responsible for task execution.
Requirements
Identifies who is expected to perform this task.
Comments
Tasks may be created with an owner not yet identified.
Data Type
Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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
- rim:.participation[typeCode=PRF].role
- w5:who.actor
|
reference |
Σ |
0..1 |
string |
There are no (further) constraints on this element Element Id
Short description
Literal reference, Relative, internal or absolute URL Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
identifier |
Σ |
0..1 |
Identifier |
Element Id
Short description
AGB-code of the intended recipient Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.
Data Type
Identifier Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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 (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
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Data Type
code Binding
IdentifierUse (required) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Data Type
CodeableConcept Binding
Identifier Type Codes (extensible) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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.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
see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data Type
uri Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Fixed Value
http://fhir.nl/fhir/NamingSystem/agb-z
Mappings
- rim:n/a
- v2:CX.4 / EI-2-4
- rim:II.root or Role.id.root
- servd:./IdentifierType
|
value |
Σ |
1..1 |
string |
There are no (further) constraints on this element Element Id
Task.owner.identifier.value
Short description
The value that is unique Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comments
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Examples
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 |
Σ |
0..1 |
Period |
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
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.
Data Type
Period Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- per-1:If present, start SHALL have a lower value than end
start.empty() or end.empty() 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 |
Σ |
0..1 |
Reference(Organization) |
There are no (further) constraints on this element Element Id
Task.owner.identifier.assigner
Short description
Organization that issued id (may be just text) Definition
Organization that issued/manages the identifier.
Comments
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data Type
Reference(Organization) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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 |
string |
Element Id
Short description
Name of the intended recipient Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comments
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
reason |
|
0..1 |
CodeableConcept |
There are no (further) constraints on this element Element Id
Short description
Why task is needed Definition
A description or code indicating why this task needs to be performed.
Comments
This should only be included if there is no focus or if it differs from the reason indicated on the focus.
Data Type
CodeableConcept Binding
(unbound) (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- workflow:Request.reasonCode, Event.reasonCodeableConcept
- rim:.reasonCode
- w5:why
|
note |
|
0..* |
Annotation |
There are no (further) constraints on this element Element Id
Short description
Comments made about the task Definition
Free-text information captured about the task as it progresses.
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
Annotation Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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..* |
Reference(Provenance) |
There are no (further) constraints on this element Element Id
Short description
Key events in history of the Task Alternate names
Status History Definition
Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
Comments
This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.
Data Type
Reference(Provenance) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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]
|
restriction |
|
0..1 |
BackboneElement |
There are no (further) constraints on this element Element Id
Short description
Constraints on fulfillment tasks Definition
If the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
Requirements
Sometimes when fulfillment is sought, you don't want full fulfillment.
Data Type
BackboneElement Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 |
positiveInt |
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
positiveInt Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- rim:.repeatNumber
|
period |
|
0..1 |
Period |
There are no (further) constraints on this element Element Id
Short description
When fulfillment sought Definition
Over what time-period is fulfillment sought.
Requirements
E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.
Comments
Note that period.high is the due date representing the time by which the task should be completed.
Data Type
Period Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
- per-1:If present, start SHALL have a lower value than end
start.empty() or end.empty() 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>)
|
recipient |
|
0..* |
Reference(Patient | Practitioner | RelatedPerson | Group | Organization) |
There are no (further) constraints on this element Element Id
Task.restriction.recipient
Short description
For whom is fulfillment sought? Definition
For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
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
Reference(Patient | Practitioner | RelatedPerson | Group | Organization) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 %resource.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
|
input |
|
0..* |
BackboneElement |
Element Id
Short description
Addtional input parameters for performing the task in ZorgDomein Alternate names
Supporting Information Definition
Additional information that may be needed in the execution of the task.
Requirements
Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.
Data Type
BackboneElement Sliced:
Unordered, Open, by type.coding.code(Value) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
(All Slices) |
|
|
|
There are no (further) constraints on this element
|
type |
|
1..1 |
CodeableConcept |
There are no (further) constraints on this element Element Id
Short description
Label for the input Alternate names
Name Definition
A code or description indicating how the input is intended to be used as part of the task execution.
Requirements
Inputs are named to enable task automation to bind data and pass it from one task to the next.
Comments
If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
Data Type
CodeableConcept Binding
(unbound) (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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
Short description
Content to use in performing the task Definition
The value of the input parameter as a basic type.
Comments
A stream of bytes, base64 encoded
Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
valueBase64Binary |
|
|
base64Binary |
There are no (further) constraints on this element Data Type
base64Binary
|
valueBoolean |
|
|
boolean |
There are no (further) constraints on this element Data Type
boolean
|
valueCode |
|
|
code |
There are no (further) constraints on this element Data Type
code
|
valueDate |
|
|
date |
There are no (further) constraints on this element Data Type
date
|
valueDateTime |
|
|
dateTime |
There are no (further) constraints on this element Data Type
dateTime
|
valueDecimal |
|
|
decimal |
There are no (further) constraints on this element Data Type
decimal
|
valueId |
|
|
id |
There are no (further) constraints on this element Data Type
id
|
valueInstant |
|
|
instant |
There are no (further) constraints on this element Data Type
instant
|
valueInteger |
|
|
integer |
There are no (further) constraints on this element Data Type
integer
|
valueMarkdown |
|
|
markdown |
There are no (further) constraints on this element Data Type
markdown
|
valueOid |
|
|
oid |
There are no (further) constraints on this element Data Type
oid
|
valuePositiveInt |
|
|
positiveInt |
There are no (further) constraints on this element Data Type
positiveInt
|
valueString |
|
|
string |
There are no (further) constraints on this element Data Type
string
|
valueTime |
|
|
time |
There are no (further) constraints on this element Data Type
time
|
valueUnsignedInt |
|
|
unsignedInt |
There are no (further) constraints on this element Data Type
unsignedInt
|
valueUri |
|
|
uri |
There are no (further) constraints on this element Data Type
uri
|
valueAddress |
|
|
Address |
There are no (further) constraints on this element Data Type
Address
|
valueAge |
|
|
Age |
There are no (further) constraints on this element Data Type
Age
|
valueAnnotation |
|
|
Annotation |
There are no (further) constraints on this element Data Type
Annotation
|
valueAttachment |
|
|
Attachment |
There are no (further) constraints on this element Data Type
Attachment
|
valueCodeableConcept |
|
|
CodeableConcept |
There are no (further) constraints on this element Data Type
CodeableConcept
|
valueCoding |
|
|
Coding |
There are no (further) constraints on this element Data Type
Coding
|
valueContactPoint |
|
|
ContactPoint |
There are no (further) constraints on this element Data Type
ContactPoint
|
valueCount |
|
|
Count |
There are no (further) constraints on this element Data Type
Count
|
valueDistance |
|
|
Distance |
There are no (further) constraints on this element Data Type
Distance
|
valueDuration |
|
|
Duration |
There are no (further) constraints on this element Data Type
Duration
|
valueHumanName |
|
|
HumanName |
There are no (further) constraints on this element Data Type
HumanName
|
valueIdentifier |
|
|
Identifier |
There are no (further) constraints on this element Data Type
Identifier
|
valueMoney |
|
|
Money |
There are no (further) constraints on this element Data Type
Money
|
valuePeriod |
|
|
Period |
There are no (further) constraints on this element Data Type
Period
|
valueQuantity |
|
|
Quantity |
There are no (further) constraints on this element Data Type
Quantity
|
valueRange |
|
|
Range |
There are no (further) constraints on this element Data Type
Range
|
valueRatio |
|
|
Ratio |
There are no (further) constraints on this element Data Type
Ratio
|
valueSampledData |
|
|
SampledData |
There are no (further) constraints on this element Data Type
SampledData
|
valueSignature |
|
|
Signature |
There are no (further) constraints on this element Data Type
Signature
|
valueTiming |
|
|
Timing |
There are no (further) constraints on this element Data Type
Timing
|
valueMeta |
|
|
Meta |
There are no (further) constraints on this element Data Type
Meta
|
valueReference |
|
|
Reference() |
There are no (further) constraints on this element Data Type
Reference()
|
message |
|
0..1 |
BackboneElement |
Element Id
Short description
Reference to a pregenerated message or document Alternate names
Supporting Information Definition
Additional information that may be needed in the execution of the task.
Requirements
Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.
Data Type
BackboneElement Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
type |
|
1..1 |
CodeableConcept |
There are no (further) constraints on this element Element Id
Short description
Label for the input Alternate names
Name Definition
A code or description indicating how the input is intended to be used as part of the task execution.
Requirements
Inputs are named to enable task automation to bind data and pass it from one task to the next.
Comments
If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.
Data Type
CodeableConcept Binding
(unbound) (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
- rim:n/a
- v2:CE/CNE/CWE
- rim:CD
- orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
- rim:???
|
coding |
Σ |
1..1 |
Coding |
There are no (further) constraints on this element Element Id
Task.input:message.type.coding
Short description
Code defined by a terminology system Definition
A reference to a code defined by a terminology system.
Requirements
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Comments
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Data Type
Coding Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 |
Σ |
1..1 |
uriFixed Value |
Element Id
Task.input:message.type.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 de-reference to some definition that establish the system clearly and unambiguously.
Data Type
uri Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Fixed Value
http://zorgdomein.nl/terminology/code-system/launch-input-type
Mappings
- rim:n/a
- v2:C*E.3
- rim:./codeSystem
- orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
|
version |
Σ |
0..1 |
string |
There are no (further) constraints on this element Element Id
Task.input:message.type.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
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 |
codeFixed Value |
Element Id
Task.input:message.type.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 may not exceed 1MB in size
Data Type
code Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Fixed Value
Mappings
- rim:n/a
- v2:C*E.1
- rim:./code
- orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
|
display |
Σ |
0..1 |
string |
There are no (further) constraints on this element Element Id
Task.input:message.type.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 may not exceed 1MB in size
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 |
boolean |
There are no (further) constraints on this element Element Id
Task.input:message.type.coding.userSelected
Short description
If this coding was chosen directly by the user Definition
Indicates that this coding was chosen by a user directly - i.e. 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
boolean Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 |
string |
There are no (further) constraints on this element Element Id
Task.input:message.type.text
Short description
Plain text representation of the concept Definition
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Requirements
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Comments
Very often the text is the same as a displayName of one of the codings.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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
|
valueReference |
|
1..1 |
Reference(ZD Communication) |
Element Id
Task.input:message.value[x]:valueReference
Short description
Content to use in performing the task Definition
The value of the input parameter as a basic type.
Comments
A stream of bytes, base64 encoded
Data Type
Reference(ZD Communication) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
reference |
Σ |
1..1 |
string |
There are no (further) constraints on this element Element Id
Task.input:message.value[x]:valueReference.reference
Short description
Literal reference, Relative, internal or absolute URL Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comments
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
identifier |
Σ |
0..1 |
Identifier |
There are no (further) constraints on this element Element Id
Task.input:message.value[x]:valueReference.identifier
Short description
Logical reference, when literal reference is not known Definition
An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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.
Data Type
Identifier Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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 - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. 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
|
display |
Σ |
0..1 |
string |
There are no (further) constraints on this element Element Id
Task.input:message.value[x]:valueReference.display
Short description
Text alternative for the resource Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comments
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Data Type
string Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
output |
|
0..* |
BackboneElement |
There are no (further) constraints on this element Element Id
Short description
Information produced as part of task Definition
Outputs produced by the Task.
Requirements
Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.
Data Type
BackboneElement Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
type |
|
1..1 |
CodeableConcept |
There are no (further) constraints on this element Element Id
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
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
CodeableConcept Binding
(unbound) (example) Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (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
Short description
Result of output Definition
The value of the Output parameter as a basic type.
Requirements
Task outputs can take any form.
Comments
A stream of bytes, base64 encoded
Constraints
- ele-1:All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
Mappings
|
valueBase64Binary |
|
|
base64Binary |
There are no (further) constraints on this element Data Type
base64Binary
|
valueBoolean |
|
|
boolean |
There are no (further) constraints on this element Data Type
boolean
|
valueCode |
|
|
code |
There are no (further) constraints on this element Data Type
code
|
valueDate |
|
|
date |
There are no (further) constraints on this element Data Type
date
|
valueDateTime |
|
|
dateTime |
There are no (further) constraints on this element Data Type
dateTime
|
valueDecimal |
|
|
decimal |
There are no (further) constraints on this element Data Type
decimal
|
valueId |
|
|
id |
There are no (further) constraints on this element Data Type
id
|
valueInstant |
|
|
instant |
There are no (further) constraints on this element Data Type
instant
|
valueInteger |
|
|
integer |
There are no (further) constraints on this element Data Type
integer
|
valueMarkdown |
|
|
markdown |
There are no (further) constraints on this element Data Type
markdown
|
valueOid |
|
|
oid |
There are no (further) constraints on this element Data Type
oid
|
valuePositiveInt |
|
|
positiveInt |
There are no (further) constraints on this element Data Type
positiveInt
|
valueString |
|
|
string |
There are no (further) constraints on this element Data Type
string
|
valueTime |
|
|
time |
There are no (further) constraints on this element Data Type
time
|
valueUnsignedInt |
|
|
unsignedInt |
There are no (further) constraints on this element Data Type
unsignedInt
|
valueUri |
|
|
uri |
There are no (further) constraints on this element Data Type
uri
|
valueAddress |
|
|
Address |
There are no (further) constraints on this element Data Type
Address
|
valueAge |
|
|
Age |
There are no (further) constraints on this element Data Type
Age
|
valueAnnotation |
|
|
Annotation |
There are no (further) constraints on this element Data Type
Annotation
|
valueAttachment |
|
|
Attachment |
There are no (further) constraints on this element Data Type
Attachment
|
valueCodeableConcept |
|
|
CodeableConcept |
There are no (further) constraints on this element Data Type
CodeableConcept
|
valueCoding |
|
|
Coding |
There are no (further) constraints on this element Data Type
Coding
|
valueContactPoint |
|
|
ContactPoint |
There are no (further) constraints on this element Data Type
ContactPoint
|
valueCount |
|
|
Count |
There are no (further) constraints on this element Data Type
Count
|
valueDistance |
|
|
Distance |
There are no (further) constraints on this element Data Type
Distance
|
valueDuration |
|
|
Duration |
There are no (further) constraints on this element Data Type
Duration
|
valueHumanName |
|
|
HumanName |
There are no (further) constraints on this element Data Type
HumanName
|
valueIdentifier |
|
|
Identifier |
There are no (further) constraints on this element Data Type
Identifier
|
valueMoney |
|
|
Money |
There are no (further) constraints on this element Data Type
Money
|
valuePeriod |
|
|
Period |
There are no (further) constraints on this element Data Type
Period
|
valueQuantity |
|
|
Quantity |
There are no (further) constraints on this element Data Type
Quantity
|
valueRange |
|
|
Range |
There are no (further) constraints on this element Data Type
Range
|
valueRatio |
|
|
Ratio |
There are no (further) constraints on this element Data Type
Ratio
|
valueSampledData |
|
|
SampledData |
There are no (further) constraints on this element Data Type
SampledData
|
valueSignature |
|
|
Signature |
There are no (further) constraints on this element Data Type
Signature
|
valueTiming |
|
|
Timing |
There are no (further) constraints on this element Data Type
Timing
|
valueMeta |
|
|
Meta |
There are no (further) constraints on this element Data Type
Meta
|
valueReference |
|
|
Reference() |
There are no (further) constraints on this element Data Type
Reference()
|