1.0.0 - release

CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: TaskReferral

Official URL: https://fhir.cambio.se/StructureDefinition/TaskReferral/v1 Version: 1.0.0
Active as of 2021-04-14 Computable Name: 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.

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.

APIs & Supported Operations

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

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

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 _include params

The following _include 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 params

Task:focus - 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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* TaskReferralCore A task to be performed
Constraints: inv-1
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code Draft | Requested | Accepted | Rejected | Cancelled | In progress | Completed | Entered in error
Binding: TaskStatus (required): The current status of the task.
... businessStatus Σ 0..1 CodeableConcept E.g. "Specimen collected", "IV prepped"
Binding Description: (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
.... coding Σ 1..1 Coding Code defined by a terminology system
Binding: ReferralBusinessStatus (required)
... intent Σ 1..1 code order
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Fixed Value: order
... priority 0..1 code routine | urgent | asap
Binding: RequestPriority (required): The task's priority.
... focus Σ 1..1 Reference(ServiceRequestReferral) What task is acting on
.... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: ServiceRequest
... lastModified ΣC 0..1 dateTime Task Last Modified Date
... requester Σ 0..1 Reference(Organization | Patient | Practitioner | PractitionerRoleLiteSe) Who is asking for task to be done
... owner Σ 0..1 Reference(Practitioner | Organization | PractitionerRoleLiteSe) Responsible individual
... Slices for output 0..* BackboneElement Information produced as part of task
Slice: Unordered, Open by pattern:type.coding.code
.... output:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for output
Binding: Referral Documentation Types (required)
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Result of output
.... output:finalAnswer 0..1 BackboneElement Information produced as part of task
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for output
Binding: Referral Documentation Types (required)
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Final Answer

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Task.statusrequiredTaskStatus
http://hl7.org/fhir/ValueSet/task-status|4.0.1
From the FHIR Standard
Task.businessStatusexample
Task.businessStatus.codingrequiredReferralBusinessStatus
https://fhir.cambio.se/ValueSet/ReferralBusinessStatus/v1
From this IG
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.focus.typeextensibleFixed Value: ServiceRequest
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Task.input.typeexample
Task.output.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG
Task.output:finalAnswer.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTaskIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTaskIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorTaskIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorTaskIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTaskA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorTaskLast modified date must be greater than or equal to authored-on date.
: lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn

This structure is derived from TaskReferralCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task 0..* TaskReferralCore A task to be performed
... meta 1..1 Meta Metadata about the resource
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier 1..1 Identifier Task Instance Identifier
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... groupIdentifier 0..0
... partOf 0..0
... status 1..1 code Draft | Requested | Accepted | Rejected | Cancelled | In progress | Completed | Entered in error
... statusReason 0..0
... businessStatus 0..1 CodeableConcept E.g. "Specimen collected", "IV prepped"
.... coding 1..1 Coding Code defined by a terminology system
Binding: ReferralBusinessStatus (required)
... intent 1..1 code order
Fixed Value: order
... priority 0..1 code routine | urgent | asap
... code 0..0
... focus 1..1 Reference(ServiceRequestReferral) What task is acting on
... encounter 0..0
... executionPeriod 0..0
... authoredOn 0..0
... lastModified 0..1 dateTime Task Last Modified Date
... requester 0..1 Reference(Organization | Patient | Practitioner | PractitionerRoleLiteSe) Who is asking for task to be done
... performerType 0..0
... owner 0..1 Reference(Practitioner | Organization | PractitionerRoleLiteSe) Responsible individual
... location 0..0
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... note 0..0
... relevantHistory 0..0
... restriction 0..0
... input 0..0
... Slices for output 0..* BackboneElement Information produced as part of task
Slice: Unordered, Open by pattern:type.coding.code
.... output:All Slices Content/Rules for all slices
..... type 1..1 CodeableConcept Label for output
Binding: Referral Documentation Types (required)
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Result of output
.... output:finalAnswer 0..1 BackboneElement Information produced as part of task
..... type 1..1 CodeableConcept Label for output
Binding: Referral Documentation Types (required)
...... coding
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: FIN
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Final Answer

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Task.businessStatus.codingrequiredReferralBusinessStatus
https://fhir.cambio.se/ValueSet/ReferralBusinessStatus/v1
From this IG
Task.output.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG
Task.output:finalAnswer.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* TaskReferralCore A task to be performed
Constraints: inv-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 Identifier Task Instance Identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code Draft | Requested | Accepted | Rejected | Cancelled | In progress | Completed | Entered in error
Binding: TaskStatus (required): The current status of the task.
... businessStatus Σ 0..1 CodeableConcept E.g. "Specimen collected", "IV prepped"
Binding Description: (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
.... 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 Σ 1..1 Coding Code defined by a terminology system
Binding: ReferralBusinessStatus (required)
.... text Σ 0..1 string Plain text representation of the concept
... intent Σ 1..1 code order
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Fixed Value: order
... priority 0..1 code routine | urgent | asap
Binding: RequestPriority (required): The task's priority.
... description Σ 0..1 string Human-readable explanation of task
... focus Σ 1..1 Reference(ServiceRequestReferral) What task is acting on
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: ServiceRequest
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... for Σ 0..1 Reference(Patient) Beneficiary of the Task
... lastModified ΣC 0..1 dateTime Task Last Modified Date
... requester Σ 0..1 Reference(Organization | Patient | Practitioner | PractitionerRoleLiteSe) Who is asking for task to be done
... owner Σ 0..1 Reference(Practitioner | Organization | PractitionerRoleLiteSe) Responsible individual
... Slices for output 0..* BackboneElement Information produced as part of task
Slice: Unordered, Open by pattern:type.coding.code
.... 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: Referral Documentation Types (required)
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Result of output
.... output:finalAnswer 0..1 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: Referral Documentation Types (required)
...... 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
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: FIN
....... 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
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Final Answer

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Task.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Task.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Task.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Task.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Task.statusrequiredTaskStatus
http://hl7.org/fhir/ValueSet/task-status|4.0.1
From the FHIR Standard
Task.businessStatusexample
Task.businessStatus.codingrequiredReferralBusinessStatus
https://fhir.cambio.se/ValueSet/ReferralBusinessStatus/v1
From this IG
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.focus.typeextensibleFixed Value: ServiceRequest
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Task.input.typeexample
Task.output.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG
Task.output:finalAnswer.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTaskIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTaskIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorTaskIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorTaskIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTaskA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorTaskLast modified date must be greater than or equal to authored-on date.
: lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn

This structure is derived from TaskReferralCore

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Fixed: 2 elements
Prohibited: 19 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Task.output

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* TaskReferralCore A task to be performed
Constraints: inv-1
... meta Σ 1..1 Meta Metadata about the resource
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code Draft | Requested | Accepted | Rejected | Cancelled | In progress | Completed | Entered in error
Binding: TaskStatus (required): The current status of the task.
... businessStatus Σ 0..1 CodeableConcept E.g. "Specimen collected", "IV prepped"
Binding Description: (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
.... coding Σ 1..1 Coding Code defined by a terminology system
Binding: ReferralBusinessStatus (required)
... intent Σ 1..1 code order
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Fixed Value: order
... priority 0..1 code routine | urgent | asap
Binding: RequestPriority (required): The task's priority.
... focus Σ 1..1 Reference(ServiceRequestReferral) What task is acting on
.... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: ServiceRequest
... lastModified ΣC 0..1 dateTime Task Last Modified Date
... requester Σ 0..1 Reference(Organization | Patient | Practitioner | PractitionerRoleLiteSe) Who is asking for task to be done
... owner Σ 0..1 Reference(Practitioner | Organization | PractitionerRoleLiteSe) Responsible individual
... Slices for output 0..* BackboneElement Information produced as part of task
Slice: Unordered, Open by pattern:type.coding.code
.... output:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for output
Binding: Referral Documentation Types (required)
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Result of output
.... output:finalAnswer 0..1 BackboneElement Information produced as part of task
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for output
Binding: Referral Documentation Types (required)
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Final Answer

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Task.statusrequiredTaskStatus
http://hl7.org/fhir/ValueSet/task-status|4.0.1
From the FHIR Standard
Task.businessStatusexample
Task.businessStatus.codingrequiredReferralBusinessStatus
https://fhir.cambio.se/ValueSet/ReferralBusinessStatus/v1
From this IG
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.focus.typeextensibleFixed Value: ServiceRequest
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Task.input.typeexample
Task.output.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG
Task.output:finalAnswer.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG

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

Differential View

This structure is derived from TaskReferralCore

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task 0..* TaskReferralCore A task to be performed
... meta 1..1 Meta Metadata about the resource
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... identifier 1..1 Identifier Task Instance Identifier
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... instantiatesCanonical 0..0
... instantiatesUri 0..0
... basedOn 0..0
... groupIdentifier 0..0
... partOf 0..0
... status 1..1 code Draft | Requested | Accepted | Rejected | Cancelled | In progress | Completed | Entered in error
... statusReason 0..0
... businessStatus 0..1 CodeableConcept E.g. "Specimen collected", "IV prepped"
.... coding 1..1 Coding Code defined by a terminology system
Binding: ReferralBusinessStatus (required)
... intent 1..1 code order
Fixed Value: order
... priority 0..1 code routine | urgent | asap
... code 0..0
... focus 1..1 Reference(ServiceRequestReferral) What task is acting on
... encounter 0..0
... executionPeriod 0..0
... authoredOn 0..0
... lastModified 0..1 dateTime Task Last Modified Date
... requester 0..1 Reference(Organization | Patient | Practitioner | PractitionerRoleLiteSe) Who is asking for task to be done
... performerType 0..0
... owner 0..1 Reference(Practitioner | Organization | PractitionerRoleLiteSe) Responsible individual
... location 0..0
... reasonCode 0..0
... reasonReference 0..0
... insurance 0..0
... note 0..0
... relevantHistory 0..0
... restriction 0..0
... input 0..0
... Slices for output 0..* BackboneElement Information produced as part of task
Slice: Unordered, Open by pattern:type.coding.code
.... output:All Slices Content/Rules for all slices
..... type 1..1 CodeableConcept Label for output
Binding: Referral Documentation Types (required)
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Result of output
.... output:finalAnswer 0..1 BackboneElement Information produced as part of task
..... type 1..1 CodeableConcept Label for output
Binding: Referral Documentation Types (required)
...... coding
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: FIN
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Final Answer

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Task.businessStatus.codingrequiredReferralBusinessStatus
https://fhir.cambio.se/ValueSet/ReferralBusinessStatus/v1
From this IG
Task.output.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG
Task.output:finalAnswer.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* TaskReferralCore A task to be performed
Constraints: inv-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 1..1 Identifier Task Instance Identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code Draft | Requested | Accepted | Rejected | Cancelled | In progress | Completed | Entered in error
Binding: TaskStatus (required): The current status of the task.
... businessStatus Σ 0..1 CodeableConcept E.g. "Specimen collected", "IV prepped"
Binding Description: (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.
.... 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 Σ 1..1 Coding Code defined by a terminology system
Binding: ReferralBusinessStatus (required)
.... text Σ 0..1 string Plain text representation of the concept
... intent Σ 1..1 code order
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Fixed Value: order
... priority 0..1 code routine | urgent | asap
Binding: RequestPriority (required): The task's priority.
... description Σ 0..1 string Human-readable explanation of task
... focus Σ 1..1 Reference(ServiceRequestReferral) What task is acting on
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Fixed Value: ServiceRequest
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... for Σ 0..1 Reference(Patient) Beneficiary of the Task
... lastModified ΣC 0..1 dateTime Task Last Modified Date
... requester Σ 0..1 Reference(Organization | Patient | Practitioner | PractitionerRoleLiteSe) Who is asking for task to be done
... owner Σ 0..1 Reference(Practitioner | Organization | PractitionerRoleLiteSe) Responsible individual
... Slices for output 0..* BackboneElement Information produced as part of task
Slice: Unordered, Open by pattern:type.coding.code
.... 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: Referral Documentation Types (required)
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Result of output
.... output:finalAnswer 0..1 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: Referral Documentation Types (required)
...... 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
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: FIN
....... 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
..... value[x] 1..1 Reference(CompositionReferralClinicalInformation) Final Answer

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Task.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Task.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Task.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Task.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Task.statusrequiredTaskStatus
http://hl7.org/fhir/ValueSet/task-status|4.0.1
From the FHIR Standard
Task.businessStatusexample
Task.businessStatus.codingrequiredReferralBusinessStatus
https://fhir.cambio.se/ValueSet/ReferralBusinessStatus/v1
From this IG
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.focus.typeextensibleFixed Value: ServiceRequest
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Task.input.typeexample
Task.output.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG
Task.output:finalAnswer.typerequiredReferralDocumentationTypes
https://cambio.codes/referral-documentation-type/v1
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTaskIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTaskIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorTaskIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorTaskIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTaskA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorTaskLast modified date must be greater than or equal to authored-on date.
: lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn

This structure is derived from TaskReferralCore

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Fixed: 2 elements
Prohibited: 19 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Task.output

 

Other representations of profile: CSV, Excel, Schematron