Clinical Practice Guidelines
2.0.0 - STU2
Clinical Practice Guidelines
2.0.0 - STU2
This page is part of the Clinical Guidelines (v2.0.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-holdtask | Version: 2.0.0 | |||
| Active as of 2024-11-26 | Computable Name: CPGHoldTask | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.42.70 | ||||
Recommendation to hold an activity that is currently in progress as part of the delivery of a computable clinical practice guideline
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CPGTask
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Task |
C | 0..* | CPGTask | 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 |
  Slices for extension |
Content/Rules for all slices | |||
   rationale |
S | 0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale |
| pertinent |
S | 0..* | Reference() | CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent |
 rating |
S | 0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating |
 Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| modifierExtension:doNotPerform |
?!S | 0..1 | DoNotPerform(5.1.0) | true if request is prohibiting action |
 identifier |
S | 0..* | Identifier | Task Instance Identifier |
| instantiatesCanonical |
SΣ | 0..1 | canonical(ActivityDefinition) | Source |
 basedOn |
SΣ | 0..* | Reference(Resource) | Request fulfilled by this 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. |
| intent |
SΣ | 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 |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. |
| code |
SΣ | 0..1 | CodeableConcept | Task Type Binding: CPG Activity Type Value Set (extensible): Activity types for use in computable guidelines 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/uv/cpg/CodeSystem/cpg-activity-type-cs | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: hold-activity | |
| description |
SΣ | 0..1 | string | Human-readable explanation of task |
| focus |
SΣ | 1..1 | Reference(CPG Communication Request | CPG Communication | CPG Questionnaire Task | CPG Questionnaire Response | CPG Medication Request | CPG Medication Dispense | CPG Medication Administration | CPG Medication Statement | CPG Dispense Medication Task | CPG Administer Medication Task | CPG Document Medication Task | CPG Immunization Request | CPG Immunization | CPG Service Request | CPG Procedure | CPG Observation | CPG Enrollment Task | CPG Generate Report Task | CPG Propose Diagnosis Task | CPG Record Detected Issue Task | CPG Record Inference Task | CPG Report Flag Task) | What task is acting on |
| for |
SΣ | 0..1 | Reference(CPG Patient) | Beneficiary of the Task |
| encounter |
SΣ | 0..1 | Reference(CPG Encounter) | Healthcare event during which this task originated |
| executionPeriod |
SΣ | 0..1 | Period | Start and end time of execution |
| authoredOn |
SC | 0..1 | dateTime | Task Creation Date |
| 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] |
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.status | required | TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1from the FHIR Standard | |
| Task.statusReason | example | ||
| Task.intent | required | TaskIntenthttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | |
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| Task.code | extensible | Pattern: hold-activityhttp://hl7.org/fhir/uv/cpg/ValueSet/cpg-activity-type-vsfrom this IG | |
| Task.output.type | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If 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-4 | error | Task | If 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-5 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | CPGTask | 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 | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rationale |
S | 0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | ||||
| pertinent |
S | 0..* | Reference() | CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent | ||||
| rating |
S | 0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating | ||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:doNotPerform |
?!S | 0..1 | DoNotPerform(5.1.0) | true if request is prohibiting action | ||||
| identifier |
S | 0..* | Identifier | Task Instance Identifier | ||||
| instantiatesCanonical |
SΣ | 0..1 | canonical(ActivityDefinition) | Source | ||||
| instantiatesUri |
Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn |
SΣ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| partOf |
Σ | 0..* | Reference(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. | ||||
| businessStatus |
Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| intent |
SΣ | 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 |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | ||||
| code |
SΣ | 0..1 | CodeableConcept | Task Type Binding: CPG Activity Type Value Set (extensible): Activity types for use in computable guidelines 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/uv/cpg/CodeSystem/cpg-activity-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: hold-activity | |||||
| 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 |
SΣ | 0..1 | string | Human-readable explanation of task | ||||
| focus |
SΣ | 1..1 | Reference(CPG Communication Request | CPG Communication | CPG Questionnaire Task | CPG Questionnaire Response | CPG Medication Request | CPG Medication Dispense | CPG Medication Administration | CPG Medication Statement | CPG Dispense Medication Task | CPG Administer Medication Task | CPG Document Medication Task | CPG Immunization Request | CPG Immunization | CPG Service Request | CPG Procedure | CPG Observation | CPG Enrollment Task | CPG Generate Report Task | CPG Propose Diagnosis Task | CPG Record Detected Issue Task | CPG Record Inference Task | CPG Report Flag Task) | What task is acting on | ||||
| for |
SΣ | 0..1 | Reference(CPG Patient) | Beneficiary of the Task | ||||
| encounter |
SΣ | 0..1 | Reference(CPG Encounter) | Healthcare event during which this task originated | ||||
| executionPeriod |
SΣ | 0..1 | Period | Start and end time of execution | ||||
| authoredOn |
SC | 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 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 |
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] |
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/languagesfrom the FHIR Standard | ||||
| Task.status | required | TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1from the FHIR Standard | ||||
| Task.statusReason | example | |||||
| Task.businessStatus | example | |||||
| Task.intent | required | TaskIntenthttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | ||||
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| Task.code | extensible | Pattern: hold-activityhttp://hl7.org/fhir/uv/cpg/ValueSet/cpg-activity-type-vsfrom this IG | ||||
| Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| Task.reasonCode | example | |||||
| Task.input.type | example | |||||
| Task.output.type | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If 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-4 | error | Task | If 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-5 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
This structure is derived from CPGTask
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from CPGTask
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task |
C | 0..* | CPGTask | 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 |
| Slices for extension |
Content/Rules for all slices | |||
| rationale |
S | 0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale |
| pertinent |
S | 0..* | Reference() | CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent |
| rating |
S | 0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating |
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| modifierExtension:doNotPerform |
?!S | 0..1 | DoNotPerform(5.1.0) | true if request is prohibiting action |
| identifier |
S | 0..* | Identifier | Task Instance Identifier |
| instantiatesCanonical |
SΣ | 0..1 | canonical(ActivityDefinition) | Source |
| basedOn |
SΣ | 0..* | Reference(Resource) | Request fulfilled by this 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. |
| intent |
SΣ | 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 |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. |
| code |
SΣ | 0..1 | CodeableConcept | Task Type Binding: CPG Activity Type Value Set (extensible): Activity types for use in computable guidelines 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/uv/cpg/CodeSystem/cpg-activity-type-cs | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: hold-activity | |
| description |
SΣ | 0..1 | string | Human-readable explanation of task |
| focus |
SΣ | 1..1 | Reference(CPG Communication Request | CPG Communication | CPG Questionnaire Task | CPG Questionnaire Response | CPG Medication Request | CPG Medication Dispense | CPG Medication Administration | CPG Medication Statement | CPG Dispense Medication Task | CPG Administer Medication Task | CPG Document Medication Task | CPG Immunization Request | CPG Immunization | CPG Service Request | CPG Procedure | CPG Observation | CPG Enrollment Task | CPG Generate Report Task | CPG Propose Diagnosis Task | CPG Record Detected Issue Task | CPG Record Inference Task | CPG Report Flag Task) | What task is acting on |
| for |
SΣ | 0..1 | Reference(CPG Patient) | Beneficiary of the Task |
| encounter |
SΣ | 0..1 | Reference(CPG Encounter) | Healthcare event during which this task originated |
| executionPeriod |
SΣ | 0..1 | Period | Start and end time of execution |
| authoredOn |
SC | 0..1 | dateTime | Task Creation Date |
| 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] |
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.status | required | TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1from the FHIR Standard | |
| Task.statusReason | example | ||
| Task.intent | required | TaskIntenthttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | |
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| Task.code | extensible | Pattern: hold-activityhttp://hl7.org/fhir/uv/cpg/ValueSet/cpg-activity-type-vsfrom this IG | |
| Task.output.type | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If 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-4 | error | Task | If 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-5 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | CPGTask | 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| rationale |
S | 0..1 | markdown | CPG Rationale Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale | ||||
| pertinent |
S | 0..* | Reference() | CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent | ||||
| rating |
S | 0..1 | Quantity, Range, Ratio | CPG Rating Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rating | ||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modifierExtension:doNotPerform |
?!S | 0..1 | DoNotPerform(5.1.0) | true if request is prohibiting action | ||||
| identifier |
S | 0..* | Identifier | Task Instance Identifier | ||||
| instantiatesCanonical |
SΣ | 0..1 | canonical(ActivityDefinition) | Source | ||||
| instantiatesUri |
Σ | 0..1 | uri | Formal definition of task | ||||
| basedOn |
SΣ | 0..* | Reference(Resource) | Request fulfilled by this task | ||||
| groupIdentifier |
Σ | 0..1 | Identifier | Requisition or grouper id | ||||
| partOf |
Σ | 0..* | Reference(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. | ||||
| businessStatus |
Σ | 0..1 | CodeableConcept | E.g. "Specimen collected", "IV prepped" Binding Description (No ValueSet): (example): The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. | ||||
| intent |
SΣ | 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 |
S | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority. | ||||
| code |
SΣ | 0..1 | CodeableConcept | Task Type Binding: CPG Activity Type Value Set (extensible): Activity types for use in computable guidelines 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/uv/cpg/CodeSystem/cpg-activity-type-cs | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: hold-activity | |||||
| 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 |
SΣ | 0..1 | string | Human-readable explanation of task | ||||
| focus |
SΣ | 1..1 | Reference(CPG Communication Request | CPG Communication | CPG Questionnaire Task | CPG Questionnaire Response | CPG Medication Request | CPG Medication Dispense | CPG Medication Administration | CPG Medication Statement | CPG Dispense Medication Task | CPG Administer Medication Task | CPG Document Medication Task | CPG Immunization Request | CPG Immunization | CPG Service Request | CPG Procedure | CPG Observation | CPG Enrollment Task | CPG Generate Report Task | CPG Propose Diagnosis Task | CPG Record Detected Issue Task | CPG Record Inference Task | CPG Report Flag Task) | What task is acting on | ||||
| for |
SΣ | 0..1 | Reference(CPG Patient) | Beneficiary of the Task | ||||
| encounter |
SΣ | 0..1 | Reference(CPG Encounter) | Healthcare event during which this task originated | ||||
| executionPeriod |
SΣ | 0..1 | Period | Start and end time of execution | ||||
| authoredOn |
SC | 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 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 |
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] |
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/languagesfrom the FHIR Standard | ||||
| Task.status | required | TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1from the FHIR Standard | ||||
| Task.statusReason | example | |||||
| Task.businessStatus | example | |||||
| Task.intent | required | TaskIntenthttp://hl7.org/fhir/ValueSet/task-intent|4.0.1from the FHIR Standard | ||||
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | ||||
| Task.code | extensible | Pattern: hold-activityhttp://hl7.org/fhir/uv/cpg/ValueSet/cpg-activity-type-vsfrom this IG | ||||
| Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-rolefrom the FHIR Standard | ||||
| Task.reasonCode | example | |||||
| Task.input.type | example | |||||
| Task.output.type | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Task | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Task | If 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-4 | error | Task | If 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-5 | error | Task | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Task | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| inv-1 | error | Task | Last modified date must be greater than or equal to authored-on date. : lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn |
This structure is derived from CPGTask
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.cpg#2.0.0 based on FHIR 4.0.1. Generated 2024-11-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
