Patient Request for Corrections Implementation Guide, published by HL7 International - Patient Empowerment Workgroup. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-patient-correction/ and changes regularly. See the Directory of published versions
Draft as of 2023-09-11 |
Definitions for the patient-correction-task resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Task | |
Invariants | task-reasonreference: If this is a Disagreement Task, there SHALL be a reference to the original Request for Correction Communication. (Task.code.coding.exists(code = 'medRecCxDenialDisagree' and system = 'http://hl7.org/fhir/uv/patient-corrections/CodeSystem/PatientCorrectionTaskTypes') implies Task.reasonReference.exists() )task-output2: If this is a completed Request for Correction Task, there SHALL be a formal response to the request (acceptance, denial, partial acceptance/denial). ( (Task.code.coding.exists(code = 'medRecCxReq' and system = 'http://hl7.org/fhir/uv/patient-corrections/CodeSystem/PatientCorrectionTaskTypes') and Task.status = 'completed') implies Task.output.type.coding.exists(code = 'medRecCxReqResolution' and system = 'http://hl7.org/fhir/uv/patient-corrections/CodeSystem/PatientCorrectionOutputTypes') ) |
2. Task.identifier | |
Short | A business identifier for the correction process. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Must Support | true |
4. Task.basedOn | |
Control | 0..0 |
6. Task.partOf | |
Control | 0..0 |
8. Task.status | |
Short | Current status of a Correction Request or Log Disagreement. |
Comments | The current status of the Correction Request or Log Disagreement process. This status together with the business status can be used to determine the state of the process. |
Binding | The codes SHALL be taken from TaskStatus |
Must Support | true |
Invariants | task-status-allowed: The status of the Task SHALL be one of the following: ready, in-progress, cancelled, completed. ($this in ('ready' | 'in-progress' | 'cancelled' | 'completed') ) |
10. Task.statusReason | |
Short | Reason for the correction request status. |
Comments | The reason for the correction request status. Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
12. Task.businessStatus | |
Short | Business status of the request for correction process or the log disagreement process. |
Comments | The business status of the request for correction process or the log disagreement process. The domain-specific business-contextual sub-state of the task. For example: Waiting on additional information from requester, waiting on additional information from fulfiller (could be a specific party on the fulfiller side), more time needed to review request, an amendment will be made to the record, an amendment has been made to the record, current record determined accurate and will not be amended, a partial amendment will be made to the record, a partial amendment has been made to the record, disagreement has been reviewed and attached to the record, disagreement has been rebutted. |
Binding | The codes SHALL be taken from Patient Correction Business Status |
Must Support | true |
14. Task.intent | |
Short | Indicates the actionability associated with the Task. |
Fixed Value | order |
16. Task.code | |
Definition | Either a patient correction or a disagreement. |
Short | Correction Task type. |
Control | 1..? This element is affected by the following invariants: task-reasonreference |
Binding | The codes SHALL be taken from Patient Correction Task Types Values Set |
Must Support | true |
18. Task.for | |
Short | Patient this correction or disagreement relates to. |
Comments | The patient whose record this correction or disagreement references. If this task was created in response to a request received through a Communication resource, this value SHALL be populated with the value of |
Control | 1..? |
Type | Reference(Patient) |
Must Support | true |
20. Task.encounter | |
Control | 0..0 |
22. Task.executionPeriod | |
Short | When the request is completed by the Fulfiller. |
24. Task.authoredOn | |
Short | When this Task was created. |
Comments | The date/time that the original request was received by the Fulfiller, kicking off the request for correction or log disagreement process. If the request was received within the payload of a Communication resource, it SHOULD match |
Control | 1..? |
Must Support | true |
26. Task.lastModified | |
Short | When the correction task was last modified. |
Comments | Indicates the most recent modification date/time for the correction process. Usually this will change in conjunction with a status or businessStatus change. When |
Must Support | true |
28. Task.requester | |
Definition | The entity that is requesting the correction or logging the disagreement, such as a patient or their caregiver. |
Short | Entity requesting the correction or logging the disagreement. |
Type | Reference(Patient, RelatedPerson) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
30. Task.owner | |
Short | The entity that is responsibility for fulfilling the request. Initially, this could be populated from Communication.recipient on the Communication resource of the initial request. TheFulfiller can then refine to a specific individual, group, role, or department. For example, a medical records staff person. |
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
32. Task.reasonCode | |
Short | Why task is needed. E.g., need record correct prior to upcoming surgery. |
34. Task.reasonReference | |
Short | Log Disagreement Task to point to the original Request for Correction Task. |
Comments | Used on Log Disagreement Task to point to the original Request for Correction Task. |
Type | Reference(Patient Correction Task) |
36. Task.note | |
Short | Non-actionable notes about this communication. |
Comments | Notes from Requestors SHOULD be placed into additional communications instead of notes, so that Fulfillers review them. This element SHALL NOT contain actionable requests from either Requestors or Fulfillers. |
38. Task.restriction | |
Control | 0..0 |
40. Task.input | |
42. Task.input.id | |
Control | 0..0 |
44. Task.input.extension | |
Control | 0..0 |
46. Task.input.modifierExtension | |
Control | 0..0 |
48. Task.input.type | |
Short | Label for input |
Binding | The codes SHALL be taken from Patient Correction Communication Types Value Set |
50. Task.input.value[x] | |
Type | Choice of: string, Attachment, Reference(Patient Correction Communication), date, Meta, Address, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. Task.output | |
Short | Formal Response from Fulfiller to the Correction Request or to the Disagreement to Correction Denial. |
54. Task.output.id | |
Control | 0..0 |
56. Task.output.extension | |
Control | 0..0 |
58. Task.output.modifierExtension | |
Control | 0..0 |
60. Task.output.type | |
Binding | The codes SHALL be taken from Patient Correction Output Types Value Set |
62. Task.output.value[x] | |
Type | Choice of: string, Attachment, Reference(Patient Correction Communication), date, Meta, Address, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. Task | |
Definition | A task to be performed. |
Short | A task to be performed |
Control | 0..* |
Is Modifier | false |
Summary | false |
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) 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 )task-reasonreference: If this is a Disagreement Task, there SHALL be a reference to the original Request for Correction Communication. ( Task.code.coding.exists(code = 'medRecCxDenialDisagree' and system = 'http://hl7.org/fhir/uv/patient-corrections/CodeSystem/PatientCorrectionTaskTypes') implies Task.reasonReference.exists() )task-output2: If this is a completed Request for Correction Task, there SHALL be a formal response to the request (acceptance, denial, partial acceptance/denial). ( (Task.code.coding.exists(code = 'medRecCxReq' and system = 'http://hl7.org/fhir/uv/patient-corrections/CodeSystem/PatientCorrectionTaskTypes') and Task.status = 'completed') implies Task.output.type.coding.exists(code = 'medRecCxReqResolution' and system = 'http://hl7.org/fhir/uv/patient-corrections/CodeSystem/PatientCorrectionOutputTypes') )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) |
2. Task.implicitRules | |
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. |
Short | A set of rules under which this content was created |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true because 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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
4. Task.modifierExtension | |
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). |
Short | Extensions that cannot be ignored |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
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. |
Alternate Names | extensions, user content |
Invariants | 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()) |
6. Task.identifier | |
Definition | The business identifier for this task. |
Short | A business identifier for the correction process.Task Instance Identifier |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. Task.basedOn | |
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. |
Short | Request fulfilled by this task |
Control | 0..0* |
Type | Reference(Resource) |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. Task.partOf | |
Definition | Task that this particular task is part of. |
Short | Composite task |
Comments | This should usually be 0..1. |
Control | 0..0* |
Type | Reference(Task) |
Is Modifier | false |
Summary | true |
Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. Task.status | |
Definition | The current status of the task. |
Short | Current status of a Correction Request or Log Disagreement.draft | requested | received | accepted | + |
Comments | The current status of the Correction Request or Log Disagreement process. This status together with the business status can be used to determine the state of the process. |
Control | 1..1 |
Binding | The codes SHALL be taken from TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1 |
Type | code |
Is Modifier | true because 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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) task-status-allowed: The status of the Task SHALL be one of the following: ready, in-progress, cancelled, completed. ( $this in ('ready' | 'in-progress' | 'cancelled' | 'completed') ) |
14. Task.statusReason | |
Definition | An explanation as to why this task is held, failed, was refused, etc. |
Short | Reason for the correction request status.Reason for current status |
Comments | The reason for the correction request status. Codes to identify the reason for current status. These will typically be specific to a particular workflow. This applies to the current status. Look at the history of the task to see reasons for past statuses. |
Control | 0..1 |
Binding | Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
Type | CodeableConcept |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. Task.businessStatus | |
Definition | Contains business-specific nuances of the business state. |
Short | Business status of the request for correction process or the log disagreement process.E.g. "Specimen collected", "IV prepped" |
Comments | The business status of the request for correction process or the log disagreement process. The domain-specific business-contextual sub-state of the task. For example: Waiting on additional information from requester, waiting on additional information from fulfiller (could be a specific party on the fulfiller side), more time needed to review request, an amendment will be made to the record, an amendment has been made to the record, current record determined accurate and will not be amended, a partial amendment will be made to the record, a partial amendment has been made to the record, disagreement has been reviewed and attached to the record, disagreement has been rebutted. |
Control | 0..1 |
Binding | The codes SHALL be taken from For example codes, see Patient Correction Business Status |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Task.intent | |
Definition | Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc. |
Short | Indicates the actionability associated with the Task.unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option |
Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". |
Control | 1..1 |
Binding | The codes SHALL be taken from TaskIntenthttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 Distinguishes whether the task is a proposal, plan or full order. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Fixed Value | order |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. Task.code | |
Definition | Either a patient correction or a disagreement. A name or code (or both) briefly describing what the task involves. |
Short | Correction Task type.Task Type |
Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. |
Control | 10..1 This element is affected by the following invariants: task-reasonreference |
Binding | The codes SHALL be taken from For example codes, see Patient Correction Task Types Values Sethttp://hl7.org/fhir/ValueSet/task-code |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. Task.for | |
Definition | The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
Short | Patient this correction or disagreement relates to.Beneficiary of the Task |
Comments | The patient whose record this correction or disagreement references. If this task was created in response to a request received through a Communication resource, this value SHALL be populated with the value of |
Control | 10..1 |
Type | Reference(Patient, Resource) |
Is Modifier | false |
Must Support | true |
Summary | true |
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. |
Alternate Names | Patient |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. Task.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. |
Short | Healthcare event during which this task originated |
Control | 0..01 |
Type | Reference(Encounter) |
Is Modifier | false |
Summary | true |
Requirements | For some tasks it may be important to know the link between the encounter the task originated within. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. Task.executionPeriod | |
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). |
Short | When the request is completed by the Fulfiller.Start and end time of execution |
Control | 0..1 |
Type | Period |
Is Modifier | false |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. Task.authoredOn | |
Definition | The date and time this task was created. |
Short | When this Task was created.Task Creation Date |
Comments | The date/time that the original request was received by the Fulfiller, kicking off the request for correction or log disagreement process. If the request was received within the payload of a Communication resource, it SHOULD match |
Control | 10..1 This element is affected by the following invariants: inv-1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. |
Alternate Names | Created Date |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. Task.lastModified | |
Definition | The date and time of last modification to this task. |
Short | When the correction task was last modified.Task Last Modified Date |
Comments | Indicates the most recent modification date/time for the correction process. Usually this will change in conjunction with a status or businessStatus change. When |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. |
Alternate Names | Update Date |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
32. Task.requester | |
Definition | The entity that is requesting the correction or logging the disagreement, such as a patient or their caregiver. The creator of the task. |
Short | Entity requesting the correction or logging the disagreement.Who is asking for task to be done |
Control | 0..1 |
Type | Reference(Patient, RelatedPerson, Device, Organization, Practitioner, PractitionerRole) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
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). |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. Task.owner | |
Definition | Individual organization or Device currently responsible for task execution. |
Short | The entity that is responsibility for fulfilling the request. Initially, this could be populated from Communication.recipient on the Communication resource of the initial request. TheFulfiller can then refine to a specific individual, group, role, or department. For example, a medical records staff person.Responsible individual |
Comments | Tasks may be created with an owner not yet identified. |
Control | 0..1 |
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Requirements | Identifies who is expected to perform this task. |
Alternate Names | Performer, Executer |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. Task.reasonCode | |
Definition | A description or code indicating why this task needs to be performed. |
Short | Why task is needed. E.g., need record correct prior to upcoming surgery. |
Comments | This should only be included if there is no focus or if it differs from the reason indicated on the focus. |
Control | 0..1 |
Binding | Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. Task.reasonReference | |
Definition | A resource reference indicating why this task needs to be performed. |
Short | Log Disagreement Task to point to the original Request for Correction Task.Why task is needed |
Comments | Used on Log Disagreement Task to point to the original Request for Correction Task. 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 |
Control | 0..1 This element is affected by the following invariants: task-reasonreference |
Type | Reference(Patient Correction Task, Resource) |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. Task.note | |
Definition | Free-text information captured about the task as it progresses. |
Short | Non-actionable notes about this communication.Comments made about the task |
Comments | Notes from Requestors SHOULD be placed into additional communications instead of notes, so that Fulfillers review them. This element SHALL NOT contain actionable requests from either Requestors or Fulfillers. |
Control | 0..* |
Type | Annotation |
Is Modifier | false |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. Task.restriction | |
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. |
Short | Constraints on fulfillment tasks |
Control | 0..01 |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
45. Task.output | |
Definition | Outputs produced by the Task. |
Short | Formal Response from Fulfiller to the Correction Request or to the Disagreement to Correction Denial.Information produced as part of task |
Control | 0..* This element is affected by the following invariants: task-output2 |
Type | BackboneElement |
Is Modifier | false |
Summary | false |
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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
47. Task.output.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..01 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
49. Task.output.extension | |
Definition | An Extension 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. |
Short | ExtensionAdditional content defined by implementations |
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. |
Control | 0..0* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
51. Task.output.modifierExtension | |
Definition | An Extension 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). |
Short | ExtensionExtensions that cannot be ignored even if unrecognized |
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. |
Control | 0..0* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
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. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
53. Task.output.type | |
Definition | The name of the Output parameter. |
Short | Label for output |
Control | 1..1 |
Binding | The codes SHALL be taken from For example codes, see Patient Correction Output Types Value Set |
Type | CodeableConcept |
Is Modifier | false |
Summary | false |
Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. |
Alternate Names | Name |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
55. Task.output.value[x] | |
Definition | The value of the Output parameter as a basic type. |
Short | Result of output |
Control | 1..1 |
Type | Choice of: string, Attachment, Reference(Patient Correction Communication), date, Meta, Address, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Requirements | Task outputs can take any form. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. Task | |||||
Definition | A task to be performed. | ||||
Short | A task to be performed | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() )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 )task-reasonreference: If this is a Disagreement Task, there SHALL be a reference to the original Request for Correction Communication. ( Task.code.coding.exists(code = 'medRecCxDenialDisagree' and system = 'http://hl7.org/fhir/uv/patient-corrections/CodeSystem/PatientCorrectionTaskTypes') implies Task.reasonReference.exists() )task-output2: If this is a completed Request for Correction Task, there SHALL be a formal response to the request (acceptance, denial, partial acceptance/denial). ( (Task.code.coding.exists(code = 'medRecCxReq' and system = 'http://hl7.org/fhir/uv/patient-corrections/CodeSystem/PatientCorrectionTaskTypes') and Task.status = 'completed') implies Task.output.type.coding.exists(code = 'medRecCxReqResolution' and system = 'http://hl7.org/fhir/uv/patient-corrections/CodeSystem/PatientCorrectionOutputTypes') ) | ||||
2. Task.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical id of this artifact | ||||
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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
4. Task.meta | |||||
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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
6. Task.implicitRules | |||||
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. | ||||
Short | A set of rules under which this content was created | ||||
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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true because 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
8. Task.language | |||||
Definition | The base language in which the resource is written. | ||||
Short | Language of the resource content | ||||
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). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages: A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
10. Task.text | |||||
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. | ||||
Short | Text summary of the resource, for human interpretation | ||||
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. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
12. Task.contained | |||||
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. | ||||
Short | Contained, inline Resources | ||||
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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||
14. Task.extension | |||||
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. | ||||
Short | Additional content defined by implementations | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | 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() ) | ||||
16. Task.modifierExtension | |||||
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. | ||||
Short | Extensions that cannot be ignored | ||||
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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
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. | ||||
Alternate Names | extensions, user content | ||||
Invariants | 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() ) | ||||
18. Task.identifier | |||||
Definition | The business identifier for this task. | ||||
Short | A business identifier for the correction process. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
20. Task.instantiatesCanonical | |||||
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. | ||||
Short | Formal definition of task | ||||
Control | 0..1 | ||||
Type | canonical(ActivityDefinition) | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Requirements | Enables a formal definition of how he task is to be performed, enabling automation. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
22. Task.instantiatesUri | |||||
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. | ||||
Short | Formal definition of task | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. Task.basedOn | |||||
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. | ||||
Short | Request fulfilled by this task | ||||
Control | 0..0 | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
26. Task.groupIdentifier | |||||
Definition | An identifier that links together multiple tasks and other requests that were created in the same context. | ||||
Short | Requisition or grouper id | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. Task.partOf | |||||
Definition | Task that this particular task is part of. | ||||
Short | Composite task | ||||
Comments | This should usually be 0..1. | ||||
Control | 0..0 | ||||
Type | Reference(Task) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. Task.status | |||||
Definition | The current status of the task. | ||||
Short | Current status of a Correction Request or Log Disagreement. | ||||
Comments | The current status of the Correction Request or Log Disagreement process. This status together with the business status can be used to determine the state of the process. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from TaskStatus | ||||
Type | code | ||||
Is Modifier | true because 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )task-status-allowed: The status of the Task SHALL be one of the following: ready, in-progress, cancelled, completed. ( $this in ('ready' | 'in-progress' | 'cancelled' | 'completed') ) | ||||
32. Task.statusReason | |||||
Definition | An explanation as to why this task is held, failed, was refused, etc. | ||||
Short | Reason for the correction request status. | ||||
Comments | The reason for the correction request status. Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
Control | 0..1 | ||||
Binding | Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
34. Task.businessStatus | |||||
Definition | Contains business-specific nuances of the business state. | ||||
Short | Business status of the request for correction process or the log disagreement process. | ||||
Comments | The business status of the request for correction process or the log disagreement process. The domain-specific business-contextual sub-state of the task. For example: Waiting on additional information from requester, waiting on additional information from fulfiller (could be a specific party on the fulfiller side), more time needed to review request, an amendment will be made to the record, an amendment has been made to the record, current record determined accurate and will not be amended, a partial amendment will be made to the record, a partial amendment has been made to the record, disagreement has been reviewed and attached to the record, disagreement has been rebutted. | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Patient Correction Business Status | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
36. Task.intent | |||||
Definition | Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc. | ||||
Short | Indicates the actionability associated with the Task. | ||||
Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from TaskIntent: Distinguishes whether the task is a proposal, plan or full order. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Fixed Value | order | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
38. Task.priority | |||||
Definition | Indicates how quickly the Task should be addressed with respect to other requests. | ||||
Short | routine | urgent | asap | stat | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from RequestPriority: The task's priority. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Used to identify the service level expected while performing a task. | ||||
Meaning if Missing | If missing, this task should be performed with normal priority | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
40. Task.code | |||||
Definition | Either a patient correction or a disagreement. | ||||
Short | Correction Task type. | ||||
Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. | ||||
Control | 1..1 This element is affected by the following invariants: task-reasonreference | ||||
Binding | The codes SHALL be taken from Patient Correction Task Types Values Set | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
42. Task.description | |||||
Definition | A free-text description of what is to be performed. | ||||
Short | Human-readable explanation of task | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
44. Task.focus | |||||
Definition | The request being actioned or the resource being manipulated by this task. | ||||
Short | What task is acting on | ||||
Comments | If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.). | ||||
Control | 0..1 | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | Used to identify the thing to be done. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
46. Task.for | |||||
Definition | The entity who benefits from the performance of the service specified in the task (e.g., the patient). | ||||
Short | Patient this correction or disagreement relates to. | ||||
Comments | The patient whose record this correction or disagreement references. If this task was created in response to a request received through a Communication resource, this value SHALL be populated with the value of | ||||
Control | 1..1 | ||||
Type | Reference(Patient) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
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. | ||||
Alternate Names | Patient | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
48. Task.encounter | |||||
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. | ||||
Short | Healthcare event during which this task originated | ||||
Control | 0..0 | ||||
Type | Reference(Encounter) | ||||
Is Modifier | false | ||||
Summary | true | ||||
Requirements | For some tasks it may be important to know the link between the encounter the task originated within. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
50. Task.executionPeriod | |||||
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). | ||||
Short | When the request is completed by the Fulfiller. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
52. Task.authoredOn | |||||
Definition | The date and time this task was created. | ||||
Short | When this Task was created. | ||||
Comments | The date/time that the original request was received by the Fulfiller, kicking off the request for correction or log disagreement process. If the request was received within the payload of a Communication resource, it SHOULD match | ||||
Control | 1..1 This element is affected by the following invariants: inv-1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. | ||||
Alternate Names | Created Date | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
54. Task.lastModified | |||||
Definition | The date and time of last modification to this task. | ||||
Short | When the correction task was last modified. | ||||
Comments | Indicates the most recent modification date/time for the correction process. Usually this will change in conjunction with a status or businessStatus change. When | ||||
Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. | ||||
Alternate Names | Update Date | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
56. Task.requester | |||||
Definition | The entity that is requesting the correction or logging the disagreement, such as a patient or their caregiver. | ||||
Short | Entity requesting the correction or logging the disagreement. | ||||
Control | 0..1 | ||||
Type | Reference(Patient, RelatedPerson) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
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). | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
58. Task.performerType | |||||
Definition | The kind of participant that should perform the task. | ||||
Short | Requested performer | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from ProcedurePerformerRoleCodes: The type(s) of task performers allowed. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Use to distinguish tasks on different activity queues. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
60. Task.owner | |||||
Definition | Individual organization or Device currently responsible for task execution. | ||||
Short | The entity that is responsibility for fulfilling the request. Initially, this could be populated from Communication.recipient on the Communication resource of the initial request. TheFulfiller can then refine to a specific individual, group, role, or department. For example, a medical records staff person. | ||||
Comments | Tasks may be created with an owner not yet identified. | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
Requirements | Identifies who is expected to perform this task. | ||||
Alternate Names | Performer, Executer | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
62. Task.location | |||||
Definition | Principal physical location where the this task is performed. | ||||
Short | Where task occurs | ||||
Control | 0..1 | ||||
Type | Reference(Location) | ||||
Is Modifier | false | ||||
Summary | true | ||||
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). | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
64. Task.reasonCode | |||||
Definition | A description or code indicating why this task needs to be performed. | ||||
Short | Why task is needed. E.g., need record correct prior to upcoming surgery. | ||||
Comments | This should only be included if there is no focus or if it differs from the reason indicated on the focus. | ||||
Control | 0..1 | ||||
Binding | Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
66. Task.reasonReference | |||||
Definition | A resource reference indicating why this task needs to be performed. | ||||
Short | Log Disagreement Task to point to the original Request for Correction Task. | ||||
Comments | Used on Log Disagreement Task to point to the original Request for Correction Task. | ||||
Control | 0..1 This element is affected by the following invariants: task-reasonreference | ||||
Type | Reference(Patient Correction Task) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
68. Task.insurance | |||||
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. | ||||
Short | Associated insurance coverage | ||||
Control | 0..* | ||||
Type | Reference(Coverage, ClaimResponse) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
70. Task.note | |||||
Definition | Free-text information captured about the task as it progresses. | ||||
Short | Non-actionable notes about this communication. | ||||
Comments | Notes from Requestors SHOULD be placed into additional communications instead of notes, so that Fulfillers review them. This element SHALL NOT contain actionable requests from either Requestors or Fulfillers. | ||||
Control | 0..* | ||||
Type | Annotation | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
72. Task.relevantHistory | |||||
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. | ||||
Short | Key events in history 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. | ||||
Control | 0..* | ||||
Type | Reference(Provenance) | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | Status History | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
74. Task.restriction | |||||
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. | ||||
Short | Constraints on fulfillment tasks | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
82. Task.input | |||||
Definition | Additional information that may be needed in the execution of the task. | ||||
Short | Information used to perform task | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Alternate Names | Supporting Information | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
84. Task.input.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
86. Task.input.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | 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() ) | ||||
88. Task.input.modifierExtension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Invariants | 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() ) | ||||
90. Task.input.type | |||||
Definition | A code or description indicating how the input is intended to be used as part of the task execution. | ||||
Short | Label for input | ||||
Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input. | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Patient Correction Communication Types Value Set | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. | ||||
Alternate Names | Name | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
92. Task.input.value[x] | |||||
Definition | The value of the input parameter as a basic type. | ||||
Short | Content to use in performing the task | ||||
Control | 1..1 | ||||
Type | Choice of: string, Attachment, Reference(Patient Correction Communication) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
94. Task.output | |||||
Definition | Outputs produced by the Task. | ||||
Short | Formal Response from Fulfiller to the Correction Request or to the Disagreement to Correction Denial. | ||||
Control | 0..* This element is affected by the following invariants: task-output2 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Summary | false | ||||
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. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
96. Task.output.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..0 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
98. Task.output.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | 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() ) | ||||
100. Task.output.modifierExtension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | true | ||||
Invariants | 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() ) | ||||
102. Task.output.type | |||||
Definition | The name of the Output parameter. | ||||
Short | Label for output | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from Patient Correction Output Types Value Set | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Summary | false | ||||
Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. | ||||
Alternate Names | Name | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
104. Task.output.value[x] | |||||
Definition | The value of the Output parameter as a basic type. | ||||
Short | Result of output | ||||
Control | 1..1 | ||||
Type | Choice of: string, Attachment, Reference(Patient Correction Communication) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Requirements | Task outputs can take any form. | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |