Regulatory Workflows and Interactions - pharma
0.1.0 - ci-build International flag

Regulatory Workflows and Interactions - pharma, 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: APIX Regulatory Task

Official URL: http://hl7.org/fhir/uv/apix/StructureDefinition/apix-task Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: APIXTask

Task profile for APIX regulatory submission workflows

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1, statusreason-conditional-require
Task.meta This element is included in summaries. 1..1 Meta Metadata about the resource
Task.meta.versionId This element is included in summaries. 1..1 id Version specific identifier
Task.meta.lastUpdated This element is included in summaries. 0..1 instant Automatically updated on every change
Task.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Task.text This element must be supported. 1..1 Narrative Human-readable narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Task.contained 0..* Resource Contained, inline Resources
Task.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Task.Slices for identifier This element must be supported. 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Task.Slices for identifier.identifier:TaskInstance This element must be supported. C 1..* Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
Task.Slices for identifier.identifier:TaskInstance.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Task.Slices for identifier.identifier:TaskInstance.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixtaskinstance",
      "display" : "APIX Task Instance ID"
    }
  ]
}
Task.Slices for identifier.identifier:TaskInstance.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Task.Slices for identifier.identifier:RegulatorProcedureNumber This element must be supported. 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
Task.Slices for identifier.identifier:RegulatorProcedureNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Task.Slices for identifier.identifier:RegulatorProcedureNumber.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixregulatorprocedureno",
      "display" : "APIX Regulator Procedure Number"
    }
  ]
}
Task.Slices for identifier.identifier:RegulatorProcedureNumber.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Task.Slices for identifier.identifier:RegulatorProcedureNumber.value This element is included in summaries. C 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
Task.basedOn This element must be supported. This element is included in summaries. 0..* Reference(Resource) Reference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
Task.groupIdentifier This element must be supported. This element is included in summaries. 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
Task.status This element is a modifier element. This element is included in summaries. 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.
Task.statusReason This element is included in summaries. 0..1 CodeableReference() Required if status is rejected or cancelled
Binding: TaskStatusReason (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
Task.businessStatus This element is included in summaries. 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: Value Set APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
Task.intent This element is included in summaries. 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Required Pattern: proposal (extensions allowed)
Task.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if Task is prohibiting action
Task.code This element must be supported. This element is included in summaries. C 1..1 CodeableConcept Defines the regulatory message type and triggers specific business rules
Binding: APIX Submission Types (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.
Task.for This element must be supported. This element is included in summaries. 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
Task.requestedPeriod This element must be supported. This element is included in summaries. 0..1 Period Requested period for task fulfilment
Task.requestedPeriod.start This element must be supported. This element is included in summaries. C 0..1 dateTime Clock-start / earliest allowed start
Task.requestedPeriod.end This element must be supported. This element is included in summaries. C 0..1 dateTime Deadline / clock-stop date
Task.executionPeriod This element must be supported. This element is included in summaries. 0..1 Period Actual execution period
Task.executionPeriod.start This element must be supported. This element is included in summaries. C 0..1 dateTime Actual start time
Task.executionPeriod.end This element must be supported. This element is included in summaries. C 0..1 dateTime Actual completion time
Task.authoredOn C 1..1 dateTime Date/time the sender created the Task
Task.lastModified This element is included in summaries. C 1..1 dateTime Task Last Modified Date
Task.requester This element must be supported. This element is included in summaries. 1..1 Reference(APIX Organization) Organization that initiated the task
Task.owner This element must be supported. This element is included in summaries. 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
Task.performer This element must be supported. This element is included in summaries. 0..1 BackboneElement Organization or individual who performed the task
Task.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who performed the task
Task.input This element must be supported. 0..* BackboneElement Input parameters for the task
Task.input.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.input.type This element must be supported. 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Task.input.value[x] 1..1 Content to use in performing the task
Task.input.value[x].valueBase64Binary base64Binary
Task.input.value[x].valueBoolean boolean
Task.input.value[x].valueCanonical canonical(Any)
Task.input.value[x].valueCode code
Task.input.value[x].valueDate date
Task.input.value[x].valueDateTime dateTime
Task.input.value[x].valueDecimal decimal
Task.input.value[x].valueId id
Task.input.value[x].valueInstant instant
Task.input.value[x].valueInteger integer
Task.input.value[x].valueInteger64 integer64
Task.input.value[x].valueMarkdown markdown
Task.input.value[x].valueOid oid
Task.input.value[x].valuePositiveInt positiveInt
Task.input.value[x].valueString string
Task.input.value[x].valueTime time
Task.input.value[x].valueUnsignedInt unsignedInt
Task.input.value[x].valueUri uri
Task.input.value[x].valueUrl url
Task.input.value[x].valueUuid uuid
Task.input.value[x].valueAddress Address
Task.input.value[x].valueAge Age
Task.input.value[x].valueAnnotation Annotation
Task.input.value[x].valueAttachment Attachment
Task.input.value[x].valueCodeableConcept CodeableConcept
Task.input.value[x].valueCodeableReference CodeableReference
Task.input.value[x].valueCoding Coding
Task.input.value[x].valueContactPoint ContactPoint
Task.input.value[x].valueCount Count
Task.input.value[x].valueDistance Distance
Task.input.value[x].valueDuration Duration
Task.input.value[x].valueHumanName HumanName
Task.input.value[x].valueIdentifier Identifier
Task.input.value[x].valueMoney Money
Task.input.value[x].valuePeriod Period
Task.input.value[x].valueQuantity Quantity
Task.input.value[x].valueRange Range
Task.input.value[x].valueRatio Ratio
Task.input.value[x].valueRatioRange RatioRange
Task.input.value[x].valueReference Reference(Any)
Task.input.value[x].valueSampledData SampledData
Task.input.value[x].valueSignature Signature
Task.input.value[x].valueTiming Timing
Task.input.value[x].valueContactDetail ContactDetail
Task.input.value[x].valueDataRequirement DataRequirement
Task.input.value[x].valueExpression Expression
Task.input.value[x].valueParameterDefinition ParameterDefinition
Task.input.value[x].valueRelatedArtifact RelatedArtifact
Task.input.value[x].valueTriggerDefinition TriggerDefinition
Task.input.value[x].valueUsageContext UsageContext
Task.input.value[x].valueAvailability Availability
Task.input.value[x].valueExtendedContactDetail ExtendedContactDetail
Task.input.value[x].valueDosage Dosage
Task.input.value[x].valueMeta Meta
Task.output This element must be supported. 0..* BackboneElement Output produced by the task
Task.output.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.output.type This element must be supported. 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
Task.output.value[x] 1..1 Result of output
Task.output.value[x].valueBase64Binary base64Binary
Task.output.value[x].valueBoolean boolean
Task.output.value[x].valueCanonical canonical(Any)
Task.output.value[x].valueCode code
Task.output.value[x].valueDate date
Task.output.value[x].valueDateTime dateTime
Task.output.value[x].valueDecimal decimal
Task.output.value[x].valueId id
Task.output.value[x].valueInstant instant
Task.output.value[x].valueInteger integer
Task.output.value[x].valueInteger64 integer64
Task.output.value[x].valueMarkdown markdown
Task.output.value[x].valueOid oid
Task.output.value[x].valuePositiveInt positiveInt
Task.output.value[x].valueString string
Task.output.value[x].valueTime time
Task.output.value[x].valueUnsignedInt unsignedInt
Task.output.value[x].valueUri uri
Task.output.value[x].valueUrl url
Task.output.value[x].valueUuid uuid
Task.output.value[x].valueAddress Address
Task.output.value[x].valueAge Age
Task.output.value[x].valueAnnotation Annotation
Task.output.value[x].valueAttachment Attachment
Task.output.value[x].valueCodeableConcept CodeableConcept
Task.output.value[x].valueCodeableReference CodeableReference
Task.output.value[x].valueCoding Coding
Task.output.value[x].valueContactPoint ContactPoint
Task.output.value[x].valueCount Count
Task.output.value[x].valueDistance Distance
Task.output.value[x].valueDuration Duration
Task.output.value[x].valueHumanName HumanName
Task.output.value[x].valueIdentifier Identifier
Task.output.value[x].valueMoney Money
Task.output.value[x].valuePeriod Period
Task.output.value[x].valueQuantity Quantity
Task.output.value[x].valueRange Range
Task.output.value[x].valueRatio Ratio
Task.output.value[x].valueRatioRange RatioRange
Task.output.value[x].valueReference Reference(Any)
Task.output.value[x].valueSampledData SampledData
Task.output.value[x].valueSignature Signature
Task.output.value[x].valueTiming Timing
Task.output.value[x].valueContactDetail ContactDetail
Task.output.value[x].valueDataRequirement DataRequirement
Task.output.value[x].valueExpression Expression
Task.output.value[x].valueParameterDefinition ParameterDefinition
Task.output.value[x].valueRelatedArtifact RelatedArtifact
Task.output.value[x].valueTriggerDefinition TriggerDefinition
Task.output.value[x].valueUsageContext UsageContext
Task.output.value[x].valueAvailability Availability
Task.output.value[x].valueExtendedContactDetail ExtendedContactDetail
Task.output.value[x].valueDosage Dosage
Task.output.value[x].valueMeta Meta

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Task.identifier:TaskInstance.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Task.identifier:TaskInstance.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Task.identifier:RegulatorProcedureNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Task.identifier:RegulatorProcedureNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Task.status Base required Task Status 📍5.0.0 FHIR Std.
Task.statusReason Base example Task Status Reason 📍5.0.0 FHIR Std.
Task.businessStatus Base example Value Set APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required Task Intent 📍5.0.0 FHIR Std.
Task.code Base example APIX Submission Types 📦0.1.0 This IG
Task.input.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Task If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Task If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 error Task If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Task If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Task A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
identifier-is-uuid error Task.identifier:TaskInstance 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}$')
inv-1 error Task Last modified date must be greater than or equal to authored-on date. lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
statusreason-conditional-require error Task A status reason is required when the status is rejected or cancelled. ((status = 'rejected') or (status = 'cancelled')) implies statusReason.exists()
tsk-1 error Task 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()

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Task C 0..* Task A task to be performed
Constraints: statusreason-conditional-require
Task.meta 1..1 Meta Metadata about the resource
Task.meta.versionId 1..1 id Version specific identifier
Task.meta.lastUpdated 0..1 instant Automatically updated on every change
Task.text This element must be supported. 1..1 Narrative Human-readable narrative
Task.Slices for identifier This element must be supported. 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Task.Slices for identifier.identifier:TaskInstance This element must be supported. C 1..* Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
Task.Slices for identifier.identifier:TaskInstance.type 1..1 CodeableConcept Description of identifier
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixtaskinstance",
      "display" : "APIX Task Instance ID"
    }
  ]
}
Task.Slices for identifier.identifier:TaskInstance.value 1..1 string The value that is unique
Task.Slices for identifier.identifier:RegulatorProcedureNumber This element must be supported. 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
Task.Slices for identifier.identifier:RegulatorProcedureNumber.type 1..1 CodeableConcept Description of identifier
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixregulatorprocedureno",
      "display" : "APIX Regulator Procedure Number"
    }
  ]
}
Task.Slices for identifier.identifier:RegulatorProcedureNumber.system 1..1 uri The namespace for the identifier value
Task.Slices for identifier.identifier:RegulatorProcedureNumber.value 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Task.groupIdentifier This element must be supported. 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
Task.statusReason 0..1 CodeableReference() Required if status is rejected or cancelled
Task.businessStatus 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: Value Set APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
Task.intent 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: proposal (extensions allowed)
Task.code This element must be supported. 1..1 CodeableConcept Defines the regulatory message type and triggers specific business rules
Binding: APIX Submission Types (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.
Task.description 0..0 Human-readable explanation of task
Task.for This element must be supported. 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
Task.encounter 0..0 Healthcare event during which this task originated
Task.requestedPeriod This element must be supported. 0..1 Period Requested period for task fulfilment
Task.requestedPeriod.start This element must be supported. 0..1 dateTime Clock-start / earliest allowed start
Task.requestedPeriod.end This element must be supported. 0..1 dateTime Deadline / clock-stop date
Task.executionPeriod This element must be supported. 0..1 Period Actual execution period
Task.executionPeriod.start This element must be supported. 0..1 dateTime Actual start time
Task.executionPeriod.end This element must be supported. 0..1 dateTime Actual completion time
Task.authoredOn 1..1 dateTime Date/time the sender created the Task
Task.lastModified 1..1 dateTime Task Last Modified Date
Task.requester This element must be supported. 1..1 Reference(APIX Organization) Organization that initiated the task
Task.owner This element must be supported. 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
Task.performer This element must be supported. 0..1 BackboneElement Organization or individual who performed the task
Task.relevantHistory 0..0 Key events in history of the Task
Task.restriction 0..0 Constraints on fulfillment tasks
Task.input This element must be supported. 0..* BackboneElement Input parameters for the task
Task.input.type This element must be supported. 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Task.output This element must be supported. 0..* BackboneElement Output produced by the task
Task.output.type This element must be supported. 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Task.businessStatus Base example Value Set APIX Regulatory Business Status 📦0.1.0 This IG
Task.code Base example APIX Submission Types 📦0.1.0 This IG
Task.input.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
identifier-is-uuid error Task.identifier:TaskInstance 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}$')
statusreason-conditional-require error Task A status reason is required when the status is rejected or cancelled. ((status = 'rejected') or (status = 'cancelled')) implies statusReason.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1, statusreason-conditional-require
Task.id This element is included in summaries. 0..1 id Logical id of this artifact
Task.meta This element is included in summaries. 1..1 Meta Metadata about the resource
Task.meta.id 0..1 id Unique id for inter-element referencing
Task.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.meta.versionId This element is included in summaries. 1..1 id Version specific identifier
Task.meta.lastUpdated This element is included in summaries. 0..1 instant Automatically updated on every change
Task.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Task.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Task.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Task.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Task.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Task.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Task.text This element must be supported. 1..1 Narrative Human-readable narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Task.contained 0..* Resource Contained, inline Resources
Task.extension 0..* Extension Additional content defined by implementations
Task.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Task.Slices for identifier This element must be supported. 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Task.Slices for identifier.identifier:TaskInstance This element must be supported. C 1..* Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
Task.Slices for identifier.identifier:TaskInstance.id 0..1 id Unique id for inter-element referencing
Task.Slices for identifier.identifier:TaskInstance.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.Slices for identifier.identifier:TaskInstance.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Task.Slices for identifier.identifier:TaskInstance.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixtaskinstance",
      "display" : "APIX Task Instance ID"
    }
  ]
}
Task.Slices for identifier.identifier:TaskInstance.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Task.Slices for identifier.identifier:TaskInstance.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Task.Slices for identifier.identifier:TaskInstance.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Task.Slices for identifier.identifier:TaskInstance.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Task.Slices for identifier.identifier:RegulatorProcedureNumber This element must be supported. 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
Task.Slices for identifier.identifier:RegulatorProcedureNumber.id 0..1 id Unique id for inter-element referencing
Task.Slices for identifier.identifier:RegulatorProcedureNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.Slices for identifier.identifier:RegulatorProcedureNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Task.Slices for identifier.identifier:RegulatorProcedureNumber.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixregulatorprocedureno",
      "display" : "APIX Regulator Procedure Number"
    }
  ]
}
Task.Slices for identifier.identifier:RegulatorProcedureNumber.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Task.Slices for identifier.identifier:RegulatorProcedureNumber.value This element is included in summaries. C 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
Task.Slices for identifier.identifier:RegulatorProcedureNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Task.Slices for identifier.identifier:RegulatorProcedureNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Task.instantiatesCanonical This element is included in summaries. 0..1 canonical(ActivityDefinition) Formal definition of task
Task.instantiatesUri This element is included in summaries. 0..1 uri Formal definition of task
Task.basedOn This element must be supported. This element is included in summaries. 0..* Reference(Resource) Reference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
Task.groupIdentifier This element must be supported. This element is included in summaries. 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
Task.partOf This element is included in summaries. 0..* Reference(Task) Composite task
Task.status This element is a modifier element. This element is included in summaries. 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.
Task.statusReason This element is included in summaries. 0..1 CodeableReference() Required if status is rejected or cancelled
Binding: TaskStatusReason (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
Task.businessStatus This element is included in summaries. 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: Value Set APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
Task.intent This element is included in summaries. 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Required Pattern: proposal (extensions allowed)
Task.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): The priority of a task (may affect service level applied to the task).
Task.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if Task is prohibiting action
Task.code This element must be supported. This element is included in summaries. C 1..1 CodeableConcept Defines the regulatory message type and triggers specific business rules
Binding: APIX Submission Types (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.
Task.focus This element is included in summaries. C 0..1 Reference(Resource) What task is acting on
Task.for This element must be supported. This element is included in summaries. 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
Task.requestedPeriod This element must be supported. This element is included in summaries. 0..1 Period Requested period for task fulfilment
Task.requestedPeriod.id 0..1 id Unique id for inter-element referencing
Task.requestedPeriod.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.requestedPeriod.start This element must be supported. This element is included in summaries. C 0..1 dateTime Clock-start / earliest allowed start
Task.requestedPeriod.end This element must be supported. This element is included in summaries. C 0..1 dateTime Deadline / clock-stop date
Task.executionPeriod This element must be supported. This element is included in summaries. 0..1 Period Actual execution period
Task.executionPeriod.id 0..1 id Unique id for inter-element referencing
Task.executionPeriod.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.executionPeriod.start This element must be supported. This element is included in summaries. C 0..1 dateTime Actual start time
Task.executionPeriod.end This element must be supported. This element is included in summaries. C 0..1 dateTime Actual completion time
Task.authoredOn C 1..1 dateTime Date/time the sender created the Task
Task.lastModified This element is included in summaries. C 1..1 dateTime Task Last Modified Date
Task.requester This element must be supported. This element is included in summaries. 1..1 Reference(APIX Organization) Organization that initiated the task
Task.requestedPerformer 0..* CodeableReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Who should perform Task
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.
Task.owner This element must be supported. This element is included in summaries. 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
Task.performer This element must be supported. This element is included in summaries. 0..1 BackboneElement Organization or individual who performed the task
Task.performer.id 0..1 string Unique id for inter-element referencing
Task.performer.extension 0..* Extension Additional content defined by implementations
Task.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.performer.function This element is included in summaries. 0..1 CodeableConcept Type of performance
Binding Description: (example): Codes to identify types of task performers.
Task.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who performed the task
Task.location This element is included in summaries. 0..1 Reference(Location) Where task occurs
Task.reason 0..* CodeableReference() Why task is needed
Binding Description: (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
Task.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
Task.note 0..* Annotation Comments made about the task
Task.input This element must be supported. 0..* BackboneElement Input parameters for the task
Task.input.id 0..1 string Unique id for inter-element referencing
Task.input.extension 0..* Extension Additional content defined by implementations
Task.input.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.input.type This element must be supported. 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Task.input.value[x] 1..1 Content to use in performing the task
Task.input.value[x].valueBase64Binary base64Binary
Task.input.value[x].valueBoolean boolean
Task.input.value[x].valueCanonical canonical(Any)
Task.input.value[x].valueCode code
Task.input.value[x].valueDate date
Task.input.value[x].valueDateTime dateTime
Task.input.value[x].valueDecimal decimal
Task.input.value[x].valueId id
Task.input.value[x].valueInstant instant
Task.input.value[x].valueInteger integer
Task.input.value[x].valueInteger64 integer64
Task.input.value[x].valueMarkdown markdown
Task.input.value[x].valueOid oid
Task.input.value[x].valuePositiveInt positiveInt
Task.input.value[x].valueString string
Task.input.value[x].valueTime time
Task.input.value[x].valueUnsignedInt unsignedInt
Task.input.value[x].valueUri uri
Task.input.value[x].valueUrl url
Task.input.value[x].valueUuid uuid
Task.input.value[x].valueAddress Address
Task.input.value[x].valueAge Age
Task.input.value[x].valueAnnotation Annotation
Task.input.value[x].valueAttachment Attachment
Task.input.value[x].valueCodeableConcept CodeableConcept
Task.input.value[x].valueCodeableReference CodeableReference
Task.input.value[x].valueCoding Coding
Task.input.value[x].valueContactPoint ContactPoint
Task.input.value[x].valueCount Count
Task.input.value[x].valueDistance Distance
Task.input.value[x].valueDuration Duration
Task.input.value[x].valueHumanName HumanName
Task.input.value[x].valueIdentifier Identifier
Task.input.value[x].valueMoney Money
Task.input.value[x].valuePeriod Period
Task.input.value[x].valueQuantity Quantity
Task.input.value[x].valueRange Range
Task.input.value[x].valueRatio Ratio
Task.input.value[x].valueRatioRange RatioRange
Task.input.value[x].valueReference Reference(Any)
Task.input.value[x].valueSampledData SampledData
Task.input.value[x].valueSignature Signature
Task.input.value[x].valueTiming Timing
Task.input.value[x].valueContactDetail ContactDetail
Task.input.value[x].valueDataRequirement DataRequirement
Task.input.value[x].valueExpression Expression
Task.input.value[x].valueParameterDefinition ParameterDefinition
Task.input.value[x].valueRelatedArtifact RelatedArtifact
Task.input.value[x].valueTriggerDefinition TriggerDefinition
Task.input.value[x].valueUsageContext UsageContext
Task.input.value[x].valueAvailability Availability
Task.input.value[x].valueExtendedContactDetail ExtendedContactDetail
Task.input.value[x].valueDosage Dosage
Task.input.value[x].valueMeta Meta
Task.output This element must be supported. 0..* BackboneElement Output produced by the task
Task.output.id 0..1 string Unique id for inter-element referencing
Task.output.extension 0..* Extension Additional content defined by implementations
Task.output.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.output.type This element must be supported. 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
Task.output.value[x] 1..1 Result of output
Task.output.value[x].valueBase64Binary base64Binary
Task.output.value[x].valueBoolean boolean
Task.output.value[x].valueCanonical canonical(Any)
Task.output.value[x].valueCode code
Task.output.value[x].valueDate date
Task.output.value[x].valueDateTime dateTime
Task.output.value[x].valueDecimal decimal
Task.output.value[x].valueId id
Task.output.value[x].valueInstant instant
Task.output.value[x].valueInteger integer
Task.output.value[x].valueInteger64 integer64
Task.output.value[x].valueMarkdown markdown
Task.output.value[x].valueOid oid
Task.output.value[x].valuePositiveInt positiveInt
Task.output.value[x].valueString string
Task.output.value[x].valueTime time
Task.output.value[x].valueUnsignedInt unsignedInt
Task.output.value[x].valueUri uri
Task.output.value[x].valueUrl url
Task.output.value[x].valueUuid uuid
Task.output.value[x].valueAddress Address
Task.output.value[x].valueAge Age
Task.output.value[x].valueAnnotation Annotation
Task.output.value[x].valueAttachment Attachment
Task.output.value[x].valueCodeableConcept CodeableConcept
Task.output.value[x].valueCodeableReference CodeableReference
Task.output.value[x].valueCoding Coding
Task.output.value[x].valueContactPoint ContactPoint
Task.output.value[x].valueCount Count
Task.output.value[x].valueDistance Distance
Task.output.value[x].valueDuration Duration
Task.output.value[x].valueHumanName HumanName
Task.output.value[x].valueIdentifier Identifier
Task.output.value[x].valueMoney Money
Task.output.value[x].valuePeriod Period
Task.output.value[x].valueQuantity Quantity
Task.output.value[x].valueRange Range
Task.output.value[x].valueRatio Ratio
Task.output.value[x].valueRatioRange RatioRange
Task.output.value[x].valueReference Reference(Any)
Task.output.value[x].valueSampledData SampledData
Task.output.value[x].valueSignature Signature
Task.output.value[x].valueTiming Timing
Task.output.value[x].valueContactDetail ContactDetail
Task.output.value[x].valueDataRequirement DataRequirement
Task.output.value[x].valueExpression Expression
Task.output.value[x].valueParameterDefinition ParameterDefinition
Task.output.value[x].valueRelatedArtifact RelatedArtifact
Task.output.value[x].valueTriggerDefinition TriggerDefinition
Task.output.value[x].valueUsageContext UsageContext
Task.output.value[x].valueAvailability Availability
Task.output.value[x].valueExtendedContactDetail ExtendedContactDetail
Task.output.value[x].valueDosage Dosage
Task.output.value[x].valueMeta Meta

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Task.meta.security Base extensible All Security Labels 📍5.0.0 FHIR Std.
Task.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Task.language Base required All Languages 📍5.0.0 FHIR Std.
Task.identifier:TaskInstance.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Task.identifier:TaskInstance.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Task.identifier:RegulatorProcedureNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Task.identifier:RegulatorProcedureNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Task.status Base required Task Status 📍5.0.0 FHIR Std.
Task.statusReason Base example Task Status Reason 📍5.0.0 FHIR Std.
Task.businessStatus Base example Value Set APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required Task Intent 📍5.0.0 FHIR Std.
Task.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Task.code Base example APIX Submission Types 📦0.1.0 This IG
Task.requestedPerformer Base preferred Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Task.performer.function Base example Not State Unknown
Task.reason Base example Not State Unknown
Task.input.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Task If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Task If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 error Task If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Task If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Task A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
identifier-is-uuid error Task.identifier:TaskInstance 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}$')
inv-1 error Task Last modified date must be greater than or equal to authored-on date. lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
statusreason-conditional-require error Task A status reason is required when the status is rejected or cancelled. ((status = 'rejected') or (status = 'cancelled')) implies statusReason.exists()
tsk-1 error Task 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()

This structure is derived from Task

Summary

Mandatory: 12 elements(3 nested mandatory elements)
Must-Support: 21 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Task.identifier

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1, statusreason-conditional-require
Task.meta This element is included in summaries. 1..1 Meta Metadata about the resource
Task.meta.versionId This element is included in summaries. 1..1 id Version specific identifier
Task.meta.lastUpdated This element is included in summaries. 0..1 instant Automatically updated on every change
Task.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Task.text This element must be supported. 1..1 Narrative Human-readable narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Task.contained 0..* Resource Contained, inline Resources
Task.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Task.Slices for identifier This element must be supported. 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Task.Slices for identifier.identifier:TaskInstance This element must be supported. C 1..* Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
Task.Slices for identifier.identifier:TaskInstance.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Task.Slices for identifier.identifier:TaskInstance.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixtaskinstance",
      "display" : "APIX Task Instance ID"
    }
  ]
}
Task.Slices for identifier.identifier:TaskInstance.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Task.Slices for identifier.identifier:RegulatorProcedureNumber This element must be supported. 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
Task.Slices for identifier.identifier:RegulatorProcedureNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Task.Slices for identifier.identifier:RegulatorProcedureNumber.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixregulatorprocedureno",
      "display" : "APIX Regulator Procedure Number"
    }
  ]
}
Task.Slices for identifier.identifier:RegulatorProcedureNumber.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Task.Slices for identifier.identifier:RegulatorProcedureNumber.value This element is included in summaries. C 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
Task.basedOn This element must be supported. This element is included in summaries. 0..* Reference(Resource) Reference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
Task.groupIdentifier This element must be supported. This element is included in summaries. 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
Task.status This element is a modifier element. This element is included in summaries. 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.
Task.statusReason This element is included in summaries. 0..1 CodeableReference() Required if status is rejected or cancelled
Binding: TaskStatusReason (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
Task.businessStatus This element is included in summaries. 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: Value Set APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
Task.intent This element is included in summaries. 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Required Pattern: proposal (extensions allowed)
Task.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if Task is prohibiting action
Task.code This element must be supported. This element is included in summaries. C 1..1 CodeableConcept Defines the regulatory message type and triggers specific business rules
Binding: APIX Submission Types (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.
Task.for This element must be supported. This element is included in summaries. 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
Task.requestedPeriod This element must be supported. This element is included in summaries. 0..1 Period Requested period for task fulfilment
Task.requestedPeriod.start This element must be supported. This element is included in summaries. C 0..1 dateTime Clock-start / earliest allowed start
Task.requestedPeriod.end This element must be supported. This element is included in summaries. C 0..1 dateTime Deadline / clock-stop date
Task.executionPeriod This element must be supported. This element is included in summaries. 0..1 Period Actual execution period
Task.executionPeriod.start This element must be supported. This element is included in summaries. C 0..1 dateTime Actual start time
Task.executionPeriod.end This element must be supported. This element is included in summaries. C 0..1 dateTime Actual completion time
Task.authoredOn C 1..1 dateTime Date/time the sender created the Task
Task.lastModified This element is included in summaries. C 1..1 dateTime Task Last Modified Date
Task.requester This element must be supported. This element is included in summaries. 1..1 Reference(APIX Organization) Organization that initiated the task
Task.owner This element must be supported. This element is included in summaries. 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
Task.performer This element must be supported. This element is included in summaries. 0..1 BackboneElement Organization or individual who performed the task
Task.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who performed the task
Task.input This element must be supported. 0..* BackboneElement Input parameters for the task
Task.input.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.input.type This element must be supported. 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Task.input.value[x] 1..1 Content to use in performing the task
Task.input.value[x].valueBase64Binary base64Binary
Task.input.value[x].valueBoolean boolean
Task.input.value[x].valueCanonical canonical(Any)
Task.input.value[x].valueCode code
Task.input.value[x].valueDate date
Task.input.value[x].valueDateTime dateTime
Task.input.value[x].valueDecimal decimal
Task.input.value[x].valueId id
Task.input.value[x].valueInstant instant
Task.input.value[x].valueInteger integer
Task.input.value[x].valueInteger64 integer64
Task.input.value[x].valueMarkdown markdown
Task.input.value[x].valueOid oid
Task.input.value[x].valuePositiveInt positiveInt
Task.input.value[x].valueString string
Task.input.value[x].valueTime time
Task.input.value[x].valueUnsignedInt unsignedInt
Task.input.value[x].valueUri uri
Task.input.value[x].valueUrl url
Task.input.value[x].valueUuid uuid
Task.input.value[x].valueAddress Address
Task.input.value[x].valueAge Age
Task.input.value[x].valueAnnotation Annotation
Task.input.value[x].valueAttachment Attachment
Task.input.value[x].valueCodeableConcept CodeableConcept
Task.input.value[x].valueCodeableReference CodeableReference
Task.input.value[x].valueCoding Coding
Task.input.value[x].valueContactPoint ContactPoint
Task.input.value[x].valueCount Count
Task.input.value[x].valueDistance Distance
Task.input.value[x].valueDuration Duration
Task.input.value[x].valueHumanName HumanName
Task.input.value[x].valueIdentifier Identifier
Task.input.value[x].valueMoney Money
Task.input.value[x].valuePeriod Period
Task.input.value[x].valueQuantity Quantity
Task.input.value[x].valueRange Range
Task.input.value[x].valueRatio Ratio
Task.input.value[x].valueRatioRange RatioRange
Task.input.value[x].valueReference Reference(Any)
Task.input.value[x].valueSampledData SampledData
Task.input.value[x].valueSignature Signature
Task.input.value[x].valueTiming Timing
Task.input.value[x].valueContactDetail ContactDetail
Task.input.value[x].valueDataRequirement DataRequirement
Task.input.value[x].valueExpression Expression
Task.input.value[x].valueParameterDefinition ParameterDefinition
Task.input.value[x].valueRelatedArtifact RelatedArtifact
Task.input.value[x].valueTriggerDefinition TriggerDefinition
Task.input.value[x].valueUsageContext UsageContext
Task.input.value[x].valueAvailability Availability
Task.input.value[x].valueExtendedContactDetail ExtendedContactDetail
Task.input.value[x].valueDosage Dosage
Task.input.value[x].valueMeta Meta
Task.output This element must be supported. 0..* BackboneElement Output produced by the task
Task.output.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.output.type This element must be supported. 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
Task.output.value[x] 1..1 Result of output
Task.output.value[x].valueBase64Binary base64Binary
Task.output.value[x].valueBoolean boolean
Task.output.value[x].valueCanonical canonical(Any)
Task.output.value[x].valueCode code
Task.output.value[x].valueDate date
Task.output.value[x].valueDateTime dateTime
Task.output.value[x].valueDecimal decimal
Task.output.value[x].valueId id
Task.output.value[x].valueInstant instant
Task.output.value[x].valueInteger integer
Task.output.value[x].valueInteger64 integer64
Task.output.value[x].valueMarkdown markdown
Task.output.value[x].valueOid oid
Task.output.value[x].valuePositiveInt positiveInt
Task.output.value[x].valueString string
Task.output.value[x].valueTime time
Task.output.value[x].valueUnsignedInt unsignedInt
Task.output.value[x].valueUri uri
Task.output.value[x].valueUrl url
Task.output.value[x].valueUuid uuid
Task.output.value[x].valueAddress Address
Task.output.value[x].valueAge Age
Task.output.value[x].valueAnnotation Annotation
Task.output.value[x].valueAttachment Attachment
Task.output.value[x].valueCodeableConcept CodeableConcept
Task.output.value[x].valueCodeableReference CodeableReference
Task.output.value[x].valueCoding Coding
Task.output.value[x].valueContactPoint ContactPoint
Task.output.value[x].valueCount Count
Task.output.value[x].valueDistance Distance
Task.output.value[x].valueDuration Duration
Task.output.value[x].valueHumanName HumanName
Task.output.value[x].valueIdentifier Identifier
Task.output.value[x].valueMoney Money
Task.output.value[x].valuePeriod Period
Task.output.value[x].valueQuantity Quantity
Task.output.value[x].valueRange Range
Task.output.value[x].valueRatio Ratio
Task.output.value[x].valueRatioRange RatioRange
Task.output.value[x].valueReference Reference(Any)
Task.output.value[x].valueSampledData SampledData
Task.output.value[x].valueSignature Signature
Task.output.value[x].valueTiming Timing
Task.output.value[x].valueContactDetail ContactDetail
Task.output.value[x].valueDataRequirement DataRequirement
Task.output.value[x].valueExpression Expression
Task.output.value[x].valueParameterDefinition ParameterDefinition
Task.output.value[x].valueRelatedArtifact RelatedArtifact
Task.output.value[x].valueTriggerDefinition TriggerDefinition
Task.output.value[x].valueUsageContext UsageContext
Task.output.value[x].valueAvailability Availability
Task.output.value[x].valueExtendedContactDetail ExtendedContactDetail
Task.output.value[x].valueDosage Dosage
Task.output.value[x].valueMeta Meta

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Task.identifier:TaskInstance.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Task.identifier:TaskInstance.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Task.identifier:RegulatorProcedureNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Task.identifier:RegulatorProcedureNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Task.status Base required Task Status 📍5.0.0 FHIR Std.
Task.statusReason Base example Task Status Reason 📍5.0.0 FHIR Std.
Task.businessStatus Base example Value Set APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required Task Intent 📍5.0.0 FHIR Std.
Task.code Base example APIX Submission Types 📦0.1.0 This IG
Task.input.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Task If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Task If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 error Task If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Task If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Task A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
identifier-is-uuid error Task.identifier:TaskInstance 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}$')
inv-1 error Task Last modified date must be greater than or equal to authored-on date. lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
statusreason-conditional-require error Task A status reason is required when the status is rejected or cancelled. ((status = 'rejected') or (status = 'cancelled')) implies statusReason.exists()
tsk-1 error Task 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()

Differential View

This structure is derived from Task

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Task C 0..* Task A task to be performed
Constraints: statusreason-conditional-require
Task.meta 1..1 Meta Metadata about the resource
Task.meta.versionId 1..1 id Version specific identifier
Task.meta.lastUpdated 0..1 instant Automatically updated on every change
Task.text This element must be supported. 1..1 Narrative Human-readable narrative
Task.Slices for identifier This element must be supported. 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Task.Slices for identifier.identifier:TaskInstance This element must be supported. C 1..* Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
Task.Slices for identifier.identifier:TaskInstance.type 1..1 CodeableConcept Description of identifier
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixtaskinstance",
      "display" : "APIX Task Instance ID"
    }
  ]
}
Task.Slices for identifier.identifier:TaskInstance.value 1..1 string The value that is unique
Task.Slices for identifier.identifier:RegulatorProcedureNumber This element must be supported. 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
Task.Slices for identifier.identifier:RegulatorProcedureNumber.type 1..1 CodeableConcept Description of identifier
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixregulatorprocedureno",
      "display" : "APIX Regulator Procedure Number"
    }
  ]
}
Task.Slices for identifier.identifier:RegulatorProcedureNumber.system 1..1 uri The namespace for the identifier value
Task.Slices for identifier.identifier:RegulatorProcedureNumber.value 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Task.basedOn This element must be supported. 0..* Reference(Resource) Reference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
Task.groupIdentifier This element must be supported. 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
Task.statusReason 0..1 CodeableReference() Required if status is rejected or cancelled
Task.businessStatus 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: Value Set APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
Task.intent 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: proposal (extensions allowed)
Task.code This element must be supported. 1..1 CodeableConcept Defines the regulatory message type and triggers specific business rules
Binding: APIX Submission Types (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.
Task.description 0..0 Human-readable explanation of task
Task.for This element must be supported. 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
Task.encounter 0..0 Healthcare event during which this task originated
Task.requestedPeriod This element must be supported. 0..1 Period Requested period for task fulfilment
Task.requestedPeriod.start This element must be supported. 0..1 dateTime Clock-start / earliest allowed start
Task.requestedPeriod.end This element must be supported. 0..1 dateTime Deadline / clock-stop date
Task.executionPeriod This element must be supported. 0..1 Period Actual execution period
Task.executionPeriod.start This element must be supported. 0..1 dateTime Actual start time
Task.executionPeriod.end This element must be supported. 0..1 dateTime Actual completion time
Task.authoredOn 1..1 dateTime Date/time the sender created the Task
Task.lastModified 1..1 dateTime Task Last Modified Date
Task.requester This element must be supported. 1..1 Reference(APIX Organization) Organization that initiated the task
Task.owner This element must be supported. 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
Task.performer This element must be supported. 0..1 BackboneElement Organization or individual who performed the task
Task.relevantHistory 0..0 Key events in history of the Task
Task.restriction 0..0 Constraints on fulfillment tasks
Task.input This element must be supported. 0..* BackboneElement Input parameters for the task
Task.input.type This element must be supported. 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Task.output This element must be supported. 0..* BackboneElement Output produced by the task
Task.output.type This element must be supported. 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Task.businessStatus Base example Value Set APIX Regulatory Business Status 📦0.1.0 This IG
Task.code Base example APIX Submission Types 📦0.1.0 This IG
Task.input.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
identifier-is-uuid error Task.identifier:TaskInstance 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}$')
statusreason-conditional-require error Task A status reason is required when the status is rejected or cancelled. ((status = 'rejected') or (status = 'cancelled')) implies statusReason.exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1, statusreason-conditional-require
Task.id This element is included in summaries. 0..1 id Logical id of this artifact
Task.meta This element is included in summaries. 1..1 Meta Metadata about the resource
Task.meta.id 0..1 id Unique id for inter-element referencing
Task.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.meta.versionId This element is included in summaries. 1..1 id Version specific identifier
Task.meta.lastUpdated This element is included in summaries. 0..1 instant Automatically updated on every change
Task.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
Task.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Task.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Task.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Task.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Task.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Task.text This element must be supported. 1..1 Narrative Human-readable narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Task.contained 0..* Resource Contained, inline Resources
Task.extension 0..* Extension Additional content defined by implementations
Task.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Task.Slices for identifier This element must be supported. 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Task.Slices for identifier.identifier:TaskInstance This element must be supported. C 1..* Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
Task.Slices for identifier.identifier:TaskInstance.id 0..1 id Unique id for inter-element referencing
Task.Slices for identifier.identifier:TaskInstance.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.Slices for identifier.identifier:TaskInstance.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Task.Slices for identifier.identifier:TaskInstance.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixtaskinstance",
      "display" : "APIX Task Instance ID"
    }
  ]
}
Task.Slices for identifier.identifier:TaskInstance.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Task.Slices for identifier.identifier:TaskInstance.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Task.Slices for identifier.identifier:TaskInstance.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Task.Slices for identifier.identifier:TaskInstance.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Task.Slices for identifier.identifier:RegulatorProcedureNumber This element must be supported. 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
Task.Slices for identifier.identifier:RegulatorProcedureNumber.id 0..1 id Unique id for inter-element referencing
Task.Slices for identifier.identifier:RegulatorProcedureNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.Slices for identifier.identifier:RegulatorProcedureNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Task.Slices for identifier.identifier:RegulatorProcedureNumber.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://hl7.org/fhir/uv/apix/CodeSystem/apix-demo",
      "code" : "apixregulatorprocedureno",
      "display" : "APIX Regulator Procedure Number"
    }
  ]
}
Task.Slices for identifier.identifier:RegulatorProcedureNumber.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Task.Slices for identifier.identifier:RegulatorProcedureNumber.value This element is included in summaries. C 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
Task.Slices for identifier.identifier:RegulatorProcedureNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Task.Slices for identifier.identifier:RegulatorProcedureNumber.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Task.instantiatesCanonical This element is included in summaries. 0..1 canonical(ActivityDefinition) Formal definition of task
Task.instantiatesUri This element is included in summaries. 0..1 uri Formal definition of task
Task.basedOn This element must be supported. This element is included in summaries. 0..* Reference(Resource) Reference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
Task.groupIdentifier This element must be supported. This element is included in summaries. 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
Task.partOf This element is included in summaries. 0..* Reference(Task) Composite task
Task.status This element is a modifier element. This element is included in summaries. 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.
Task.statusReason This element is included in summaries. 0..1 CodeableReference() Required if status is rejected or cancelled
Binding: TaskStatusReason (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
Task.businessStatus This element is included in summaries. 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: Value Set APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
Task.intent This element is included in summaries. 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Required Pattern: proposal (extensions allowed)
Task.priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): The priority of a task (may affect service level applied to the task).
Task.doNotPerform This element is a modifier element. This element is included in summaries. 0..1 boolean True if Task is prohibiting action
Task.code This element must be supported. This element is included in summaries. C 1..1 CodeableConcept Defines the regulatory message type and triggers specific business rules
Binding: APIX Submission Types (example): Codes to identify what the task involves. These will typically be specific to a particular workflow.
Task.focus This element is included in summaries. C 0..1 Reference(Resource) What task is acting on
Task.for This element must be supported. This element is included in summaries. 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
Task.requestedPeriod This element must be supported. This element is included in summaries. 0..1 Period Requested period for task fulfilment
Task.requestedPeriod.id 0..1 id Unique id for inter-element referencing
Task.requestedPeriod.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.requestedPeriod.start This element must be supported. This element is included in summaries. C 0..1 dateTime Clock-start / earliest allowed start
Task.requestedPeriod.end This element must be supported. This element is included in summaries. C 0..1 dateTime Deadline / clock-stop date
Task.executionPeriod This element must be supported. This element is included in summaries. 0..1 Period Actual execution period
Task.executionPeriod.id 0..1 id Unique id for inter-element referencing
Task.executionPeriod.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Task.executionPeriod.start This element must be supported. This element is included in summaries. C 0..1 dateTime Actual start time
Task.executionPeriod.end This element must be supported. This element is included in summaries. C 0..1 dateTime Actual completion time
Task.authoredOn C 1..1 dateTime Date/time the sender created the Task
Task.lastModified This element is included in summaries. C 1..1 dateTime Task Last Modified Date
Task.requester This element must be supported. This element is included in summaries. 1..1 Reference(APIX Organization) Organization that initiated the task
Task.requestedPerformer 0..* CodeableReference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Who should perform Task
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.
Task.owner This element must be supported. This element is included in summaries. 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
Task.performer This element must be supported. This element is included in summaries. 0..1 BackboneElement Organization or individual who performed the task
Task.performer.id 0..1 string Unique id for inter-element referencing
Task.performer.extension 0..* Extension Additional content defined by implementations
Task.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.performer.function This element is included in summaries. 0..1 CodeableConcept Type of performance
Binding Description: (example): Codes to identify types of task performers.
Task.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who performed the task
Task.location This element is included in summaries. 0..1 Reference(Location) Where task occurs
Task.reason 0..* CodeableReference() Why task is needed
Binding Description: (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
Task.insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
Task.note 0..* Annotation Comments made about the task
Task.input This element must be supported. 0..* BackboneElement Input parameters for the task
Task.input.id 0..1 string Unique id for inter-element referencing
Task.input.extension 0..* Extension Additional content defined by implementations
Task.input.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.input.type This element must be supported. 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc.
Task.input.value[x] 1..1 Content to use in performing the task
Task.input.value[x].valueBase64Binary base64Binary
Task.input.value[x].valueBoolean boolean
Task.input.value[x].valueCanonical canonical(Any)
Task.input.value[x].valueCode code
Task.input.value[x].valueDate date
Task.input.value[x].valueDateTime dateTime
Task.input.value[x].valueDecimal decimal
Task.input.value[x].valueId id
Task.input.value[x].valueInstant instant
Task.input.value[x].valueInteger integer
Task.input.value[x].valueInteger64 integer64
Task.input.value[x].valueMarkdown markdown
Task.input.value[x].valueOid oid
Task.input.value[x].valuePositiveInt positiveInt
Task.input.value[x].valueString string
Task.input.value[x].valueTime time
Task.input.value[x].valueUnsignedInt unsignedInt
Task.input.value[x].valueUri uri
Task.input.value[x].valueUrl url
Task.input.value[x].valueUuid uuid
Task.input.value[x].valueAddress Address
Task.input.value[x].valueAge Age
Task.input.value[x].valueAnnotation Annotation
Task.input.value[x].valueAttachment Attachment
Task.input.value[x].valueCodeableConcept CodeableConcept
Task.input.value[x].valueCodeableReference CodeableReference
Task.input.value[x].valueCoding Coding
Task.input.value[x].valueContactPoint ContactPoint
Task.input.value[x].valueCount Count
Task.input.value[x].valueDistance Distance
Task.input.value[x].valueDuration Duration
Task.input.value[x].valueHumanName HumanName
Task.input.value[x].valueIdentifier Identifier
Task.input.value[x].valueMoney Money
Task.input.value[x].valuePeriod Period
Task.input.value[x].valueQuantity Quantity
Task.input.value[x].valueRange Range
Task.input.value[x].valueRatio Ratio
Task.input.value[x].valueRatioRange RatioRange
Task.input.value[x].valueReference Reference(Any)
Task.input.value[x].valueSampledData SampledData
Task.input.value[x].valueSignature Signature
Task.input.value[x].valueTiming Timing
Task.input.value[x].valueContactDetail ContactDetail
Task.input.value[x].valueDataRequirement DataRequirement
Task.input.value[x].valueExpression Expression
Task.input.value[x].valueParameterDefinition ParameterDefinition
Task.input.value[x].valueRelatedArtifact RelatedArtifact
Task.input.value[x].valueTriggerDefinition TriggerDefinition
Task.input.value[x].valueUsageContext UsageContext
Task.input.value[x].valueAvailability Availability
Task.input.value[x].valueExtendedContactDetail ExtendedContactDetail
Task.input.value[x].valueDosage Dosage
Task.input.value[x].valueMeta Meta
Task.output This element must be supported. 0..* BackboneElement Output produced by the task
Task.output.id 0..1 string Unique id for inter-element referencing
Task.output.extension 0..* Extension Additional content defined by implementations
Task.output.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Task.output.type This element must be supported. 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: Value Set APIX CTD/eCTD Section Code System (example): Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc.
Task.output.value[x] 1..1 Result of output
Task.output.value[x].valueBase64Binary base64Binary
Task.output.value[x].valueBoolean boolean
Task.output.value[x].valueCanonical canonical(Any)
Task.output.value[x].valueCode code
Task.output.value[x].valueDate date
Task.output.value[x].valueDateTime dateTime
Task.output.value[x].valueDecimal decimal
Task.output.value[x].valueId id
Task.output.value[x].valueInstant instant
Task.output.value[x].valueInteger integer
Task.output.value[x].valueInteger64 integer64
Task.output.value[x].valueMarkdown markdown
Task.output.value[x].valueOid oid
Task.output.value[x].valuePositiveInt positiveInt
Task.output.value[x].valueString string
Task.output.value[x].valueTime time
Task.output.value[x].valueUnsignedInt unsignedInt
Task.output.value[x].valueUri uri
Task.output.value[x].valueUrl url
Task.output.value[x].valueUuid uuid
Task.output.value[x].valueAddress Address
Task.output.value[x].valueAge Age
Task.output.value[x].valueAnnotation Annotation
Task.output.value[x].valueAttachment Attachment
Task.output.value[x].valueCodeableConcept CodeableConcept
Task.output.value[x].valueCodeableReference CodeableReference
Task.output.value[x].valueCoding Coding
Task.output.value[x].valueContactPoint ContactPoint
Task.output.value[x].valueCount Count
Task.output.value[x].valueDistance Distance
Task.output.value[x].valueDuration Duration
Task.output.value[x].valueHumanName HumanName
Task.output.value[x].valueIdentifier Identifier
Task.output.value[x].valueMoney Money
Task.output.value[x].valuePeriod Period
Task.output.value[x].valueQuantity Quantity
Task.output.value[x].valueRange Range
Task.output.value[x].valueRatio Ratio
Task.output.value[x].valueRatioRange RatioRange
Task.output.value[x].valueReference Reference(Any)
Task.output.value[x].valueSampledData SampledData
Task.output.value[x].valueSignature Signature
Task.output.value[x].valueTiming Timing
Task.output.value[x].valueContactDetail ContactDetail
Task.output.value[x].valueDataRequirement DataRequirement
Task.output.value[x].valueExpression Expression
Task.output.value[x].valueParameterDefinition ParameterDefinition
Task.output.value[x].valueRelatedArtifact RelatedArtifact
Task.output.value[x].valueTriggerDefinition TriggerDefinition
Task.output.value[x].valueUsageContext UsageContext
Task.output.value[x].valueAvailability Availability
Task.output.value[x].valueExtendedContactDetail ExtendedContactDetail
Task.output.value[x].valueDosage Dosage
Task.output.value[x].valueMeta Meta

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Task.meta.security Base extensible All Security Labels 📍5.0.0 FHIR Std.
Task.meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
Task.language Base required All Languages 📍5.0.0 FHIR Std.
Task.identifier:TaskInstance.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Task.identifier:TaskInstance.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Task.identifier:RegulatorProcedureNumber.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Task.identifier:RegulatorProcedureNumber.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Task.status Base required Task Status 📍5.0.0 FHIR Std.
Task.statusReason Base example Task Status Reason 📍5.0.0 FHIR Std.
Task.businessStatus Base example Value Set APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required Task Intent 📍5.0.0 FHIR Std.
Task.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Task.code Base example APIX Submission Types 📦0.1.0 This IG
Task.requestedPerformer Base preferred Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Task.performer.function Base example Not State Unknown
Task.reason Base example Not State Unknown
Task.input.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example Value Set APIX CTD/eCTD Section Code System 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Task If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Task If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 error Task If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Task If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Task A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
identifier-is-uuid error Task.identifier:TaskInstance 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}$')
inv-1 error Task Last modified date must be greater than or equal to authored-on date. lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn
statusreason-conditional-require error Task A status reason is required when the status is rejected or cancelled. ((status = 'rejected') or (status = 'cancelled')) implies statusReason.exists()
tsk-1 error Task 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()

This structure is derived from Task

Summary

Mandatory: 12 elements(3 nested mandatory elements)
Must-Support: 21 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Task.identifier

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron