Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-Task resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Task | |
| Definition | A task to be performed. |
| Short | A task to be performed |
| Control | 0..* |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())inv-1: Last modified date must be greater than or equal to authored-on date. ( lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn)dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) inv-1: Last modified date must be greater than or equal to authored-on date. (lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn) |
| 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. |
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. Task.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
| 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..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Task.extension:requestedPeriod | |
| Slice Name | requestedPeriod |
| Definition | R5: |
| Short | R5: When the task should be performed (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: When the task should be performed (new)) (Extension Type: Period) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. Task.extension:requestedPerformer | |
| Slice Name | requestedPerformer |
| Definition | R5: |
| Short | R5: Who should perform Task (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Who should perform Task (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. Task.extension:performer | |
| Slice Name | performer |
| Definition | R5: |
| Short | R5: Who or what performed the task (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Who or what performed the task (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. Task.extension:location | |
| Slice Name | location |
| Definition | R5: |
| Short | R5: Where task occurs (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Where task occurs (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR STU3, Location)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. Task.extension:insurance | |
| Slice Name | insurance |
| Definition | R5: |
| Short | R5: Associated insurance coverage (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Associated insurance coverage (new)) (Extension Type: Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3, Coverage, Cross-version Profile for R5.ClaimResponse for use in FHIR STU3, ClaimResponse)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. Task.modifierExtension | |
| Definition | An Extension 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. Usually modifier elements provide negation or qualification. In order 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 | ExtensionExtensions 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 No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Task.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 18. Task.modifierExtension:doNotPerform | |
| Slice Name | doNotPerform |
| Definition | R5: |
| Short | R5: True if Task is prohibiting action (new) |
| Comments | Element 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. |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/request-doNotPerform) |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| 20. Task.status | |
| Definition | The current status of the task. |
| Short | draft | requested | received | accepted | + |
| Control | 1..1 |
| Binding | The codes SHALL be taken from TaskStatushttp://hl7.org/fhir/ValueSet/task-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/task-status|3.0.2)The current status of the task. |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. |
| 22. Task.intent | |
| Definition | Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc. |
| Short | proposal | plan | order + |
| Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|3.0.2 (required to http://hl7.org/fhir/ValueSet/request-intent|3.0.2)Distinguishes whether the task is a proposal, plan or full order |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 24. Task.intent.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| 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..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Task.intent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. Task.intent.extension:intent | |
| Slice Name | intent |
| Definition | R5: |
| Short | R5: unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option |
| Comments | Element In most cases, Tasks will have an intent of "order". |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option) (Extension Type: code) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Task | |
| 2. Task.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Task.extension:requestedPeriod | |
| Slice Name | requestedPeriod |
| Definition | R5: |
| Short | R5: When the task should be performed (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: When the task should be performed (new)) (Extension Type: Period) |
| 6. Task.extension:requestedPerformer | |
| Slice Name | requestedPerformer |
| Definition | R5: |
| Short | R5: Who should perform Task (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who should perform Task (new)) (Complex Extension) |
| 8. Task.extension:performer | |
| Slice Name | performer |
| Definition | R5: |
| Short | R5: Who or what performed the task (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who or what performed the task (new)) (Complex Extension) |
| 10. Task.extension:location | |
| Slice Name | location |
| Definition | R5: |
| Short | R5: Where task occurs (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Where task occurs (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR STU3, Location)) |
| 12. Task.extension:insurance | |
| Slice Name | insurance |
| Definition | R5: |
| Short | R5: Associated insurance coverage (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Associated insurance coverage (new)) (Extension Type: Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3, Coverage, Cross-version Profile for R5.ClaimResponse for use in FHIR STU3, ClaimResponse)) |
| 14. Task.modifierExtension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Task.modifierExtension:doNotPerform | |
| Slice Name | doNotPerform |
| Definition | R5: |
| Short | R5: True if Task is prohibiting action (new) |
| Comments | Element 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. |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/request-doNotPerform) |
| 18. Task.basedOn | |
| 20. Task.basedOn.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Task.basedOn.extension:basedOn | |
| Slice Name | basedOn |
| Definition | R5: |
| Short | R5: basedOn additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 24. Task.partOf | |
| 26. Task.partOf.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 28. Task.partOf.extension:partOf | |
| Slice Name | partOf |
| Definition | R5: |
| Short | R5: partOf additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 30. Task.statusReason | |
| 32. Task.statusReason.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.statusReason.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. Task.statusReason.extension:statusReason | |
| Slice Name | statusReason |
| Definition | R5: |
| Short | R5: statusReason additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: statusReason additional types) (Extension Type: Reference) |
| 36. Task.intent | |
| 38. Task.intent.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.intent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. Task.intent.extension:intent | |
| Slice Name | intent |
| Definition | R5: |
| Short | R5: unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option |
| Comments | Element In most cases, Tasks will have an intent of "order". |
| Control | 0..1 |
| Type | Extension(R5: unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option) (Extension Type: code) |
| 42. Task.focus | |
| 44. Task.focus.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.focus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 46. Task.focus.extension:focus | |
| Slice Name | focus |
| Definition | R5: |
| Short | R5: focus additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 48. Task.for | |
| 50. Task.for.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.for.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. Task.for.extension:for | |
| Slice Name | for |
| Definition | R5: |
| Short | R5: for additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 54. Task.context | |
| 56. Task.context.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.context.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. Task.context.extension:encounter | |
| Slice Name | encounter |
| Definition | R5: |
| Short | R5: encounter additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 60. Task.requester | |
| 62. Task.requester.agent | |
| 64. Task.requester.agent.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.requester.agent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 66. Task.requester.agent.extension:requester | |
| Slice Name | requester |
| Definition | R5: |
| Short | R5: Who is asking for task to be done |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 68. Task.owner | |
| 70. Task.owner.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.owner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 72. Task.owner.extension:owner | |
| Slice Name | owner |
| Definition | R5: |
| Short | R5: owner |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 74. Task.reason | |
| 76. Task.reason.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.reason.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 78. Task.reason.extension:reason | |
| Slice Name | reason |
| Definition | R5: |
| Short | R5: reason additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: reason additional types) (Extension Type: Reference) |
| 80. Task.relevantHistory | |
| 82. Task.relevantHistory.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.relevantHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 84. Task.relevantHistory.extension:relevantHistory | |
| Slice Name | relevantHistory |
| Definition | R5: |
| Short | R5: relevantHistory additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 86. Task.restriction | |
| 88. Task.restriction.recipient | |
| 90. Task.restriction.recipient.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.restriction.recipient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 92. Task.restriction.recipient.extension:recipient | |
| Slice Name | recipient |
| Definition | R5: |
| Short | R5: recipient |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 94. Task.input | |
| 96. Task.input.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.input.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 98. Task.input.extension:value | |
| Slice Name | value |
| Definition | R5: |
| Short | R5: value additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: value additional types) (Extension Type: uri) |
| 100. Task.output | |
| 102. Task.output.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.output.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 104. Task.output.extension:value | |
| Slice Name | value |
| Definition | R5: |
| Short | R5: value additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: value additional types) (Extension Type: uri) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Task | |||||
| Definition | A task to be performed. | ||||
| Short | A task to be performed | ||||
| Control | 0..* | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())inv-1: Last modified date must be greater than or equal to authored-on date. ( lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn) | ||||
| 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 | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. Task.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 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. | ||||
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 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 | Unless not suitable, these codes SHALL be taken from Common Languages ![]() (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. Task.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. Task.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. Task.extension:requestedPeriod | |||||
| Slice Name | requestedPeriod | ||||
| Definition | R5: | ||||
| Short | R5: When the task should be performed (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: When the task should be performed (new)) (Extension Type: Period) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. Task.extension:requestedPerformer | |||||
| Slice Name | requestedPerformer | ||||
| Definition | R5: | ||||
| Short | R5: Who should perform Task (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Who should perform Task (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. Task.extension:performer | |||||
| Slice Name | performer | ||||
| Definition | R5: | ||||
| Short | R5: Who or what performed the task (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Who or what performed the task (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. Task.extension:location | |||||
| Slice Name | location | ||||
| Definition | R5: | ||||
| Short | R5: Where task occurs (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Where task occurs (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR STU3, Location)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 24. Task.extension:insurance | |||||
| Slice Name | insurance | ||||
| Definition | R5: | ||||
| Short | R5: Associated insurance coverage (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Associated insurance coverage (new)) (Extension Type: Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3, Coverage, Cross-version Profile for R5.ClaimResponse for use in FHIR STU3, ClaimResponse)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. Task.modifierExtension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Slicing | This element introduces a set of slices on Task.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 28. Task.modifierExtension:doNotPerform | |||||
| Slice Name | doNotPerform | ||||
| Definition | R5: | ||||
| Short | R5: True if Task is prohibiting action (new) | ||||
| Comments | Element 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. | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/request-doNotPerform) | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| 30. Task.identifier | |||||
| Definition | The business identifier for this task. | ||||
| Short | Task Instance Identifier | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| 32. Task.definition[x] | |||||
| Definition | A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc. | ||||
| Short | Formal definition of task | ||||
| Control | 0..1 | ||||
| Type | Choice of: uri, Reference(ActivityDefinition) | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| 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. | ||||
| 34. 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 ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient. | ||||
| Short | Request fulfilled by this task | ||||
| Control | 0..* | ||||
| Type | Reference(Resource) | ||||
| Summary | true | ||||
| 36. Task.basedOn.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 38. Task.basedOn.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 40. Task.basedOn.extension:basedOn | |||||
| Slice Name | basedOn | ||||
| Definition | R5: | ||||
| Short | R5: basedOn additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 42. Task.basedOn.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 44. Task.basedOn.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 46. Task.basedOn.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 48. 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 | ||||
| Summary | true | ||||
| Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. | ||||
| 50. Task.partOf | |||||
| Definition | Task that this particular task is part of. | ||||
| Short | Composite task | ||||
| Comments | This should usually be 0..1. | ||||
| Control | 0..* | ||||
| Type | Reference(Task) | ||||
| Summary | true | ||||
| Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). | ||||
| 52. Task.partOf.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 54. Task.partOf.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 56. Task.partOf.extension:partOf | |||||
| Slice Name | partOf | ||||
| Definition | R5: | ||||
| Short | R5: partOf additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 58. Task.partOf.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 60. Task.partOf.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 62. Task.partOf.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 64. Task.status | |||||
| Definition | The current status of the task. | ||||
| Short | draft | requested | received | accepted | + | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from TaskStatus (required to http://hl7.org/fhir/ValueSet/task-status|3.0.2)The current status of the task. | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. | ||||
| 66. Task.statusReason | |||||
| Definition | An explanation as to why this task is held, failed, was refused, etc. | ||||
| Short | Reason for current status | ||||
| Comments | 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 | ||||
| Summary | true | ||||
| 68. Task.statusReason.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 70. Task.statusReason.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.statusReason.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 72. Task.statusReason.extension:statusReason | |||||
| Slice Name | statusReason | ||||
| Definition | R5: | ||||
| Short | R5: statusReason additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(R5: statusReason additional types) (Extension Type: Reference) | ||||
| 74. Task.statusReason.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..* | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
| 76. Task.statusReason.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
| 78. Task.businessStatus | |||||
| Definition | Contains business-specific nuances of the business state. | ||||
| Short | E.g. "Specimen collected", "IV prepped" | ||||
| Control | 0..1 | ||||
| Binding | The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. | ||||
| 80. Task.intent | |||||
| Definition | Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc. | ||||
| Short | proposal | plan | order + | ||||
| Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from RequestIntent (required to http://hl7.org/fhir/ValueSet/request-intent|3.0.2)Distinguishes whether the task is a proposal, plan or full order | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 82. Task.intent.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 84. Task.intent.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.intent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 86. Task.intent.extension:intent | |||||
| Slice Name | intent | ||||
| Definition | R5: | ||||
| Short | R5: unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option | ||||
| Comments | Element In most cases, Tasks will have an intent of "order". | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 88. Task.intent.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 90. Task.priority | |||||
| Definition | Indicates how quickly the Task should be addressed with respect to other requests. | ||||
| Short | normal | urgent | asap | stat | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority|3.0.2)The task's priority | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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 | ||||
| 92. Task.code | |||||
| Definition | A name or code (or both) briefly describing what the task involves. | ||||
| Short | Task Type | ||||
| Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. | ||||
| Control | 0..1 | ||||
| Binding | Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 94. Task.description | |||||
| Definition | A free-text description of what is to be performed. | ||||
| Short | Human-readable explanation of task | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 96. 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) | ||||
| Summary | true | ||||
| Requirements | Used to identify the thing to be done. | ||||
| 98. Task.focus.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 100. Task.focus.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.focus.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 102. Task.focus.extension:focus | |||||
| Slice Name | focus | ||||
| Definition | R5: | ||||
| Short | R5: focus additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 104. Task.focus.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 106. Task.focus.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 108. Task.focus.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 110. Task.for | |||||
| Definition | The entity who benefits from the performance of the service specified in the task (e.g., the patient). | ||||
| Short | Beneficiary of the Task | ||||
| Control | 0..1 | ||||
| Type | Reference(Resource) | ||||
| 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 | ||||
| 112. Task.for.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 114. Task.for.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.for.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 116. Task.for.extension:for | |||||
| Slice Name | for | ||||
| Definition | R5: | ||||
| Short | R5: for additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 118. Task.for.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 120. Task.for.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 122. Task.for.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 124. Task.context | |||||
| 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..1 | ||||
| Type | Reference(Encounter, EpisodeOfCare) | ||||
| Summary | true | ||||
| Requirements | For some tasks it may be important to know the link between the task or episode of care the task originated within. | ||||
| 126. Task.context.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 128. Task.context.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.context.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 130. Task.context.extension:encounter | |||||
| Slice Name | encounter | ||||
| Definition | R5: | ||||
| Short | R5: encounter additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 132. Task.context.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 134. Task.context.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 136. Task.context.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 138. 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 | Start and end time of execution | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Summary | true | ||||
| 140. Task.authoredOn | |||||
| Definition | The date and time this task was created. | ||||
| Short | Task Creation Date | ||||
| Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. | ||||
| Alternate Names | Created Date | ||||
| 142. Task.lastModified | |||||
| Definition | The date and time of last modification to this task. | ||||
| Short | Task Last Modified Date | ||||
| Control | 0..1 This element is affected by the following invariants: inv-1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 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 | ||||
| 144. Task.requester | |||||
| Definition | The creator of the task. | ||||
| Short | Who is asking for task to be done | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| 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() | (children().count() > id.count())) | ||||
| 146. Task.requester.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 148. Task.requester.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| 150. Task.requester.modifierExtension | |||||
| Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 152. Task.requester.agent | |||||
| Definition | The device, practitioner, etc. who initiated the task. | ||||
| Short | Individual asking for task | ||||
| Control | 1..1 | ||||
| Type | Reference(Device, Organization, Patient, Practitioner, RelatedPerson) | ||||
| Summary | true | ||||
| Alternate Names | Initiator, Author | ||||
| 154. Task.requester.agent.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 156. Task.requester.agent.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.requester.agent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 158. Task.requester.agent.extension:requester | |||||
| Slice Name | requester | ||||
| Definition | R5: | ||||
| Short | R5: Who is asking for task to be done | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 160. Task.requester.agent.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 162. Task.requester.agent.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 164. Task.requester.agent.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 166. Task.requester.onBehalfOf | |||||
| Definition | The organization the device or practitioner was acting on behalf of when they initiated the task. | ||||
| Short | Organization individual is acting for | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. | ||||
| 168. Task.performerType | |||||
| Definition | The type of participant that can execute the task. | ||||
| Short | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer | ||||
| Control | 0..* | ||||
| Binding | The codes SHOULD be taken from TaskPerformerType (preferred to http://hl7.org/fhir/ValueSet/task-performer-type|3.0.2)The type(s) of task performers allowed | ||||
| Type | CodeableConcept | ||||
| Requirements | Use to distinguish tasks on different activity queues. | ||||
| 170. Task.owner | |||||
| Definition | Individual organization or Device currently responsible for task execution. | ||||
| Short | Responsible individual | ||||
| Comments | Tasks may be created with an owner not yet identified. | ||||
| Control | 0..1 | ||||
| Type | Reference(Device, Organization, Patient, Practitioner, RelatedPerson) | ||||
| Summary | true | ||||
| Requirements | Identifies who is expected to perform this task. | ||||
| Alternate Names | Performer, Executer | ||||
| 172. Task.owner.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 174. Task.owner.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.owner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 176. Task.owner.extension:owner | |||||
| Slice Name | owner | ||||
| Definition | R5: | ||||
| Short | R5: owner | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 178. Task.owner.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 180. Task.owner.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 182. Task.owner.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 184. Task.reason | |||||
| Definition | A description or code indicating why this task needs to be performed. | ||||
| Short | Why task is needed | ||||
| 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 | ||||
| 186. Task.reason.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 188. Task.reason.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.reason.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 190. Task.reason.extension:reason | |||||
| Slice Name | reason | ||||
| Definition | R5: | ||||
| Short | R5: reason additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(R5: reason additional types) (Extension Type: Reference) | ||||
| 192. Task.reason.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..* | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
| 194. Task.reason.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
| 196. Task.note | |||||
| Definition | Free-text information captured about the task as it progresses. | ||||
| Short | Comments made about the task | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||
| 198. 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) | ||||
| Alternate Names | Status History | ||||
| 200. Task.relevantHistory.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 202. Task.relevantHistory.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.relevantHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 204. Task.relevantHistory.extension:relevantHistory | |||||
| Slice Name | relevantHistory | ||||
| Definition | R5: | ||||
| Short | R5: relevantHistory additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 206. Task.relevantHistory.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 208. Task.relevantHistory.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 210. Task.relevantHistory.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 212. 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..1 | ||||
| Type | BackboneElement | ||||
| 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() | (children().count() > id.count())) | ||||
| 214. Task.restriction.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 216. Task.restriction.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| 218. Task.restriction.modifierExtension | |||||
| Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 220. Task.restriction.repetitions | |||||
| Definition | Indicates the number of times the requested action should occur. | ||||
| Short | How many times to repeat | ||||
| Control | 0..1 | ||||
| Type | positiveInt | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | E.g. order that requests monthly lab tests, fulfillment is sought for 1. | ||||
| 222. Task.restriction.period | |||||
| Definition | Over what time-period is fulfillment sought. | ||||
| Short | When fulfillment sought | ||||
| Comments | Note that period.high is the due date representing the time by which the task should be completed. | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Requirements | E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months. | ||||
| 224. Task.restriction.recipient | |||||
| Definition | For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought? | ||||
| Short | For whom is fulfillment sought? | ||||
| Control | 0..* | ||||
| Type | Reference(Patient, Practitioner, RelatedPerson, Group, Organization) | ||||
| 226. Task.restriction.recipient.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 228. Task.restriction.recipient.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.restriction.recipient.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 230. Task.restriction.recipient.extension:recipient | |||||
| Slice Name | recipient | ||||
| Definition | R5: | ||||
| Short | R5: recipient | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 232. Task.restriction.recipient.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 234. Task.restriction.recipient.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 236. Task.restriction.recipient.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 238. 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 | ||||
| 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() | (children().count() > id.count())) | ||||
| 240. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 242. Task.input.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.input.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 244. Task.input.extension:value | |||||
| Slice Name | value | ||||
| Definition | R5: | ||||
| Short | R5: value additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: value additional types) (Extension Type: uri) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 246. Task.input.modifierExtension | |||||
| Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 248. 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 the 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 | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concommitent Medications", etc. | ||||
| Type | CodeableConcept | ||||
| Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. | ||||
| Alternate Names | Name | ||||
| 250. 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: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 252. Task.output | |||||
| Definition | Outputs produced by the Task. | ||||
| Short | Information produced as part of task | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| 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() | (children().count() > id.count())) | ||||
| 254. 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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 256. Task.output.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Task.output.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 258. Task.output.extension:value | |||||
| Slice Name | value | ||||
| Definition | R5: | ||||
| Short | R5: value additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: value additional types) (Extension Type: uri) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 260. Task.output.modifierExtension | |||||
| Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order 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 No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 262. Task.output.type | |||||
| Definition | The name of the Output parameter. | ||||
| Short | Label for output | ||||
| Control | 1..1 | ||||
| Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. | ||||
| Type | CodeableConcept | ||||
| Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. | ||||
| Alternate Names | Name | ||||
| 264. 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: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Requirements | Task outputs can take any form. | ||||