BSeR: Bidirectional Services_eReferral
2.0.0-connectathon - CI Build United States of America flag

BSeR: Bidirectional Services_eReferral - Local Development build (v2.0.0-connectathon). See the Directory of published versions

Resource Profile: Referral Task

Official URL: http://hl7.org/fhir/us/bser/StructureDefinition/ReferralTask Version: 2.0.0-connectathon
Active as of 2023-04-13 Computable Name: ReferralTask

A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is used in a referral to track the performance and state of completion of the referral service request.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task 0..*TaskA task to be performed
... Slices for identifier S1..2IdentifierTask Instance Identifier
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorTaskIdentifier S1..1IdentifierTask Instance Identifier
..... type S1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... value S1..1stringThe value that is unique
..... assigner S0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientTaskIdentifier S0..1IdentifierTask Instance Identifier
..... type S1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... value S1..1stringThe value that is unique
..... assigner S1..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
... Slices for partOf 0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:supportedPartOf 0..*Reference(Task)Composite task
... status S1..1codedraft | requested | received | accepted | +
... businessStatus S1..1CodeableConceptE.g. "Specimen collected", "IV prepped"
Binding: Task Business Status VS (extensible)
... intent S1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Fixed Value: order
... code S1..1CodeableConceptFulfill the focal request
Fixed Value: As shown (Fulfill the focal request)
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
... focus 1..1Reference(Referral Service Request)What task is acting on
... for S1..1Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group)Beneficiary of the Task
... authoredOn S1..1dateTimeTask Creation Date
... requester S1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner S1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... note 0..1AnnotationComments made about the task
... output 0..1BackboneElementInformation produced as part of task
.... value[x] 1..1Reference()Result of output

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Task.businessStatusextensibleTaskBusinessStatusVS
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA task to be performed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..2IdentifierTask Instance Identifier
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorTaskIdentifier S1..1IdentifierTask Instance Identifier
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientTaskIdentifier S0..1IdentifierTask Instance Identifier
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ1..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... partOf:supportedPartOf Σ0..*Reference(Task)Composite task
... status ?!SΣ1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.

... statusReason SΣ0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.

... businessStatus SΣ1..1CodeableConceptE.g. "Specimen collected", "IV prepped"
Binding: Task Business Status VS (extensible)
... intent SΣ1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


Fixed Value: order
... code SΣ1..1CodeableConceptFulfill the focal request
Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.


Fixed Value: As shown (Fulfill the focal request)
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
..... display0..0stringRepresentation defined by the system
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... focus Σ1..1Reference(Referral Service Request)What task is acting on
... for SΣ1..1Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group)Beneficiary of the Task
... authoredOn SC1..1dateTimeTask Creation Date
... requester SΣ1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner SΣ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... note 0..1AnnotationComments made about the task
... output 0..1BackboneElementInformation produced as part of task
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptLabel for output
Binding: (unbound) (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

.... value[x] 1..1Reference()Result of output

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Task.identifier:referralInitiatorTaskIdentifier.userequiredIdentifierUse
Task.identifier:referralInitiatorTaskIdentifier.typeextensiblePattern: PLAC
Task.identifier:referralRecipientTaskIdentifier.userequiredIdentifierUse
Task.identifier:referralRecipientTaskIdentifier.typeextensiblePattern: FILL
Task.statusrequiredTaskStatus
Task.statusReasonexample
Task.businessStatusextensibleTaskBusinessStatusVS
Task.intentrequiredFixed Value: order
Task.codeexampleFixed Value: fulfill
Task.output.typeexample

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTaskIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTaskIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorTaskIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorTaskIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTaskA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorTaskLast modified date must be greater than or equal to authored-on date.
: lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA task to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..2IdentifierTask Instance Identifier
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorTaskIdentifier S1..1IdentifierTask Instance Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientTaskIdentifier S0..1IdentifierTask Instance Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ1..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
... instantiatesCanonical Σ0..1canonical(ActivityDefinition)Formal definition of task
... instantiatesUri Σ0..1uriFormal definition of task
... basedOn Σ0..*Reference(Resource)Request fulfilled by this task
... groupIdentifier Σ0..1IdentifierRequisition or grouper id
... Slices for partOf Σ0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:supportedPartOf Σ0..*Reference(Task)Composite task
... status ?!SΣ1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.

... statusReason SΣ0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.

... businessStatus SΣ1..1CodeableConceptE.g. "Specimen collected", "IV prepped"
Binding: Task Business Status VS (extensible)
... intent SΣ1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


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

... code SΣ1..1CodeableConceptFulfill the focal request
Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.


Fixed Value: As shown (Fulfill the focal request)
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
..... display0..0stringRepresentation defined by the system
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... description Σ0..1stringHuman-readable explanation of task
... focus Σ1..1Reference(Referral Service Request)What task is acting on
... for SΣ1..1Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group)Beneficiary of the Task
... encounter Σ0..1Reference(Encounter)Healthcare event during which this task originated
... executionPeriod Σ0..1PeriodStart and end time of execution
... authoredOn SC1..1dateTimeTask Creation Date
... lastModified ΣC0..1dateTimeTask Last Modified Date
... requester SΣ1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... performerType 0..*CodeableConceptRequested performer
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.


... owner SΣ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... location Σ0..1Reference(Location)Where task occurs
... reasonCode 0..1CodeableConceptWhy task is needed
Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

... reasonReference 0..1Reference(Resource)Why task is needed
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..1AnnotationComments made about the task
... relevantHistory 0..*Reference(Provenance)Key events in history of the Task
... restriction 0..1BackboneElementConstraints on fulfillment tasks
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... repetitions 0..1positiveIntHow many times to repeat
.... period 0..1PeriodWhen fulfillment sought
.... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization)For whom is fulfillment sought?
... input 0..*BackboneElementInformation used to perform task
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptLabel for the input
Binding: (unbound) (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.

.... value[x] 1..1Content to use in performing the task
..... valueBase64Binarybase64Binary
..... valueBooleanboolean
..... valueCanonicalcanonical(Any)
..... valueCodecode
..... valueDatedate
..... valueDateTimedateTime
..... valueDecimaldecimal
..... valueIdid
..... valueInstantinstant
..... valueIntegerinteger
..... valueMarkdownmarkdown
..... valueOidoid
..... valuePositiveIntpositiveInt
..... valueStringstring
..... valueTimetime
..... valueUnsignedIntunsignedInt
..... valueUriuri
..... valueUrlurl
..... valueUuiduuid
..... valueAddressAddress
..... valueAgeAge
..... valueAnnotationAnnotation
..... valueAttachmentAttachment
..... valueCodeableConceptCodeableConcept
..... valueCodingCoding
..... valueContactPointContactPoint
..... valueCountCount
..... valueDistanceDistance
..... valueDurationDuration
..... valueHumanNameHumanName
..... valueIdentifierIdentifier
..... valueMoneyMoney
..... valuePeriodPeriod
..... valueQuantityQuantity
..... valueRangeRange
..... valueRatioRatio
..... valueReferenceReference(Any)
..... valueSampledDataSampledData
..... valueSignatureSignature
..... valueTimingTiming
..... valueContactDetailContactDetail
..... valueContributorContributor
..... valueDataRequirementDataRequirement
..... valueExpressionExpression
..... valueParameterDefinitionParameterDefinition
..... valueRelatedArtifactRelatedArtifact
..... valueTriggerDefinitionTriggerDefinition
..... valueUsageContextUsageContext
..... valueDosageDosage
..... valueMetaMeta
... output 0..1BackboneElementInformation produced as part of task
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptLabel for output
Binding: (unbound) (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

.... value[x] 1..1Reference()Result of output

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Task.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Task.identifier:referralInitiatorTaskIdentifier.userequiredIdentifierUse
Task.identifier:referralInitiatorTaskIdentifier.typeextensiblePattern: PLAC
Task.identifier:referralRecipientTaskIdentifier.userequiredIdentifierUse
Task.identifier:referralRecipientTaskIdentifier.typeextensiblePattern: FILL
Task.statusrequiredTaskStatus
Task.statusReasonexample
Task.businessStatusextensibleTaskBusinessStatusVS
Task.intentrequiredFixed Value: order
Task.priorityrequiredRequestPriority
Task.codeexampleFixed Value: fulfill
Task.performerTypepreferredProcedurePerformerRoleCodes
Task.reasonCodeexample
Task.input.typeexample
Task.output.typeexample

Constraints

IdGradePath(s)DetailsRequirements
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()

This structure is derived from Task

Summary

Mandatory: 12 elements (4 nested mandatory elements)
Must-Support: 18 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Task.identifier is sliced based on the value of value:type
  • The element Task.partOf is sliced based on the value of profile:resolve()

Differential View

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task 0..*TaskA task to be performed
... Slices for identifier S1..2IdentifierTask Instance Identifier
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorTaskIdentifier S1..1IdentifierTask Instance Identifier
..... type S1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... value S1..1stringThe value that is unique
..... assigner S0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientTaskIdentifier S0..1IdentifierTask Instance Identifier
..... type S1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... value S1..1stringThe value that is unique
..... assigner S1..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
... Slices for partOf 0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:supportedPartOf 0..*Reference(Task)Composite task
... status S1..1codedraft | requested | received | accepted | +
... businessStatus S1..1CodeableConceptE.g. "Specimen collected", "IV prepped"
Binding: Task Business Status VS (extensible)
... intent S1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Fixed Value: order
... code S1..1CodeableConceptFulfill the focal request
Fixed Value: As shown (Fulfill the focal request)
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
... focus 1..1Reference(Referral Service Request)What task is acting on
... for S1..1Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group)Beneficiary of the Task
... authoredOn S1..1dateTimeTask Creation Date
... requester S1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner S1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... note 0..1AnnotationComments made about the task
... output 0..1BackboneElementInformation produced as part of task
.... value[x] 1..1Reference()Result of output

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Task.businessStatusextensibleTaskBusinessStatusVS

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA task to be performed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..2IdentifierTask Instance Identifier
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorTaskIdentifier S1..1IdentifierTask Instance Identifier
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientTaskIdentifier S0..1IdentifierTask Instance Identifier
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... assigner SΣ1..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... partOf:supportedPartOf Σ0..*Reference(Task)Composite task
... status ?!SΣ1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.

... statusReason SΣ0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.

... businessStatus SΣ1..1CodeableConceptE.g. "Specimen collected", "IV prepped"
Binding: Task Business Status VS (extensible)
... intent SΣ1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


Fixed Value: order
... code SΣ1..1CodeableConceptFulfill the focal request
Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.


Fixed Value: As shown (Fulfill the focal request)
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
..... display0..0stringRepresentation defined by the system
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... focus Σ1..1Reference(Referral Service Request)What task is acting on
... for SΣ1..1Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group)Beneficiary of the Task
... authoredOn SC1..1dateTimeTask Creation Date
... requester SΣ1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... owner SΣ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... note 0..1AnnotationComments made about the task
... output 0..1BackboneElementInformation produced as part of task
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptLabel for output
Binding: (unbound) (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

.... value[x] 1..1Reference()Result of output

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Task.identifier:referralInitiatorTaskIdentifier.userequiredIdentifierUse
Task.identifier:referralInitiatorTaskIdentifier.typeextensiblePattern: PLAC
Task.identifier:referralRecipientTaskIdentifier.userequiredIdentifierUse
Task.identifier:referralRecipientTaskIdentifier.typeextensiblePattern: FILL
Task.statusrequiredTaskStatus
Task.statusReasonexample
Task.businessStatusextensibleTaskBusinessStatusVS
Task.intentrequiredFixed Value: order
Task.codeexampleFixed Value: fulfill
Task.output.typeexample

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C0..*TaskA task to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier S1..2IdentifierTask Instance Identifier
Slice: Unordered, Open by value:type
.... identifier:referralInitiatorTaskIdentifier S1..1IdentifierTask Instance Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ0..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
.... identifier:referralRecipientTaskIdentifier S0..1IdentifierTask Instance Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type SΣ1..1CodeableConceptDescription 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.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: FILL
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner SΣ1..1Reference(US Core Organization Profile)Organization that issued id (may be just text)
... instantiatesCanonical Σ0..1canonical(ActivityDefinition)Formal definition of task
... instantiatesUri Σ0..1uriFormal definition of task
... basedOn Σ0..*Reference(Resource)Request fulfilled by this task
... groupIdentifier Σ0..1IdentifierRequisition or grouper id
... Slices for partOf Σ0..*Reference(Task)Composite task
Slice: Unordered, Open by profile:resolve()
.... partOf:supportedPartOf Σ0..*Reference(Task)Composite task
... status ?!SΣ1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.

... statusReason SΣ0..1CodeableConceptReason for current status
Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.

... businessStatus SΣ1..1CodeableConceptE.g. "Specimen collected", "IV prepped"
Binding: Task Business Status VS (extensible)
... intent SΣ1..1codeunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.


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

... code SΣ1..1CodeableConceptFulfill the focal request
Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.


Fixed Value: As shown (Fulfill the focal request)
.... id0..0stringUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0stringUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/CodeSystem/task-code
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: fulfill
..... display0..0stringRepresentation defined by the system
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... description Σ0..1stringHuman-readable explanation of task
... focus Σ1..1Reference(Referral Service Request)What task is acting on
... for SΣ1..1Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group)Beneficiary of the Task
... encounter Σ0..1Reference(Encounter)Healthcare event during which this task originated
... executionPeriod Σ0..1PeriodStart and end time of execution
... authoredOn SC1..1dateTimeTask Creation Date
... lastModified ΣC0..1dateTimeTask Last Modified Date
... requester SΣ1..1Reference(US Core PractitionerRole Profile | US Core Organization Profile)Who is asking for task to be done
... performerType 0..*CodeableConceptRequested performer
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.


... owner SΣ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Responsible individual
... location Σ0..1Reference(Location)Where task occurs
... reasonCode 0..1CodeableConceptWhy task is needed
Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

... reasonReference 0..1Reference(Resource)Why task is needed
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note 0..1AnnotationComments made about the task
... relevantHistory 0..*Reference(Provenance)Key events in history of the Task
... restriction 0..1BackboneElementConstraints on fulfillment tasks
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... repetitions 0..1positiveIntHow many times to repeat
.... period 0..1PeriodWhen fulfillment sought
.... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization)For whom is fulfillment sought?
... input 0..*BackboneElementInformation used to perform task
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptLabel for the input
Binding: (unbound) (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.

.... value[x] 1..1Content to use in performing the task
..... valueBase64Binarybase64Binary
..... valueBooleanboolean
..... valueCanonicalcanonical(Any)
..... valueCodecode
..... valueDatedate
..... valueDateTimedateTime
..... valueDecimaldecimal
..... valueIdid
..... valueInstantinstant
..... valueIntegerinteger
..... valueMarkdownmarkdown
..... valueOidoid
..... valuePositiveIntpositiveInt
..... valueStringstring
..... valueTimetime
..... valueUnsignedIntunsignedInt
..... valueUriuri
..... valueUrlurl
..... valueUuiduuid
..... valueAddressAddress
..... valueAgeAge
..... valueAnnotationAnnotation
..... valueAttachmentAttachment
..... valueCodeableConceptCodeableConcept
..... valueCodingCoding
..... valueContactPointContactPoint
..... valueCountCount
..... valueDistanceDistance
..... valueDurationDuration
..... valueHumanNameHumanName
..... valueIdentifierIdentifier
..... valueMoneyMoney
..... valuePeriodPeriod
..... valueQuantityQuantity
..... valueRangeRange
..... valueRatioRatio
..... valueReferenceReference(Any)
..... valueSampledDataSampledData
..... valueSignatureSignature
..... valueTimingTiming
..... valueContactDetailContactDetail
..... valueContributorContributor
..... valueDataRequirementDataRequirement
..... valueExpressionExpression
..... valueParameterDefinitionParameterDefinition
..... valueRelatedArtifactRelatedArtifact
..... valueTriggerDefinitionTriggerDefinition
..... valueUsageContextUsageContext
..... valueDosageDosage
..... valueMetaMeta
... output 0..1BackboneElementInformation produced as part of task
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptLabel for output
Binding: (unbound) (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

.... value[x] 1..1Reference()Result of output

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Task.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Task.identifier:referralInitiatorTaskIdentifier.userequiredIdentifierUse
Task.identifier:referralInitiatorTaskIdentifier.typeextensiblePattern: PLAC
Task.identifier:referralRecipientTaskIdentifier.userequiredIdentifierUse
Task.identifier:referralRecipientTaskIdentifier.typeextensiblePattern: FILL
Task.statusrequiredTaskStatus
Task.statusReasonexample
Task.businessStatusextensibleTaskBusinessStatusVS
Task.intentrequiredFixed Value: order
Task.priorityrequiredRequestPriority
Task.codeexampleFixed Value: fulfill
Task.performerTypepreferredProcedurePerformerRoleCodes
Task.reasonCodeexample
Task.input.typeexample
Task.output.typeexample

Constraints

IdGradePath(s)DetailsRequirements
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()

This structure is derived from Task

Summary

Mandatory: 12 elements (4 nested mandatory elements)
Must-Support: 18 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Task.identifier is sliced based on the value of value:type
  • The element Task.partOf is sliced based on the value of profile:resolve()

 

Other representations of profile: CSV, Excel, Schematron