Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: OHH CarePlan Task
| Official URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/ohh-care-plan-task | Version: 0.1.0 | |||
| Active as of 2026-10-27 | Computable Name: OhhCarePlanTask | |||
A profile on the Task resource for CarePlan activities.
Usages:
- Refer to this Profile: OHH Create Care Plan Profile
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Task |
C | 0..* | Task | A task to be performed Constraints: register-program-requires-create-user |
  status |
1..1 | code | draft | requested | received | accepted | + Fixed Value: requested (no extensions allowed) | |
| intent |
1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: original-order (no extensions allowed) | |
  Slices for input |
1..* | BackboneElement | Information used to perform task Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   input:createUser |
0..1 | BackboneElement | Information used to perform task | |
  type |
||||
 coding |
1..1 | Coding | Code defined by a terminology system | |
 code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: create-user (extensions allowed) | |
  value[x] |
1..1 | boolean | Content to use in performing the task | |
| input:registerProgram |
0..1 | BackboneElement | Information used to perform task | |
| type |
||||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: register-program (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
 input:sendInvitationMail |
0..1 | BackboneElement | Information used to perform task | |
| type |
||||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: send-invitation-mail (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| register-program-requires-create-user | error | Task | Cannot use register-program without also enabling create-user |
input.where(type.coding.where(code = 'register-program').exists()).empty() or input.where(type.coding.where(code = 'create-user').exists()).value.allTrue()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Task |
C | 0..* | Task | A task to be performed Constraints: inv-1, register-program-requires-create-user |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: requested (no extensions allowed) | |
| 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. Fixed Value: original-order (no extensions allowed) | |
| Slices for input |
1..* | BackboneElement | Information used to perform task Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| input:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 type |
1..1 | CodeableConcept | Label for the input Binding Description: (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 | |||
| input:createUser |
0..1 | BackboneElement | Information used to perform task | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (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. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: create-user (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| input:registerProgram |
0..1 | BackboneElement | Information used to perform task | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (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. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: register-program (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| input:sendInvitationMail |
0..1 | BackboneElement | Information used to perform task | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (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. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: send-invitation-mail (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Task.status | Base | required | TaskStatus | 📍4.0.1 | FHIR Std. |
| Task.intent | Base | required | TaskIntent | 📍4.0.1 | FHIR Std. |
| Task.input.type | Base | example | Not State | Unknown | |
| Task.input:createUser.type | Base | example | Not State | Unknown | |
| Task.input:registerProgram.type | Base | example | Not State | Unknown | |
| Task.input:sendInvitationMail.type | Base | example | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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
|
| register-program-requires-create-user | error | Task | Cannot use register-program without also enabling create-user |
input.where(type.coding.where(code = 'register-program').exists()).empty() or input.where(type.coding.where(code = 'create-user').exists()).value.allTrue()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | Task | A task to be performed Constraints: inv-1, register-program-requires-create-user | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | 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. Fixed Value: requested (no extensions allowed) | |||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding Description: (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: (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. Fixed Value: original-order (no extensions allowed) | |||||
| 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 Description: (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? | |||||
| Slices for input |
1..* | BackboneElement | Information used to perform task Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| input:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (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 | |||||||
| input:createUser |
0..1 | 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: (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. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: create-user (extensions allowed) | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| value[x] |
1..1 | boolean | Content to use in performing the task | |||||
| input:registerProgram |
0..1 | 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: (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. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: register-program (extensions allowed) | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| value[x] |
1..1 | boolean | Content to use in performing the task | |||||
| input:sendInvitationMail |
0..1 | 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: (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. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: send-invitation-mail (extensions allowed) | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| value[x] |
1..1 | boolean | Content to use in performing the task | |||||
| 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 Description: (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 | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Task.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Task.status | Base | required | TaskStatus | 📍4.0.1 | FHIR Std. |
| Task.statusReason | Base | example | Not State | Unknown | |
| Task.businessStatus | Base | example | Not State | Unknown | |
| Task.intent | Base | required | TaskIntent | 📍4.0.1 | FHIR Std. |
| Task.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Task.code | Base | example | Task Codes | 📍4.0.1 | FHIR Std. |
| Task.performerType | Base | preferred | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| Task.reasonCode | Base | example | Not State | Unknown | |
| Task.input.type | Base | example | Not State | Unknown | |
| Task.input:createUser.type | Base | example | Not State | Unknown | |
| Task.input:registerProgram.type | Base | example | Not State | Unknown | |
| Task.input:sendInvitationMail.type | Base | example | Not State | Unknown | |
| Task.output.type | Base | example | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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
|
| register-program-requires-create-user | error | Task | Cannot use register-program without also enabling create-user |
input.where(type.coding.where(code = 'register-program').exists()).empty() or input.where(type.coding.where(code = 'create-user').exists()).value.allTrue()
|
Differential View
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Task |
C | 0..* | Task | A task to be performed Constraints: register-program-requires-create-user |
| status |
1..1 | code | draft | requested | received | accepted | + Fixed Value: requested (no extensions allowed) | |
| intent |
1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: original-order (no extensions allowed) | |
| Slices for input |
1..* | BackboneElement | Information used to perform task Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| input:createUser |
0..1 | BackboneElement | Information used to perform task | |
| type |
||||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: create-user (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| input:registerProgram |
0..1 | BackboneElement | Information used to perform task | |
| type |
||||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: register-program (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| input:sendInvitationMail |
0..1 | BackboneElement | Information used to perform task | |
| type |
||||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: send-invitation-mail (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| Documentation for this format | ||||
Constraints
| Id | Grade | Path(s) | Description | Expression |
| register-program-requires-create-user | error | Task | Cannot use register-program without also enabling create-user |
input.where(type.coding.where(code = 'register-program').exists()).empty() or input.where(type.coding.where(code = 'create-user').exists()).value.allTrue()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Task |
C | 0..* | Task | A task to be performed Constraints: inv-1, register-program-requires-create-user |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| status |
1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: requested (no extensions allowed) | |
| 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. Fixed Value: original-order (no extensions allowed) | |
| Slices for input |
1..* | BackboneElement | Information used to perform task Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| input:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (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 | |||
| input:createUser |
0..1 | BackboneElement | Information used to perform task | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (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. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: create-user (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| input:registerProgram |
0..1 | BackboneElement | Information used to perform task | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (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. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: register-program (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| input:sendInvitationMail |
0..1 | BackboneElement | Information used to perform task | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (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. | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: send-invitation-mail (extensions allowed) | |
| value[x] |
1..1 | boolean | Content to use in performing the task | |
| Documentation for this format | ||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Task.status | Base | required | TaskStatus | 📍4.0.1 | FHIR Std. |
| Task.intent | Base | required | TaskIntent | 📍4.0.1 | FHIR Std. |
| Task.input.type | Base | example | Not State | Unknown | |
| Task.input:createUser.type | Base | example | Not State | Unknown | |
| Task.input:registerProgram.type | Base | example | Not State | Unknown | |
| Task.input:sendInvitationMail.type | Base | example | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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
|
| register-program-requires-create-user | error | Task | Cannot use register-program without also enabling create-user |
input.where(type.coding.where(code = 'register-program').exists()).empty() or input.where(type.coding.where(code = 'create-user').exists()).value.allTrue()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | Task | A task to be performed Constraints: inv-1, register-program-requires-create-user | ||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | 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. Fixed Value: requested (no extensions allowed) | |||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding Description: (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: (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. Fixed Value: original-order (no extensions allowed) | |||||
| 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 Description: (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? | |||||
| Slices for input |
1..* | BackboneElement | Information used to perform task Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| input:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | CodeableConcept | Label for the input Binding Description: (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 | |||||||
| input:createUser |
0..1 | 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: (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. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: create-user (extensions allowed) | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| value[x] |
1..1 | boolean | Content to use in performing the task | |||||
| input:registerProgram |
0..1 | 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: (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. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: register-program (extensions allowed) | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| value[x] |
1..1 | boolean | Content to use in performing the task | |||||
| input:sendInvitationMail |
0..1 | 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: (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. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Required Pattern: send-invitation-mail (extensions allowed) | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| value[x] |
1..1 | boolean | Content to use in performing the task | |||||
| 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 Description: (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 | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Task.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Task.status | Base | required | TaskStatus | 📍4.0.1 | FHIR Std. |
| Task.statusReason | Base | example | Not State | Unknown | |
| Task.businessStatus | Base | example | Not State | Unknown | |
| Task.intent | Base | required | TaskIntent | 📍4.0.1 | FHIR Std. |
| Task.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Task.code | Base | example | Task Codes | 📍4.0.1 | FHIR Std. |
| Task.performerType | Base | preferred | Procedure Performer Role Codes | 📍4.0.1 | FHIR Std. |
| Task.reasonCode | Base | example | Not State | Unknown | |
| Task.input.type | Base | example | Not State | Unknown | |
| Task.input:createUser.type | Base | example | Not State | Unknown | |
| Task.input:registerProgram.type | Base | example | Not State | Unknown | |
| Task.input:sendInvitationMail.type | Base | example | Not State | Unknown | |
| Task.output.type | Base | example | Not State | Unknown |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| 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
|
| register-program-requires-create-user | error | Task | Cannot use register-program without also enabling create-user |
input.where(type.coding.where(code = 'register-program').exists()).empty() or input.where(type.coding.where(code = 'create-user').exists()).value.allTrue()
|
Other representations of profile: CSV, Excel, Schematron