Physical Activity Implementation Guide
1.0.1 - STU Release 1
Physical Activity Implementation Guide
1.0.1 - STU Release 1
Physical Activity Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/physical-activity/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-task-for-referral-management | Version: 1.0.1 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: PATaskForReferralManagement | ||
Represents a request for fulfillment of a physical activity-related referral or order and supports management of the same.
Used as part of the workflow documented here. This is distinct from the Patient Task profile which is used to make requests of patients rather than providers.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Task | C | 0..* | Task | A task to be performed pa-taskrm-1: Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. |
  implicitRules | 0..0 | |||
 modifierExtension | 0..0 | |||
| status | SC | 1..1 | code | draft | requested | received | accepted | + Binding: PA Task Fulfillment Status (required) |
 statusReason | SC | 0..1 | CodeableConcept | Reason for current status |
  text | S | 0..1 | string | Plain text representation of the concept |
| businessStatus | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" | |
| text | S | 1..1 | string | Plain text representation of the concept |
| intent | 1..1 | code | order Required Pattern: order | |
| priority | S | 0..1 | code | routine | urgent | asap | stat |
| code | 0..1 | CodeableConcept | Task Type Required Pattern: At least the following | |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
 focus | S | 1..1 | ReferenceRest(PA Service Request) | What task is acting on |
| for | S | 1..1 | ReferenceRest(US Core Patient Profile) | Beneficiary of the Task |
| authoredOn | S | 1..1 | dateTime | Task Creation Date |
| requester | S | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S) | Who is asking for task to be done |
| owner | S | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S) | Responsible individual |
| reasonCode | ||||
| text | S | 1..1 | string | Plain text representation of the concept |
| note | S | 0..* | Annotation | Comments made about the task |
| author[x] | S | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S) | Individual responsible for the annotation |
| time | S | 1..1 | dateTime | When the annotation was made |
| text | S | 1..1 | markdown | The annotation - text content (as markdown) |
 Slices for output | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type, type:value | |
 output:All Slices | Content/Rules for all slices | |||
  modifierExtension | 0..0 | |||
 output:PerformedActivityType | S | 0..* | BackboneElement | Information produced as part of task |
 type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
  value[x] | S | 1..1 | CodeableConcept S | Result of output |
| text | S | 1..1 | string | Plain text representation of the concept |
 output:PerformedActivityReference | S | 0..* | BackboneElement | Information produced as part of task |
| type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
 value[x] | S | 1..1 | ReferenceRest S(PA Intervention Report S | Resource) | Result of output |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Task.status | required | PATaskFulfillmentStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-statusfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| pa-taskrm-1 | error | Task | Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. : statusReason.exists() = (status='rejected' or status='on-hold' or status='cancelled' or status='failed') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. pa-taskrm-1: Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. |
 status | ?!SΣC | 1..1 | code | draft | requested | received | accepted | + Binding: PA Task Fulfillment Status (required) |
| statusReason | SΣC | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| businessStatus | Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| intent | Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Required Pattern: order |
| priority | S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. |
| code | Σ | 0..1 | CodeableConcept | Task Type Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
| focus | SΣ | 1..1 | ReferenceRest(PA Service Request) | What task is acting on |
| for | SΣ | 1..1 | ReferenceRest(US Core Patient Profile) | Beneficiary of the Task |
| authoredOn | SC | 1..1 | dateTime | Task Creation Date |
| requester | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who is asking for task to be done |
| owner | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Responsible individual |
| reasonCode | 0..1 | CodeableConcept | Why task is needed Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| note | S | 0..* | Annotation | Comments made about the task |
| author[x] | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile | US Core Organization Profile) | Individual responsible for the annotation |
| time | SΣ | 1..1 | dateTime | When the annotation was made |
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Slices for output | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type, type:value | |
| output:All Slices | Content/Rules for all slices | |||
 type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. | |
 value[x] | 1..1 | Result of output | ||
| valueBase64Binary | base64Binary | |||
| valueBoolean | boolean | |||
| valueCanonical | canonical(Any) | |||
| valueCode | code | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueDecimal | decimal | |||
| valueId | id | |||
| valueInstant | instant | |||
| valueInteger | integer | |||
| valueMarkdown | markdown | |||
| valueOid | oid | |||
| valuePositiveInt | positiveInt | |||
| valueString | string | |||
| valueTime | time | |||
| valueUnsignedInt | unsignedInt | |||
| valueUri | uri | |||
| valueUrl | url | |||
| valueUuid | uuid | |||
| valueAddress | Address | |||
| valueAge | Age | |||
| valueAnnotation | Annotation | |||
| valueAttachment | Attachment | |||
| valueCodeableConcept | CodeableConcept | |||
| valueCoding | Coding | |||
| valueContactPoint | ContactPoint | |||
| valueCount | Count | |||
| valueDistance | Distance | |||
| valueDuration | Duration | |||
| valueHumanName | HumanName | |||
| valueIdentifier | Identifier | |||
| valueMoney | Money | |||
| valuePeriod | Period | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueRatio | Ratio | |||
| valueReference | Reference(Any) | |||
| valueSampledData | SampledData | |||
| valueSignature | Signature | |||
| valueTiming | Timing | |||
| valueContactDetail | ContactDetail | |||
| valueContributor | Contributor | |||
| valueDataRequirement | DataRequirement | |||
| valueExpression | Expression | |||
| valueParameterDefinition | ParameterDefinition | |||
| valueRelatedArtifact | RelatedArtifact | |||
| valueTriggerDefinition | TriggerDefinition | |||
| valueUsageContext | UsageContext | |||
| valueDosage | Dosage | |||
| valueMeta | Meta | |||
| output:PerformedActivityType | S | 0..* | BackboneElement | Information produced as part of task |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| value[x] | S | 1..1 | CodeableConcept | Result of output |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| output:PerformedActivityReference | S | 0..* | BackboneElement | Information produced as part of task |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| value[x] | S | 1..1 | ReferenceRest(PA Intervention Report) | Result of output |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Task.status | required | PATaskFulfillmentStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-statusfrom this IG | |
| Task.statusReason | example | ||
| Task.businessStatus | example | ||
| Task.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | |
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-codefrom the FHIR Standard | |
| Task.reasonCode | example | ||
| Task.output.type | example | ||
| Task.output:PerformedActivityType.type | example | Pattern: resulting-activity | |
| Task.output:PerformedActivityReference.type | example | Pattern: resulting-activity |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn | |
| pa-taskrm-1 | error | Task | Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. : statusReason.exists() = (status='rejected' or status='on-hold' or status='cancelled' or status='failed') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. pa-taskrm-1: Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| identifier | 0..* | Identifier | Task Instance Identifier | |||||
| instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
| instantiatesUri | Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier | Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| partOf | Σ | 0..* | Reference(Task) | Composite task | ||||
| status | ?!SΣC | 1..1 | code | draft | requested | received | accepted | + Binding: PA Task Fulfillment Status (required) | ||||
| statusReason | SΣC | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| businessStatus | Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
| intent | Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Required Pattern: order | ||||
| priority | S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | ||||
| code | Σ | 0..1 | CodeableConcept | Task Type Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| description | Σ | 0..1 | string | Human-readable explanation of task | ||||
| focus | SΣ | 1..1 | ReferenceRest(PA Service Request) | What task is acting on | ||||
| for | SΣ | 1..1 | ReferenceRest(US Core Patient Profile) | Beneficiary of the Task | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
| executionPeriod | Σ | 0..1 | Period | Start and end time of execution | ||||
| authoredOn | SC | 1..1 | dateTime | Task Creation Date | ||||
| lastModified | ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
| requester | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S) | Who is asking for task to be done | ||||
| performerType | 0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
| owner | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S) | Responsible individual | ||||
| location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
| reasonCode | 0..1 | CodeableConcept | Why task is needed Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
| reasonReference | 0..1 | Reference(Resource) | Why task is needed | |||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note | S | 0..* | Annotation | Comments made about the task | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S) | Individual responsible for the annotation | ||||
| time | SΣ | 1..1 | dateTime | When the annotation was made | ||||
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
| restriction | 0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| repetitions | 0..1 | positiveInt | How many times to repeat | |||||
| period | 0..1 | Period | When fulfillment sought | |||||
| recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
| input | 0..* | BackboneElement | Information used to perform task | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | CodeableConcept | Label for the input Binding: (unbound) (example): 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. | |||||
| value[x] | 1..1 | Content to use in performing the task | ||||||
| valueBase64Binary | base64Binary | |||||||
| valueBoolean | boolean | |||||||
| valueCanonical | canonical(Any) | |||||||
| valueCode | code | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueDecimal | decimal | |||||||
| valueId | id | |||||||
| valueInstant | instant | |||||||
| valueInteger | integer | |||||||
| valueMarkdown | markdown | |||||||
| valueOid | oid | |||||||
| valuePositiveInt | positiveInt | |||||||
| valueString | string | |||||||
| valueTime | time | |||||||
| valueUnsignedInt | unsignedInt | |||||||
| valueUri | uri | |||||||
| valueUrl | url | |||||||
| valueUuid | uuid | |||||||
| valueAddress | Address | |||||||
| valueAge | Age | |||||||
| valueAnnotation | Annotation | |||||||
| valueAttachment | Attachment | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueCoding | Coding | |||||||
| valueContactPoint | ContactPoint | |||||||
| valueCount | Count | |||||||
| valueDistance | Distance | |||||||
| valueDuration | Duration | |||||||
| valueHumanName | HumanName | |||||||
| valueIdentifier | Identifier | |||||||
| valueMoney | Money | |||||||
| valuePeriod | Period | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueReference | Reference(Any) | |||||||
| valueSampledData | SampledData | |||||||
| valueSignature | Signature | |||||||
| valueTiming | Timing | |||||||
| valueContactDetail | ContactDetail | |||||||
| valueContributor | Contributor | |||||||
| valueDataRequirement | DataRequirement | |||||||
| valueExpression | Expression | |||||||
| valueParameterDefinition | ParameterDefinition | |||||||
| valueRelatedArtifact | RelatedArtifact | |||||||
| valueTriggerDefinition | TriggerDefinition | |||||||
| valueUsageContext | UsageContext | |||||||
| valueDosage | Dosage | |||||||
| valueMeta | Meta | |||||||
| Slices for output | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type, type:value | |||||
| output:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. | |||||
| value[x] | 1..1 | Result of output | ||||||
| valueBase64Binary | base64Binary | |||||||
| valueBoolean | boolean | |||||||
| valueCanonical | canonical(Any) | |||||||
| valueCode | code | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueDecimal | decimal | |||||||
| valueId | id | |||||||
| valueInstant | instant | |||||||
| valueInteger | integer | |||||||
| valueMarkdown | markdown | |||||||
| valueOid | oid | |||||||
| valuePositiveInt | positiveInt | |||||||
| valueString | string | |||||||
| valueTime | time | |||||||
| valueUnsignedInt | unsignedInt | |||||||
| valueUri | uri | |||||||
| valueUrl | url | |||||||
| valueUuid | uuid | |||||||
| valueAddress | Address | |||||||
| valueAge | Age | |||||||
| valueAnnotation | Annotation | |||||||
| valueAttachment | Attachment | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueCoding | Coding | |||||||
| valueContactPoint | ContactPoint | |||||||
| valueCount | Count | |||||||
| valueDistance | Distance | |||||||
| valueDuration | Duration | |||||||
| valueHumanName | HumanName | |||||||
| valueIdentifier | Identifier | |||||||
| valueMoney | Money | |||||||
| valuePeriod | Period | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueReference | Reference(Any) | |||||||
| valueSampledData | SampledData | |||||||
| valueSignature | Signature | |||||||
| valueTiming | Timing | |||||||
| valueContactDetail | ContactDetail | |||||||
| valueContributor | Contributor | |||||||
| valueDataRequirement | DataRequirement | |||||||
| valueExpression | Expression | |||||||
| valueParameterDefinition | ParameterDefinition | |||||||
| valueRelatedArtifact | RelatedArtifact | |||||||
| valueTriggerDefinition | TriggerDefinition | |||||||
| valueUsageContext | UsageContext | |||||||
| valueDosage | Dosage | |||||||
| valueMeta | Meta | |||||||
| output:PerformedActivityType | S | 0..* | BackboneElement | Information produced as part of task | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | S | 1..1 | CodeableConcept S | Result of output | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
| output:PerformedActivityReference | S | 0..* | BackboneElement | Information produced as part of task | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | S | 1..1 | ReferenceRest S(PA Intervention Report S | Resource) | Result of output | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Task.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Task.status | required | PATaskFulfillmentStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-statusfrom this IG | ||||
| Task.statusReason | example | |||||
| Task.businessStatus | example | |||||
| Task.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | ||||
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-codefrom the FHIR Standard | ||||
| Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| Task.reasonCode | example | |||||
| Task.input.type | example | |||||
| Task.output.type | example | |||||
| Task.output:PerformedActivityType.type | example | Pattern: resulting-activity | ||||
| Task.output:PerformedActivityReference.type | example | Pattern: resulting-activity |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn | |
| pa-taskrm-1 | error | Task | Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. : statusReason.exists() = (status='rejected' or status='on-hold' or status='cancelled' or status='failed') |
This structure is derived from Task
Summary
Mandatory: 5 elements (5 nested mandatory elements)
Must-Support: 20 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Differential View
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | C | 0..* | Task | A task to be performed pa-taskrm-1: Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. |
| implicitRules | 0..0 | |||
| modifierExtension | 0..0 | |||
| status | SC | 1..1 | code | draft | requested | received | accepted | + Binding: PA Task Fulfillment Status (required) |
| statusReason | SC | 0..1 | CodeableConcept | Reason for current status |
| text | S | 0..1 | string | Plain text representation of the concept |
| businessStatus | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" | |
| text | S | 1..1 | string | Plain text representation of the concept |
| intent | 1..1 | code | order Required Pattern: order | |
| priority | S | 0..1 | code | routine | urgent | asap | stat |
| code | 0..1 | CodeableConcept | Task Type Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
| focus | S | 1..1 | ReferenceRest(PA Service Request) | What task is acting on |
| for | S | 1..1 | ReferenceRest(US Core Patient Profile) | Beneficiary of the Task |
| authoredOn | S | 1..1 | dateTime | Task Creation Date |
| requester | S | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S) | Who is asking for task to be done |
| owner | S | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S) | Responsible individual |
| reasonCode | ||||
| text | S | 1..1 | string | Plain text representation of the concept |
| note | S | 0..* | Annotation | Comments made about the task |
| author[x] | S | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S) | Individual responsible for the annotation |
| time | S | 1..1 | dateTime | When the annotation was made |
| text | S | 1..1 | markdown | The annotation - text content (as markdown) |
| Slices for output | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type, type:value | |
| output:All Slices | Content/Rules for all slices | |||
| modifierExtension | 0..0 | |||
| output:PerformedActivityType | S | 0..* | BackboneElement | Information produced as part of task |
| type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| value[x] | S | 1..1 | CodeableConcept S | Result of output |
| text | S | 1..1 | string | Plain text representation of the concept |
| output:PerformedActivityReference | S | 0..* | BackboneElement | Information produced as part of task |
| type | 1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| value[x] | S | 1..1 | ReferenceRest S(PA Intervention Report S | Resource) | Result of output |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Task.status | required | PATaskFulfillmentStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-statusfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| pa-taskrm-1 | error | Task | Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. : statusReason.exists() = (status='rejected' or status='on-hold' or status='cancelled' or status='failed') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. pa-taskrm-1: Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. |
| status | ?!SΣC | 1..1 | code | draft | requested | received | accepted | + Binding: PA Task Fulfillment Status (required) |
| statusReason | SΣC | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| businessStatus | Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| intent | Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Required Pattern: order |
| priority | S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. |
| code | Σ | 0..1 | CodeableConcept | Task Type Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
| focus | SΣ | 1..1 | ReferenceRest(PA Service Request) | What task is acting on |
| for | SΣ | 1..1 | ReferenceRest(US Core Patient Profile) | Beneficiary of the Task |
| authoredOn | SC | 1..1 | dateTime | Task Creation Date |
| requester | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who is asking for task to be done |
| owner | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Responsible individual |
| reasonCode | 0..1 | CodeableConcept | Why task is needed Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| note | S | 0..* | Annotation | Comments made about the task |
| author[x] | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile | US Core Organization Profile) | Individual responsible for the annotation |
| time | SΣ | 1..1 | dateTime | When the annotation was made |
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Slices for output | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type, type:value | |
| output:All Slices | Content/Rules for all slices | |||
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. | |
| value[x] | 1..1 | Result of output | ||
| valueBase64Binary | base64Binary | |||
| valueBoolean | boolean | |||
| valueCanonical | canonical(Any) | |||
| valueCode | code | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueDecimal | decimal | |||
| valueId | id | |||
| valueInstant | instant | |||
| valueInteger | integer | |||
| valueMarkdown | markdown | |||
| valueOid | oid | |||
| valuePositiveInt | positiveInt | |||
| valueString | string | |||
| valueTime | time | |||
| valueUnsignedInt | unsignedInt | |||
| valueUri | uri | |||
| valueUrl | url | |||
| valueUuid | uuid | |||
| valueAddress | Address | |||
| valueAge | Age | |||
| valueAnnotation | Annotation | |||
| valueAttachment | Attachment | |||
| valueCodeableConcept | CodeableConcept | |||
| valueCoding | Coding | |||
| valueContactPoint | ContactPoint | |||
| valueCount | Count | |||
| valueDistance | Distance | |||
| valueDuration | Duration | |||
| valueHumanName | HumanName | |||
| valueIdentifier | Identifier | |||
| valueMoney | Money | |||
| valuePeriod | Period | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueRatio | Ratio | |||
| valueReference | Reference(Any) | |||
| valueSampledData | SampledData | |||
| valueSignature | Signature | |||
| valueTiming | Timing | |||
| valueContactDetail | ContactDetail | |||
| valueContributor | Contributor | |||
| valueDataRequirement | DataRequirement | |||
| valueExpression | Expression | |||
| valueParameterDefinition | ParameterDefinition | |||
| valueRelatedArtifact | RelatedArtifact | |||
| valueTriggerDefinition | TriggerDefinition | |||
| valueUsageContext | UsageContext | |||
| valueDosage | Dosage | |||
| valueMeta | Meta | |||
| output:PerformedActivityType | S | 0..* | BackboneElement | Information produced as part of task |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| value[x] | S | 1..1 | CodeableConcept | Result of output |
| text | SΣ | 1..1 | string | Plain text representation of the concept |
| output:PerformedActivityReference | S | 0..* | BackboneElement | Information produced as part of task |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| value[x] | S | 1..1 | ReferenceRest(PA Intervention Report) | Result of output |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Task.status | required | PATaskFulfillmentStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-statusfrom this IG | |
| Task.statusReason | example | ||
| Task.businessStatus | example | ||
| Task.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | |
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-codefrom the FHIR Standard | |
| Task.reasonCode | example | ||
| Task.output.type | example | ||
| Task.output:PerformedActivityType.type | example | Pattern: resulting-activity | |
| Task.output:PerformedActivityReference.type | example | Pattern: resulting-activity |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn | |
| pa-taskrm-1 | error | Task | Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. : statusReason.exists() = (status='rejected' or status='on-hold' or status='cancelled' or status='failed') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. pa-taskrm-1: Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| identifier | 0..* | Identifier | Task Instance Identifier | |||||
| instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
| instantiatesUri | Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier | Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| partOf | Σ | 0..* | Reference(Task) | Composite task | ||||
| status | ?!SΣC | 1..1 | code | draft | requested | received | accepted | + Binding: PA Task Fulfillment Status (required) | ||||
| statusReason | SΣC | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| businessStatus | Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
| intent | Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Required Pattern: order | ||||
| priority | S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | ||||
| code | Σ | 0..1 | CodeableConcept | Task Type Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| description | Σ | 0..1 | string | Human-readable explanation of task | ||||
| focus | SΣ | 1..1 | ReferenceRest(PA Service Request) | What task is acting on | ||||
| for | SΣ | 1..1 | ReferenceRest(US Core Patient Profile) | Beneficiary of the Task | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
| executionPeriod | Σ | 0..1 | Period | Start and end time of execution | ||||
| authoredOn | SC | 1..1 | dateTime | Task Creation Date | ||||
| lastModified | ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
| requester | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S) | Who is asking for task to be done | ||||
| performerType | 0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
| owner | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S) | Responsible individual | ||||
| location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
| reasonCode | 0..1 | CodeableConcept | Why task is needed Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
| reasonReference | 0..1 | Reference(Resource) | Why task is needed | |||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note | S | 0..* | Annotation | Comments made about the task | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] | SΣ | 1..1 | ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S) | Individual responsible for the annotation | ||||
| time | SΣ | 1..1 | dateTime | When the annotation was made | ||||
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
| restriction | 0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| repetitions | 0..1 | positiveInt | How many times to repeat | |||||
| period | 0..1 | Period | When fulfillment sought | |||||
| recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
| input | 0..* | BackboneElement | Information used to perform task | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | CodeableConcept | Label for the input Binding: (unbound) (example): 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. | |||||
| value[x] | 1..1 | Content to use in performing the task | ||||||
| valueBase64Binary | base64Binary | |||||||
| valueBoolean | boolean | |||||||
| valueCanonical | canonical(Any) | |||||||
| valueCode | code | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueDecimal | decimal | |||||||
| valueId | id | |||||||
| valueInstant | instant | |||||||
| valueInteger | integer | |||||||
| valueMarkdown | markdown | |||||||
| valueOid | oid | |||||||
| valuePositiveInt | positiveInt | |||||||
| valueString | string | |||||||
| valueTime | time | |||||||
| valueUnsignedInt | unsignedInt | |||||||
| valueUri | uri | |||||||
| valueUrl | url | |||||||
| valueUuid | uuid | |||||||
| valueAddress | Address | |||||||
| valueAge | Age | |||||||
| valueAnnotation | Annotation | |||||||
| valueAttachment | Attachment | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueCoding | Coding | |||||||
| valueContactPoint | ContactPoint | |||||||
| valueCount | Count | |||||||
| valueDistance | Distance | |||||||
| valueDuration | Duration | |||||||
| valueHumanName | HumanName | |||||||
| valueIdentifier | Identifier | |||||||
| valueMoney | Money | |||||||
| valuePeriod | Period | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueReference | Reference(Any) | |||||||
| valueSampledData | SampledData | |||||||
| valueSignature | Signature | |||||||
| valueTiming | Timing | |||||||
| valueContactDetail | ContactDetail | |||||||
| valueContributor | Contributor | |||||||
| valueDataRequirement | DataRequirement | |||||||
| valueExpression | Expression | |||||||
| valueParameterDefinition | ParameterDefinition | |||||||
| valueRelatedArtifact | RelatedArtifact | |||||||
| valueTriggerDefinition | TriggerDefinition | |||||||
| valueUsageContext | UsageContext | |||||||
| valueDosage | Dosage | |||||||
| valueMeta | Meta | |||||||
| Slices for output | 0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by pattern:type, type:value | |||||
| output:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. | |||||
| value[x] | 1..1 | Result of output | ||||||
| valueBase64Binary | base64Binary | |||||||
| valueBoolean | boolean | |||||||
| valueCanonical | canonical(Any) | |||||||
| valueCode | code | |||||||
| valueDate | date | |||||||
| valueDateTime | dateTime | |||||||
| valueDecimal | decimal | |||||||
| valueId | id | |||||||
| valueInstant | instant | |||||||
| valueInteger | integer | |||||||
| valueMarkdown | markdown | |||||||
| valueOid | oid | |||||||
| valuePositiveInt | positiveInt | |||||||
| valueString | string | |||||||
| valueTime | time | |||||||
| valueUnsignedInt | unsignedInt | |||||||
| valueUri | uri | |||||||
| valueUrl | url | |||||||
| valueUuid | uuid | |||||||
| valueAddress | Address | |||||||
| valueAge | Age | |||||||
| valueAnnotation | Annotation | |||||||
| valueAttachment | Attachment | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueCoding | Coding | |||||||
| valueContactPoint | ContactPoint | |||||||
| valueCount | Count | |||||||
| valueDistance | Distance | |||||||
| valueDuration | Duration | |||||||
| valueHumanName | HumanName | |||||||
| valueIdentifier | Identifier | |||||||
| valueMoney | Money | |||||||
| valuePeriod | Period | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueReference | Reference(Any) | |||||||
| valueSampledData | SampledData | |||||||
| valueSignature | Signature | |||||||
| valueTiming | Timing | |||||||
| valueContactDetail | ContactDetail | |||||||
| valueContributor | Contributor | |||||||
| valueDataRequirement | DataRequirement | |||||||
| valueExpression | Expression | |||||||
| valueParameterDefinition | ParameterDefinition | |||||||
| valueRelatedArtifact | RelatedArtifact | |||||||
| valueTriggerDefinition | TriggerDefinition | |||||||
| valueUsageContext | UsageContext | |||||||
| valueDosage | Dosage | |||||||
| valueMeta | Meta | |||||||
| output:PerformedActivityType | S | 0..* | BackboneElement | Information produced as part of task | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | S | 1..1 | CodeableConcept S | Result of output | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
| output:PerformedActivityReference | S | 0..* | BackboneElement | Information produced as part of task | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | CodeableConcept | Label for output Binding: (unbound) (example): 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. Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| value[x] | S | 1..1 | ReferenceRest S(PA Intervention Report S | Resource) | Result of output | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Task.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Task.status | required | PATaskFulfillmentStatushttp://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-statusfrom this IG | ||||
| Task.statusReason | example | |||||
| Task.businessStatus | example | |||||
| Task.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | ||||
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-codefrom the FHIR Standard | ||||
| Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| Task.reasonCode | example | |||||
| Task.input.type | example | |||||
| Task.output.type | example | |||||
| Task.output:PerformedActivityType.type | example | Pattern: resulting-activity | ||||
| Task.output:PerformedActivityReference.type | example | Pattern: resulting-activity |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Task | 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 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn | |
| pa-taskrm-1 | error | Task | Task.statusReason is required if Task.status is 'rejected', 'on-hold', 'cancelled', or 'failed' and is not permitted otherwise. : statusReason.exists() = (status='rejected' or status='on-hold' or status='cancelled' or status='failed') |
This structure is derived from Task
Summary
Mandatory: 5 elements (5 nested mandatory elements)
Must-Support: 20 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
This profile supports a number of Task.status codes. The referral fufillment task
status diagram on the Workflow page describes the relationships between the states. The table below provides additional
detail on each state, as well as rules around its use.
| Status | Initiator | Task Reason? | Meaning | Rules |
|---|---|---|---|---|
| draft | Care Manager | No | This will rarely, if ever, appear. It would be relevant if a provider system has begun the work of deciding who to route a referral to, but has not yet actually clicked 'send' to make the request. | Service Providers SHALL either filter out or ignore Tasks in this state. |
| requested | Care Manager | No | Indicates that fulfillment is being requested and no response has yet been provided. | This SHALL be the initial status of the Task when it is first released for consideration. Once the Task has left this status, it SHOULD NOT return to this status, though in cases of an erroneous transition, a quick return to this status might be appropriate. |
| accepted | Service Provider | No | Indicates that the Service Provider has agreed to perform the actions described in the referral ServiceRequest. | |
| rejected | Service Provider | Yes | Indicates that the Service Provider does NOT agree to perform the actions described in the referral ServiceRequest. It is possible that, based on the reason for the refusal, the underlying ServiceRequest might be revised (or a new one created) and a new Task seeking fulfillment could be created for the same target Service Provider. | This is a final state. When in this state, a Task.statusReason SHALL be provided explaining the refusal. |
| cancelled | Care Manager | Yes | Indicates the request for fulfillment has been terminated. This occurs when the authorization for the action has been revoked. This should happen only in exceptional circumstances, for example if the patient's clinical status changes in a way that would make the ordered therapy inappropriate. A cancelled Task means the Service Provider should cease their interventions as soon as possible, though this may not be instantaneous. A Care Manager should always make sure the patient is aware when an existing referral is being cancelled. | Cancelled is a terminal state. If there is subsequently a decision to seek continuation of an existing ServiceRequest after the Task has been cancelled, a new Task will be needed - which would then be accepted or rejected as usual. |
| in-progress | Service Provider | No | Used to distinguish that the requested work has actually begun. E.g. The patient has started attending classes, the patient has come to their first consultation, etc. Not all systems will track this information. | |
| on-hold | Service Provider | Yes | Indicates that work on the service(s) requested by the referral has been temporarily paused. For example, the patient has gone on vacation, the patient has suffered an injury that requires a break from activity, etc. Communicating this is generally only relevant when the pause will significantly impact when the service might have been expected to complete and/or will result in a noticable change to the ongoing observations being communicated to the Care Manager to allow them to monitor progress. | 'on-hold' is a temporary state. If the Service Provider determines after putting the Task on-hold that it will not resume, then the Task SHALL be transitioned to 'failed'. |
| failed | Service Provider | Yes | Indicates that the action(s) requested by the referral were attempted but could not be successfully completed. For example, the patient stopped attending a program, the exercise professional determined their services were not a good match for the patient's needs, etc. | Failed is a terminal state. In order to solicit further action (from the same Service Provider or someone else, a new Task is needed, which will go through the Accept/Reject proecess the same as any other. |
| completed | Service Provider | No | Indicates that the Service Provider believes they have completed all of the requested actions asked for as part of the ServiceRequest. No further action is expected to be taken as part of the referral, though the Service Provider and the patient might still have further interaction through their own volition. | It is up to the Care Manager to decide whether to update the ServiceRequest to 'completed'. However, if further action is desired, a new Task will need to be initiated. |
| entered-in-error | Care Manager | No | Indicates that the Task record should never have existed. E.g. A record was accidentally created against the wrong patient, against an unapproved order, against a completed order, etc. | Service Providers SHALL NOT filter out 'entered-in-error' Tasks so that they can see if a Task they've previously received gets marked as 'entered-in-error'. If this occurs, then they SHOULD cease service as soon as possible and, if they opt to continue service, understand that it is not considered to be 'authorized' and may therefore have limitations with respect to insurance coverage. In all other circumstances, Service Providers SHALL otherwise ignore 'entered-in-error' Tasks. |
General Notes:
IG © 2022+ HL7 International / Patient Care. Package hl7.fhir.us.physical-activity#1.0.1 based on FHIR 4.0.1. Generated 2024-03-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change