Bidirectional Services eReferral (BSeR), published by HL7 Public Health Working Group. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/bser/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/bser/StructureDefinition/referral-task | Version: 2.0.0-ballot | |||
Active as of 2024-11-26 | Computable Name: ReferralTask | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.33.42.17 |
This Task profile represents the state of a task containing a referral service request.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Task
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | Task | |||
Slices for identifier | S | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:type |
identifier:referralInitiatorTaskIdentifier | S | 0..1 | Identifier | Task Instance Identifier |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
value | S | 1..1 | string | The value that is unique |
assigner | S | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
identifier:referralRecipientTaskIdentifier | S | 0..1 | Identifier | Task Instance Identifier |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
value | S | 1..1 | string | The value that is unique |
assigner | S | 1..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
Slices for partOf | S | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() |
partOf:supportedPartOf | S | 0..* | Reference(Referral Task) | Composite task |
status | S | 1..1 | code | draft | requested | received | accepted | + |
statusReason | S | 0..1 | CodeableConcept | Reason for current status |
text | S | 1..1 | string | Plain text representation of the concept |
businessStatus | S | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: Task Business Status VS (extensible) |
text | S | 0..1 | string | Plain text representation of the concept |
intent | S | 1..1 | code | order Fixed Value: order |
code | S | 1..1 | CodeableConcept | Fulfill the focal request Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
focus | S | 1..1 | Reference(Referral Service Request) | What task is acting on |
for | S | 1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group) | Beneficiary of the Task |
authoredOn | S | 1..1 | dateTime | Task Creation Date |
requester | S | 1..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Referral Initiator |
owner | S | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile | HealthcareService | US Core Patient Profile | Device | US Core RelatedPerson Profile) | Referral Recipient |
note | S | 0..* | Annotation | Comments made about the task |
output | S | 0..* | BackboneElement | Information produced as part of task |
value[x] | S | 1..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Result of output |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Task.businessStatus | extensible | TaskBusinessStatusVShttp://hl7.org/fhir/us/bser/ValueSet/TaskBusinessStatusVS from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | S | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:type |
identifier:referralInitiatorTaskIdentifier | S | 0..1 | Identifier | Task Instance Identifier |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | SΣ | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
identifier:referralRecipientTaskIdentifier | S | 0..1 | Identifier | Task Instance Identifier |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | SΣ | 1..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
Slices for partOf | SΣ | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() |
partOf:supportedPartOf | SΣ | 0..* | Reference(Referral Task) | Composite task |
status | ?!SΣ | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. |
statusReason | SΣ | 0..1 | CodeableConcept | Reason for current status Binding Description (No ValueSet): (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
text | SΣ | 1..1 | string | Plain text representation of the concept |
businessStatus | SΣ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: Task Business Status VS (extensible) |
text | SΣ | 0..1 | string | Plain text representation of the concept |
intent | SΣ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: order |
code | SΣ | 1..1 | CodeableConcept | Fulfill the focal request Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
focus | SΣ | 1..1 | Reference(Referral Service Request) | What task is acting on |
for | SΣ | 1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group) | Beneficiary of the Task |
authoredOn | SC | 1..1 | dateTime | Task Creation Date |
requester | SΣ | 1..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Referral Initiator |
owner | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile | HealthcareService | US Core Patient Profile | Device | US Core RelatedPerson Profile) | Referral Recipient |
note | S | 0..* | Annotation | Comments made about the task |
output | S | 0..* | 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 Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. | |
value[x] | S | 1..1 | Result of output | |
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.identifier:referralInitiatorTaskIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Task.identifier:referralInitiatorTaskIdentifier.type | extensible | Pattern: PLAChttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Task.identifier:referralRecipientTaskIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Task.identifier:referralRecipientTaskIdentifier.type | extensible | Pattern: FILLhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Task.status | required | TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1 from the FHIR Standard | |
Task.statusReason | example | ||
Task.businessStatus | extensible | TaskBusinessStatusVShttp://hl7.org/fhir/us/bser/ValueSet/TaskBusinessStatusVS from this IG | |
Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | |
Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-code from the FHIR Standard | |
Task.output.type | example |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | S | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:type | ||||
identifier:referralInitiatorTaskIdentifier | S | 0..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 | SΣ | 1..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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||
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 | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 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 | SΣ | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) | ||||
identifier:referralRecipientTaskIdentifier | S | 0..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 | SΣ | 1..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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||
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 | |||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 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 | SΣ | 1..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) | ||||
instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
instantiatesUri | Σ | 0..1 | uri | Formal definition of task | ||||
basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
groupIdentifier | Σ | 0..1 | Identifier | Requisition or grouper id | ||||
Slices for partOf | SΣ | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() | ||||
partOf:supportedPartOf | SΣ | 0..* | Reference(Referral Task) | Composite task | ||||
status | ?!SΣ | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. | ||||
statusReason | SΣ | 0..1 | CodeableConcept | Reason for current status Binding Description (No ValueSet): (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 1..1 | string | Plain text representation of the concept | ||||
businessStatus | SΣ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: Task Business Status VS (extensible) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
intent | SΣ | 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 | stat Binding: RequestPriority (required): The task's priority. | |||||
code | SΣ | 1..1 | CodeableConcept | Fulfill the focal request Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
description | Σ | 0..1 | string | Human-readable explanation of task | ||||
focus | SΣ | 1..1 | Reference(Referral Service Request) | What task is acting on | ||||
for | SΣ | 1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group) | Beneficiary of the Task | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | ||||
executionPeriod | Σ | 0..1 | Period | Start and end time of execution | ||||
authoredOn | SC | 1..1 | dateTime | Task Creation Date | ||||
lastModified | ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
requester | SΣ | 1..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Referral Initiator | ||||
performerType | 0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
owner | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile | HealthcareService | US Core Patient Profile | Device | US Core RelatedPerson Profile) | Referral Recipient | ||||
location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
reasonCode | 0..1 | CodeableConcept | Why task is needed Binding Description (No ValueSet): (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
reasonReference | 0..1 | Reference(Resource) | Why task is needed | |||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
note | S | 0..* | Annotation | Comments made about the task | ||||
relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
restriction | 0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
repetitions | 0..1 | positiveInt | How many times to repeat | |||||
period | 0..1 | Period | When fulfillment sought | |||||
recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
input | 0..* | BackboneElement | Information used to perform task | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for the input Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc. | |||||
value[x] | 1..1 | Content to use in performing the task | ||||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
output | S | 0..* | BackboneElement | Information produced as part of task | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | 1..1 | CodeableConcept | Label for output Binding Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. | |||||
value[x] | S | 1..1 | Result of output | |||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Task.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Task.identifier:referralInitiatorTaskIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Task.identifier:referralInitiatorTaskIdentifier.type | extensible | Pattern: PLAChttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Task.identifier:referralRecipientTaskIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Task.identifier:referralRecipientTaskIdentifier.type | extensible | Pattern: FILLhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Task.status | required | TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1 from the FHIR Standard | ||||
Task.statusReason | example | |||||
Task.businessStatus | extensible | TaskBusinessStatusVShttp://hl7.org/fhir/us/bser/ValueSet/TaskBusinessStatusVS from this IG | ||||
Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | ||||
Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-code from the FHIR Standard | ||||
Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | ||||
Task.reasonCode | example | |||||
Task.input.type | example | |||||
Task.output.type | example |
This structure is derived from Task
Summary
Mandatory: 6 elements(6 nested mandatory elements)
Must-Support: 26 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Task
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | Task | |||
Slices for identifier | S | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:type |
identifier:referralInitiatorTaskIdentifier | S | 0..1 | Identifier | Task Instance Identifier |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
value | S | 1..1 | string | The value that is unique |
assigner | S | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
identifier:referralRecipientTaskIdentifier | S | 0..1 | Identifier | Task Instance Identifier |
type | S | 1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
value | S | 1..1 | string | The value that is unique |
assigner | S | 1..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
Slices for partOf | S | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() |
partOf:supportedPartOf | S | 0..* | Reference(Referral Task) | Composite task |
status | S | 1..1 | code | draft | requested | received | accepted | + |
statusReason | S | 0..1 | CodeableConcept | Reason for current status |
text | S | 1..1 | string | Plain text representation of the concept |
businessStatus | S | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: Task Business Status VS (extensible) |
text | S | 0..1 | string | Plain text representation of the concept |
intent | S | 1..1 | code | order Fixed Value: order |
code | S | 1..1 | CodeableConcept | Fulfill the focal request Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
focus | S | 1..1 | Reference(Referral Service Request) | What task is acting on |
for | S | 1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group) | Beneficiary of the Task |
authoredOn | S | 1..1 | dateTime | Task Creation Date |
requester | S | 1..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Referral Initiator |
owner | S | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile | HealthcareService | US Core Patient Profile | Device | US Core RelatedPerson Profile) | Referral Recipient |
note | S | 0..* | Annotation | Comments made about the task |
output | S | 0..* | BackboneElement | Information produced as part of task |
value[x] | S | 1..1 | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Result of output |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Task.businessStatus | extensible | TaskBusinessStatusVShttp://hl7.org/fhir/us/bser/ValueSet/TaskBusinessStatusVS from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Task | C | 0..* | Task | A task to be performed inv-1: Last modified date must be greater than or equal to authored-on date. |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | S | 0..* | Identifier | Task Instance Identifier Slice: Unordered, Open by value:type |
identifier:referralInitiatorTaskIdentifier | S | 0..1 | Identifier | Task Instance Identifier |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | SΣ | 0..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
identifier:referralRecipientTaskIdentifier | S | 0..1 | Identifier | Task Instance Identifier |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | SΣ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | SΣ | 1..1 | Reference(US Core Organization Profile) | Organization that issued id (may be just text) |
Slices for partOf | SΣ | 0..* | Reference(Task) | Composite task Slice: Unordered, Open by profile:resolve() |
partOf:supportedPartOf | SΣ | 0..* | Reference(Referral Task) | Composite task |
status | ?!SΣ | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. |
statusReason | SΣ | 0..1 | CodeableConcept | Reason for current status Binding Description (No ValueSet): (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
text | SΣ | 1..1 | string | Plain text representation of the concept |
businessStatus | SΣ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: Task Business Status VS (extensible) |
text | SΣ | 0..1 | string | Plain text representation of the concept |
intent | SΣ | 1..1 | code | order Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order. Fixed Value: order |
code | SΣ | 1..1 | CodeableConcept | Fulfill the focal request Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/CodeSystem/task-code | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: fulfill | |
focus | SΣ | 1..1 | Reference(Referral Service Request) | What task is acting on |
for | SΣ | 1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile | Group) | Beneficiary of the Task |
authoredOn | SC | 1..1 | dateTime | Task Creation Date |
requester | SΣ | 1..1 | Reference(US Core PractitionerRole Profile | US Core Practitioner Profile | US Core Organization Profile) | Referral Initiator |
owner | SΣ | 1..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile | US Core CareTeam Profile | HealthcareService | US Core Patient Profile | Device | US Core RelatedPerson Profile) | Referral Recipient |
note | S | 0..* | Annotation | Comments made about the task |
output | S | 0..* | 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 Description (No ValueSet): (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. | |
value[x] | S | 1..1 | Result of output | |
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueMarkdown | markdown | |||
valueOid | oid | |||
valuePositiveInt | positiveInt | |||
valueString | string | |||
valueTime | time | |||
valueUnsignedInt | unsignedInt | |||
valueUri | uri | |||
valueUrl | url | |||
valueUuid | uuid | |||
valueAddress | Address | |||
valueAge | Age | |||
valueAnnotation | Annotation | |||
valueAttachment | Attachment | |||
valueCodeableConcept | CodeableConcept | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
valueReference | Reference(Any) | |||
valueSampledData | SampledData | |||
valueSignature | Signature | |||
valueTiming | Timing | |||
valueContactDetail | ContactDetail | |||
valueContributor | Contributor | |||
valueDataRequirement | DataRequirement | |||
valueExpression | Expression | |||
valueParameterDefinition | ParameterDefinition | |||
valueRelatedArtifact | RelatedArtifact | |||
valueTriggerDefinition | TriggerDefinition | |||
valueUsageContext | UsageContext | |||
valueDosage | Dosage | |||
valueMeta | Meta | |||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Task.identifier:referralInitiatorTaskIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Task.identifier:referralInitiatorTaskIdentifier.type | extensible | Pattern: PLAChttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Task.identifier:referralRecipientTaskIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Task.identifier:referralRecipientTaskIdentifier.type | extensible | Pattern: FILLhttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Task.status | required | TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1 from the FHIR Standard | |
Task.statusReason | example | ||
Task.businessStatus | extensible | TaskBusinessStatusVShttp://hl7.org/fhir/us/bser/ValueSet/TaskBusinessStatusVS from this IG | |
Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1 from the FHIR Standard | |
Task.code | example | Pattern: fulfillhttp://hl7.org/fhir/ValueSet/task-code from the FHIR Standard | |
Task.output.type | example |
Snapshot View