Generated Narrative: StructureDefinition Task-phpid-pub Name Flags Card. Type Description & Constraints Task 0..* Task A task to be performed #xD; id 1..1 id Logical id of this artifact #xD; implicitRules 0..1 uri Not used in this profile #xD; contained 4..* Resource Resources, according to 'input', used in PhPID generation. #xD; identifier 0..* Identifier Identifier assigned by the requestor to track the request. #xD; instantiatesUri 0..1 uri Link to the definiton of the task #xD; status 1..1 code Status of the task Binding: Request Status Value Set (required) #xD; businessStatus 0..1 CodeableConcept business-specific state #xD; intent 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: proposal #xD; priority 0..1 code Task priority #xD; code 1..1 CodeableConcept Task Type Binding: Task Request Code Value Set (required) Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://umcterminologies.org/CodeSystem/task-request-code #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: phpid-request #xD; encounter 0..1 Reference(Encounter) Not used in this profile #xD; authoredOn 1..1 dateTime Task Creation Date #xD; lastModified 1..1 dateTime Task Last Modified Date #xD; requester 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) Not used in this profile #xD; insurance 0..* Reference(Coverage | ClaimResponse) Not used in this profile #xD; restriction 0..1 BackboneElement Not used in this profile #xD; Slices for input 0..* BackboneElement Information used to perform task Slice: Unordered, Open by value:type #xD; input:MPD S 0..1 BackboneElement Information used to perform task #xD; type 1..1 CodeableConcept Label for the input Binding: PhPID request input type value set (required) Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://umcterminologies.org/CodeSystem/task-input-type #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: mpd-request-resource #xD; value[x] 1..1 Reference(MedicinalProductDefinition (request)) Content to use in performing the task #xD; input:ING S 0..* BackboneElement Information used to perform task #xD; type 1..1 CodeableConcept Label for the input Binding: PhPID request input type value set (required) Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://umcterminologies.org/CodeSystem/task-input-type #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: ingredient-request-resource #xD; value[x] 1..1 Reference(Ingredient (request)) Content to use in performing the task #xD; input:ORG S 0..1 BackboneElement Information used to perform task #xD; type 1..1 CodeableConcept Label for the input Binding: PhPID request input type value set (required) Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://umcterminologies.org/CodeSystem/task-input-type #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: organization-request-resource #xD; value[x] 1..1 Reference(Organization) Content to use in performing the task #xD; input:REGAUTH S 0..1 BackboneElement Information used to perform task #xD; type 1..1 CodeableConcept Label for the input Binding: PhPID request input type value set (required) Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://umcterminologies.org/CodeSystem/task-input-type #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: regauth-request-resource #xD; value[x] 1..1 Reference(Regulated Authorization (PhPID request)) Content to use in performing the task #xD; output 0..5 BackboneElement Information produced as part of task #xD; type 1..1 CodeableConcept Label for output Binding: PhPID request output type value set (required) #xD; value[x] 1..1 Reference() Result of output #xD; Documentation for this format
This profile defines how the Task resource is used for PhPID publish of a previously sent request
If the resource is contained in another resource, it SHALL NOT contain nested Resources
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
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()
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
Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified.
restriction.exists() implies code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists()
Entity, Role, or Act,ControlAct[moodCode=INT]
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
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())
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 its 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 its 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 a 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.
Resources, according to 'input', used in PhPID generation.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
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 managable, 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
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 managable, 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/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Identifier assigned by the requestor to track the request.
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 the 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 the 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, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.
Task.basedOn is never the same as Task.focus. Task.basedOn will typically not be present for 'please fulfill' Tasks as a distinct authorization is rarely needed to request fulfillment. If the Task is seeking fulfillment of an order, the order to be fulfilled is always communicated using `focus`, never basedOn. However, authorization may be needed to perform other types of Task actions. As an example of when both would be present, a Task seeking suspension of a prescription might have a Task.basedOn pointing to the ServiceRequest ordering surgery (which is the driver for suspending the MedicationRequest - which would be the Task.focus).
A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.
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).
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
The priority of a task (may affect service level applied to the task).
If true indicates that the Task is asking for the specified action to *not* occur.
The attributes provided with the Task qualify what is not to be done. For example, if a requestedPeriod is provided, the 'do not' request only applies within the specified time. If a requestedPerformer is specified then the 'do not' request only applies to performers of that type. Qualifiers include: code, subject, occurrence, requestedPerformer and performer. In some cases, the Request.code may pre-coordinate prohibition into the requested action. E.g. 'NPO' (nothing by mouth), 'DNR' (do not recussitate). If this happens, doNotPerform SHALL NOT be set to true. I.e. The resource shall not have double negation. (E.g. 'Do not DNR'). doNotPerform should ONLY be used with Tasks that are tightly bounded in time or process phase. E.g. 'Do not fulfill the midnight dose of medication X tonight due to the early morning scheduled procedure, where the nurse could reasonably check off 'Med X not given at midnight as instructed'. Similarly, a decision support proposal that a patient should not be given a standard intake questionnaire (because the patient is cognitively impaired) would be marked as 'complete' or 'rejected' when the clinician preps the CarePlan or order set after reviewing the decision support results. If there is a need to create a standing order to not do something that can't be satisfied by a single 'non-action', but rather an ongoing refusal to perform the function, MedicationRequest, ServiceRequest or some other form of authorization should be used.
If true, this element negates the Task. For example, instead of a request to perform a task, it is a request _not_ to perform a task.
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.
A free-text description of what is to be performed.
The request being fulfilled or the resource being manipulated (changed, suspended, etc.) 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.
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]
Indicates the start and/or end of the period of time when completion of the task is desired to take place.
This is typically used when the Task is *not* seeking fulfillment of a focus Request, as in that case the period would be specified on the Request and/or in the Task.restriction.period. Instead, it is used for stand-alone tasks.
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 or specific participant that should perform the task.
Use to distinguish tasks on different activity queues.
Event.performer.function, Request.performerType
Party responsible for managing 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
The entity who performed the requested task.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
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 managable, 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.
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 managable, 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
A code or description of the performer of the task.
Codes to identify types of task performers.
The actor or entity who performed the task.
Principal physical location where this task is performed.
This should only be specified when the Task to be/being performed happens or is expected to happen primarily within the bounds of a single Location. Other locations (e.g. source, destination, etc.) would either be reflected on the 'basedOn' Request or be conveyed as distinct Task.input values.
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, code, or reference indicating why this task needs to be performed.
This will typically not be present for Tasks with a code of 'please fulfill' as, for those, the reason for action is conveyed on the Request pointed to by Task.focus. Some types of tasks will not need a 'reason'. E.g. a request to discharge a patient can be inferred to be 'because the patient is ready' and this would not need a reason to be stated on the Task.
Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
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]
Task.restriction can only be present if the Task is seeking fulfillment of another Request resource, and the restriction identifies what subset of the authorization conveyed by the request is supposed to be fulfilled by this Task. A possible example could be a standing order (the request) covering a significant time period and/or individuals, while the Task seeks fulfillment for only a subset of that time-period and a single individual.
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
Indicates the number of times the requested action should occur.
E.g. order that requests monthly lab tests, fulfillment is sought for 1.
The time-period for which fulfillment is sought. This must fall within the overall time period authorized in the referenced request. E.g. ServiceRequest.occurance[x].
This is distinct from Task.executionPeriod. ExecutionPeriod indicates when the task needs to be initiated, while Task.restriction.period specifies the subset of the overall authorization that this period covers. For example, a MedicationRequest with an overall effective period of 1 year might have a Task whose restriction.period is 2 months (i.e. satisfy 2 months of medication therapy), while the execution period might be 'between now and 5 days from now' - i.e. If you say yes to this, then you're agreeing to supply medication for that 2 month period within the next 5 days. 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 one potential recipient/target, to identify who is fulfillment is sought for.
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.
The value of the Output parameter as a basic type.