SDOH Clinical Care
2.1.0 - STU 2.1 United States of America flag

SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-sdoh-clinicalcare/ and changes regularly. See the Directory of published versions

Resource Profile: SDOHCC Task For Referral Management

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement Version: 2.1.0
Standards status: Trial-use Computable Name: SDOHCCTaskForReferralManagement

Profile for tasks requesting fulfillment of an SDOHCC ServiceRequest (i.e. referral for service) and subsequently tracking and managing the fulfillment of that referral.

Purpose

This profile is used to pass an SDOHCC Service Request (the .focus field) authored by a Practitioner or Organization (.requester field) targeting a Patient, Related Person or Group (.for field) to a service-providing organization. These fields are required. The .output is used to return a collection of procedure codes or references to procedures that were performed in fulfillment of the referral.

If the Task is posted to the service delivery system and the ServiceRequest is on a different system, the reference should be absolute. The Task can be updated by either the service requester or the recipient.

Usage

Checking Task Status

See Checking Task Status.

Status Management

The status values allow for a complete flow of the Task in both the requesting and performing systems.

The allowed state transitions are defined graphically in the state diagram below, and are described in the table below.

ReferralTaskStateDiagram.svg
Figure 1: Referral Task State Diagram

Code Display Definition Set By
draft Draft The task is not yet ready to be acted upon Requester
requested Requested The task is ready to be acted upon and action is sought Requester
accepted Accepted The potential performer has agreed to execute the task but has not yet started work Referral Target
rejected Rejected The potential performer has decided not to execute it prior to performing any action. Referral Target
canceled Canceled The task was not completed Requester or Referral Target
in-progress In Progress The task has been started but is not yet complete Referral Target
on-hold On Hold The task has been started but work has been paused. Referral Target
failed Failed The task was attempted but could not be completed due to some error. Referral Target
completed Completed The task has been completed. Referral Target
entered-in-error Entered in Error The task should never have existed and is retained only because of the possibility it may have been used Requester

Usage:

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 0..*TaskA request to fulfill an SDOH service request
... Slices for partOf 0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:SupportedPartOf S0..*Reference(SDOHCC Task For Referral Management)Composite task
... status S1..1codedraft | requested | received | accepted | +
Binding: SDOHCC ValueSet Referral Task Status (required)
... statusReason S0..1CodeableConceptReason for current status
.... text S1..1stringPlain text representation of the concept
... priority S0..1coderoutine | urgent | asap | stat
... code 1..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..1Reference(SDOHCC ServiceRequest)What task is acting on
... for S1..1Reference(RelatedPerson | Group | US Core Patient Profile)Beneficiary of the Task
... authoredOn S1..1dateTimeTask Creation Date
... requester S1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner S0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... Slices for output 0..*BackboneElementInformation produced as part of task
Slice: Unordered, Open by pattern:type, type:value
.... 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
..... Slices for value[x] 1..1Reference()Result of output
Slice: Unordered, Open by type:$this
...... value[x]:valueReference S1..1Reference(SDOHCC Procedure)Result of output
.... output:PerformedActivityCode 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
..... Slices for value[x] 1..1CodeableConceptResult of output
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept S1..1CodeableConceptResult of output
Binding: US Core Procedure Codes (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Task.statusrequiredSDOHCCValueSetReferralTaskStatus
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatus
from this IG
Task.output:PerformedActivityCode.value[x]:valueCodeableConceptrequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA request to fulfill an SDOH service request
inv-1: Last modified date must be greater than or equal to authored-on date.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for partOf Σ0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:SupportedPartOf SΣ0..*Reference(SDOHCC Task For Referral Management)Composite task
... statusReason SΣ0..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Σ1..1stringPlain text representation of the concept
... intent Σ1..1codeorder
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


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

... code Σ1..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..1Reference(SDOHCC ServiceRequest)What task is acting on
... for SΣ1..1Reference(RelatedPerson | Group | US Core Patient Profile)Beneficiary of the Task
... authoredOn SC1..1dateTimeTask Creation Date
... requester SΣ1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner SΣ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... 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..*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.

..... 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: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
..... Slices for value[x] 1..1Reference()Result of output
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference S1..1Reference(SDOHCC Procedure)Result of output
.... output:PerformedActivityCode 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
..... Slices for value[x] 1..1CodeableConceptResult of output
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept S1..1CodeableConceptResult of output
Binding: US Core Procedure Codes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.statusrequiredSDOHCCValueSetReferralTaskStatus
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatus
from this IG
Task.statusReasonexample
Task.intentrequiredFixed Value: 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.output.typeexample
Task.output:PerformedActivityReference.typeexamplePattern: resulting-activity
Task.output:PerformedActivityCode.typeexamplePattern: resulting-activity
Task.output:PerformedActivityCode.value[x]:valueCodeableConceptrequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code

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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA request to fulfill an SDOH service request
inv-1: Last modified date must be greater than or equal to authored-on date.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... 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
... Slices for partOf Σ0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:SupportedPartOf SΣ0..*Reference(SDOHCC Task For Referral Management)Composite task
... status ?!SΣ1..1codedraft | requested | received | accepted | +
Binding: SDOHCC ValueSet Referral Task Status (required)
... statusReason SΣ0..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Σ1..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.

... intent Σ1..1codeorder
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


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

... code Σ1..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..1Reference(SDOHCC ServiceRequest)What task is acting on
... for SΣ1..1Reference(RelatedPerson | Group | 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..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... performerType 0..*CodeableConceptRequested performer
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.


... owner SΣ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)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.

... reasonReference 0..1Reference(Resource)Why task is needed
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..*AnnotationComments made about the task
... 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
..... 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.

..... 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: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
..... Slices for value[x] 1..1Reference()Result of output
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference S1..1Reference(SDOHCC Procedure)Result of output
.... output:PerformedActivityCode 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
..... Slices for value[x] 1..1CodeableConceptResult of output
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept S1..1CodeableConceptResult of output
Binding: US Core Procedure Codes (required)

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.statusrequiredSDOHCCValueSetReferralTaskStatus
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatus
from this IG
Task.statusReasonexample
Task.businessStatusexample
Task.intentrequiredFixed Value: 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:PerformedActivityReference.typeexamplePattern: resulting-activity
Task.output:PerformedActivityCode.typeexamplePattern: resulting-activity
Task.output:PerformedActivityCode.value[x]:valueCodeableConceptrequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code

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

This structure is derived from Task

Summary

Mandatory: 5 elements (3 nested mandatory elements)
Must-Support: 14 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Task.partOf is sliced based on the value of profile:resolve()
  • The element Task.output is sliced based on the values of pattern:type, type:value
  • The element Task.output.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task 0..*TaskA request to fulfill an SDOH service request
... Slices for partOf 0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:SupportedPartOf S0..*Reference(SDOHCC Task For Referral Management)Composite task
... status S1..1codedraft | requested | received | accepted | +
Binding: SDOHCC ValueSet Referral Task Status (required)
... statusReason S0..1CodeableConceptReason for current status
.... text S1..1stringPlain text representation of the concept
... priority S0..1coderoutine | urgent | asap | stat
... code 1..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..1Reference(SDOHCC ServiceRequest)What task is acting on
... for S1..1Reference(RelatedPerson | Group | US Core Patient Profile)Beneficiary of the Task
... authoredOn S1..1dateTimeTask Creation Date
... requester S1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner S0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... Slices for output 0..*BackboneElementInformation produced as part of task
Slice: Unordered, Open by pattern:type, type:value
.... 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
..... Slices for value[x] 1..1Reference()Result of output
Slice: Unordered, Open by type:$this
...... value[x]:valueReference S1..1Reference(SDOHCC Procedure)Result of output
.... output:PerformedActivityCode 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
..... Slices for value[x] 1..1CodeableConceptResult of output
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept S1..1CodeableConceptResult of output
Binding: US Core Procedure Codes (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Task.statusrequiredSDOHCCValueSetReferralTaskStatus
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatus
from this IG
Task.output:PerformedActivityCode.value[x]:valueCodeableConceptrequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA request to fulfill an SDOH service request
inv-1: Last modified date must be greater than or equal to authored-on date.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for partOf Σ0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:SupportedPartOf SΣ0..*Reference(SDOHCC Task For Referral Management)Composite task
... statusReason SΣ0..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Σ1..1stringPlain text representation of the concept
... intent Σ1..1codeorder
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


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

... code Σ1..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..1Reference(SDOHCC ServiceRequest)What task is acting on
... for SΣ1..1Reference(RelatedPerson | Group | US Core Patient Profile)Beneficiary of the Task
... authoredOn SC1..1dateTimeTask Creation Date
... requester SΣ1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner SΣ0..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... 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..*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.

..... 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: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
..... Slices for value[x] 1..1Reference()Result of output
Slice: Unordered, Closed by type:$this
...... value[x]:valueReference S1..1Reference(SDOHCC Procedure)Result of output
.... output:PerformedActivityCode 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
..... Slices for value[x] 1..1CodeableConceptResult of output
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept S1..1CodeableConceptResult of output
Binding: US Core Procedure Codes (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.statusrequiredSDOHCCValueSetReferralTaskStatus
http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatus
from this IG
Task.statusReasonexample
Task.intentrequiredFixed Value: 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.output.typeexample
Task.output:PerformedActivityReference.typeexamplePattern: resulting-activity
Task.output:PerformedActivityCode.typeexamplePattern: resulting-activity
Task.output:PerformedActivityCode.value[x]:valueCodeableConceptrequiredUSCoreProcedureCodes
http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA request to fulfill an SDOH service request
inv-1: Last modified date must be greater than or equal to authored-on date.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... 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
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... 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
... Slices for partOf Σ0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:SupportedPartOf SΣ0..*Reference(SDOHCC Task For Referral Management)Composite task
... status ?!SΣ1..1codedraft | requested | received | accepted | +
Binding: SDOHCC ValueSet Referral Task Status (required)
... statusReason SΣ0..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Σ1..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.

... intent Σ1..1codeorder
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


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

... code Σ1..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
.... extension