SFM Datadeling API Implementation Guide

sfm-Task

Profile on Task for use in SFM API

Task will use a dedicated code system for defining particular task types: (Not all of these are relevant for the API Basis usage) sfm-task-types.codesystem

This code system http://ehelse.no/fhir/CodeSystem/sfm-task-types defines the following codes:

Code	Display
1	Godkjenn LIB
2	Godkjenn dobbeltsignering
3	Godkjenn kladd
4	Send klargjort melding
5	Intervensjon
6	Spørsmål fra apotek
7	PLL kommentar
8	Endring på multidosepasient
9	Ny multidosepakking
10	Endring på pasient
11	Nytt varsel fra FEST
12	SFM har blitt oppdatert
13	SFM planlegger nedetid
14	Feil ved sending til RF
15	Utleveringsmelding
16	Mottatt svar på Helfosøknad
17	Mottatt svar på søknad til SLV
18	Melding til PLO
19	Endring i legemiddelreaksjon
20	Ny MD lege påmeldt
21	Revurderingsdato, INR kontroll
22	Endring i PID
23	Endring i HPR
24	Legemiddelreaksjonregistering er mangelfull
25	Revurderingsdato er satt på legemiddelbehandling
26	E-multidose er ikke startet

Profile

sfm-Task

Task	I		Task	Element id Task Short description Actions required in SFM Definition The SFM-Oppgave is used to identify actions that must be taken in SFM. 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]
id	Σ	0..1	id	There are no (further) constraints on this element Element id Task.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type id Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Task.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Task.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Comments Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id Task.language Short description Language of the resource content Definition The base language in which the resource is written. Comments Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text		0..1	Narrative	There are no (further) constraints on this element Element id Task.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Comments Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Task.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. Data type Resource Mappings rim: Entity. Role, or Act rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element 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 Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Task.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
identifier		0..*	Identifier	There are no (further) constraints on this element Element id Task.identifier Short description Task Instance Identifier Definition The business identifier for this task. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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
instantiatesCanonical	Σ	0..0	canonical(ActivityDefinition)	There are no (further) constraints on this element Element id Task.instantiatesCanonical Short description Formal definition of task Definition The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. Requirements Enables a formal definition of how he task is to be performed, enabling automation. Comments see Canonical References Data type canonical(ActivityDefinition) 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..0	uri	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 uri 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..0	Reference(Resource)	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 Reference(Resource) 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 %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, Event.basedOn rim: .outboundRelationship[typeCode=FLFS].target[moodCode=INT]
groupIdentifier	Σ	0..0	Identifier	There are no (further) constraints on this element Element id Task.groupIdentifier Short description Requisition or grouper id Definition An identifier that links together multiple tasks and other requests that were created in the same context. Requirements Billing and/or reporting can be linked to whether multiple requests were created as a single unit. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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..0	Reference(Task)	There are no (further) constraints on this element Element id Task.partOf Short description Composite task Definition Task that this particular task is part of. Requirements Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). Comments This should usually be 0..1. Data type Reference(Task) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` 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	S Σ ?!	1..1	codeBinding	Element id Task.status Short description draft \| requested \| received \| accepted \| + Definition The current status of the task. All tasks created by SFM will initially have status "reqested". For some tasks EHR will be able to report that the task is fulfilled. This should then be set to completed. Requirements These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type code Binding The current status of the task. TaskStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Request.status, Event.status w5: FiveWs.status rim: .statusCode
statusReason	Σ	0..0	CodeableConcept	There are no (further) constraints on this element Element id Task.statusReason Short description Reason for current status Definition An explanation as to why this task is held, failed, was refused, etc. Comments This applies to the current status. Look at the history of the task to see reasons for past statuses. Data type CodeableConcept Binding Codes to identify the reason for current status. These will typically be specific to a particular workflow. (unbound) (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: 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..0	CodeableConcept	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 CodeableConcept Binding The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. (unbound) (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 rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="business status"]
intent	S Σ	1..1	codeBinding	Element id Task.intent Short description unknown \| proposal \| plan \| order \| original-order \| reflex-order \| filler-order \| instance-order \| option Definition SFM will only use "order". Comments This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". Data type code Binding Distinguishes whether the task is a proposal, plan or full order. TaskIntent (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` 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 code Binding The task's priority. RequestPriority (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Request.priority w5: FiveWs.grade rim: .priorityCode
code	S Σ	1..1	CodeableConceptBinding	Element id Task.code Short description Task Type Definition Examples of task types are: GodkjennKladd EndringMDPakking Comments The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. Data type CodeableConcept Binding Codes to identify what the task involves. These will typically be specific to a particular workflow. sfm-task-types.codesystem (extensible) 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
id		0..1		There are no (further) constraints on this element Element id Task.code.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Task.code.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
coding	Σ	0..*	Coding	There are no (further) constraints on this element 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 Coding 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: CE.1-8, CE.10-22 rim: union(., ./translation) orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
id		0..1		There are no (further) constraints on this element Element id Task.code.coding.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Task.code.coding.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
system	Σ	0..1	uriFixed Value	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 uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value http://ehelse.no/fhir/CodeSystem/sfm-task-types Mappings rim: n/a v2: CE.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.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 string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.7 rim:* ./codeSystemVersion orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	Σ	1..1	code	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 code Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.1 rim:* ./code orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	Σ	1..1	string	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 string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.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.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 boolean 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	string	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 string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE.9. But note many systems use CE.2 for this rim: ./originalText[mediaType/code="text/plain"]/data orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
description	S Σ	1..1	string	Element id Task.description Short description Human-readable explanation of task Definition Includes the text that should be shown to the user within the work list. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .text
focus	Σ I	0..0	Reference(Resource)	There are no (further) constraints on this element Element id Task.focus Short description What task is acting on Definition The request being actioned or the resource being manipulated by this task. Requirements Used to identify the thing to be done. Comments If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.). Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` 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) w5: FiveWs.what[x] rim: .outboundRelationship[typeCode=SUBJ].target
for	S Σ I	0..1	Reference(sfm-Patient)	Element id Task.for Short description Beneficiary of the Task Alternate names Patient Definition The entity who benefits from the performance of the service specified in the task (e.g., the patient). Requirements Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control. 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(sfm-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 %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 w5: FiveWs.subject[x] rim: .participation[typeCode=RCT].role w5: FiveWs.subject
encounter	Σ I	0..0	Reference(Encounter)	There are no (further) constraints on this element Element id Task.encounter Short description Healthcare event during which this task originated Definition The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. Requirements For some tasks it may be important to know the link between the encounter the task originated within. 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) 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 %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 w5: FiveWs.context rim: .inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]
executionPeriod	Σ I	0..0	Period	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 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 Period 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	dateTime	There are no (further) constraints on this element Element id Task.authoredOn Short description Task Creation Date Alternate names Created Date Definition The date and time this task was created. Requirements Most often used along with lastUpdated to track duration of task to supporting monitoring and management. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Request.authoredOn w5: FiveWs.recorded rim: .participation[typeCode=AUT].time
lastModified	S Σ I	0..1	dateTime	There are no (further) constraints on this element Element id Task.lastModified Short description Task Last Modified Date Alternate names Update Date Definition The date and time of last modification to this task. Requirements Used along with history to track task activity and time in a particular task state. This enables monitoring and management. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime
requester	Σ I	0..1	Reference(Device \| sfm-PractitionerRole)	Element id Task.requester Short description Who is asking for task to be done Definition The creator of the task. Requirements Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task). 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 \| sfm-PractitionerRole) 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 %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 w5: FiveWs.author rim: .participation[typeCode=AUT].role
performerType	S	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 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 The type(s) of task performers allowed. ProcedurePerformerRoleCodes (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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(sfm-Practitioner \| sfm-Organization)	Element id Task.owner Short description Responsible individual Alternate names Performer, Executer Definition Individual or organization 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(sfm-Practitioner \| sfm-Organization) 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 %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 w5: FiveWs.actor rim: .participation[typeCode=PRF].role
location	Σ I	0..0	Reference(Location)	There are no (further) constraints on this element Element id Task.location Short description Where task occurs Definition Principal physical location where the this task is performed. Requirements Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). 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(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 %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.reasonCode, Event.reasonCode w5: FiveWs.where[x] rim: .participation[typeCode=LOC].role
reasonCode		0..0	CodeableConcept	There are no (further) constraints on this element Element id Task.reasonCode Short description Why task is needed Definition A description or code indicating why this task needs to be performed. Comments This should only be included if there is no focus or if it differs from the reason indicated on the focus. Data type CodeableConcept Binding Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. (unbound) (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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
reasonReference	I	0..0	Reference(Resource)	There are no (further) constraints on this element Element id Task.reasonReference Short description Why task is needed Definition A resource reference indicating why this task needs to be performed. Comments Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in `Task.reasonCode` if the data is free (uncoded) text. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` 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.reasonReference, Event.reasonReference w5: FiveWs.why[x] rim: .outboundRelationship[typeCode=RSON].target
insurance	I	0..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 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(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 %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.insurance v2: IN1/IN2 rim: .outboundRelationship[typeCode=COVBY].target
note		0..0	Annotation	There are no (further) constraints on this element Element id Task.note Short description Comments made about the task Definition Free-text information captured about the task as it progresses. 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() 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	I	0..0	Reference(Provenance)	There are no (further) constraints on this element Element id Task.relevantHistory Short description Key events in history of the Task Alternate names Status History Definition Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. Comments This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. Data type Reference(Provenance) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` 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..0	BackboneElement	There are no (further) constraints on this element Element id Task.restriction Short description Constraints on fulfillment tasks Definition If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned. Requirements Sometimes when fulfillment is sought, you don't want full fulfillment. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: Instead of pointing to request, would point to component of request, having these characteristics
input		0..0	BackboneElement	There are no (further) constraints on this element Element id Task.input Short description Information used to perform task Alternate names Supporting Information Definition Additional information that may be needed in the execution of the task. Requirements Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: ???
output		0..0	BackboneElement	There are no (further) constraints on this element Element id Task.output Short description Information produced as part of task Definition Outputs produced by the Task. Requirements Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: ???