Koppeltaal 2.0 Implementation Guide (Full Documentation)
0.16.5 - ci-build Netherlands flag

Koppeltaal 2.0 Implementation Guide (Full Documentation) - Local Development build (v0.16.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: KT2_DeletePendingTask - Detailed Descriptions

Draft as of 2026-07-09

Definitions for the KT2DeletePendingTask 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)
kt2-dpt-status-reason: statusReason is mandatory when status is on-hold and must be absent for every other status ((status = 'on-hold' implies statusReason.exists()) and (statusReason.exists() implies status = 'on-hold'))
kt2-dpt-delete-flow-marker: The Task must carry the server-owned kt2-delete-flow security label, because that marker is what grants applications access to the deletion flow (meta.security.where(system = 'http://vzvz.nl/fhir/CodeSystem/koppeltaal-security-label' and code = 'kt2-delete-flow').exists())
kt2-dpt-grace-deadline: The grace deadline must lie after the announcement, since the grace period starts at authoredOn (restriction.period.end > authoredOn)
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.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()))
4. Task.extension
Definition

An Extension


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.

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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Task.extension:resource-origin
    Slice Nameresource-origin
    Definition

    Defines the author of the resource.

    ShortExtension
    Comments

    Part of the authorisation model. Upon creation of the resource this extension is set to the device that created it.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device))
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. 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())
    10. 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..01
    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()))
    12. 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..0*
    TypeReference(Resource)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. 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..01
    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()))
    16. Task.status
    Definition

    The current status of the task.

    Shortdraft | requested | received | accepted | +
    Comments

    Native Task lifecycle. The Koppeltaal service sets requested (announcement), cancelled (renewed patient engagement) and completed (deletion executed). The target application only sets on-hold (temporary emergency brake) or accepted (green light); the server validates every transition.

    Control1..1
    BindingThe codes SHALL be taken from Koppeltaal Delete Pending Task Statushttp://hl7.org/fhir/ValueSet/task-status|4.0.1
    (required to http://vzvz.nl/fhir/ValueSet/koppeltaal-delete-pending-task-status)
    Typecode
    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()))
    18. Task.statusReason
    Definition

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

    ShortReason for the emergency brake when `status = on-hold`Reason for current status
    Comments

    Coded, from a closed list; text is closed off so the reason itself is not a free-text field. It must not be used to convey demographics. Set by the target application in the status write to on-hold; the server clears it when on-hold is left. The reason lives on the Task only (per application) and is not carried in the aggregated deletion lifecycle AuditEvents.


    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 Koppeltaal Delete Hold Reason
    (required to http://vzvz.nl/fhir/ValueSet/koppeltaal-delete-hold-reason)
    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. Task.statusReason.coding
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control10..1*
    TypeCoding
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

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

    A representation of the meaning of the code in the system, following the rules of the system.

    ShortHuman-readable description of the emergency-brake reasonRepresentation defined by the system
    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

    ShortPlain text representation of the concept
    Comments

    Very often the text is the same as a displayName of one of the codings.

    Control0..01
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

    Contains business-specific nuances of the business state.

    ShortE.g. "Specimen collected", "IV prepped"
    Control0..01
    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()))
    28. 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
    Fixed Valueorder
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Task.code
    Definition

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

    ShortType of the announcement TaskTask 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 Koppeltaal Task Codehttp://hl7.org/fhir/ValueSet/task-code|4.0.1
    (required to http://vzvz.nl/fhir/ValueSet/koppeltaal-task-code)
    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Pattern Value{
      "coding" : [{
        "system" : "http://vzvz.nl/fhir/CodeSystem/koppeltaal-task-code",
        "code" : "delete-pending"
      }]
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. Task.description
    Definition

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

    ShortHuman-readable explanation of task
    Control0..01
    Typestring
    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()))
    34. 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.).

    Control0..01
    TypeReference(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()))
    36. Task.for
    Definition

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

    ShortThe Patient whose data is scheduled for deletionBeneficiary of the Task
    Control10..1
    TypeReference(KT2_Patient, 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()))
    38. 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..01
    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()))
    40. Task.authoredOn
    Definition

    The date and time this task was created.

    ShortMoment of the announcement; the grace period starts hereTask Creation Date
    Control10..1
    This element is affected by the following invariants: inv-1
    TypedateTime
    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()))
    42. Task.requester
    Definition

    The creator of the task.

    ShortThe Koppeltaal service announcing the deletionWho is asking for task to be done
    Control10..1
    TypeReference(KT2_Device, 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()))
    44. Task.performerType
    Definition

    The kind of participant that should perform the task.

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

    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()))
    46. Task.owner
    Definition

    Individual organization or Device currently responsible for task execution.

    ShortThe target application this announcement is directed atResponsible individual
    Comments

    Always a Device. Never the Patient or a RelatedPerson, because a Task owned by the patient counts as patient engagement and would reset the retention clock.


    Tasks may be created with an owner not yet identified.

    Control10..1
    TypeReference(KT2_Device, 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()))
    48. Task.location
    Definition

    Principal physical location where the this task is performed.

    ShortWhere task occurs
    Control0..01
    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()))
    50. 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.

    Control0..01
    Binding

    Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. 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..01
    TypeReference(Resource)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. Task.insurance
    Definition

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

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

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

    ShortComments made about the task
    Control0..0*
    TypeAnnotation
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. 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..0*
    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()))
    60. 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
    Control10..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()))
    62. 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())
    64. 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.

    Control10..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()))
    66. Task.restriction.period.end
    Definition

    The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

    ShortGrace deadline: the planned moment of definitive deletionEnd time with inclusive boundary, if not ongoing
    Comments

    Server-managed: on a grace reset the Koppeltaal service sets a new deadline; applications never modify this element.


    The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

    Control10..1
    This element is affected by the following invariants: per-1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    68. Task.input
    Definition

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

    ShortInformation used to perform task
    Control0..0*
    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()))
    73. Task.output
    Definition

    Outputs produced by the Task.

    ShortInformation produced as part of task
    Control0..0*
    TypeBackboneElement
    Is Modifierfalse
    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()))

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

    0. Task
    Invariantskt2-dpt-status-reason: statusReason is mandatory when status is on-hold and must be absent for every other status ((status = 'on-hold' implies statusReason.exists()) and (statusReason.exists() implies status = 'on-hold'))
    kt2-dpt-delete-flow-marker: The Task must carry the server-owned kt2-delete-flow security label, because that marker is what grants applications access to the deletion flow (meta.security.where(system = 'http://vzvz.nl/fhir/CodeSystem/koppeltaal-security-label' and code = 'kt2-delete-flow').exists())
    kt2-dpt-grace-deadline: The grace deadline must lie after the announcement, since the grace period starts at authoredOn (restriction.period.end > authoredOn)
    2. Task.extension
    SlicingThis element introduces a set of slices on Task.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Task.extension:resource-origin
      Slice Nameresource-origin
      Control0..1
      TypeExtension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device))
      6. Task.instantiatesUri
      Control0..0
      8. Task.basedOn
      Control0..0
      10. Task.groupIdentifier
      Control0..0
      12. Task.status
      Comments

      Native Task lifecycle. The Koppeltaal service sets requested (announcement), cancelled (renewed patient engagement) and completed (deletion executed). The target application only sets on-hold (temporary emergency brake) or accepted (green light); the server validates every transition.

      BindingThe codes SHALL be taken from Koppeltaal Delete Pending Task Status
      (required to http://vzvz.nl/fhir/ValueSet/koppeltaal-delete-pending-task-status)
      14. Task.statusReason
      ShortReason for the emergency brake when `status = on-hold`
      Comments

      Coded, from a closed list; text is closed off so the reason itself is not a free-text field. It must not be used to convey demographics. Set by the target application in the status write to on-hold; the server clears it when on-hold is left. The reason lives on the Task only (per application) and is not carried in the aggregated deletion lifecycle AuditEvents.

      BindingThe codes SHALL be taken from Koppeltaal Delete Hold Reason
      (required to http://vzvz.nl/fhir/ValueSet/koppeltaal-delete-hold-reason)
      16. Task.statusReason.coding
      Control1..1
      18. Task.statusReason.coding.display
      ShortHuman-readable description of the emergency-brake reason
      20. Task.statusReason.text
      Control0..0
      22. Task.businessStatus
      Control0..0
      24. Task.intent
      Fixed Valueorder
      26. Task.code
      ShortType of the announcement Task
      Control1..?
      BindingThe codes SHALL be taken from Koppeltaal Task Code
      (required to http://vzvz.nl/fhir/ValueSet/koppeltaal-task-code)
      Pattern Value{
        "coding" : [{
          "system" : "http://vzvz.nl/fhir/CodeSystem/koppeltaal-task-code",
          "code" : "delete-pending"
        }]
      }
      28. Task.description
      Control0..0
      30. Task.focus
      Control0..0
      32. Task.for
      ShortThe Patient whose data is scheduled for deletion
      Control1..?
      TypeReference(KT2_Patient)
      34. Task.encounter
      Control0..0
      36. Task.authoredOn
      ShortMoment of the announcement; the grace period starts here
      Control1..?
      38. Task.requester
      ShortThe Koppeltaal service announcing the deletion
      Control1..?
      TypeReference(KT2_Device)
      40. Task.performerType
      Control0..0
      42. Task.owner
      ShortThe target application this announcement is directed at
      Comments

      Always a Device. Never the Patient or a RelatedPerson, because a Task owned by the patient counts as patient engagement and would reset the retention clock.

      Control1..?
      TypeReference(KT2_Device)
      44. Task.location
      Control0..0
      46. Task.reasonCode
      Control0..0
      48. Task.reasonReference
      Control0..0
      50. Task.insurance
      Control0..0
      52. Task.note
      Control0..0
      54. Task.relevantHistory
      Control0..0
      56. Task.restriction
      Control1..?
      58. Task.restriction.period
      Control1..?
      60. Task.restriction.period.end
      ShortGrace deadline: the planned moment of definitive deletion
      Comments

      Server-managed: on a grace reset the Koppeltaal service sets a new deadline; applications never modify this element.

      Control1..?
      62. Task.input
      Control0..0
      64. Task.output
      Control0..0

      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)
      kt2-dpt-status-reason: statusReason is mandatory when status is on-hold and must be absent for every other status ((status = 'on-hold' implies statusReason.exists()) and (statusReason.exists() implies status = 'on-hold'))
      kt2-dpt-delete-flow-marker: The Task must carry the server-owned kt2-delete-flow security label, because that marker is what grants applications access to the deletion flow (meta.security.where(system = 'http://vzvz.nl/fhir/CodeSystem/koppeltaal-security-label' and code = 'kt2-delete-flow').exists())
      kt2-dpt-grace-deadline: The grace deadline must lie after the announcement, since the grace period starts at authoredOn (restriction.period.end > 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.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      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
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. 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()))
      8. 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|4.0.1)

      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()))
      10. 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()))
      12. 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
      14. Task.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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. Task.extension:resource-origin
        Slice Nameresource-origin
        Definition

        Defines the author of the resource.

        ShortExtension
        Comments

        Part of the authorisation model. Upon creation of the resource this extension is set to the device that created it.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(KT2_ResourceOrigin) (Extension Type: Reference(KT2_Device))
        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())
        18. 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())
        20. Task.identifier
        Definition

        The business identifier for this task.

        ShortTask Instance Identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. 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()))
        24. 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..0
        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()))
        26. 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..0
        TypeReference(Resource)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. 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..0
        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()))
        30. 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()))
        32. Task.status
        Definition

        The current status of the task.

        Shortdraft | requested | received | accepted | +
        Comments

        Native Task lifecycle. The Koppeltaal service sets requested (announcement), cancelled (renewed patient engagement) and completed (deletion executed). The target application only sets on-hold (temporary emergency brake) or accepted (green light); the server validates every transition.

        Control1..1
        BindingThe codes SHALL be taken from Koppeltaal Delete Pending Task Status
        (required to http://vzvz.nl/fhir/ValueSet/koppeltaal-delete-pending-task-status)
        Typecode
        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()))
        34. Task.statusReason
        Definition

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

        ShortReason for the emergency brake when `status = on-hold`
        Comments

        Coded, from a closed list; text is closed off so the reason itself is not a free-text field. It must not be used to convey demographics. Set by the target application in the status write to on-hold; the server clears it when on-hold is left. The reason lives on the Task only (per application) and is not carried in the aggregated deletion lifecycle AuditEvents.

        Control0..1
        BindingThe codes SHALL be taken from Koppeltaal Delete Hold Reason
        (required to http://vzvz.nl/fhir/ValueSet/koppeltaal-delete-hold-reason)
        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. Task.statusReason.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
        38. Task.statusReason.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.statusReason.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 40. Task.statusReason.coding
          Definition

          A reference to a code defined by a terminology system.

          ShortCode defined by a terminology system
          Comments

          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

          Control1..1
          TypeCoding
          Is Modifierfalse
          Summarytrue
          Requirements

          Allows for alternative encodings within a code system, and translations to other code systems.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. Task.statusReason.coding.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
          44. Task.statusReason.coding.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.statusReason.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 46. Task.statusReason.coding.system
            Definition

            The identification of the code system that defines the meaning of the symbol in the code.

            ShortIdentity of the terminology system
            Comments

            The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

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

            Need to be unambiguous about the source of the definition of the symbol.

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

            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

            ShortVersion of the system - if relevant
            Comments

            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

            NoteThis is a business version Id, not a resource version Id (see discussion)
            Control0..1
            Typestring
            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()))
            50. Task.statusReason.coding.code
            Definition

            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

            ShortSymbol in syntax defined by the system
            Control0..1
            Typecode
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to refer to a particular code in the system.

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

            A representation of the meaning of the code in the system, following the rules of the system.

            ShortHuman-readable description of the emergency-brake reason
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

            ShortIf this coding was chosen directly by the user
            Comments

            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

            Control0..1
            Typeboolean
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

            ShortPlain text representation of the concept
            Comments

            Very often the text is the same as a displayName of one of the codings.

            Control0..0
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

            Contains business-specific nuances of the business state.

            ShortE.g. "Specimen collected", "IV prepped"
            Control0..0
            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()))
            60. 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
            Fixed Valueorder
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. Task.priority
            Definition

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

            Shortroutine | urgent | asap | stat
            Control0..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
            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
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            64. Task.code
            Definition

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

            ShortType of the announcement Task
            Comments

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

            Control1..1
            BindingThe codes SHALL be taken from Koppeltaal Task Code
            (required to http://vzvz.nl/fhir/ValueSet/koppeltaal-task-code)
            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Pattern Value{
              "coding" : [{
                "system" : "http://vzvz.nl/fhir/CodeSystem/koppeltaal-task-code",
                "code" : "delete-pending"
              }]
            }
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            66. Task.description
            Definition

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

            ShortHuman-readable explanation of task
            Control0..0
            Typestring
            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()))
            68. 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.).

            Control0..0
            TypeReference(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()))
            70. Task.for
            Definition

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

            ShortThe Patient whose data is scheduled for deletion
            Control1..1
            TypeReference(KT2_Patient)
            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()))
            72. 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..0
            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()))
            74. 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()))
            76. Task.authoredOn
            Definition

            The date and time this task was created.

            ShortMoment of the announcement; the grace period starts here
            Control1..1
            This element is affected by the following invariants: inv-1
            TypedateTime
            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()))
            78. Task.lastModified
            Definition

            The date and time of last modification to this task.

            ShortTask Last Modified Date
            Control0..1
            This element is affected by the following invariants: inv-1
            TypedateTime
            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()))
            80. Task.requester
            Definition

            The creator of the task.

            ShortThe Koppeltaal service announcing the deletion
            Control1..1
            TypeReference(KT2_Device)
            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()))
            82. Task.performerType
            Definition

            The kind of participant that should perform the task.

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

            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()))
            84. Task.owner
            Definition

            Individual organization or Device currently responsible for task execution.

            ShortThe target application this announcement is directed at
            Comments

            Always a Device. Never the Patient or a RelatedPerson, because a Task owned by the patient counts as patient engagement and would reset the retention clock.

            Control1..1
            TypeReference(KT2_Device)
            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()))
            86. Task.location
            Definition

            Principal physical location where the this task is performed.

            ShortWhere task occurs
            Control0..0
            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()))
            88. 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.

            Control0..0
            Binding

            Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.

            TypeCodeableConcept
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            90. 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..0
            TypeReference(Resource)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. Task.insurance
            Definition

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

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

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

            ShortComments made about the task
            Control0..0
            TypeAnnotation
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            96. 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..0
            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()))
            98. 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
            Control1..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()))
            100. 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
            102. 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())
            104. 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())
            106. 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()))
            108. 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.

            Control1..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()))
            110. Task.restriction.period.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
            112. Task.restriction.period.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.restriction.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 114. Task.restriction.period.start
              Definition

              The start of the period. The boundary is inclusive.

              ShortStarting time with inclusive boundary
              Comments

              If the low element is missing, the meaning is that the low boundary is not known.

              Control0..1
              This element is affected by the following invariants: per-1
              TypedateTime
              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()))
              116. Task.restriction.period.end
              Definition

              The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

              ShortGrace deadline: the planned moment of definitive deletion
              Comments

              Server-managed: on a grace reset the Koppeltaal service sets a new deadline; applications never modify this element.

              Control1..1
              This element is affected by the following invariants: per-1
              TypedateTime
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              118. 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()))
              120. Task.input
              Definition

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

              ShortInformation used to perform task
              Control0..0
              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()))
              127. Task.output
              Definition

              Outputs produced by the Task.

              ShortInformation produced as part of task
              Control0..0
              TypeBackboneElement
              Is Modifierfalse
              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()))