API for the Exchange of Medicinal Product Information (APIX)
0.1.0 - ci-build International flag

API for the Exchange of Medicinal Product Information (APIX), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/APIX---API-Exchange-for-Medicinal-Products/ and changes regularly. See the Directory of published versions

Resource Profile: APIXTask - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the apix-task 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
Must Supportfalse
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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)
tsk-1: Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. (restriction.exists() implies code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists())
statusreason-conditional-require: A status reason is required when the status is rejected or cancelled. (((status = 'rejected') or (status = 'cancelled')) implies statusReason.exists())
2. 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
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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.

Control10..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()))
6. Task.meta.lastUpdated
Definition

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

ShortAutomatically updated on every changeWhen the resource version last changed
Comments

This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. 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()))
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 its 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 its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
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.

ShortHuman-readable narrativeText summary of the resource, for human interpretation
Comments

Contained resources do not have a 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.

Control10..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supporttrue
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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. 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 managable, 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
Must Supportfalse
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
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())
16. Task.identifier
Definition

The business identifier for this task.

ShortTask instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as wellTask Instance Identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
TypeIdentifier
Is Modifierfalse
Must Supporttrue
Summaryfalse
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.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ type
  • value @ system
  • 18. Task.identifier:TaskInstance
    Slice NameTaskInstance
    Definition

    The business identifier for this task.

    ShortTechnical UUID for this specific Task instanceTask Instance Identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control10..1*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    identifier-is-uuid: Identifier value must be a urn:uuid (value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'))
    20. Task.identifier:TaskInstance.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
    (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

    ShortDescription of identifier
    Comments

    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

    Control10..1
    BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0
    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

    A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    Allows users to make use of identifiers when the identifier system is not known.

    Pattern Value{
      "coding" : [{
        "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code" : "RI",
        "display" : "Resource identifier"
      }]
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Task.identifier:RegulatorProcedureNumber
    Slice NameRegulatorProcedureNumber
    Definition

    The business identifier for this task.

    ShortOfficial regulator procedure/submission number (EMA, FDA, PMDA, etc.)Task Instance Identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. Task.identifier:RegulatorProcedureNumber.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
    (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

    Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

    ShortThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

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

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    Pattern Valuehttps://ema.europa.eu/procedure
    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. Task.identifier:RegulatorProcedureNumber.value
    Definition

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortThe actual regulator-assigned procedure number (format varies by authority)The value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Control10..1
    This element is affected by the following invariants: ident-1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    ExampleGeneral: 123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. 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, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.

    ShortReference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).Request fulfilled by this task
    Comments

    Task.basedOn is never the same as Task.focus. Task.basedOn will typically not be present for 'please fulfill' Tasks as a distinct authorization is rarely needed to request fulfillment. If the Task is seeking fulfillment of an order, the order to be fulfilled is always communicated using focus, never basedOn. However, authorization may be needed to perform other types of Task actions. As an example of when both would be present, a Task seeking suspension of a prescription might have a Task.basedOn pointing to the ServiceRequest ordering surgery (which is the driver for suspending the MedicationRequest - which would be the Task.focus).

    Control0..*
    TypeReference(Resource)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Task.groupIdentifier
    Definition

    A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

    ShortParent/Set ID – groups all Tasks in the same regulatory procedureRequisition or grouper id
    Control10..1
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    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()))
    36. 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|5.0.0
    (required to http://hl7.org/fhir/ValueSet/task-status|5.0.0)

    The current status of the task.

    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
    Must Supportfalse
    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()))
    38. Task.statusReason
    Definition

    Required if status is rejected or cancelled. Reason for current status.


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

    ShortRequired if status is rejected or cancelledReason 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
    BindingFor example codes, see TaskStatusReasonhttp://hl7.org/fhir/ValueSet/task-status-reason|5.0.0
    (example to http://hl7.org/fhir/ValueSet/task-status-reason|5.0.0)

    Codes to identify the reason for current status. These will typically be specific to a particular workflow.

    TypeCodeableReference
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Task.businessStatus
    Definition

    Contains business-specific nuances of the business state.

    ShortDetailed regulatory status (e.g., clock-stop)E.g. "Specimen collected", "IV prepped"
    Control0..1
    BindingFor example codes, see APIX Regulatory Business Status
    (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-business-status-vs)

    Detailed regulatory status such as clock-stop


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

    TypeCodeableConcept
    Is Modifierfalse
    Must Supportfalse
    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()))
    42. 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|5.0.0
    (required to http://hl7.org/fhir/ValueSet/task-intent|5.0.0)

    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
    Must Supportfalse
    Summarytrue
    Pattern Valueproposal
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. Task.doNotPerform
    Definition

    If true indicates that the Task is asking for the specified action to not occur.

    ShortTrue if Task is prohibiting action
    Comments

    The attributes provided with the Task qualify what is not to be done. For example, if a requestedPeriod is provided, the 'do not' request only applies within the specified time. If a requestedPerformer is specified then the 'do not' request only applies to performers of that type. Qualifiers include: code, subject, occurrence, requestedPerformer and performer.

    In some cases, the Request.code may pre-coordinate prohibition into the requested action. E.g. 'NPO' (nothing by mouth), 'DNR' (do not recussitate). If this happens, doNotPerform SHALL NOT be set to true. I.e. The resource shall not have double negation. (E.g. 'Do not DNR').

    doNotPerform should ONLY be used with Tasks that are tightly bounded in time or process phase. E.g. 'Do not fulfill the midnight dose of medication X tonight due to the early morning scheduled procedure, where the nurse could reasonably check off 'Med X not given at midnight as instructed'. Similarly, a decision support proposal that a patient should not be given a standard intake questionnaire (because the patient is cognitively impaired) would be marked as 'complete' or 'rejected' when the clinician preps the CarePlan or order set after reviewing the decision support results. If there is a need to create a standing order to not do something that can't be satisfied by a single 'non-action', but rather an ongoing refusal to perform the function, MedicationRequest, ServiceRequest or some other form of authorization should be used.

    Control0..1
    Typeboolean
    Is Modifiertrue because If true, this element negates the Task. For example, instead of a request to perform a task, it is a request _not_ to perform a task.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Task.code
    Definition

    Defines the regulatory message type and triggers specific business rules


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

    ShortDefines the regulatory message type and triggers specific business rulesTask Type
    Comments

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

    Control10..1
    This element is affected by the following invariants: tsk-1
    BindingFor example codes, see APIX Submission Typeshttp://hl7.org/fhir/ValueSet/task-code|5.0.0
    (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs)

    Codes to identify what the task involves. These will typically be specific to a particular workflow.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. 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
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. Task.for
    Definition

    Identifies the medicinal product(s) that is the subject of the process, use Group or List FHIR Resource is there are multiple.


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

    ShortIdentifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR ResourceBeneficiary of the Task
    Control0..1
    TypeReference(Resource)
    Is Modifierfalse
    Must Supporttrue
    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()))
    52. 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
    Must Supportfalse
    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()))
    54. Task.requestedPeriod
    Definition

    The period during which the regulatory timeline (e.g., clock start to decision deadline) for the medicinal product procedure or response will be performed.


    Indicates the start and/or end of the period of time when completion of the task is desired to take place.

    ShortRequested period for task fulfilmentWhen the task should be performed
    Comments

    This is typically used when the Task is not seeking fulfillment of a focus Request, as in that case the period would be specified on the Request and/or in the Task.restriction.period. Instead, it is used for stand-alone tasks.

    Control0..1
    TypePeriod
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    56. Task.requestedPeriod.start
    Definition

    The date/time when the regulatory clock starts or the earliest the task may begin.


    The start of the period. The boundary is inclusive.

    ShortClock-start / earliest allowed startStarting time with inclusive boundary
    Comments

    Example: Day 0 of a marketing-authorisation procedure, validation completion date, etc.


    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
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. Task.requestedPeriod.end
    Definition

    The latest date/time by which the task must be completed.


    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.

    ShortDeadline / clock-stop dateEnd time with inclusive boundary, if not ongoing
    Comments

    Example: Day 210 of centralised procedure, response deadline to List of Questions, etc.


    The end 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.

    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
    Must Supporttrue
    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()))
    60. Task.executionPeriod
    Definition

    The actual time period during which the task was performed (e.g., when validation actually started and when it was completed).


    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).

    ShortActual execution periodStart and end time of execution
    Control0..1
    TypePeriod
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    62. Task.executionPeriod.start
    Definition

    The start of the period. The boundary is inclusive.

    ShortActual start timeStarting 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
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. Task.executionPeriod.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.

    ShortActual completion timeEnd time with inclusive boundary, if not ongoing
    Comments

    The end 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.

    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
    Must Supporttrue
    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()))
    66. Task.authoredOn
    Definition

    Starting point for regulatory cycle-time metrics.


    The date and time this task was created.

    ShortDate/time the sender created the TaskTask 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
    Must Supportfalse
    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()))
    68. 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
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    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()))
    70. Task.requester
    Definition

    The person or system that created the Task and wants the work done. In regulatory context: The Regulatory Authority (e.g., FDA/EMA) or a senior manager initiating a submission review.


    The creator of the task.

    ShortOrganization that initiated the taskWho is asking for task to be done
    Control10..1
    TypeReference(APIX Organization, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson)
    Is Modifierfalse
    Must Supporttrue
    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()))
    72. Task.owner
    Definition

    The organization, person or system currently responsible for fulfillng the Task.


    Party responsible for managing task execution.

    ShortThe Organization accountable for fulfilling the Task.Responsible individual
    Comments

    Tasks may be created with an owner not yet identified.

    Control0..1
    TypeReference(APIX Organization, Practitioner, PractitionerRole, Organization, CareTeam, Patient, RelatedPerson)
    Is Modifierfalse
    Must Supporttrue
    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()))
    74. Task.performer
    Definition

    Organization or individual who performed the task. Can be different from the Task.owner.


    The entity who performed the requested task.

    ShortOrganization or individual who performed the taskWho or what performed the task
    Control0..1*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    76. Task.performer.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 managable, 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())
    78. Task.performer.actor
    Definition

    The actor or entity who performed the task.

    ShortWho performed the task
    Control1..1
    TypeReference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, RelatedPerson)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    80. 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
    Must Supportfalse
    Summaryfalse
    Alternate NamesStatus History
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    82. 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
    Comments

    Task.restriction can only be present if the Task is seeking fulfillment of another Request resource, and the restriction identifies what subset of the authorization conveyed by the request is supposed to be fulfilled by this Task. A possible example could be a standing order (the request) covering a significant time period and/or individuals, while the Task seeks fulfillment for only a subset of that time-period and a single individual.

    Control0..01
    This element is affected by the following invariants: tsk-1
    TypeBackboneElement
    Is Modifierfalse
    Must Supportfalse
    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()))
    85. Task.input
    Definition

    Additional information that may be needed for fulfilment of the task in the context of medicinal product regulatory procedures.


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

    ShortInput parameters for the taskInformation used to perform task
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    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()))
    87. 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 managable, 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())
    89. Task.input.type
    Definition

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

    ShortInput type indicates the type of input, such as the code used as a DocumentReference typeLabel 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
    BindingFor example codes, see APIX CTD/eCTD Section Code System
    (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-ctd-section-vs)

    Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    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()))
    91. 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, 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
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    93. Task.output
    Definition

    Outputs produced by the task in the context of medicinal product regulatory procedures.


    Outputs produced by the Task.

    ShortOutput produced by the taskInformation 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()))
    95. 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 managable, 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())
    97. Task.output.type
    Definition

    The name of the Output parameter.

    ShortOutput type indicates the type of output, such as the code used as a DocumentReference typeLabel for output
    Control1..1
    BindingFor example codes, see APIX CTD/eCTD Section Code System
    (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-ctd-section-vs)

    Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    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()))
    99. 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, 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
    Must Supportfalse
    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
    Invariantsstatusreason-conditional-require: A status reason is required when the status is rejected or cancelled. (((status = 'rejected') or (status = 'cancelled')) implies statusReason.exists())
    2. Task.meta
    Control1..?
    4. Task.meta.versionId
    Control1..?
    6. Task.meta.lastUpdated
    ShortAutomatically updated on every change
    8. Task.text
    ShortHuman-readable narrative
    Control1..?
    Must Supporttrue
    10. Task.identifier
    ShortTask instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..?
    Must Supporttrue
    SlicingThis element introduces a set of slices on Task.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ type
    • value @ system
    • 12. Task.identifier:TaskInstance
      Slice NameTaskInstance
      ShortTechnical UUID for this specific Task instance
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..1
      Must Supporttrue
      Invariantsidentifier-is-uuid: Identifier value must be a urn:uuid (value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'))
      14. Task.identifier:TaskInstance.type
      Control1..?
      Pattern Value{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
          "code" : "RI",
          "display" : "Resource identifier"
        }]
      }
      16. Task.identifier:RegulatorProcedureNumber
      Slice NameRegulatorProcedureNumber
      ShortOfficial regulator procedure/submission number (EMA, FDA, PMDA, etc.)
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      Must Supporttrue
      18. Task.identifier:RegulatorProcedureNumber.system
      Control1..?
      Pattern Valuehttps://ema.europa.eu/procedure
      20. Task.identifier:RegulatorProcedureNumber.value
      ShortThe actual regulator-assigned procedure number (format varies by authority)
      Control1..?
      22. Task.basedOn
      ShortReference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
      Must Supporttrue
      24. Task.groupIdentifier
      ShortParent/Set ID – groups all Tasks in the same regulatory procedure
      Control1..?
      Must Supporttrue
      26. Task.statusReason
      Definition

      Required if status is rejected or cancelled. Reason for current status.

      ShortRequired if status is rejected or cancelled
      28. Task.businessStatus
      ShortDetailed regulatory status (e.g., clock-stop)
      BindingFor example codes, see APIX Regulatory Business Status
      (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-business-status-vs)

      Detailed regulatory status such as clock-stop

      30. Task.intent
      Pattern Valueproposal
      32. Task.code
      Definition

      Defines the regulatory message type and triggers specific business rules

      ShortDefines the regulatory message type and triggers specific business rules
      Control1..?
      BindingFor example codes, see APIX Submission Types
      (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs)

      Codes to identify what the task involves. These will typically be specific to a particular workflow.

      Must Supporttrue
      34. Task.description
      Control0..0
      36. Task.for
      Definition

      Identifies the medicinal product(s) that is the subject of the process, use Group or List FHIR Resource is there are multiple.

      ShortIdentifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
      Must Supporttrue
      38. Task.encounter
      Control0..0
      40. Task.requestedPeriod
      Definition

      The period during which the regulatory timeline (e.g., clock start to decision deadline) for the medicinal product procedure or response will be performed.

      ShortRequested period for task fulfilment
      Must Supporttrue
      42. Task.requestedPeriod.start
      Definition

      The date/time when the regulatory clock starts or the earliest the task may begin.

      ShortClock-start / earliest allowed start
      Comments

      Example: Day 0 of a marketing-authorisation procedure, validation completion date, etc.

      Must Supporttrue
      44. Task.requestedPeriod.end
      Definition

      The latest date/time by which the task must be completed.

      ShortDeadline / clock-stop date
      Comments

      Example: Day 210 of centralised procedure, response deadline to List of Questions, etc.

      Must Supporttrue
      46. Task.executionPeriod
      Definition

      The actual time period during which the task was performed (e.g., when validation actually started and when it was completed).

      ShortActual execution period
      Must Supporttrue
      48. Task.executionPeriod.start
      ShortActual start time
      Must Supporttrue
      50. Task.executionPeriod.end
      ShortActual completion time
      Must Supporttrue
      52. Task.authoredOn
      Definition

      Starting point for regulatory cycle-time metrics.

      ShortDate/time the sender created the Task
      Control1..?
      54. Task.lastModified
      Control1..?
      56. Task.requester
      Definition

      The person or system that created the Task and wants the work done. In regulatory context: The Regulatory Authority (e.g., FDA/EMA) or a senior manager initiating a submission review.

      ShortOrganization that initiated the task
      Control1..?
      TypeReference(APIX Organization)
      Must Supporttrue
      58. Task.owner
      Definition

      The organization, person or system currently responsible for fulfillng the Task.

      ShortThe Organization accountable for fulfilling the Task.
      TypeReference(APIX Organization)
      Must Supporttrue
      60. Task.performer
      Definition

      Organization or individual who performed the task. Can be different from the Task.owner.

      ShortOrganization or individual who performed the task
      Control0..1
      Must Supporttrue
      62. Task.relevantHistory
      Control0..0
      64. Task.restriction
      Control0..0
      66. Task.input
      Definition

      Additional information that may be needed for fulfilment of the task in the context of medicinal product regulatory procedures.

      ShortInput parameters for the task
      Must Supporttrue
      68. Task.input.type
      ShortInput type indicates the type of input, such as the code used as a DocumentReference type
      BindingFor example codes, see APIX CTD/eCTD Section Code System
      (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-ctd-section-vs)

      Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.

      Must Supporttrue
      70. Task.output
      Definition

      Outputs produced by the task in the context of medicinal product regulatory procedures.

      ShortOutput produced by the task
      Must Supporttrue
      72. Task.output.type
      ShortOutput type indicates the type of output, such as the code used as a DocumentReference type
      BindingFor example codes, see APIX CTD/eCTD Section Code System
      (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-ctd-section-vs)

      Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

      Must Supporttrue

      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
      Must Supportfalse
      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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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)
      tsk-1: Task.restriction is only allowed if the Task is seeking fulfillment and a focus is specified. (restriction.exists() implies code.coding.where(code='fulfill' and system='http://hl7.org/fhir/CodeSystem/task-code').exists() and focus.exists())
      statusreason-conditional-require: A status reason is required when the status is rejected or cancelled. (((status = 'rejected') or (status = 'cancelled')) implies statusReason.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

      Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

      Control0..1
      Typeid
      Is Modifierfalse
      Must Supportfalse
      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
      Control1..1
      TypeMeta
      Is Modifierfalse
      Must Supportfalse
      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
      This element is affected by the following invariants: ele-1
      Typeid
      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 managable, 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.

        Control1..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.

        ShortAutomatically updated on every change
        Comments

        This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. 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

        The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference.

        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.

        Control0..*
        Typecanonical(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 AllSecurityLabels
        (extensible to http://hl7.org/fhir/ValueSet/security-labels|5.0.0)

        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|5.0.0)

        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 its 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 its meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        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 SHALL be taken from AllLanguages
        (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

        IETF language tag for a human language

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        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.

        ShortHuman-readable narrative
        Comments

        Contained resources do not have a 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.

        Control1..1
        This element is affected by the following invariants: dom-6
        TypeNarrative
        Is Modifierfalse
        Must Supporttrue
        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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

        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..*
        This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
        TypeResource
        Is Modifierfalse
        Must Supportfalse
        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 managable, 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
        Must Supportfalse
        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 managable, 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
        Must Supportfalse
        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
        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 UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control1..*
        TypeIdentifier
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        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.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ type
        • value @ system
        • 36. Task.identifier:TaskInstance
          Slice NameTaskInstance
          Definition

          The business identifier for this task.

          ShortTechnical UUID for this specific Task instance
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control1..1
          TypeIdentifier
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          identifier-is-uuid: Identifier value must be a urn:uuid (value.matches('^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'))
          38. Task.identifier:TaskInstance.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
          This element is affected by the following invariants: ele-1
          Typeid
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          40. Task.identifier:TaskInstance.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 managable, 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.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 42. Task.identifier:TaskInstance.use
            Definition

            The purpose of this identifier.

            Shortusual | official | temp | secondary | old (If known)
            Comments

            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

            Control0..1
            BindingThe codes SHALL be taken from IdentifierUse
            (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

            Identifies the purpose for this identifier, if known .

            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

            A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

            ShortDescription of identifier
            Comments

            This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

            Control1..1
            BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
            (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

            A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows users to make use of identifiers when the identifier system is not known.

            Pattern Value{
              "coding" : [{
                "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
                "code" : "RI",
                "display" : "Resource identifier"
              }]
            }
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. Task.identifier:TaskInstance.system
            Definition

            Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

            ShortThe namespace for the identifier value
            Comments

            Identifier.system is always case sensitive.

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

            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

            ExampleGeneral: http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. Task.identifier:TaskInstance.value
            Definition

            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

            ShortThe value that is unique
            Comments

            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

            Control0..1
            This element is affected by the following invariants: ident-1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            ExampleGeneral: 123456
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            50. Task.identifier:TaskInstance.period
            Definition

            Time period during which identifier is/was valid for use.

            ShortTime period when id is/was valid for use
            Control0..1
            TypePeriod
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. Task.identifier:TaskInstance.assigner
            Definition

            Organization that issued/manages the identifier.

            ShortOrganization that issued id (may be just text)
            Comments

            The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

            Control0..1
            TypeReference(Organization)
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. Task.identifier:RegulatorProcedureNumber
            Slice NameRegulatorProcedureNumber
            Definition

            The business identifier for this task.

            ShortOfficial regulator procedure/submission number (EMA, FDA, PMDA, etc.)
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            TypeIdentifier
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            56. Task.identifier:RegulatorProcedureNumber.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
            This element is affected by the following invariants: ele-1
            Typeid
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            58. Task.identifier:RegulatorProcedureNumber.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 managable, 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.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 60. Task.identifier:RegulatorProcedureNumber.use
              Definition

              The purpose of this identifier.

              Shortusual | official | temp | secondary | old (If known)
              Comments

              Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

              Control0..1
              BindingThe codes SHALL be taken from IdentifierUse
              (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

              Identifies the purpose for this identifier, if known .

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

              A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

              ShortDescription of identifier
              Comments

              This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
              (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

              A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

              TypeCodeableConcept
              Is Modifierfalse
              Summarytrue
              Requirements

              Allows users to make use of identifiers when the identifier system is not known.

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

              Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

              ShortThe namespace for the identifier value
              Comments

              Identifier.system is always case sensitive.

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

              There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

              Pattern Valuehttps://ema.europa.eu/procedure
              ExampleGeneral: http://www.acme.com/identifiers/patient
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              66. Task.identifier:RegulatorProcedureNumber.value
              Definition

              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

              ShortThe actual regulator-assigned procedure number (format varies by authority)
              Comments

              If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

              Control1..1
              This element is affected by the following invariants: ident-1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              ExampleGeneral: 123456
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              68. Task.identifier:RegulatorProcedureNumber.period
              Definition

              Time period during which identifier is/was valid for use.

              ShortTime period when id is/was valid for use
              Control0..1
              TypePeriod
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              70. Task.identifier:RegulatorProcedureNumber.assigner
              Definition

              Organization that issued/manages the identifier.

              ShortOrganization that issued id (may be just text)
              Comments

              The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

              Control0..1
              TypeReference(Organization)
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              72. 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
              Must Supportfalse
              Summarytrue
              Requirements

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

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              74. 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
              Must Supportfalse
              Summarytrue
              Requirements

              Enables a formal definition of how the 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()))
              76. 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, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by focus. For example, based on a CarePlan (= basedOn), a task is created to fulfill a ServiceRequest ( = focus ) to collect a specimen from a patient.

              ShortReference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
              Comments

              Task.basedOn is never the same as Task.focus. Task.basedOn will typically not be present for 'please fulfill' Tasks as a distinct authorization is rarely needed to request fulfillment. If the Task is seeking fulfillment of an order, the order to be fulfilled is always communicated using focus, never basedOn. However, authorization may be needed to perform other types of Task actions. As an example of when both would be present, a Task seeking suspension of a prescription might have a Task.basedOn pointing to the ServiceRequest ordering surgery (which is the driver for suspending the MedicationRequest - which would be the Task.focus).

              Control0..*
              TypeReference(Resource)
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              78. Task.groupIdentifier
              Definition

              A shared identifier common to multiple independent Task and Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

              ShortParent/Set ID – groups all Tasks in the same regulatory procedure
              Control1..1
              TypeIdentifier
              Is Modifierfalse
              Must Supporttrue
              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()))
              80. 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
              Must Supportfalse
              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()))
              82. 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|5.0.0)

              The current status of the task.

              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
              Must Supportfalse
              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()))
              84. Task.statusReason
              Definition

              Required if status is rejected or cancelled. Reason for current status.

              ShortRequired if status is rejected or cancelled
              Comments

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

              Control0..1
              BindingFor example codes, see TaskStatusReason
              (example to http://hl7.org/fhir/ValueSet/task-status-reason|5.0.0)

              Codes to identify the reason for current status. These will typically be specific to a particular workflow.

              TypeCodeableReference
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              86. Task.businessStatus
              Definition

              Contains business-specific nuances of the business state.

              ShortDetailed regulatory status (e.g., clock-stop)
              Control0..1
              BindingFor example codes, see APIX Regulatory Business Status
              (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-business-status-vs)

              Detailed regulatory status such as clock-stop

              TypeCodeableConcept
              Is Modifierfalse
              Must Supportfalse
              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()))
              88. 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|5.0.0)

              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
              Must Supportfalse
              Summarytrue
              Pattern Valueproposal
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              90. 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|5.0.0)

              The priority of a task (may affect service level applied to the task).

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              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()))
              92. Task.doNotPerform
              Definition

              If true indicates that the Task is asking for the specified action to not occur.

              ShortTrue if Task is prohibiting action
              Comments

              The attributes provided with the Task qualify what is not to be done. For example, if a requestedPeriod is provided, the 'do not' request only applies within the specified time. If a requestedPerformer is specified then the 'do not' request only applies to performers of that type. Qualifiers include: code, subject, occurrence, requestedPerformer and performer.

              In some cases, the Request.code may pre-coordinate prohibition into the requested action. E.g. 'NPO' (nothing by mouth), 'DNR' (do not recussitate). If this happens, doNotPerform SHALL NOT be set to true. I.e. The resource shall not have double negation. (E.g. 'Do not DNR').

              doNotPerform should ONLY be used with Tasks that are tightly bounded in time or process phase. E.g. 'Do not fulfill the midnight dose of medication X tonight due to the early morning scheduled procedure, where the nurse could reasonably check off 'Med X not given at midnight as instructed'. Similarly, a decision support proposal that a patient should not be given a standard intake questionnaire (because the patient is cognitively impaired) would be marked as 'complete' or 'rejected' when the clinician preps the CarePlan or order set after reviewing the decision support results. If there is a need to create a standing order to not do something that can't be satisfied by a single 'non-action', but rather an ongoing refusal to perform the function, MedicationRequest, ServiceRequest or some other form of authorization should be used.

              Control0..1
              Typeboolean
              Is Modifiertrue because If true, this element negates the Task. For example, instead of a request to perform a task, it is a request _not_ to perform a task.
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              94. Task.code
              Definition

              Defines the regulatory message type and triggers specific business rules

              ShortDefines the regulatory message type and triggers specific business rules
              Comments

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

              Control1..1
              This element is affected by the following invariants: tsk-1
              BindingFor example codes, see APIX Submission Types
              (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs)

              Codes to identify what the task involves. These will typically be specific to a particular workflow.

              TypeCodeableConcept
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              96. 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
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              98. Task.focus
              Definition

              The request being fulfilled or the resource being manipulated (changed, suspended, etc.) 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..1
              This element is affected by the following invariants: tsk-1
              TypeReference(Resource)
              Is Modifierfalse
              Must Supportfalse
              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()))
              100. Task.for
              Definition

              Identifies the medicinal product(s) that is the subject of the process, use Group or List FHIR Resource is there are multiple.

              ShortIdentifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
              Control0..1
              TypeReference(Resource)
              Is Modifierfalse
              Must Supporttrue
              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()))
              102. 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
              Must Supportfalse
              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()))
              104. Task.requestedPeriod
              Definition

              The period during which the regulatory timeline (e.g., clock start to decision deadline) for the medicinal product procedure or response will be performed.

              ShortRequested period for task fulfilment
              Comments

              This is typically used when the Task is not seeking fulfillment of a focus Request, as in that case the period would be specified on the Request and/or in the Task.restriction.period. Instead, it is used for stand-alone tasks.

              Control0..1
              TypePeriod
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              106. Task.requestedPeriod.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
              This element is affected by the following invariants: ele-1
              Typeid
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              108. Task.requestedPeriod.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 managable, 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.requestedPeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 110. Task.requestedPeriod.start
                Definition

                The date/time when the regulatory clock starts or the earliest the task may begin.

                ShortClock-start / earliest allowed start
                Comments

                Example: Day 0 of a marketing-authorisation procedure, validation completion date, etc.

                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
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                112. Task.requestedPeriod.end
                Definition

                The latest date/time by which the task must be completed.

                ShortDeadline / clock-stop date
                Comments

                Example: Day 210 of centralised procedure, response deadline to List of Questions, etc.

                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
                Must Supporttrue
                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()))
                114. Task.executionPeriod
                Definition

                The actual time period during which the task was performed (e.g., when validation actually started and when it was completed).

                ShortActual execution period
                Control0..1
                TypePeriod
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                116. Task.executionPeriod.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
                This element is affected by the following invariants: ele-1
                Typeid
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                118. Task.executionPeriod.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 managable, 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.executionPeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 120. Task.executionPeriod.start
                  Definition

                  The start of the period. The boundary is inclusive.

                  ShortActual start time
                  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
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  122. Task.executionPeriod.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.

                  ShortActual completion time
                  Comments

                  The end 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.

                  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
                  Must Supporttrue
                  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()))
                  124. Task.authoredOn
                  Definition

                  Starting point for regulatory cycle-time metrics.

                  ShortDate/time the sender created the Task
                  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
                  Must Supportfalse
                  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()))
                  126. 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
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Must Supportfalse
                  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()))
                  128. Task.requester
                  Definition

                  The person or system that created the Task and wants the work done. In regulatory context: The Regulatory Authority (e.g., FDA/EMA) or a senior manager initiating a submission review.

                  ShortOrganization that initiated the task
                  Control1..1
                  TypeReference(APIX Organization)
                  Is Modifierfalse
                  Must Supporttrue
                  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()))
                  130. Task.requestedPerformer
                  Definition

                  The kind of participant or specific participant that should perform the task.

                  ShortWho should perform Task
                  Control0..*
                  BindingThe codes SHOULD be taken from ProcedurePerformerRoleCodes
                  (preferred to http://hl7.org/fhir/ValueSet/performer-role|5.0.0)

                  The type(s) of task performers allowed.

                  TypeCodeableReference(Practitioner, PractitionerRole, Organization, CareTeam, HealthcareService, Patient, Device, RelatedPerson)
                  Is Modifierfalse
                  Must Supportfalse
                  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()))
                  132. Task.owner
                  Definition

                  The organization, person or system currently responsible for fulfillng the Task.

                  ShortThe Organization accountable for fulfilling the Task.
                  Comments

                  Tasks may be created with an owner not yet identified.

                  Control0..1
                  TypeReference(APIX Organization)
                  Is Modifierfalse
                  Must Supporttrue
                  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()))
                  134. Task.performer
                  Definition

                  Organization or individual who performed the task. Can be different from the Task.owner.

                  ShortOrganization or individual who performed the task
                  Control0..1
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  136. Task.performer.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
                  This element is affected by the following invariants: ele-1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  138. Task.performer.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 managable, 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())
                  140. Task.performer.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 managable, 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())
                  142. Task.performer.function
                  Definition

                  A code or description of the performer of the task.

                  ShortType of performance
                  Control0..1
                  Binding

                  Codes to identify types of task performers.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  144. Task.performer.actor
                  Definition

                  The actor or entity who performed the task.

                  ShortWho performed the task
                  Control1..1
                  TypeReference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, RelatedPerson)
                  Is Modifierfalse
                  Must Supportfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  146. Task.location
                  Definition

                  Principal physical location where this task is performed.

                  ShortWhere task occurs
                  Comments

                  This should only be specified when the Task to be/being performed happens or is expected to happen primarily within the bounds of a single Location. Other locations (e.g. source, destination, etc.) would either be reflected on the 'basedOn' Request or be conveyed as distinct Task.input values.

                  Control0..1
                  TypeReference(Location)
                  Is Modifierfalse
                  Must Supportfalse
                  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()))
                  148. Task.reason
                  Definition

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

                  ShortWhy task is needed
                  Comments

                  This will typically not be present for Tasks with a code of 'please fulfill' as, for those, the reason for action is conveyed on the Request pointed to by Task.focus. Some types of tasks will not need a 'reason'. E.g. a request to discharge a patient can be inferred to be 'because the patient is ready' and this would not need a reason to be stated on the Task.

                  Control0..*
                  Binding

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

                  TypeCodeableReference
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  150. 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
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  152. Task.note
                  Definition

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

                  ShortComments made about the task
                  Control0..*
                  TypeAnnotation
                  Is Modifierfalse
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  154. 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
                  Must Supportfalse
                  Summaryfalse
                  Alternate NamesStatus History
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  156. 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
                  Comments

                  Task.restriction can only be present if the Task is seeking fulfillment of another Request resource, and the restriction identifies what subset of the authorization conveyed by the request is supposed to be fulfilled by this Task. A possible example could be a standing order (the request) covering a significant time period and/or individuals, while the Task seeks fulfillment for only a subset of that time-period and a single individual.

                  Control0..0
                  This element is affected by the following invariants: tsk-1
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supportfalse
                  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()))
                  164. Task.input
                  Definition

                  Additional information that may be needed for fulfilment of the task in the context of medicinal product regulatory procedures.

                  ShortInput parameters for the task
                  Control0..*
                  TypeBackboneElement
                  Is Modifierfalse
                  Must Supporttrue
                  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()))
                  166. 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
                  This element is affected by the following invariants: ele-1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  168. 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 managable, 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())
                  170. 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 managable, 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())
                  172. Task.input.type
                  Definition

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

                  ShortInput type indicates the type of input, such as the code used as a DocumentReference type
                  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
                  BindingFor example codes, see APIX CTD/eCTD Section Code System
                  (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-ctd-section-vs)

                  Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  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()))
                  174. 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, 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
                  Must Supportfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  176. Task.output
                  Definition

                  Outputs produced by the task in the context of medicinal product regulatory procedures.

                  ShortOutput produced by the 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()))
                  178. 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
                  This element is affected by the following invariants: ele-1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  180. 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 managable, 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())
                  182. 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 managable, 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())
                  184. Task.output.type
                  Definition

                  The name of the Output parameter.

                  ShortOutput type indicates the type of output, such as the code used as a DocumentReference type
                  Control1..1
                  BindingFor example codes, see APIX CTD/eCTD Section Code System
                  (example to http://hl7.org/fhir/uv/apix/ValueSet/apix-ctd-section-vs)

                  Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  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()))
                  186. 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, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, 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
                  Must Supportfalse
                  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()))