Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-ProcessRequest-for-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..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())inv-1: Last modified date must be greater than or equal to authored-on date. ( lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn)dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) inv-1: Last modified date must be greater than or equal to authored-on date. (lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn) |
| 2. Task.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Task.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | 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 | 10..* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 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:action | |
| Slice Name | action |
| Definition | DSTU2: |
| Short | DSTU2: cancel | poll | reprocess | status (new) |
| Comments | Element |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: cancel | poll | reprocess | status (new)) (Extension Type: code) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 8. Task.extension:ruleset | |
| Slice Name | ruleset |
| Definition | DSTU2: |
| Short | DSTU2: Resource version (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Resource version (new)) (Extension Type: Coding) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 10. Task.extension:originalRuleset | |
| Slice Name | originalRuleset |
| Definition | DSTU2: |
| Short | DSTU2: Original version (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Original version (new)) (Extension Type: Coding) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 12. Task.extension:created | |
| Slice Name | created |
| Definition | DSTU2: |
| Short | DSTU2: Creation date (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Creation date (new)) (Extension Type: dateTime) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 14. Task.extension:target | |
| Slice Name | target |
| Definition | DSTU2: |
| Short | DSTU2: Target of the request (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Target of the request (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Organization for use in FHIR R4B, Organization)) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 16. Task.extension:provider | |
| Slice Name | provider |
| Definition | DSTU2: |
| Short | DSTU2: Responsible practitioner (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Responsible practitioner (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Practitioner for use in FHIR R4B, PractitionerRole)) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 18. Task.extension:organization | |
| Slice Name | organization |
| Definition | DSTU2: |
| Short | DSTU2: Responsible organization (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Responsible organization (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Organization for use in FHIR R4B, Organization)) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 20. Task.extension:request | |
| Slice Name | request |
| Definition | DSTU2: |
| Short | DSTU2: Request reference (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Request reference (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Resource for use in FHIR R4B, Resource)) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 22. Task.extension:response | |
| Slice Name | response |
| Definition | DSTU2: |
| Short | DSTU2: Response reference (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Response reference (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Resource for use in FHIR R4B, Resource)) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 24. Task.extension:nullify | |
| Slice Name | nullify |
| Definition | DSTU2: |
| Short | DSTU2: Nullify (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Nullify (new)) (Extension Type: boolean) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 26. Task.extension:reference | |
| Slice Name | reference |
| Definition | DSTU2: |
| Short | DSTU2: Reference number/string (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Reference number/string (new)) (Extension Type: string) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 28. Task.extension:item | |
| Slice Name | item |
| Definition | DSTU2: |
| Short | DSTU2: Items to re-adjudicate (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Items to re-adjudicate (new)) (Complex Extension) |
| Is Modifier | false |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 30. Task.extension:include | |
| Slice Name | include |
| Definition | DSTU2: |
| Short | DSTU2: Resource type(s) to include (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Resource type(s) to include (new)) (Extension Type: string) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 32. Task.extension:exclude | |
| Slice Name | exclude |
| Definition | DSTU2: |
| Short | DSTU2: Resource type(s) to exclude (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Resource type(s) to exclude (new)) (Extension Type: string) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 34. Task.extension:period | |
| Slice Name | period |
| Definition | DSTU2: |
| Short | DSTU2: Period (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(DSTU2: Period (new)) (Extension Type: Period) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 36. Task.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | false |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 38. 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|4.3.0 (required to http://hl7.org/fhir/ValueSet/task-status|4.3.0)The current status of the task. |
| Type | code |
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. Task.intent | |
| Definition | Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc. |
| Short | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option |
| Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". |
| Control | 1..1 |
| Binding | The codes SHALL be taken from TaskIntenthttp://hl7.org/fhir/ValueSet/task-intent|4.3.0 (required to http://hl7.org/fhir/ValueSet/task-intent|4.3.0)Distinguishes whether the task is a proposal, plan or full order. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Task | |
| 2. Task.meta | |
| 4. Task.meta.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Task.meta.extension:meta | |
| Slice Name | meta |
| Definition | DSTU2: |
| Short | DSTU2: meta additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: meta additional types) (Complex Extension) |
| 8. Task.text | |
| 10. Task.text.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 12. Task.text.extension:text | |
| Slice Name | text |
| Definition | DSTU2: |
| Short | DSTU2: text additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: text additional types) (Complex Extension) |
| 14. Task.extension | |
| Control | 1..* |
| 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:action | |
| Slice Name | action |
| Definition | DSTU2: |
| Short | DSTU2: cancel | poll | reprocess | status (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(DSTU2: cancel | poll | reprocess | status (new)) (Extension Type: code) |
| 18. Task.extension:ruleset | |
| Slice Name | ruleset |
| Definition | DSTU2: |
| Short | DSTU2: Resource version (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Resource version (new)) (Extension Type: Coding) |
| 20. Task.extension:originalRuleset | |
| Slice Name | originalRuleset |
| Definition | DSTU2: |
| Short | DSTU2: Original version (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Original version (new)) (Extension Type: Coding) |
| 22. Task.extension:created | |
| Slice Name | created |
| Definition | DSTU2: |
| Short | DSTU2: Creation date (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Creation date (new)) (Extension Type: dateTime) |
| 24. Task.extension:target | |
| Slice Name | target |
| Definition | DSTU2: |
| Short | DSTU2: Target of the request (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Target of the request (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Organization for use in FHIR R4B, Organization)) |
| 26. Task.extension:provider | |
| Slice Name | provider |
| Definition | DSTU2: |
| Short | DSTU2: Responsible practitioner (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Responsible practitioner (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Practitioner for use in FHIR R4B, PractitionerRole)) |
| 28. Task.extension:organization | |
| Slice Name | organization |
| Definition | DSTU2: |
| Short | DSTU2: Responsible organization (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Responsible organization (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Organization for use in FHIR R4B, Organization)) |
| 30. Task.extension:request | |
| Slice Name | request |
| Definition | DSTU2: |
| Short | DSTU2: Request reference (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Request reference (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Resource for use in FHIR R4B, Resource)) |
| 32. Task.extension:response | |
| Slice Name | response |
| Definition | DSTU2: |
| Short | DSTU2: Response reference (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Response reference (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Resource for use in FHIR R4B, Resource)) |
| 34. Task.extension:nullify | |
| Slice Name | nullify |
| Definition | DSTU2: |
| Short | DSTU2: Nullify (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Nullify (new)) (Extension Type: boolean) |
| 36. Task.extension:reference | |
| Slice Name | reference |
| Definition | DSTU2: |
| Short | DSTU2: Reference number/string (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Reference number/string (new)) (Extension Type: string) |
| 38. Task.extension:item | |
| Slice Name | item |
| Definition | DSTU2: |
| Short | DSTU2: Items to re-adjudicate (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Items to re-adjudicate (new)) (Complex Extension) |
| 40. Task.extension:include | |
| Slice Name | include |
| Definition | DSTU2: |
| Short | DSTU2: Resource type(s) to include (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Resource type(s) to include (new)) (Extension Type: string) |
| 42. Task.extension:exclude | |
| Slice Name | exclude |
| Definition | DSTU2: |
| Short | DSTU2: Resource type(s) to exclude (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Resource type(s) to exclude (new)) (Extension Type: string) |
| 44. Task.extension:period | |
| Slice Name | period |
| Definition | DSTU2: |
| Short | DSTU2: Period (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(DSTU2: Period (new)) (Extension Type: Period) |
| 46. Task.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| 48. Task.identifier.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Task.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 50. Task.identifier.extension:identifier | |
| Slice Name | identifier |
| Definition | DSTU2: |
| Short | DSTU2: Business Identifier additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(DSTU2: Business Identifier additional types) (Extension Type: Identifier) |
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..* | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())inv-1: Last modified date must be greater than or equal to authored-on date. ( lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn) | ||||
| 2. Task.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| 4. Task.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. Task.meta.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 8. Task.meta.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Task.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. Task.meta.extension:meta | |||||
| Slice Name | meta | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: meta additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(DSTU2: meta additional types) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 12. Task.meta.versionId | |||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
| Short | Version specific identifier | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 14. Task.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 16. Task.meta.source | |||||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
| Short | Identifies where the resource comes from | ||||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 18. Task.meta.profile | |||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profiles this resource claims to conform to | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 0..* | ||||
| Type | canonical(StructureDefinition) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. Task.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.3.0) | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. Task.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|4.3.0) | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. Task.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. Task.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.3.0)IETF language tag
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. Task.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 30. Task.text.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 32. Task.text.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Task.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 34. Task.text.extension:text | |||||
| Slice Name | text | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: text additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(DSTU2: text additional types) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 36. Task.text.status | |||||
| Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. | ||||
| Short | generated | extensions | additional | empty | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from NarrativeStatus (required to http://hl7.org/fhir/ValueSet/narrative-status|4.3.0) | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. Task.text.div | |||||
| Definition | The actual narrative content, a stripped down version of XHTML. | ||||
| Short | Limited xhtml content | ||||
| Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. | ||||
| Control | 1..1 | ||||
| Type | xhtml | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes ( htmlChecks())txt-2: The narrative SHALL have some non-whitespace content ( htmlChecks()) | ||||
| 40. Task.contained | |||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
| Short | Contained, inline Resources | ||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| Invariants | dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)) | ||||
| 42. Task.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 44. Task.extension:action | |||||
| Slice Name | action | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: cancel | poll | reprocess | status (new) | ||||
| Comments | Element | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: cancel | poll | reprocess | status (new)) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 46. Task.extension:ruleset | |||||
| Slice Name | ruleset | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Resource version (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Resource version (new)) (Extension Type: Coding) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 48. Task.extension:originalRuleset | |||||
| Slice Name | originalRuleset | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Original version (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Original version (new)) (Extension Type: Coding) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 50. Task.extension:created | |||||
| Slice Name | created | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Creation date (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Creation date (new)) (Extension Type: dateTime) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 52. Task.extension:target | |||||
| Slice Name | target | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Target of the request (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Target of the request (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Organization for use in FHIR R4B, Organization)) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 54. Task.extension:provider | |||||
| Slice Name | provider | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Responsible practitioner (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Responsible practitioner (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Practitioner for use in FHIR R4B, PractitionerRole)) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 56. Task.extension:organization | |||||
| Slice Name | organization | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Responsible organization (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Responsible organization (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Organization for use in FHIR R4B, Organization)) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 58. Task.extension:request | |||||
| Slice Name | request | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Request reference (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Request reference (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Resource for use in FHIR R4B, Resource)) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 60. Task.extension:response | |||||
| Slice Name | response | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Response reference (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Response reference (new)) (Extension Type: Reference(Cross-version Profile for DSTU2.Resource for use in FHIR R4B, Resource)) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 62. Task.extension:nullify | |||||
| Slice Name | nullify | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Nullify (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Nullify (new)) (Extension Type: boolean) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 64. Task.extension:reference | |||||
| Slice Name | reference | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Reference number/string (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Reference number/string (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 66. Task.extension:item | |||||
| Slice Name | item | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Items to re-adjudicate (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Items to re-adjudicate (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 68. Task.extension:include | |||||
| Slice Name | include | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Resource type(s) to include (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Resource type(s) to include (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 70. Task.extension:exclude | |||||
| Slice Name | exclude | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Resource type(s) to exclude (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Resource type(s) to exclude (new)) (Extension Type: string) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 72. Task.extension:period | |||||
| Slice Name | period | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Period (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(DSTU2: Period (new)) (Extension Type: Period) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 74. Task.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 76. 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 | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 78. Task.identifier.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 80. Task.identifier.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| Slicing | This element introduces a set of slices on Task.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 82. Task.identifier.extension:identifier | |||||
| Slice Name | identifier | ||||
| Definition | DSTU2: | ||||
| Short | DSTU2: Business Identifier additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(DSTU2: Business Identifier additional types) (Extension Type: Identifier) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 84. Task.identifier.use | |||||
| Definition | The purpose of this identifier. | ||||
| Short | usual | official | temp | secondary | old (If known) | ||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0) | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. Task.identifier.type | |||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| Short | Description of identifier | ||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.3.0) | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 88. Task.identifier.system | |||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | ||||
| Short | The namespace for the identifier value | ||||
| Comments | Identifier.system is always case sensitive. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | ||||
| Example | General: http://www.acme.com/identifiers/patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 90. Task.identifier.value | |||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | ||||
| Short | The value that is unique | ||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Example | General: 123456 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 92. Task.identifier.period | |||||
| Definition | Time period during which identifier is/was valid for use. | ||||
| Short | Time period when id is/was valid for use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 94. Task.identifier.assigner | |||||
| Definition | Organization that issued/manages the identifier. | ||||
| Short | Organization that issued id (may be just text) | ||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. Task.instantiatesCanonical | |||||
| Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. | ||||
| Short | Formal definition of task | ||||
| Control | 0..1 | ||||
| Type | canonical(ActivityDefinition) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Enables a formal definition of how he task is to be performed, enabling automation. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 98. Task.instantiatesUri | |||||
| Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task. | ||||
| Short | Formal definition of task | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 100. Task.basedOn | |||||
| Definition | BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient. | ||||
| Short | Request fulfilled by this task | ||||
| Control | 0..* | ||||
| Type | Reference(Resource) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 102. Task.groupIdentifier | |||||
| Definition | An identifier that links together multiple tasks and other requests that were created in the same context. | ||||
| Short | Requisition or grouper id | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 104. 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) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 106. 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|4.3.0)The current status of the task. | ||||
| Type | code | ||||
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 108. 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 | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 110. 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 | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 112. Task.intent | |||||
| Definition | Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc. | ||||
| Short | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option | ||||
| Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from TaskIntent (required to http://hl7.org/fhir/ValueSet/task-intent|4.3.0)Distinguishes whether the task is a proposal, plan or full order. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 114. Task.priority | |||||
| Definition | Indicates how quickly the Task should be addressed with respect to other requests. | ||||
| Short | routine | urgent | asap | stat | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority|4.3.0)The priority of a task (may affect service level applied to the task). | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Used to identify the service level expected while performing a task. | ||||
| Meaning if Missing | If missing, this task should be performed with normal priority | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 116. 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 | For example codes, see TaskCode (example to http://hl7.org/fhir/ValueSet/task-code|4.3.0)Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 118. Task.description | |||||
| Definition | A free-text description of what is to be performed. | ||||
| Short | Human-readable explanation of task | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 120. Task.focus | |||||
| Definition | The request being actioned or the resource being manipulated by this task. | ||||
| Short | What task is acting on | ||||
| Comments | If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.). | ||||
| Control | 0..1 | ||||
| Type | Reference(Resource) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Used to identify the thing to be done. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 122. 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) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control. | ||||
| Alternate Names | Patient | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 124. Task.encounter | |||||
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. | ||||
| Short | Healthcare event during which this task originated | ||||
| Control | 0..1 | ||||
| Type | Reference(Encounter) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | For some tasks it may be important to know the link between the encounter the task originated within. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 126. 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 | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 128. 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 | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. | ||||
| Alternate Names | Created Date | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 130. 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 | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. | ||||
| Alternate Names | Update Date | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 132. Task.requester | |||||
| Definition | The creator of the task. | ||||
| Short | Who is asking for task to be done | ||||
| Control | 0..1 | ||||
| Type | Reference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task). | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 134. Task.performerType | |||||
| Definition | The kind of participant that should perform the task. | ||||
| Short | Requested performer | ||||
| Control | 0..* | ||||
| Binding | The codes SHOULD be taken from ProcedurePerformerRoleCodes (preferred to http://hl7.org/fhir/ValueSet/performer-role|4.3.0)The type(s) of task performers allowed. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Use to distinguish tasks on different activity queues. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 136. 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(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Identifies who is expected to perform this task. | ||||
| Alternate Names | Performer, Executer | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 138. Task.location | |||||
| Definition | Principal physical location where the this task is performed. | ||||
| Short | Where task occurs | ||||
| Control | 0..1 | ||||
| Type | Reference(Location) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | true | ||||
| Requirements | Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 140. Task.reasonCode | |||||
| 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 | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 142. Task.reasonReference | |||||
| Definition | A resource reference indicating why this task needs to be performed. | ||||
| Short | Why task is needed | ||||
| Comments | Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in | ||||
| Control | 0..1 | ||||
| Type | Reference(Resource) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 144. Task.insurance | |||||
| Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. | ||||
| Short | Associated insurance coverage | ||||
| Control | 0..* | ||||
| Type | Reference(Coverage, ClaimResponse) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 146. Task.note | |||||
| Definition | Free-text information captured about the task as it progresses. | ||||
| Short | Comments made about the task | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 148. Task.relevantHistory | |||||
| Definition | Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task. | ||||
| Short | Key events in history of the Task | ||||
| Comments | This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. | ||||
| Control | 0..* | ||||
| Type | Reference(Provenance) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Alternate Names | Status History | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 150. 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 | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 152. 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 | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 154. Task.restriction.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 156. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 158. 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 | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | E.g. order that requests monthly lab tests, fulfillment is sought for 1. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 160. 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 | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 162. 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, PractitionerRole, RelatedPerson, Group, Organization) | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 164. Task.input | |||||
| Definition | Additional information that may be needed in the execution of the task. | ||||
| Short | Information used to perform task | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows. | ||||
| Alternate Names | Supporting Information | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 166. Task.input.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 168. Task.input.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 170. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 172. 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", "Concomitent Medications", etc. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. | ||||
| Alternate Names | Name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 174. 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, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 176. Task.output | |||||
| Definition | Outputs produced by the Task. | ||||
| Short | Information produced as part of task | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters) | ||||
| 178. Task.output.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 180. Task.output.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional content defined by implementations | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 182. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 184. 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 | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. | ||||
| Alternate Names | Name | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 186. 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, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Requirements | Task outputs can take any form. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||