SDOH Clinical Care
2.3.0-draft - STU 2.3 Draft 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.3.0-draft 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.3.0-draft
Standards status: Trial-use Maturity Level: 2 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 Task.focus field) authored by a Practitioner or Organization (.requester field) targeting a Patient, Related Person or Group (Task.for field) to a service-providing organization. These fields are required. The Task.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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C 0..* Task A request to fulfill an SDOH service request
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
inv-1: Last modified date must be greater than or equal to authored-on date.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for partOf Σ 0..* Reference(Task) Composite task
Slice: Unordered, Open by profile:resolve()
ele-1: All FHIR elements must have a @value or children
.... partOf:SupportedPartOf SΣ 0..* Reference(SDOHCC Task For Referral Management) Composite task
ele-1: All FHIR elements must have a @value or children
... statusReason SΣ 0..1 CodeableConcept Reason for current status
Binding Description (No ValueSet): (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.


ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... intent Σ 1..1 code order
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


ele-1: All FHIR elements must have a @value or children
Fixed Value: order
... priority S 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): The task's priority.


ele-1: All FHIR elements must have a @value or children
... code Σ 1..1 CodeableConcept Task Type
Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.


ele-1: All FHIR elements must have a @value or children
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 Reference(SDOHCC ServiceRequest) What task is acting on
ele-1: All FHIR elements must have a @value or children
... for SΣ 1..1 Reference(RelatedPerson | Group | US Core Patient Profile(7.0.0)) Beneficiary of the Task
ele-1: All FHIR elements must have a @value or children
... authoredOn SC 1..1 dateTime Task Creation Date
ele-1: All FHIR elements must have a @value or children
... requester SΣ 1..1 Reference(SDOHCC PractitionerRole | US Core Organization Profile(7.0.0)) Who is asking for task to be done
ele-1: All FHIR elements must have a @value or children
... owner SΣ 0..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Responsible individual
ele-1: All FHIR elements must have a @value or children
... Slices for output 0..* BackboneElement Information produced as part of task
Slice: Unordered, Open by value:type, type:value
ele-1: All FHIR elements must have a @value or children
.... output:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type 1..1 CodeableConcept Label for output
Binding Description (No ValueSet): (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.


ele-1: All FHIR elements must have a @value or children
..... value[x] 1..1 Result of output
ele-1: All FHIR elements must have a @value or children
...... 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:PerformedActivityReference S 0..* BackboneElement Information produced as part of task
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type 1..1 CodeableConcept Label for output
Binding Description (No ValueSet): (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.


ele-1: All FHIR elements must have a @value or children
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
..... Slices for value[x] 1..1 Reference() Result of output
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
...... value[x]:valueReference S 1..1 Reference(SDOHCC Procedure) Result of output
ele-1: All FHIR elements must have a @value or children
.... output:PerformedActivityCode S 0..* BackboneElement Information produced as part of task
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type 1..1 CodeableConcept Label for output
Binding Description (No ValueSet): (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.


ele-1: All FHIR elements must have a @value or children
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
..... Slices for value[x] 1..1 CodeableConcept Result of output
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
...... value[x]:valueCodeableConcept S 1..1 CodeableConcept Result of output
Binding: USCoreProcedureCodes (7.0.0) (required)
ele-1: All FHIR elements must have a @value or children

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|7.0.0

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

 

Other representations of profile: CSV, Excel, Schematron