TaskReferral

Introduction

The TaskReferral profile represents the task to be performed as a result of a referral request. This profile is based on the FHIR resource Task.

Intended Use

TaskReferral is intended to be used for communicating referral statuses and referral outputs, e.g. assessments and answers. The output section refers to composition resources which can be contained within the Task. For the intended use of Composition, refer to CompositionReferralClinicalInformation section.

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Type Description
Rule External user should not be someone else than the patient of which record the referral data belongs. E.g. A healthcare professional is not the intended user of the API.
Rule The consumer of the API is responsible for making sure data retrieved is filtered in compliance with laws and regulations prior to presenting it to any end-users.
Rule For reading referral information, the external system needs to be able to evaluate PDL. This means whether the information can be displayed for a healthcare professional with a specific assignment. PDL data needed (HSA care unit and HSA care provider) is retrieved by including the organization referenced from ServiceRequest.performer.PractitionerRoleLiteSe (PractitionerRoleLiteSe.OrganizationSEVendorLite). For more information, see supported Queries.

Profile Overview

TaskReferral

idΣ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
instantiatesCanonicalΣ0..0canonical(ActivityDefinition)
instantiatesUriΣ0..0uri
basedOnΣ I0..0Reference(Resource)
groupIdentifierΣ0..0Identifier
partOfΣ I0..0Reference(Task)
statusΣ ?!1..1codeBinding
statusReasonΣ0..0CodeableConcept
id0..1string
extensionI0..*Extension
codingΣ1..1CodingBinding
textΣ0..1string
intentΣ1..1codeBindingFixed Value
priority0..1codeBinding
descriptionΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ1..1uriBindingFixed Value
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBindingFixed Value
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
displayΣ0..1string
encounterΣ I0..0Reference(Encounter)
executionPeriodΣ I0..0Period
authoredOnI0..0dateTime
lastModifiedΣ I0..1dateTime
requesterΣ I0..1Reference(Organization | Patient | Practitioner | PractitionerRoleLiteSe)
performerType0..0CodeableConceptBinding
ownerΣ I0..1Reference(Practitioner | Organization | PractitionerRoleLiteSe)
locationΣ I0..0Reference(Location)
reasonCode0..0CodeableConcept
reasonReferenceI0..0Reference(Resource)
insuranceI0..0Reference(Coverage | ClaimResponse)
note0..0Annotation
relevantHistoryI0..0Reference(Provenance)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
valueReferenceReference(CompositionReferralClinicalInformation)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ1..1codeBindingFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1stringFixed Value
valueReferenceReference(CompositionReferralClinicalInformation)

Versions

COS version Profile version Required COSMIC version Date Description
3.0.0 1.0.0 R8.3.05 Mar 2021 Initial version, support for GET.

ValueSet

Task can reference 0..* outputs which may be of different types. Therefore output.coding is bound to the value set ReferralDocumentationTypes.

Code Display
PART Partial Answer
FIN Final Answer
COMP Complementary Answer
REJ Rejection Answer
RRD Referral Record Data
REQCOMP Request for complementary information (Assessment)
ASN Assessment note (Assessment)

This value set includes codes from https://cambio.codes/cs/referral-documentation-type.

Supported Operations

TaskReferral supports GET queries. It supports a SearchInclude operation which makes it possible to read both the referral request(ServiceRequest) and the included referenced referral documentation, answers and assessments (Composition).

HTTP Methods

Method Description
GET Support for GET Task by specific Id, and also to search by subject.

Query Operations

Search Parameters

Parameter Format Mandatory Comment
_profile string No
focus reference Yes

Supported Queries

  1. GET [baseURL]/Task/focus= (Search)
  2. GET [baseURL]/Task/focus=[]&_include=[] (Search)

Supported SearchInclude Operations

The following searchInclude parameters are supported:

  1. for
  2. focus
  3. owner
  4. owner.practitioner
  5. owner.organization
  6. requester
  7. requester.practitioner
  8. requester.organization

Supported RevInclude Operations

This will return all tasks which reference this ServiceRequest.

Error Codes

No specific error codes for Task, for common codes, refer to the Error Handling section.