SDOH Clinical Care
2.3.0 - STU 2.3
SDOH Clinical Care
2.3.0 - STU 2.3
This page is part of the SDOH Clinical Care for Multiple Domains (v2.3.0: STU 2.3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement | Version: 2.3.0 | |||
| 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.
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.
See Checking Task Status.
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.
| 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 |
cancelled |
Cancelled | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 |
| status |
?!SΣ | 1..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Referral Task Status (required) 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Task.status | required | SDOHCCValueSetReferralTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatusfrom this IG | |
| Task.statusReason | example | ||
| Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | |
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-codefrom the FHIR Standard | |
| Task.output.type | example | ||
| Task.output:PerformedActivityReference.type | example | Pattern: resulting-activity | |
| Task.output:PerformedActivityCode.type | example | Pattern: resulting-activity | |
| Task.output:PerformedActivityCode.value[x]:valueCodeableConcept | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Task | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task |
0..* | Task | A request to fulfill an SDOH service request | |
| 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..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Referral Task Status (required) |
| statusReason |
S | 0..1 | CodeableConcept | Reason for current status |
| text |
S | 1..1 | string | Plain text representation of the concept |
| intent |
1..1 | code | order Fixed Value: order | |
| priority |
S | 0..1 | code | routine | urgent | asap | stat |
| code |
1..1 | CodeableConcept | Task Type Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
| focus |
S | 1..1 | Reference(SDOHCC ServiceRequest) | What task is acting on |
| for |
S | 1..1 | Reference(RelatedPerson | Group | US Core Patient Profile(7.0.0)) | Beneficiary of the Task |
| authoredOn |
S | 1..1 | dateTime | Task Creation Date |
| requester |
S | 1..1 | Reference(SDOHCC PractitionerRole | US Core Organization Profile(7.0.0)) | Who is asking for task to be done |
| owner |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual |
| Slices for output |
0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by value:type, type:value | |
| output:PerformedActivityReference |
S | 0..* | BackboneElement | Information produced as part of task |
| type |
1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| Slices for value[x] |
1..1 | Reference() | Result of output Slice: Unordered, Open by type:$this | |
| value[x]:valueReference |
S | 1..1 | Reference(SDOHCC Procedure) | Result of output |
| output:PerformedActivityCode |
S | 0..* | BackboneElement | Information produced as part of task |
| type |
1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| Slices for value[x] |
1..1 | CodeableConcept | Result of output Slice: Unordered, Open by type:$this | |
| value[x]:valueCodeableConcept |
S | 1..1 | CodeableConcept | Result of output Binding: USCoreProcedureCodes (7.0.0) (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Task.status | required | SDOHCCValueSetReferralTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatusfrom this IG | |
| Task.output:PerformedActivityCode.value[x]:valueCodeableConcept | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | Task | A request to fulfill an SDOH service request inv-1: Last modified date must be greater than or equal to authored-on date. | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Task Instance Identifier | |||||
| instantiatesCanonical |
Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
| instantiatesUri |
Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn |
Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| 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..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Referral Task Status (required) | ||||
| 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. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 1..1 | string | Plain text representation of the concept | ||||
| businessStatus |
Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| intent |
Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: order | ||||
| priority |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | ||||
| 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. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| description |
Σ | 0..1 | string | Human-readable explanation of task | ||||
| focus |
SΣ | 1..1 | Reference(SDOHCC ServiceRequest) | What task is acting on | ||||
| for |
SΣ | 1..1 | Reference(RelatedPerson | Group | US Core Patient Profile(7.0.0)) | Beneficiary of the Task | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
| executionPeriod |
Σ | 0..1 | Period | Start and end time of execution | ||||
| authoredOn |
SC | 1..1 | dateTime | Task Creation Date | ||||
| lastModified |
ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
| requester |
SΣ | 1..1 | Reference(SDOHCC PractitionerRole | US Core Organization Profile(7.0.0)) | Who is asking for task to be done | ||||
| performerType |
0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
| owner |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual | ||||
| location |
Σ | 0..1 | Reference(Location) | Where task occurs | ||||
| reasonCode |
0..1 | CodeableConcept | Why task is needed Binding Description (No ValueSet): (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
| reasonReference |
0..1 | Reference(Resource) | Why task is needed | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note |
0..* | Annotation | Comments made about the task | |||||
| relevantHistory |
0..* | Reference(Provenance) | Key events in history of the Task | |||||
| restriction |
0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| repetitions |
0..1 | positiveInt | How many times to repeat | |||||
| period |
0..1 | Period | When fulfillment sought | |||||
| recipient |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
| input |
0..* | BackboneElement | Information used to perform task | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc. | |||||
| value[x] |
1..1 | Content to use in performing the task | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| Slices for output |
0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by value:type, type:value | |||||
| output:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | |||||
| value[x] |
1..1 | Result of output | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| output:PerformedActivityReference |
S | 0..* | BackboneElement | Information produced as part of task | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for output Binding 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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for value[x] |
1..1 | Reference() | Result of output Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueReference |
S | 1..1 | Reference(SDOHCC Procedure) | Result of output | ||||
| output:PerformedActivityCode |
S | 0..* | BackboneElement | Information produced as part of task | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for output Binding 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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for value[x] |
1..1 | CodeableConcept | Result of output Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept |
S | 1..1 | CodeableConcept | Result of output Binding: USCoreProcedureCodes (7.0.0) (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Task.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Task.status | required | SDOHCCValueSetReferralTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatusfrom this IG | ||||
| Task.statusReason | example | |||||
| Task.businessStatus | example | |||||
| Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | ||||
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-codefrom the FHIR Standard | ||||
| Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| Task.reasonCode | example | |||||
| Task.input.type | example | |||||
| Task.output.type | example | |||||
| Task.output:PerformedActivityReference.type | example | Pattern: resulting-activity | ||||
| Task.output:PerformedActivityCode.type | example | Pattern: resulting-activity | ||||
| Task.output:PerformedActivityCode.value[x]:valueCodeableConcept | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Task | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
This structure is derived from Task
Summary
Mandatory: 5 elements(3 nested mandatory elements)
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| status |
?!SΣ | 1..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Referral Task Status (required) 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Task.status | required | SDOHCCValueSetReferralTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatusfrom this IG | |
| Task.statusReason | example | ||
| Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | |
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-codefrom the FHIR Standard | |
| Task.output.type | example | ||
| Task.output:PerformedActivityReference.type | example | Pattern: resulting-activity | |
| Task.output:PerformedActivityCode.type | example | Pattern: resulting-activity | |
| Task.output:PerformedActivityCode.value[x]:valueCodeableConcept | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Task | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
Differential View
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task |
0..* | Task | A request to fulfill an SDOH service request | |
| 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..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Referral Task Status (required) |
| statusReason |
S | 0..1 | CodeableConcept | Reason for current status |
| text |
S | 1..1 | string | Plain text representation of the concept |
| intent |
1..1 | code | order Fixed Value: order | |
| priority |
S | 0..1 | code | routine | urgent | asap | stat |
| code |
1..1 | CodeableConcept | Task Type Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
| focus |
S | 1..1 | Reference(SDOHCC ServiceRequest) | What task is acting on |
| for |
S | 1..1 | Reference(RelatedPerson | Group | US Core Patient Profile(7.0.0)) | Beneficiary of the Task |
| authoredOn |
S | 1..1 | dateTime | Task Creation Date |
| requester |
S | 1..1 | Reference(SDOHCC PractitionerRole | US Core Organization Profile(7.0.0)) | Who is asking for task to be done |
| owner |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual |
| Slices for output |
0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by value:type, type:value | |
| output:PerformedActivityReference |
S | 0..* | BackboneElement | Information produced as part of task |
| type |
1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| Slices for value[x] |
1..1 | Reference() | Result of output Slice: Unordered, Open by type:$this | |
| value[x]:valueReference |
S | 1..1 | Reference(SDOHCC Procedure) | Result of output |
| output:PerformedActivityCode |
S | 0..* | BackboneElement | Information produced as part of task |
| type |
1..1 | CodeableConcept | Label for output Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |
| Slices for value[x] |
1..1 | CodeableConcept | Result of output Slice: Unordered, Open by type:$this | |
| value[x]:valueCodeableConcept |
S | 1..1 | CodeableConcept | Result of output Binding: USCoreProcedureCodes (7.0.0) (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Task.status | required | SDOHCCValueSetReferralTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatusfrom this IG | |
| Task.output:PerformedActivityCode.value[x]:valueCodeableConcept | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | Task | A request to fulfill an SDOH service request inv-1: Last modified date must be greater than or equal to authored-on date. | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
0..* | Identifier | Task Instance Identifier | |||||
| instantiatesCanonical |
Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
| instantiatesUri |
Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn |
Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| 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..1 | code | draft | requested | received | accepted | + Binding: SDOHCC ValueSet Referral Task Status (required) | ||||
| 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. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
SΣ | 1..1 | string | Plain text representation of the concept | ||||
| businessStatus |
Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| intent |
Σ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: order | ||||
| priority |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | ||||
| 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. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| description |
Σ | 0..1 | string | Human-readable explanation of task | ||||
| focus |
SΣ | 1..1 | Reference(SDOHCC ServiceRequest) | What task is acting on | ||||
| for |
SΣ | 1..1 | Reference(RelatedPerson | Group | US Core Patient Profile(7.0.0)) | Beneficiary of the Task | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
| executionPeriod |
Σ | 0..1 | Period | Start and end time of execution | ||||
| authoredOn |
SC | 1..1 | dateTime | Task Creation Date | ||||
| lastModified |
ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
| requester |
SΣ | 1..1 | Reference(SDOHCC PractitionerRole | US Core Organization Profile(7.0.0)) | Who is asking for task to be done | ||||
| performerType |
0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
| owner |
SΣ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual | ||||
| location |
Σ | 0..1 | Reference(Location) | Where task occurs | ||||
| reasonCode |
0..1 | CodeableConcept | Why task is needed Binding Description (No ValueSet): (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
| reasonReference |
0..1 | Reference(Resource) | Why task is needed | |||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note |
0..* | Annotation | Comments made about the task | |||||
| relevantHistory |
0..* | Reference(Provenance) | Key events in history of the Task | |||||
| restriction |
0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| repetitions |
0..1 | positiveInt | How many times to repeat | |||||
| period |
0..1 | Period | When fulfillment sought | |||||
| recipient |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
| input |
0..* | BackboneElement | Information used to perform task | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc. | |||||
| value[x] |
1..1 | Content to use in performing the task | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| Slices for output |
0..* | BackboneElement | Information produced as part of task Slice: Unordered, Open by value:type, type:value | |||||
| output:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | |||||
| value[x] |
1..1 | Result of output | ||||||
| valueBase64Binary |
base64Binary | |||||||
| valueBoolean |
boolean | |||||||
| valueCanonical |
canonical(Any) | |||||||
| valueCode |
code | |||||||
| valueDate |
date | |||||||
| valueDateTime |
dateTime | |||||||
| valueDecimal |
decimal | |||||||
| valueId |
id | |||||||
| valueInstant |
instant | |||||||
| valueInteger |
integer | |||||||
| valueMarkdown |
markdown | |||||||
| valueOid |
oid | |||||||
| valuePositiveInt |
positiveInt | |||||||
| valueString |
string | |||||||
| valueTime |
time | |||||||
| valueUnsignedInt |
unsignedInt | |||||||
| valueUri |
uri | |||||||
| valueUrl |
url | |||||||
| valueUuid |
uuid | |||||||
| valueAddress |
Address | |||||||
| valueAge |
Age | |||||||
| valueAnnotation |
Annotation | |||||||
| valueAttachment |
Attachment | |||||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueCoding |
Coding | |||||||
| valueContactPoint |
ContactPoint | |||||||
| valueCount |
Count | |||||||
| valueDistance |
Distance | |||||||
| valueDuration |
Duration | |||||||
| valueHumanName |
HumanName | |||||||
| valueIdentifier |
Identifier | |||||||
| valueMoney |
Money | |||||||
| valuePeriod |
Period | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueRatio |
Ratio | |||||||
| valueReference |
Reference(Any) | |||||||
| valueSampledData |
SampledData | |||||||
| valueSignature |
Signature | |||||||
| valueTiming |
Timing | |||||||
| valueContactDetail |
ContactDetail | |||||||
| valueContributor |
Contributor | |||||||
| valueDataRequirement |
DataRequirement | |||||||
| valueExpression |
Expression | |||||||
| valueParameterDefinition |
ParameterDefinition | |||||||
| valueRelatedArtifact |
RelatedArtifact | |||||||
| valueTriggerDefinition |
TriggerDefinition | |||||||
| valueUsageContext |
UsageContext | |||||||
| valueDosage |
Dosage | |||||||
| valueMeta |
Meta | |||||||
| output:PerformedActivityReference |
S | 0..* | BackboneElement | Information produced as part of task | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for output Binding 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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for value[x] |
1..1 | Reference() | Result of output Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueReference |
S | 1..1 | Reference(SDOHCC Procedure) | Result of output | ||||
| output:PerformedActivityCode |
S | 0..* | BackboneElement | Information produced as part of task | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
1..1 | CodeableConcept | Label for output Binding 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. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/sdoh-clinicalcare/CodeSystem/SDOHCC-CodeSystemTemporaryCodes | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: resulting-activity | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for value[x] |
1..1 | CodeableConcept | Result of output Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept |
S | 1..1 | CodeableConcept | Result of output Binding: USCoreProcedureCodes (7.0.0) (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Task.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Task.status | required | SDOHCCValueSetReferralTaskStatushttp://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetReferralTaskStatusfrom this IG | ||||
| Task.statusReason | example | |||||
| Task.businessStatus | example | |||||
| Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | ||||
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-codefrom the FHIR Standard | ||||
| Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| Task.reasonCode | example | |||||
| Task.input.type | example | |||||
| Task.output.type | example | |||||
| Task.output:PerformedActivityReference.type | example | Pattern: resulting-activity | ||||
| Task.output:PerformedActivityCode.type | example | Pattern: resulting-activity | ||||
| Task.output:PerformedActivityCode.value[x]:valueCodeableConcept | required | USCoreProcedureCodeshttp://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Task | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
This structure is derived from Task
Summary
Mandatory: 5 elements(3 nested mandatory elements)
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Patient Care. Package hl7.fhir.us.sdoh-clinicalcare#2.3.0 based on FHIR 4.0.1. Generated 2025-05-15
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change