Healthcare Financial Services IG Edition 1
0.3.0 - STU-Ballot Saudi Arabia flag

Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: NphiesCancelResponse - Detailed Descriptions

Draft as of 2025-07-30

Definitions for the cancel-response resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. Task
Definition

A task to be performed.

ShortA task to be performed
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
inv-1: Last modified date must be greater than or equal to authored-on date. (lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn)
CANRS001: status SHALL be either 'completed' or 'failed'. (status.exists() implies ((status = 'completed') or (status = 'failed')))
CANRQ002: reasonCode SHALL be 'WP', 'NP or 'TAS'. (reasonCode.exists() implies ((reasonCode.coding.first().code = 'WP') or (reasonCode.coding.first().code = 'NP') or (reasonCode.coding.first().code = 'TAS')))
BV-00132: Cancel Response focus.type shall contain Claim, or ClaimResponse (Advanced Authorization) (focus.exists() implies focus.type.exists() implies (focus.type = 'Claim' or focus.type = 'ClaimResponse'))
BV-00241: A cancellation response output type can only be “error”, if the output element is used. (output.exists() implies output.type.coding.where(code='error').exists())
inv-1: Last modified date must be greater than or equal to authored-on date. (lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn)
2. Task.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control10..1
Typeidstring
Is Modifierfalse
Summarytrue
Max Length:64
4. Task.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control10..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Task.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.


A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

ShortProfiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control10..*
Typecanonical(DP_canonical)(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Task.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Task.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Task.identifier
Definition

The business identifier for this task.

ShortTask Instance Identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier(DP_Identifier_A)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Task.status
Definition

The current status of the task.

Shortdraft | requested | received | accepted | +
Control1..1
BindingThe codes SHALL be taken from TaskStatushttp://hl7.org/fhir/ValueSet/task-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/task-status|4.0.1)

The current status of the task.

Typecode(DP_code)
Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Task.statusReason
Definition

An explanation as to why this task is held, failed, was refused, etc.

ShortReason for current status
Comments

This applies to the current status. Look at the history of the task to see reasons for past statuses.

Control0..1
BindingThe codes SHALL be taken from For example codes, see Task Status Reason
(required to http://nphies.sa/terminology/ValueSet/task-status-reason)
TypeCodeableConcept(DP_CodeableConcept)
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Task.intent
Definition

Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.

Shortunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Comments

This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.

In most cases, Tasks will have an intent of "order".

Control1..1
BindingThe codes SHALL be taken from TaskIntenthttp://hl7.org/fhir/ValueSet/task-intent|4.0.1
(required to http://hl7.org/fhir/ValueSet/task-intent|4.0.1)

Distinguishes whether the task is a proposal, plan or full order.

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Pattern Valueorder
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Task.priority
Definition

Indicates how quickly the Task should be addressed with respect to other requests.

Shortroutine | urgent | asap | stat
Control10..1
BindingThe codes SHALL be taken from RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1
(required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

The task's priority.

Typecode(DP_code)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Used to identify the service level expected while performing a task.

Meaning if MissingIf missing, this task should be performed with normal priority
Pattern Valueroutine
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Task.code
Definition

A name or code (or both) briefly describing what the task involves.

ShortTask Type
Comments

The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.

Control10..1
BindingThe codes SHALL be taken from For example codes, see Task Codeshttp://hl7.org/fhir/ValueSet/task-code
(required to http://nphies.sa/terminology/ValueSet/task-code)
TypeCodeableConcept(DP_CodeableConcept)
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Task.description
Definition

A free-text description of what is to be performed.

ShortHuman-readable explanation of task
Control0..1
Typestring(DP_string)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Task.focus
Definition

The request being actioned or the resource being manipulated by this task.

ShortWhat task is acting on
Comments

If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).

Control10..1
TypeReference(DP_Reference_1or3b)(Resource)
Is Modifierfalse
Summarytrue
Requirements

Used to identify the thing to be done.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Task.authoredOn
Definition

The date and time this task was created.

ShortTask Creation Date
Control10..1
This element is affected by the following invariants: inv-1
TypedateTime(DP_dateTime)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Requirements

Most often used along with lastUpdated to track duration of task to supporting monitoring and management.

Alternate NamesCreated Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Task.lastModified
Definition

The date and time of last modification to this task.

ShortTask Last Modified Date
Control10..1
This element is affected by the following invariants: inv-1
TypedateTime(DP_dateTime)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Used along with history to track task activity and time in a particular task state. This enables monitoring and management.

Alternate NamesUpdate Date
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Task.requester
Definition

The creator of the task.

ShortWho is asking for task to be done
Control10..1
TypeReference(DP_Reference_1or2a)(Nphies Organization, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
Is Modifierfalse
Summarytrue
Requirements

Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Task.owner
Definition

Individual organization or Device currently responsible for task execution.

ShortResponsible individual
Comments

Tasks may be created with an owner not yet identified.

Control10..1
TypeReference(DP_Reference_1or2a)(Nphies Organization, Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson)
Is Modifierfalse
Summarytrue
Requirements

Identifies who is expected to perform this task.

Alternate NamesPerformer, Executer
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Task.reasonCode
Definition

A description or code indicating why this task needs to be performed.

ShortWhy task is needed
Comments

This should only be included if there is no focus or if it differs from the reason indicated on the focus.

Control10..1
BindingThe codes SHALL be taken from For example codes, see Task Reason
(required to http://nphies.sa/terminology/ValueSet/task-reason-code)
TypeCodeableConcept(DP_CodeableConcept)
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Task.output
Definition

Outputs produced by the Task.

ShortInformation produced as part of task
Control0..*
TypeBackboneElement
Is Modifierfalse
Must Supporttrue
Summaryfalse
Requirements

Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Task.output. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ type
  • 40. Task.output.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    42. Task.output.type
    Definition

    The name of the Output parameter.

    ShortLabel for output
    Control1..1
    BindingThe codes SHALL be taken from For example codes, see Task Output Type
    (required to http://nphies.sa/terminology/ValueSet/task-output-type)
    TypeCodeableConcept(DP_CodeableConcept)
    Is Modifierfalse
    Summaryfalse
    Requirements

    Outputs are named to enable task automation to bind data and pass it from one task to the next.

    Alternate NamesName
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Task.output.value[x]
    Definition

    The value of the Output parameter as a basic type.

    ShortResult of output
    Control1..1
    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Requirements

    Task outputs can take any form.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Task.output:error
    Slice Nameerror
    Definition

    An error in the request has been detected.


    Outputs produced by the Task.

    ShorterrorInformation produced as part of task
    Control0..1*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Requirements

    Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. Task.output:error.extension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortExtensionAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on Task.output.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 50. Task.output:error.extension:expression
      Slice Nameexpression
      Definition

      Expression for error location as part of error reporting to indicate the location of error.

      ShortError Expression
      Control0..1
      This element is affected by the following invariants: ele-1
      TypeExtension(Error Expression) (Extension Type: string)
      Is Modifierfalse
      Must Supporttrue
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      52. Task.output:error.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      54. Task.output:error.type
      Definition

      The name of the Output parameter.

      ShortLabel for output
      Control1..1
      BindingThe codes SHALL be taken from For example codes, see Task Output Type
      (required to http://nphies.sa/terminology/ValueSet/task-output-type)
      TypeCodeableConcept(DP_CodeableConcept)
      Is Modifierfalse
      Summaryfalse
      Requirements

      Outputs are named to enable task automation to bind data and pass it from one task to the next.

      Alternate NamesName
      Pattern Value{
        "coding" : [{
          "system" : "http://nphies.sa/terminology/CodeSystem/task-output-type",
          "code" : "error"
        }]
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      56. Task.output:error.value[x]
      Definition

      The value of the Output parameter as a basic type.

      ShortResult of output
      Control1..1
      BindingThe codes SHALL be taken from For codes, see Adjudication Error Codes
      (required to http://nphies.sa/terminology/ValueSet/adjudication-error)
      TypeCodeableConcept(DP_CodeableConcept), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Is Modifierfalse
      Summaryfalse
      Requirements

      Task outputs can take any form.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be foundhere

      0. Task
      InvariantsCANRS001: status SHALL be either 'completed' or 'failed'. (status.exists() implies ((status = 'completed') or (status = 'failed')))
      CANRQ002: reasonCode SHALL be 'WP', 'NP or 'TAS'. (reasonCode.exists() implies ((reasonCode.coding.first().code = 'WP') or (reasonCode.coding.first().code = 'NP') or (reasonCode.coding.first().code = 'TAS')))
      BV-00132: Cancel Response focus.type shall contain Claim, or ClaimResponse (Advanced Authorization) (focus.exists() implies focus.type.exists() implies (focus.type = 'Claim' or focus.type = 'ClaimResponse'))
      BV-00241: A cancellation response output type can only be “error”, if the output element is used. (output.exists() implies output.type.coding.where(code='error').exists())
      2. Task.priority
      Pattern Valueroutine
      4. Task.focus
      Control1..?
      6. Task.reasonCode
      Control1..?
      8. Task.output
      Must Supporttrue
      SlicingThis element introduces a set of slices on Task.output. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ type
      • 10. Task.output.type
        BindingThe codes SHALL be taken from Task Output Type
        (required to http://nphies.sa/terminology/ValueSet/task-output-type)
        TypeCodeableConcept(DP_CodeableConcept)
        12. Task.output:error
        Slice Nameerror
        Definition

        An error in the request has been detected.

        Shorterror
        Control0..1
        Must Supporttrue
        14. Task.output:error.extension
        SlicingThis element introduces a set of slices on Task.output.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. Task.output:error.extension:expression
          Slice Nameexpression
          Control0..1
          TypeExtension(Error Expression) (Extension Type: string)
          Must Supporttrue
          18. Task.output:error.type
          Pattern Value{
            "coding" : [{
              "system" : "http://nphies.sa/terminology/CodeSystem/task-output-type",
              "code" : "error"
            }]
          }
          20. Task.output:error.value[x]
          BindingThe codes SHALL be taken from Adjudication Error Codes
          (required to http://nphies.sa/terminology/ValueSet/adjudication-error)
          TypeCodeableConcept(DP_CodeableConcept)
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]

          Guidance on how to interpret the contents of this table can be foundhere

          0. Task
          Definition

          A task to be performed.

          ShortA task to be performed
          Control0..*
          Is Modifierfalse
          Summaryfalse
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          inv-1: Last modified date must be greater than or equal to authored-on date. (lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn)
          CANRS001: status SHALL be either 'completed' or 'failed'. (status.exists() implies ((status = 'completed') or (status = 'failed')))
          CANRQ002: reasonCode SHALL be 'WP', 'NP or 'TAS'. (reasonCode.exists() implies ((reasonCode.coding.first().code = 'WP') or (reasonCode.coding.first().code = 'NP') or (reasonCode.coding.first().code = 'TAS')))
          BV-00132: Cancel Response focus.type shall contain Claim, or ClaimResponse (Advanced Authorization) (focus.exists() implies focus.type.exists() implies (focus.type = 'Claim' or focus.type = 'ClaimResponse'))
          BV-00241: A cancellation response output type can only be “error”, if the output element is used. (output.exists() implies output.type.coding.where(code='error').exists())
          2. Task.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

          Control1..1
          Typeid
          Is Modifierfalse
          Summarytrue
          Max Length:64
          4. Task.meta
          Definition

          The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

          ShortMetadata about the resource
          Control1..1
          TypeMeta
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. Task.meta.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          8. Task.meta.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Task.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 10. Task.meta.versionId
            Definition

            The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

            ShortVersion specific identifier
            Comments

            The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

            Control0..1
            Typeid
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            12. Task.meta.lastUpdated
            Definition

            When the resource last changed - e.g. when the version changed.

            ShortWhen the resource version last changed
            Comments

            This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

            Control0..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            14. Task.meta.source
            Definition

            A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

            ShortIdentifies where the resource comes from
            Comments

            In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

            This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            16. Task.meta.profile
            Definition

            A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

            ShortProfiles this resource claims to conform to
            Comments

            It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

            Control1..*
            Typecanonical(DP_canonical)(StructureDefinition)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            18. Task.meta.security
            Definition

            Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

            ShortSecurity Labels applied to this resource
            Comments

            The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

            Control0..*
            BindingUnless not suitable, these codes SHALL be taken from All Security Labels
            (extensible to http://hl7.org/fhir/ValueSet/security-labels)

            Security Labels from the Healthcare Privacy and Security Classification System.

            TypeCoding
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. Task.meta.tag
            Definition

            Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

            ShortTags applied to this resource
            Comments

            The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

            Control0..*
            BindingFor example codes, see CommonTags
            (example to http://hl7.org/fhir/ValueSet/common-tags)

            Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

            TypeCoding
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            22. Task.implicitRules
            Definition

            A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

            ShortA set of rules under which this content was created
            Comments

            Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

            Control0..1
            Typeuri
            Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            24. Task.language
            Definition

            The base language in which the resource is written.

            ShortLanguage of the resource content
            Comments

            Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

            Control0..1
            BindingThe codes SHOULD be taken from CommonLanguages
            (preferred to http://hl7.org/fhir/ValueSet/languages)

            A human language.

            Additional BindingsPurpose
            AllLanguagesMax Binding
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. Task.text
            Definition

            A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

            ShortText summary of the resource, for human interpretation
            Comments

            Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

            Control0..1
            TypeNarrative
            Is Modifierfalse
            Summaryfalse
            Alternate Namesnarrative, html, xhtml, display
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            28. Task.contained
            Definition

            These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

            ShortContained, inline Resources
            Comments

            This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

            Control0..*
            TypeResource
            Is Modifierfalse
            Summaryfalse
            Alternate Namesinline resources, anonymous resources, contained resources
            30. Task.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            32. Task.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Summaryfalse
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            34. Task.identifier
            Definition

            The business identifier for this task.

            ShortTask Instance Identifier
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control1..*
            TypeIdentifier(DP_Identifier_A)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            36. Task.instantiatesCanonical
            Definition

            The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

            ShortFormal definition of task
            Control0..1
            Typecanonical(ActivityDefinition)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Enables a formal definition of how he task is to be performed, enabling automation.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            38. Task.instantiatesUri
            Definition

            The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.

            ShortFormal definition of task
            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation to be associated with a task), enabling automation.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            40. Task.basedOn
            Definition

            BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.

            ShortRequest fulfilled by this task
            Control0..*
            TypeReference(Resource)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            42. Task.groupIdentifier
            Definition

            An identifier that links together multiple tasks and other requests that were created in the same context.

            ShortRequisition or grouper id
            Control0..1
            TypeIdentifier
            Is Modifierfalse
            Summarytrue
            Requirements

            Billing and/or reporting can be linked to whether multiple requests were created as a single unit.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            44. Task.partOf
            Definition

            Task that this particular task is part of.

            ShortComposite task
            Comments

            This should usually be 0..1.

            Control0..*
            TypeReference(Task)
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. Task.status
            Definition

            The current status of the task.

            Shortdraft | requested | received | accepted | +
            Control1..1
            BindingThe codes SHALL be taken from TaskStatus
            (required to http://hl7.org/fhir/ValueSet/task-status|4.0.1)

            The current status of the task.

            Typecode(DP_code)
            Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. Task.statusReason
            Definition

            An explanation as to why this task is held, failed, was refused, etc.

            ShortReason for current status
            Comments

            This applies to the current status. Look at the history of the task to see reasons for past statuses.

            Control0..1
            BindingThe codes SHALL be taken from Task Status Reason
            (required to http://nphies.sa/terminology/ValueSet/task-status-reason)
            TypeCodeableConcept(DP_CodeableConcept)
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            50. Task.businessStatus
            Definition

            Contains business-specific nuances of the business state.

            ShortE.g. "Specimen collected", "IV prepped"
            Control0..1
            Binding

            The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Requirements

            There's often a need to track substates of a task - this is often variable by specific workflow implementation.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. Task.intent
            Definition

            Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.

            Shortunknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
            Comments

            This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances.

            In most cases, Tasks will have an intent of "order".

            Control1..1
            BindingThe codes SHALL be taken from TaskIntent
            (required to http://hl7.org/fhir/ValueSet/task-intent|4.0.1)

            Distinguishes whether the task is a proposal, plan or full order.

            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Pattern Valueorder
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. Task.priority
            Definition

            Indicates how quickly the Task should be addressed with respect to other requests.

            Shortroutine | urgent | asap | stat
            Control1..1
            BindingThe codes SHALL be taken from RequestPriority
            (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

            The task's priority.

            Typecode(DP_code)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            Used to identify the service level expected while performing a task.

            Meaning if MissingIf missing, this task should be performed with normal priority
            Pattern Valueroutine
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            56. Task.code
            Definition

            A name or code (or both) briefly describing what the task involves.

            ShortTask Type
            Comments

            The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code.

            Control1..1
            BindingThe codes SHALL be taken from Task Codes
            (required to http://nphies.sa/terminology/ValueSet/task-code)
            TypeCodeableConcept(DP_CodeableConcept)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            58. Task.description
            Definition

            A free-text description of what is to be performed.

            ShortHuman-readable explanation of task
            Control0..1
            Typestring(DP_string)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            60. Task.focus
            Definition

            The request being actioned or the resource being manipulated by this task.

            ShortWhat task is acting on
            Comments

            If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.).

            Control1..1
            TypeReference(DP_Reference_1or3b)(Resource)
            Is Modifierfalse
            Summarytrue
            Requirements

            Used to identify the thing to be done.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. Task.for
            Definition

            The entity who benefits from the performance of the service specified in the task (e.g., the patient).

            ShortBeneficiary of the Task
            Control0..1
            TypeReference(Resource)
            Is Modifierfalse
            Summarytrue
            Requirements

            Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control.

            Alternate NamesPatient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            64. Task.encounter
            Definition

            The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.

            ShortHealthcare event during which this task originated
            Control0..1
            TypeReference(Encounter)
            Is Modifierfalse
            Summarytrue
            Requirements

            For some tasks it may be important to know the link between the encounter the task originated within.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            66. Task.executionPeriod
            Definition

            Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).

            ShortStart and end time of execution
            Control0..1
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            68. Task.authoredOn
            Definition

            The date and time this task was created.

            ShortTask Creation Date
            Control1..1
            This element is affected by the following invariants: inv-1
            TypedateTime(DP_dateTime)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            Most often used along with lastUpdated to track duration of task to supporting monitoring and management.

            Alternate NamesCreated Date
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            70. Task.lastModified
            Definition

            The date and time of last modification to this task.

            ShortTask Last Modified Date
            Control1..1
            This element is affected by the following invariants: inv-1
            TypedateTime(DP_dateTime)
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Used along with history to track task activity and time in a particular task state. This enables monitoring and management.

            Alternate NamesUpdate Date
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            72. Task.requester
            Definition

            The creator of the task.

            ShortWho is asking for task to be done
            Control1..1
            TypeReference(DP_Reference_1or2a)(Nphies Organization)
            Is Modifierfalse
            Summarytrue
            Requirements

            Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task).

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            74. Task.performerType
            Definition

            The kind of participant that should perform the task.

            ShortRequested performer
            Control0..*
            BindingThe codes SHOULD be taken from ProcedurePerformerRoleCodes
            (preferred to http://hl7.org/fhir/ValueSet/performer-role)

            The type(s) of task performers allowed.

            TypeCodeableConcept
            Is Modifierfalse
            Summaryfalse
            Requirements

            Use to distinguish tasks on different activity queues.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            76. Task.owner
            Definition

            Individual organization or Device currently responsible for task execution.

            ShortResponsible individual
            Comments

            Tasks may be created with an owner not yet identified.

            Control1..1
            TypeReference(DP_Reference_1or2a)(Nphies Organization)
            Is Modifierfalse
            Summarytrue
            Requirements

            Identifies who is expected to perform this task.

            Alternate NamesPerformer, Executer
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            78. Task.location
            Definition

            Principal physical location where the this task is performed.

            ShortWhere task occurs
            Control0..1
            TypeReference(Location)
            Is Modifierfalse
            Summarytrue
            Requirements

            Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            80. Task.reasonCode
            Definition

            A description or code indicating why this task needs to be performed.

            ShortWhy task is needed
            Comments

            This should only be included if there is no focus or if it differs from the reason indicated on the focus.

            Control1..1
            BindingThe codes SHALL be taken from Task Reason
            (required to http://nphies.sa/terminology/ValueSet/task-reason-code)
            TypeCodeableConcept(DP_CodeableConcept)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            82. Task.reasonReference
            Definition

            A resource reference indicating why this task needs to be performed.

            ShortWhy task is needed
            Comments

            Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in Task.reasonCode if the data is free (uncoded) text.

            Control0..1
            TypeReference(Resource)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. Task.insurance
            Definition

            Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.

            ShortAssociated insurance coverage
            Control0..*
            TypeReference(Coverage, ClaimResponse)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. Task.note
            Definition

            Free-text information captured about the task as it progresses.

            ShortComments made about the task
            Control0..*
            TypeAnnotation
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            88. Task.relevantHistory
            Definition

            Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.

            ShortKey events in history of the Task
            Comments

            This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude.

            Control0..*
            TypeReference(Provenance)
            Is Modifierfalse
            Summaryfalse
            Alternate NamesStatus History
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            90. Task.restriction
            Definition

            If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.

            ShortConstraints on fulfillment tasks
            Control0..1
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Requirements

            Sometimes when fulfillment is sought, you don't want full fulfillment.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. Task.restriction.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            94. Task.restriction.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            96. Task.restriction.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            98. Task.restriction.repetitions
            Definition

            Indicates the number of times the requested action should occur.

            ShortHow many times to repeat
            Control0..1
            TypepositiveInt
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            E.g. order that requests monthly lab tests, fulfillment is sought for 1.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            100. Task.restriction.period
            Definition

            Over what time-period is fulfillment sought.

            ShortWhen fulfillment sought
            Comments

            Note that period.high is the due date representing the time by which the task should be completed.

            Control0..1
            TypePeriod
            Is Modifierfalse
            Summaryfalse
            Requirements

            E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            102. Task.restriction.recipient
            Definition

            For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?

            ShortFor whom is fulfillment sought?
            Control0..*
            TypeReference(Patient, Practitioner, PractitionerRole, RelatedPerson, Group, Organization)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            104. Task.input
            Definition

            Additional information that may be needed in the execution of the task.

            ShortInformation used to perform task
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Summaryfalse
            Requirements

            Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows.

            Alternate NamesSupporting Information
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            106. Task.input.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            108. Task.input.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            110. Task.input.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            112. Task.input.type
            Definition

            A code or description indicating how the input is intended to be used as part of the task execution.

            ShortLabel for the input
            Comments

            If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input.

            Control1..1
            BindingThe codes SHALL be taken from Task Input Type
            (required to http://nphies.sa/terminology/ValueSet/task-input-type)
            TypeCodeableConcept(DP_CodeableConcept)
            Is Modifierfalse
            Summaryfalse
            Requirements

            Inputs are named to enable task automation to bind data and pass it from one task to the next.

            Alternate NamesName
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            114. Task.input.value[x]
            Definition

            The value of the input parameter as a basic type.

            ShortContent to use in performing the task
            Control1..1
            TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            116. Task.output
            Definition

            Outputs produced by the Task.

            ShortInformation produced as part of task
            Control0..*
            TypeBackboneElement
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

            Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on Task.output. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ type
            • 118. Task.output.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              120. Task.output.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              122. Task.output.modifierExtension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

              ShortExtensions that cannot be ignored even if unrecognized
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              Requirements

              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

              Alternate Namesextensions, user content, modifiers
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              124. Task.output.type
              Definition

              The name of the Output parameter.

              ShortLabel for output
              Control1..1
              BindingThe codes SHALL be taken from Task Output Type
              (required to http://nphies.sa/terminology/ValueSet/task-output-type)
              TypeCodeableConcept(DP_CodeableConcept)
              Is Modifierfalse
              Summaryfalse
              Requirements

              Outputs are named to enable task automation to bind data and pass it from one task to the next.

              Alternate NamesName
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              126. Task.output.value[x]
              Definition

              The value of the Output parameter as a basic type.

              ShortResult of output
              Control1..1
              TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Requirements

              Task outputs can take any form.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              128. Task.output:error
              Slice Nameerror
              Definition

              An error in the request has been detected.

              Shorterror
              Control0..1
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Requirements

              Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              130. Task.output:error.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              132. Task.output:error.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Task.output.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 134. Task.output:error.extension:expression
                Slice Nameexpression
                Definition

                Expression for error location as part of error reporting to indicate the location of error.

                ShortError Expression
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(Error Expression) (Extension Type: string)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                136. Task.output:error.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                138. Task.output:error.type
                Definition

                The name of the Output parameter.

                ShortLabel for output
                Control1..1
                BindingThe codes SHALL be taken from Task Output Type
                (required to http://nphies.sa/terminology/ValueSet/task-output-type)
                TypeCodeableConcept(DP_CodeableConcept)
                Is Modifierfalse
                Summaryfalse
                Requirements

                Outputs are named to enable task automation to bind data and pass it from one task to the next.

                Alternate NamesName
                Pattern Value{
                  "coding" : [{
                    "system" : "http://nphies.sa/terminology/CodeSystem/task-output-type",
                    "code" : "error"
                  }]
                }
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                140. Task.output:error.value[x]
                Definition

                The value of the Output parameter as a basic type.

                ShortResult of output
                Control1..1
                BindingThe codes SHALL be taken from Adjudication Error Codes
                (required to http://nphies.sa/terminology/ValueSet/adjudication-error)
                TypeCodeableConcept(DP_CodeableConcept)
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Summaryfalse
                Requirements

                Task outputs can take any form.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))