Generated Narrative: StructureDefinition kenya-referral-task Name Flags Card. Type Description & Constraints Task <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( kenya-referral-task-focus )">C 0..* Task A task to be performed Constraints: kenya-referral-task-focus #xD; identifier S 1..* Identifier Task Instance Identifier #xD; use S 0..1 code usual | official | temp | secondary | old (If known) #xD; type S 1..1 CodeableConcept Description of identifier #xD; system S 1..1 uri The namespace for the identifier value #xD; value S 1..1 string The value that is unique #xD; status S 1..1 code draft | requested | received | accepted | + #xD; intent S 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: order #xD; focus S 1..1 Reference(Kenya Referral ServiceRequest) What task is acting on #xD; encounter S 1..1 Reference(Encounter) Healthcare event during which this task originated #xD; executionPeriod S 0..1 Period Start and end time of execution #xD; authoredOn S 0..1 dateTime Task Creation Date #xD; requester S 1..1 Reference(Organization | PractitionerRole | Practitioner) Who is asking for task to be done #xD; owner S 1..1 Reference(Organization | PractitionerRole | Practitioner) Responsible individual #xD; input S 0..* BackboneElement Information used to perform task #xD; output S 0..* BackboneElement Information produced as part of task #xD; Documentation for this format
Kenya referral workflow Task for hub and spoke coordination.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Last modified date must be greater than or equal to authored-on date.
lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
not(exists(f:lastModified/@value)) or not(exists(f:authoredOn/@value)) or f:lastModified/@value >= f:authoredOn/@value
Referral Task must have focus referencing a ServiceRequest.
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
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.
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.
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.
Additional content defined by implementations
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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
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).
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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
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.
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
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.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Identifier.system is always case sensitive.
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.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
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](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
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.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
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.
Enables a formal definition of how he task is to be performed, enabling automation.
Request.instantiatesCanonical, Event.instantiatesCanonical
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.
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.
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.
An identifier that links together multiple tasks and other requests that were created in the same context.
Billing and/or reporting can be linked to whether multiple requests were created as a single unit.
Task that this particular task is part of.
Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).
draft | requested | received | accepted | +
These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.
This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
An explanation as to why this task is held, failed, was refused, etc.
This applies to the current status. Look at the history of the task to see reasons for past statuses.
Codes to identify the reason for current status. These will typically be specific to a particular workflow.
.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN, code="status change"].reasonCode
Contains business-specific nuances of the business state.
There's often a need to track substates of a task - this is often variable by specific workflow implementation.
The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="business status"]
unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order".
Distinguishes whether the task is a proposal, plan or full order.
Indicates how quickly the Task should be addressed with respect to other requests.
Used to identify the service level expected while performing a task.
If missing, this task should be performed with normal priority
A name or code (or both) briefly describing what the task involves.
The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.
Codes to identify what the task involves. These will typically be specific to a particular workflow.
A free-text description of what is to be performed.
The request being actioned or the resource being manipulated by this task.
If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).
The entity who benefits from the performance of the service specified in the task (e.g., the patient).
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.
Healthcare event during which this task originated
The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
For some tasks it may be important to know the link between the encounter the task originated within.
.inboundRelationship[typeCode=COMP].source[classCode=PCPR, moodCode=EVN]
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).
The date and time this task was created.
Most often used along with lastUpdated to track duration of task to supporting monitoring and management.
The date and time of last modification to this task.
Used along with history to track task activity and time in a particular task state. This enables monitoring and management.
.inboundRelationship[typeCode=SUBJ, ].source[classCode=CACT, moodCode=EVN].effectiveTime
Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).
The kind of participant that should perform the task.
Use to distinguish tasks on different activity queues.
Event.performer.role, Request.performerType
Individual organization or Device currently responsible for task execution.
Tasks may be created with an owner not yet identified.
Identifies who is expected to perform this task.
Event.performer.actor, Request.performer
Principal physical location where the this task is performed.
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).
A description or code indicating why this task needs to be performed.
This should only be included if there is no focus or if it differs from the reason indicated on the focus.
Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
A resource reference indicating why this task needs to be performed.
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.
Request.reasonReference, Event.reasonReference
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
Free-text information captured about the task as it progresses.
.inboundRelationship[typeCode=SUBJ, ].source[classCode=OBS, moodCode=EVN, code="annotation"].value(string)
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.
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.
.inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]
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.
Sometimes when fulfillment is sought, you don't want full fulfillment.
Instead of pointing to request, would point to component of request, having these characteristics
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Indicates the number of times the requested action should occur.
E.g. order that requests monthly lab tests, fulfillment is sought for 1.
Over what time-period is fulfillment sought.
Note that period.high is the due date representing the time by which the task should be completed.
E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.
For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
Additional information that may be needed in the execution of the task.
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.
A code or description indicating how the input is intended to be used as part of the task execution.
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.
Inputs are named to enable task automation to bind data and pass it from one task to the next.
Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
The value of the input parameter as a basic type.
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.
Outputs are named to enable task automation to bind data and pass it from one task to the next.
Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
The value of the Output parameter as a basic type.