Physical Activity Implementation Guide
1.0.1 - STU Release 1 United States of America flag

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

Resource Profile: PA Task for Referral Management

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:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA 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 SC1..1codedraft | requested | received | accepted | +
Binding: PA Task Fulfillment Status (required)
.... text S0..1stringPlain text representation of the concept
... businessStatus 0..1CodeableConceptE.g. "Specimen collected", "IV prepped"
.... text S1..1stringPlain text representation of the concept
... intent 1..1codeorder
Required Pattern: order
... priority S0..1coderoutine | urgent | asap | stat
... code 0..1CodeableConceptTask Type
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
... focus S1..1ReferenceRest(PA Service Request)What task is acting on
... for S1..1ReferenceRest(US Core Patient Profile)Beneficiary of the Task
... authoredOn S1..1dateTimeTask Creation Date
... requester S1..1ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S)Who is asking for task to be done
... owner S1..1ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S)Responsible individual
... reasonCode
.... text S1..1stringPlain text representation of the concept
... note S0..*AnnotationComments made about the task
.... author[x] S1..1ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S)Individual responsible for the annotation
.... time S1..1dateTimeWhen the annotation was made
.... text S1..1markdownThe annotation - text content (as markdown)
... Slices for output 0..*BackboneElementInformation 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 S0..*BackboneElementInformation produced as part of task
..... type 1..1CodeableConceptLabel for output
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
..... value[x] S1..1CodeableConcept SResult of output
...... text S1..1stringPlain text representation of the concept
.... output:PerformedActivityReference S0..*BackboneElementInformation produced as part of task
..... type 1..1CodeableConceptLabel for output
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
..... value[x] S1..1ReferenceRest S(PA Intervention Report S | Resource)Result of output

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Task.statusrequiredPATaskFulfillmentStatus
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-status
from this IG

Constraints

IdGradePath(s)DetailsRequirements
pa-taskrm-1errorTaskTask.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')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA 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ΣC1..1codedraft | requested | received | accepted | +
Binding: PA Task Fulfillment Status (required)
... statusReason SΣC0..1CodeableConceptReason 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..1stringPlain text representation of the concept
... businessStatus Σ0..1CodeableConceptE.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..1stringPlain text representation of the concept
... priority S0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): The task's priority.

... code Σ0..1CodeableConceptTask 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
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
... focus SΣ1..1ReferenceRest(PA Service Request)What task is acting on
... for SΣ1..1ReferenceRest(US Core Patient Profile)Beneficiary of the Task
... authoredOn SC1..1dateTimeTask Creation Date
... requester SΣ1..1ReferenceRest(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner SΣ1..1ReferenceRest(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Responsible individual
... reasonCode 0..1CodeableConceptWhy task is needed
Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

.... text SΣ1..1stringPlain text representation of the concept
... note S0..*AnnotationComments made about the task
.... author[x] SΣ1..1ReferenceRest(US Core Practitioner Profile | US Core Organization Profile)Individual responsible for the annotation
.... time SΣ1..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
... Slices for output 0..*BackboneElementInformation produced as part of task
Slice: Unordered, Open by pattern:type, type:value
.... output:All Slices Content/Rules for all slices
..... type 1..1CodeableConceptLabel 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..1Result of output
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... output:PerformedActivityType S0..*BackboneElementInformation produced as part of task
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
..... value[x] S1..1CodeableConceptResult of output
...... text SΣ1..1stringPlain text representation of the concept
.... output:PerformedActivityReference S0..*BackboneElementInformation produced as part of task
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
..... value[x] S1..1ReferenceRest(PA Intervention Report)Result of output

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.statusrequiredPATaskFulfillmentStatus
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-status
from this IG
Task.statusReasonexample
Task.businessStatusexample
Task.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/task-intent|4.0.1
from the FHIR Standard
Task.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
Task.codeexamplePattern: fulfill
http://hl7.org/fhir/ValueSet/task-code
from the FHIR Standard
Task.reasonCodeexample
Task.output.typeexample
Task.output:PerformedActivityType.typeexamplePattern: resulting-activity
Task.output:PerformedActivityReference.typeexamplePattern: resulting-activity

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTaskIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTaskIf 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-4errorTaskIf 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-5errorTaskIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTaskA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorTaskLast modified date must be greater than or equal to authored-on date.
: lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
pa-taskrm-1errorTaskTask.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')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA 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..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... identifier 0..*IdentifierTask Instance Identifier
... instantiatesCanonical Σ0..1canonical(ActivityDefinition)Formal definition of task
... instantiatesUri Σ0..1uriFormal definition of task
... basedOn Σ0..*Reference(Resource)Request fulfilled by this task
... groupIdentifier Σ0..1IdentifierRequisition or grouper id
... partOf Σ0..*Reference(Task)Composite task
... status ?!SΣC1..1codedraft | requested | received | accepted | +
Binding: PA Task Fulfillment Status (required)
... statusReason SΣC0..1CodeableConceptReason 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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ0..1stringPlain text representation of the concept
... businessStatus Σ0..1CodeableConceptE.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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ1..1stringPlain text representation of the concept
... intent Σ1..1codeorder
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


Required Pattern: order
... priority S0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): The task's priority.

... code Σ0..1CodeableConceptTask 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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... description Σ0..1stringHuman-readable explanation of task
... focus SΣ1..1ReferenceRest(PA Service Request)What task is acting on
... for SΣ1..1ReferenceRest(US Core Patient Profile)Beneficiary of the Task
... encounter Σ0..1Reference(Encounter)Healthcare event during which this task originated
... executionPeriod Σ0..1PeriodStart and end time of execution
... authoredOn SC1..1dateTimeTask Creation Date
... lastModified ΣC0..1dateTimeTask Last Modified Date
... requester SΣ1..1ReferenceRest(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..*CodeableConceptRequested performer
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.


... owner SΣ1..1ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S)Responsible individual
... location Σ0..1Reference(Location)Where task occurs
... reasonCode 0..1CodeableConceptWhy task is needed
Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text SΣ1..1stringPlain text representation of the concept
... reasonReference 0..1Reference(Resource)Why task is needed
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note S0..*AnnotationComments made about the task
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] SΣ1..1ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S)Individual responsible for the annotation
.... time SΣ1..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
... relevantHistory 0..*Reference(Provenance)Key events in history of the Task
... restriction 0..1BackboneElementConstraints on fulfillment tasks
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... repetitions 0..1positiveIntHow many times to repeat
.... period 0..1PeriodWhen fulfillment sought
.... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization)For whom is fulfillment sought?
... input 0..*BackboneElementInformation used to perform task
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptLabel 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..1Content to use in performing the task
..... valueBase64Binarybase64Binary
..... valueBooleanboolean
..... valueCanonicalcanonical(Any)
..... valueCodecode
..... valueDatedate
..... valueDateTimedateTime
..... valueDecimaldecimal
..... valueIdid
..... valueInstantinstant
..... valueIntegerinteger
..... valueMarkdownmarkdown
..... valueOidoid
..... valuePositiveIntpositiveInt
..... valueStringstring
..... valueTimetime
..... valueUnsignedIntunsignedInt
..... valueUriuri
..... valueUrlurl
..... valueUuiduuid
..... valueAddressAddress
..... valueAgeAge
..... valueAnnotationAnnotation
..... valueAttachmentAttachment
..... valueCodeableConceptCodeableConcept
..... valueCodingCoding
..... valueContactPointContactPoint
..... valueCountCount
..... valueDistanceDistance
..... valueDurationDuration
..... valueHumanNameHumanName
..... valueIdentifierIdentifier
..... valueMoneyMoney
..... valuePeriodPeriod
..... valueQuantityQuantity
..... valueRangeRange
..... valueRatioRatio
..... valueReferenceReference(Any)
..... valueSampledDataSampledData
..... valueSignatureSignature
..... valueTimingTiming
..... valueContactDetailContactDetail
..... valueContributorContributor
..... valueDataRequirementDataRequirement
..... valueExpressionExpression
..... valueParameterDefinitionParameterDefinition
..... valueRelatedArtifactRelatedArtifact
..... valueTriggerDefinitionTriggerDefinition
..... valueUsageContextUsageContext
..... valueDosageDosage
..... valueMetaMeta
... Slices for output 0..*BackboneElementInformation produced as part of task
Slice: Unordered, Open by pattern:type, type:value
.... output:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... type 1..1CodeableConceptLabel 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..1Result of output
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... output:PerformedActivityType S0..*BackboneElementInformation produced as part of task
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] S1..1CodeableConcept SResult of output
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text SΣ1..1stringPlain text representation of the concept
.... output:PerformedActivityReference S0..*BackboneElementInformation produced as part of task
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel 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
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value[x] S1..1ReferenceRest S(PA Intervention Report S | Resource)Result of output

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Task.statusrequiredPATaskFulfillmentStatus
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-status
from this IG
Task.statusReasonexample
Task.businessStatusexample
Task.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/task-intent|4.0.1
from the FHIR Standard
Task.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
Task.codeexamplePattern: fulfill
http://hl7.org/fhir/ValueSet/task-code
from the FHIR Standard
Task.performerTypepreferredProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
Task.reasonCodeexample
Task.input.typeexample
Task.output.typeexample
Task.output:PerformedActivityType.typeexamplePattern: resulting-activity
Task.output:PerformedActivityReference.typeexamplePattern: resulting-activity

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTaskIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTaskIf 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-4errorTaskIf 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-5errorTaskIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTaskA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorTaskLast modified date must be greater than or equal to authored-on date.
: lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
pa-taskrm-1errorTaskTask.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')

Differential View

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA 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 SC1..1codedraft | requested | received | accepted | +
Binding: PA Task Fulfillment Status (required)
.... text S0..1stringPlain text representation of the concept
... businessStatus 0..1CodeableConceptE.g. "Specimen collected", "IV prepped"
.... text S1..1stringPlain text representation of the concept
... intent 1..1codeorder
Required Pattern: order
... priority S0..1coderoutine | urgent | asap | stat
... code 0..1CodeableConceptTask Type
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
... focus S1..1ReferenceRest(PA Service Request)What task is acting on
... for S1..1ReferenceRest(US Core Patient Profile)Beneficiary of the Task
... authoredOn S1..1dateTimeTask Creation Date
... requester S1..1ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S)Who is asking for task to be done
... owner S1..1ReferenceRest(US Core Practitioner Profile S | US Core PractitionerRole Profile S | US Core Organization Profile S)Responsible individual
... reasonCode
.... text S1..1stringPlain text representation of the concept
... note S0..*AnnotationComments made about the task
.... author[x] S1..1ReferenceRest(US Core Practitioner Profile S | US Core Organization Profile S)Individual responsible for the annotation
.... time S1..1dateTimeWhen the annotation was made
.... text S1..1markdownThe annotation - text content (as markdown)
... Slices for output 0..*BackboneElementInformation 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 S0..*BackboneElementInformation produced as part of task
..... type 1..1CodeableConceptLabel for output
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
..... value[x] S1..1CodeableConcept SResult of output
...... text S1..1stringPlain text representation of the concept
.... output:PerformedActivityReference S0..*BackboneElementInformation produced as part of task
..... type 1..1CodeableConceptLabel for output
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
..... value[x] S1..1ReferenceRest S(PA Intervention Report S | Resource)Result of output

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Task.statusrequiredPATaskFulfillmentStatus
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-status
from this IG

Constraints

IdGradePath(s)DetailsRequirements
pa-taskrm-1errorTaskTask.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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA 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ΣC1..1codedraft | requested | received | accepted | +
Binding: PA Task Fulfillment Status (required)
... statusReason SΣC0..1CodeableConceptReason 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..1stringPlain text representation of the concept
... businessStatus Σ0..1CodeableConceptE.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..1stringPlain text representation of the concept
... priority S0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): The task's priority.

... code Σ0..1CodeableConceptTask 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
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
... focus SΣ1..1ReferenceRest(PA Service Request)What task is acting on
... for SΣ1..1ReferenceRest(US Core Patient Profile)Beneficiary of the Task
... authoredOn SC1..1dateTimeTask Creation Date
... requester SΣ1..1ReferenceRest(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner SΣ1..1ReferenceRest(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Responsible individual
... reasonCode 0..1CodeableConceptWhy task is needed
Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

.... text SΣ1..1stringPlain text representation of the concept
... note S0..*AnnotationComments made about the task
.... author[x] SΣ1..1ReferenceRest(US Core Practitioner Profile | US Core Organization Profile)Individual responsible for the annotation
.... time SΣ1..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)
... Slices for output 0..*BackboneElementInformation produced as part of task
Slice: Unordered, Open by pattern:type, type:value
.... output:All Slices Content/Rules for all slices
..... type 1..1CodeableConceptLabel 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..1Result of output
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
.... output:PerformedActivityType S0..*BackboneElementInformation produced as part of task
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
..... value[x] S1..1CodeableConceptResult of output
...... text SΣ1..1stringPlain text representation of the concept
.... output:PerformedActivityReference S0..*BackboneElementInformation produced as part of task
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptLabel 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
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: resulting-activity
..... value[x] S1..1ReferenceRest(PA Intervention Report)Result of output

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.statusrequiredPATaskFulfillmentStatus
http://hl7.org/fhir/us/physical-activity/ValueSet/pa-task-status
from this IG
Task.statusReasonexample
Task.businessStatusexample
Task.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/task-intent|4.0.1
from the FHIR Standard
Task.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
Task.codeexamplePattern: fulfill
http://hl7.org/fhir/ValueSet/task-code
from the FHIR Standard
Task.reasonCodeexample
Task.output.typeexample
Task.output:PerformedActivityType.typeexamplePattern: resulting-activity
Task.output:PerformedActivityReference.typeexamplePattern: resulting-activity

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTaskIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTaskIf 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-4errorTaskIf 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-5errorTaskIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTaskA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorTaskLast modified date must be greater than or eq