FHIR Implementation Guide for HCX
0.8.0 - CI Build
FHIR Implementation Guide for HCX
0.8.0 - CI Build
FHIR Implementation Guide for HCX - Local Development build (v0.8.0). See the Directory of published versions
| Defining URL: | https://ig.hcxprotocol.io/v0.8/StructureDefinition-Task.html |
| Version: | 0.8.0 |
| Name: | Task |
| Status: | Draft as of 2019-11-01 09:29:23+1100 (Standards Status: Trial Use) |
| Definition: | A task to be performed. |
| Publisher: | HCX Open Community |
| Maturity: | 0 |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://ig.hcxprotocol.io/v0.8/StructureDefinition-Task.html
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Task
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Task | 0..* | Task | A task to be performed | |
  identifier | 1..* | Identifier | Task Instance Identifier | |
 encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated |
| requester | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who is asking for task to be done |
| owner | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual |
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
  restriction | ||||
  recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Task | C | 0..* | Task | A task to be performed | ||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 1..* | Identifier | Task Instance Identifier | |||||
| instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
| instantiatesUri | Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier | Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| partOf | Σ | 0..* | Reference(Task) | Composite task | ||||
| status | ?!Σ | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. | ||||
| statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
| businessStatus | Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| intent | Σ | 1..1 | code | unknown | 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. | ||||
| priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | |||||
| code | Σ | 0..1 | CodeableConcept | Task Type Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||||
| description | Σ | 0..1 | string | Human-readable explanation of task | ||||
| focus | Σ | 0..1 | Reference(Resource) | What task is acting on | ||||
| for | Σ | 0..1 | Reference(Resource) | 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 | C | 0..1 | dateTime | Task Creation Date | ||||
| lastModified | ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
| requester | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who is asking for task to be done | ||||
| performerType | 0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
| owner | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual | ||||
| location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
| reasonCode | 0..1 | CodeableConcept | Why task is needed Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
| reasonReference | 0..1 | Reference(Resource) | Why task is needed | |||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note | 0..* | Annotation | Comments made about the task | |||||
| relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
 restriction | 0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| repetitions | 0..1 | positiveInt | How many times to repeat | |||||
| period | 0..1 | Period | When fulfillment sought | |||||
| recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
| input | 0..* | BackboneElement | Information used to perform task | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | CodeableConcept | Label for the input Binding: (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..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 | 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: (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..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 | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | C | 0..* | Task | A task to be performed |
| Documentation for this format | ||||
This structure is derived from Task
Summary
Mandatory: 1 element
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | 0..* | Task | A task to be performed | |
| identifier | 1..* | Identifier | Task Instance Identifier | |
| encounter | Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated |
| requester | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who is asking for task to be done |
| owner | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual |
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |
| restriction | ||||
| recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Task | C | 0..* | Task | A task to be performed | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 1..* | Identifier | Task Instance Identifier | |||||
| instantiatesCanonical | Σ | 0..1 | canonical(ActivityDefinition) | Formal definition of task | ||||
| instantiatesUri | Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn | Σ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier | Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| partOf | Σ | 0..* | Reference(Task) | Composite task | ||||
| status | ?!Σ | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. | ||||
| statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: (unbound) (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow. | ||||
| businessStatus | Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding: (unbound) (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| intent | Σ | 1..1 | code | unknown | 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. | ||||
| priority | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | |||||
| code | Σ | 0..1 | CodeableConcept | Task Type Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. | ||||
| description | Σ | 0..1 | string | Human-readable explanation of task | ||||
| focus | Σ | 0..1 | Reference(Resource) | What task is acting on | ||||
| for | Σ | 0..1 | Reference(Resource) | 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 | C | 0..1 | dateTime | Task Creation Date | ||||
| lastModified | ΣC | 0..1 | dateTime | Task Last Modified Date | ||||
| requester | Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | Who is asking for task to be done | ||||
| performerType | 0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | |||||
| owner | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Responsible individual | ||||
| location | Σ | 0..1 | Reference(Location) | Where task occurs | ||||
| reasonCode | 0..1 | CodeableConcept | Why task is needed Binding: (unbound) (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | |||||
| reasonReference | 0..1 | Reference(Resource) | Why task is needed | |||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| note | 0..* | Annotation | Comments made about the task | |||||
| relevantHistory | 0..* | Reference(Provenance) | Key events in history of the Task | |||||
| restriction | 0..1 | BackboneElement | Constraints on fulfillment tasks | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| repetitions | 0..1 | positiveInt | How many times to repeat | |||||
| period | 0..1 | Period | When fulfillment sought | |||||
| recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | |||||
| input | 0..* | BackboneElement | Information used to perform task | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 1..1 | CodeableConcept | Label for the input Binding: (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..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 | 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: (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..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 | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | ||||
| Task.language | preferred | CommonLanguages
| ||||
| Task.status | required | TaskStatus | ||||
| Task.statusReason | example | |||||
| Task.businessStatus | example | |||||
| Task.intent | required | TaskIntent | ||||
| Task.priority | required | RequestPriority | ||||
| Task.code | example | TaskCode | ||||
| Task.performerType | preferred | ProcedurePerformerRoleCodes | ||||
| Task.reasonCode | example | |||||
| Task.input.type | example | |||||
| Task.output.type | example |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |